Difference between revisions of "Get Asset Statuses"
From MyMobileWorkers API
(Created page with "== Summary == {| border="1" class="wikitable" ! Asset ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/asset/statuses |- ! Type | colspan="2" | ...") |
(→Example curl request) |
||
| (5 intermediate revisions by one user not shown) | |||
| Line 2: | Line 2: | ||
{| border="1" class="wikitable" | {| border="1" class="wikitable" | ||
| − | ! Asset | + | ! Asset Statuses |
! colspan="2" | | ! colspan="2" | | ||
|- | |- | ||
! URL | ! URL | ||
| − | | colspan="2" | http://:base_url/:api_path/:version/asset/statuses | + | | colspan="2" | http://:base_url/:api_path/:version/assets/asset/statuses |
|- | |- | ||
! Type | ! Type | ||
| Line 17: | Line 17: | ||
| colspan="2" | JSON | | colspan="2" | JSON | ||
|} | |} | ||
| − | |||
The Get Asset Statuses method returns all asset statuses corresponding to the company making the method call. | The Get Asset Statuses method returns all asset statuses corresponding to the company making the method call. | ||
| − | |||
== 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 == | ||
| Line 40: | Line 68: | ||
== Example curl request == | == Example curl request == | ||
| − | curl "http:// | + | curl "http://api.mymobileworkers.com:8080/api/1/assets/asset/statuses/?api_key=darrenwebapi" |
Latest revision as of 12:40, 14 November 2016
Contents |
[edit] 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.
[edit] 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 |
[edit] 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 } ]
[edit] Example curl request
curl "http://api.mymobileworkers.com:8080/api/1/assets/asset/statuses/?api_key=darrenwebapi"
