Get Mobile Users - Revision history

Ian: /* Example curl request */

2016-11-14T12:46:12Z

‎Example curl request

Ryanmt: /* Example curl request */

2016-05-31T11:27:04Z

‎Example curl request

Ryanmt: /* Summary */

2016-05-31T11:03:29Z

‎Summary

Ryanmt: /* Summary */

2016-05-31T11:02:53Z

‎Summary

Ryanmt at 13:50, 15 May 2013

2013-05-15T13:50:17Z

Ryanmt: 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="2" ..."

2013-05-15T10:47:33Z

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="2" ..."

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:46, 14 November 2016
Line 63:		Line 63:
	== Example curl request ==		== Example curl request ==

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

← Older revision		Revision as of 11:27, 31 May 2016
Line 63:		Line 63:
	== Example curl request ==		== Example curl request ==

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

@@ Line 18: / Line 18: @@
 |-
+!
-| include_deleted || optional (default true)
+| include_deleted || optional (default = true)
 |-
 ! Response

@@ Line 16: / Line 16: @@
+!
 | branch_id || optional
 |-
 ! Response
@@ Line 23: / Line 26: @@
 The mobile users method returns a list of all mobile users for your company unless the branch id is specified.
 == Response Parameters ==

@@ Line 6: / Line 6: @@
 |-
 ! URL
-| colspan="2" |  http://base_url/api_path/version/mobile_users
+| colspan="2" |  http://:base_url/:api_path/:version/mobile_users
 |-
 ! Type