Get Company - Revision history

Ian: /* Example curl request */

2016-11-14T12:47:39Z

‎Example curl request

Ian: /* Attachments array */

2016-11-14T12:47:28Z

‎Attachments array

Ryanmt: /* Attachments array */

2013-05-15T14:04:45Z

‎Attachments array

Ryanmt: /* Example response */

2013-05-15T14:04:05Z

‎Example response

Ryanmt: /* Response Parameters */

2013-05-15T14:03:43Z

‎Response Parameters

Ryanmt: Created page with "== Summary == {| border="1" class="wikitable" ! Get Company ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/companies/company |- ! Type | colsp..."

2013-05-15T13:59:38Z

Created page with "== Summary == {| border="1" class="wikitable" ! Get Company ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/companies/company |- ! Type | colsp..."

New page

== Summary ==
{| border="1" class="wikitable"

! Get Company
! colspan="2" |
|-
! URL
| colspan="2" | http://:base_url/:api_path/:version/companies/company
|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
! Response
| colspan="2" | JSON
|}

Returns company data and company attachments. Company attachments are separate from job attachments. Along with the basic information on the company you get a few bits related to their customisations (colour scheme etc) which may be useful for developing bespoke applications.

== Response Parameters ==
{| border="1" class="wikitable"

! Field
! Description
|-
! name
| Company Name
|-
! contact_name
| Contact Name
|-

! contact_email
| Contact Email
|-
! created_at
| Date company signed up to MMW
|-
! color_1
| One of the colours used to customise the portal
|-
! color_2
| One of the colours used to customise the portal
|-
! color_3
| One of the colours used to customise the portal
|-
! locale
| Currently not used
|-
! logo_path
| Raw filename of companies logo. To hotlink use http://live.mymobileworkers.com/uploads/logos/"logo_path"
|-
! vehicle_check_disclaimer
| Vehicle Check Disclaimer
|-
! company_registration_number
| VAT number if entered
|-
! subdomain
| If customer portal is enabled companies customers can visit http://"subdomain".mymobileworkers.com
|-
! address_1
| Address line 1
|-
! address_2
| Address line 2
|-
! address_3
| Address line 3
|-
! address_4
| Address line 4
|-
! postcode
| Postcode
|-
! vat_rate
| VAT percentage (1.2 = 20% etc.)
|-
! attachments
| Array of attachments
|-
|}

== Example response ==
<source lang="java">
[
{"username":"USER1","email":"ryanmt@nospam.com","color":"D7C863","engineer_registration_number":null},
{"username":"USER2","email":"bobbob@nospam.com","color":"97326A","engineer_registration_number":null},
{"username":"USER3","email":"sdfasdf@nospam.com","color":"56500D","engineer_registration_number":null},
{"username":"USER4","email":"asdsdf@nospam.com","color":"C1C355","engineer_registration_number":null},
{"username":"USER5","email":"asdfds@nospam.com","color":"FA556A","engineer_registration_number":null}
]
</source>

== Example curl request ==

http://live.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY

← Older revision		Revision as of 12:47, 14 November 2016
Line 146:		Line 146:
	== Example curl request ==		== Example curl request ==

−	http://~~live~~.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY	+	http://api.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY

@@ Line 95: / Line 95: @@
 |-
 ! file
-| Filename. To hotlink use http://live.mymobileworkers.com/uploads/company_attachments/"file"
+| Filename. To hotlink use http://api.mymobileworkers.com/uploads/company_attachments/"file"
 |-
 ! comment

@@ Line 95: / Line 95: @@
 |-
 ! file
-| Filename. To hotlink use http://live.mymobileworkers.com/uploads/company_uploads/"file"
+| Filename. To hotlink use http://live.mymobileworkers.com/uploads/company_attachments/"file"
 |-
 ! comment

@@ Line 107: / Line 107: @@
 == Example response ==
 <source lang="java">
-−
+{
-{"username":"USER1","email":"ryanmt@nospam.com","color":"D7C863","engineer_registration_number":null},
+   "name":"Test Company",
-{"username":"USER2","email":"bobbob@nospam.com","color":"97326A","engineer_registration_number":null},
+   "locale":"",
-{"username":"USER3","email":"sdfasdf@nospam.com","color":"56500D","engineer_registration_number":null},
+   "contact_name":"John Smith",
-{"username":"USER4","email":"asdsdf@nospam.com","color":"C1C355","engineer_registration_number":null},
+   "contact_number":"01942295906",
-{"username":"USER5","email":"asdfds@nospam.com","color":"FA556A","engineer_registration_number":null}
+   "contact_email":"john.smith@momote.com",
+   "created_at":"2011-10-10T14:37:09+01:00",
 </source>

@@ Line 85: / Line 85: @@
 ! attachments
 | Array of attachments
 |-
 |}