Difference between revisions of "Get Item By Name"
From MyMobileWorkers API
(Created page with "== Summary == {| border="1" class="wikitable" ! Item by name ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/asset?api_key=YOUR_KEY&serial_numb...") |
(→Example curl request) |
||
| (3 intermediate revisions by one user not shown) | |||
| Line 6: | Line 6: | ||
|- | |- | ||
! URL | ! URL | ||
| − | | colspan="2" | http://:base_url/:api_path/:version/ | + | | colspan="2" | http://:base_url/:api_path/:version/items/item/name?api_key=YOUR_KEY&item_name=ITEM_NAME |
|- | |- | ||
! Type | ! Type | ||
| Line 24: | Line 24: | ||
== Response Parameters == | == Response Parameters == | ||
| + | {| border="1" class="wikitable" | ||
| + | |||
| + | ! Field | ||
| + | ! Description | ||
| + | |- | ||
| + | ! name | ||
| + | | Item name | ||
| + | |- | ||
| + | |- | ||
| + | ! category | ||
| + | | Contains both category name and id for item | ||
| + | |- | ||
| + | |- | ||
| + | ! notes | ||
| + | | Item notes | ||
| + | |- | ||
| + | |- | ||
| + | ! price | ||
| + | | Item price | ||
| + | |- | ||
| + | ! external_id | ||
| + | | Item external id | ||
| + | |- | ||
| + | ! product_code | ||
| + | | Item product code | ||
| + | |- | ||
| + | |} | ||
== Example response == | == Example response == | ||
| Line 42: | Line 69: | ||
== Example curl request == | == Example curl request == | ||
| − | curl "http:// | + | curl "http://api.mymobileworkers.com:8080/api/1/items/item/name/?api_key=darrenwebapi&item_name=darrenItem" |
Latest revision as of 12:41, 14 November 2016
Contents |
[edit] Summary
| Item by name | ||
|---|---|---|
| URL | http://:base_url/:api_path/:version/items/item/name?api_key=YOUR_KEY&item_name=ITEM_NAME | |
| Type | GET | |
| Params: | api_key | required |
| item_name | required | |
| Response | JSON | |
The Get Item By Name method returns the item corresponding to the item name provided.
[edit] Response Parameters
| Field | Description |
|---|---|
| name | Item name |
| category | Contains both category name and id for item |
| notes | Item notes |
| price | Item price |
| external_id | Item external id |
| product_code | Item product code |
[edit] Example response
{ "name":"darrenItem", "category":{ "external_id":"", "name":"Test1" }, "notes":"notes", "external_id":"ss303", "product_code":"productCodeTest", "price":2.5 }
[edit] Example curl request
curl "http://api.mymobileworkers.com:8080/api/1/items/item/name/?api_key=darrenwebapi&item_name=darrenItem"
