Get List - Revision history

Ryanmt: Blanked the page

2013-05-15T10:47:13Z

Blanked the page

Ryanmt at 10:46, 15 May 2013

2013-05-15T10:46:59Z

Ryanmt: /* Summary */

2013-05-15T10:45:41Z

‎Summary

Ryanmt at 10:44, 15 May 2013

2013-05-15T10:44:31Z

Ryanmt: /* Example response */

2013-05-15T10:40:17Z

‎Example response

Ryanmt: /* Example response */

2013-05-15T10:40:02Z

‎Example response

Ryanmt: /* Example response */

2013-05-15T10:39:49Z

‎Example response

Ryanmt: /* Example response */

2013-05-15T10:39:36Z

‎Example response

Ryanmt: /* Example curl request */

2013-05-15T10:38:11Z

‎Example curl request

Ryanmt: Created page with "{| border="1" class="wikitable" ! Mobile Users ! |- ! URL | http://base_url/api_path/version/mobile_users |- ! Type | GET |- ! Params: | api_key |- ! | branch_id (optional)..."

2013-05-14T16:46:36Z

Created page with "{| border="1" class="wikitable" ! Mobile Users ! |- ! URL | http://base_url/api_path/version/mobile_users |- ! Type | GET |- ! Params: | api_key |- ! | branch_id (optional)..."

New page

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

! Mobile Users
!
|-
! URL
| http://base_url/api_path/version/mobile_users
|-
! Type
| GET
|-
! Params:
| api_key
|-
!
| branch_id (optional)
|-
! Response
| JSON
|}

== Example response ==

== Example curl request ==

← Older revision		Revision as of 10:47, 15 May 2013
Line 1:		Line 1:
−	~~== 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~~

@@ Line 20: / Line 20: @@
 | colspan="2" | JSON
 |}
 == Response Parameters ==

@@ Line 22: / Line 22: @@
 == Example response ==
-<source lang="javascript">
+<source lang="java">
+[
-{"username":"USER1,"email":"ryanmt@nospam.com","color":"D7C863","engineer_registration_number":null},
+{"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},

@@ Line 22: / Line 22: @@
 == Example response ==
-<source lang="java">
+<source lang="javascript">
 [{"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}]
+{"username":"USER5","email":"asdfds@nospam.com","color":"FA556A","engineer_registration_number":null}
 </source>

@@ Line 23: / Line 23: @@
 == 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}]
+[{"username":"USER1,"email":"ryanmt@nospam.com","color":"D7C863","engineer_registration_number":null},
 </source>

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

@@ Line 1: / Line 1: @@
 {| border="1" class="wikitable"
@@ Line 20: / Line 21: @@
 |}
 == Example response ==

← Older revision		Revision as of 10:38, 15 May 2013
Line 25:		Line 25:

	== Example curl request ==		== Example curl request ==
		+
		+	http://live.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY