Difference between revisions of "Get List"
From MyMobileWorkers API
(→Summary) |
|||
| Line 3: | Line 3: | ||
! Mobile Users | ! Mobile Users | ||
| − | ! | + | ! colspan="2" | |
|- | |- | ||
! URL | ! URL | ||
| − | | http://base_url/api_path/version/mobile_users | + | | colspan="2" | http://base_url/api_path/version/mobile_users |
|- | |- | ||
! Type | ! Type | ||
| − | | GET | + | | colspan="2" | GET |
|- | |- | ||
! Params: | ! Params: | ||
| − | | api_key | + | | api_key || required |
|- | |- | ||
! | ! | ||
| − | | branch_id | + | | branch_id || optional |
|- | |- | ||
! Response | ! Response | ||
| − | | JSON | + | | colspan="2" | JSON |
|} | |} | ||
Revision as of 10:45, 15 May 2013
Contents |
Summary
| Mobile Users | ||
|---|---|---|
| URL | http://base_url/api_path/version/mobile_users | |
| Type | GET | |
| Params: | api_key | required |
| branch_id | optional | |
| Response | JSON | |
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. |
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} ]
Example curl request
http://live.mymobileworkers.com:8080/api/1/mobile_users?api_key=YOURAPIKEY
