Difference between revisions of "Get Mobile Users"
From MyMobileWorkers API
(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" ...") |
(→Example curl request) |
||
| (4 intermediate revisions by one user not shown) | |||
| Line 6: | Line 6: | ||
|- | |- | ||
! URL | ! URL | ||
| − | | colspan="2" | http://base_url/api_path/version/mobile_users | + | | colspan="2" | http://:base_url/:api_path/:version/mobile_users |
|- | |- | ||
! Type | ! Type | ||
| Line 16: | Line 16: | ||
! | ! | ||
| branch_id || optional | | branch_id || optional | ||
| + | |- | ||
| + | ! | ||
| + | | include_deleted || optional (default = true) | ||
|- | |- | ||
! Response | ! 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. | The mobile users method returns a list of all mobile users for your company unless the branch id is specified. | ||
| − | |||
== Response Parameters == | == Response Parameters == | ||
| Line 61: | Line 63: | ||
== Example curl request == | == Example curl request == | ||
| − | http:// | + | http://api.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY&include_deleted=false |
Latest revision as of 12:46, 14 November 2016
Contents |
[edit] Summary
| Mobile Users | ||
|---|---|---|
| URL | http://:base_url/:api_path/:version/mobile_users | |
| Type | GET | |
| Params: | api_key | required |
| branch_id | optional | |
| include_deleted | optional (default = true) | |
| Response | JSON | |
The mobile users method returns a list of all mobile users for your company unless the branch id is specified.
[edit] Response Parameters
| 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. |
[edit] Example response
[ {"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} ]
[edit] Example curl request
http://api.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY&include_deleted=false
