Get Asset - Revision history

Darren.atherton: /* Example curl request */

2013-08-06T12:33:37Z

‎Example curl request

Darren.atherton at 12:33, 6 August 2013

2013-08-06T12:33:22Z

Darren.atherton: Created page with "== Summary == {| border="1" class="wikitable" ! Mobile Users ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/mobile_users |- ! Type | colspan="..."

2013-08-06T12:30:02Z

Created page with "== Summary == {| border="1" class="wikitable" ! Mobile Users ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/mobile_users |- ! Type | colspan="..."

New page

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

! Mobile Users
! colspan="2" |
|-
! URL
| colspan="2" | http://:base_url/:api_path/:version/mobile_users
|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
!
| branch_id || optional
|-
! Response
| colspan="2" | JSON
|}

The mobile users method returns a list of all mobile users for your company unless the branch id is specified.

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

! Field
! Description
|-
! username
| Mobile username
|-
|-
! email_address
| Email address
|-
|-
! color
| Hex Colour used within MMW to identify the user (see the calendar)
|-
|-
! engineer_registration_number
| The users gas safe engineer ID if provided.
|-
|}

== 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:33, 6 August 2013
Line 36:		Line 36:
	== Example curl request ==		== Example curl request ==

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

@@ Line 2: / Line 2: @@
 {| border="1" class="wikitable"
-! Mobile Users
+! Asset
 ! colspan="2" |
 |-
 ! URL
-| colspan="2" |  http://:base_url/:api_path/:version/mobile_users
+| colspan="2" |  http://:base_url/:api_path/:version/asset
 |-
 ! Type
@@ Line 15: / Line 15: @@
 |-
+!
-| branch_id || optional
+| serial_number || required
 |-
 ! Response
@@ Line 22: / Line 22: @@
-The mobile users method returns a list of all mobile users for your company unless the branch id is specified.
+The Get Asset method returns the asset corresponding to the serial number specified.
 == Response Parameters ==
 == 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>
@@ Line 61: / Line 36: @@
 == Example curl request ==
-http://live.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY
+http://live.mymobileworkers.com:8080/api/1/assets?api_key=YOURAPIKEY