Difference between revisions of "Get Asset Statuses"
From MyMobileWorkers API
(→Summary) |
(→Response Parameters) |
||
| Line 21: | Line 21: | ||
== Response Parameters == | == Response Parameters == | ||
| + | {| border="1" class="wikitable" | ||
| + | |||
| + | ! Field | ||
| + | ! Description | ||
| + | |- | ||
| + | ! status | ||
| + | | Name of the status | ||
| + | |- | ||
| + | |- | ||
| + | ! external_id | ||
| + | | Status external id | ||
| + | |- | ||
| + | |- | ||
| + | ! available_on_device | ||
| + | | Whether or not status is available on device | ||
| + | |- | ||
| + | |- | ||
| + | ! available_on_portal | ||
| + | | Whether or not status is available on portal | ||
| + | |- | ||
| + | |- | ||
| + | ! default_on_pda_in_job | ||
| + | | Whether or not status is the default status on pda in job | ||
| + | |- | ||
| + | |- | ||
| + | ! default_on_pda_home | ||
| + | | Whether or not status is the default status on pda on home | ||
| + | |- | ||
| + | |- | ||
| + | |} | ||
== Example response == | == Example response == | ||
Revision as of 11:38, 12 August 2013
Contents |
Summary
| Asset Statuses | ||
|---|---|---|
| URL | http://:base_url/:api_path/:version/assets/asset/statuses | |
| Type | GET | |
| Params: | api_key | required |
| Response | JSON | |
The Get Asset Statuses method returns all asset statuses corresponding to the company making the method call.
Response Parameters
| Field | Description |
|---|---|
| status | Name of the status |
| external_id | Status external id |
| available_on_device | Whether or not status is available on device |
| available_on_portal | Whether or not status is available on portal |
| default_on_pda_in_job | Whether or not status is the default status on pda in job |
| default_on_pda_home | Whether or not status is the default status on pda on home |
Example response
[ { "status":"test", "external_id":null, "available_on_device":true, "available_on_portal":true, "default_on_pda_in_job":true, "default_on_pda_home":true } ]
Example curl request
curl "http://live.mymobileworkers.com:8080/api/1/assets/asset/statuses/?api_key=darrenwebapi"
