Difference between revisions of "Get Categories"
From MyMobileWorkers API
(→Example response) |
(→Example curl request) |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 21: | Line 21: | ||
== Response Parameters == | == Response Parameters == | ||
| + | {| border="1" class="wikitable" | ||
| + | |||
| + | ! Field | ||
| + | ! Description | ||
| + | |- | ||
| + | ! name | ||
| + | | Category name | ||
| + | |- | ||
| + | ! external_id | ||
| + | | Category external id | ||
| + | |} | ||
== Example response == | == Example response == | ||
| Line 42: | Line 53: | ||
== Example curl request == | == Example curl request == | ||
| − | curl "http:// | + | curl "http://api.mymobileworkers.com:8080/api/1/categories/all/?api_key=darrenwebapi" |
Latest revision as of 12:45, 14 November 2016
Contents |
[edit] Summary
| Get All Categories | ||
|---|---|---|
| URL | http://:base_url/:api_path/:version/categories/all | |
| Type | GET | |
| Params: | api_key | required |
| Response | JSON | |
The Get All Categories method returns all categories corresponding to the company making the method call.
[edit] Response Parameters
| Field | Description |
|---|---|
| name | Category name |
| external_id | Category external id |
[edit] Example response
[ { "name":"exampleCategory", "external_id":"ss304" }, { "name":"test1", "external_id":"exampleId" }, { "name":"test2", "external_id":"exampleId2" } ]
[edit] Example curl request
curl "http://api.mymobileworkers.com:8080/api/1/categories/all/?api_key=darrenwebapi"
