Difference between revisions of "Get Asset By Serial Number"
From MyMobileWorkers API
(→Response Parameters) |
|||
| Line 26: | Line 26: | ||
== Response Parameters == | == Response Parameters == | ||
| + | {| border="1" class="wikitable" | ||
| + | |||
| + | ! Field | ||
| + | ! Description | ||
| + | |- | ||
| + | ! location | ||
| + | | Asset location | ||
| + | |- | ||
| + | |- | ||
| + | ! status | ||
| + | | Contains both external id and status name for asset status | ||
| + | |- | ||
| + | |- | ||
| + | ! description | ||
| + | | Asset description | ||
| + | |- | ||
| + | |- | ||
| + | ! item | ||
| + | | Contains the name, category and external id of the item the asset is linked to | ||
| + | |- | ||
| + | ! serial_number | ||
| + | | Asset serial number | ||
| + | |- | ||
| + | ! created_at | ||
| + | | Date asset was created | ||
| + | |- | ||
| + | ! last_updated_by | ||
| + | | User who last updated asset | ||
| + | |- | ||
| + | ! external_id | ||
| + | | Asset external id | ||
| + | |- | ||
| + | ! last_scanned_by | ||
| + | | User who last scanned asset | ||
| + | |- | ||
| + | ! custom_fields | ||
| + | | Asset custom fields | ||
| + | |- | ||
| + | ! last_updated_by | ||
| + | | User who last updated asset | ||
| + | |- | ||
| + | ! job | ||
| + | | Job the asset is linked to | ||
| + | |- | ||
| + | ! customer | ||
| + | | Customer the asset is linked to | ||
| + | |- | ||
| + | |} | ||
== Example response == | == Example response == | ||
Revision as of 11:28, 12 August 2013
Contents |
Summary
| Asset | ||
|---|---|---|
| URL | http://:base_url/:api_path/:version/asset?api_key=YOUR_KEY&serial_number=SERIAL_NUMBER | |
| Type | GET | |
| Params: | api_key | required |
| serial_number | required | |
| Response | JSON | |
The Get Asset method returns the asset corresponding to the serial number specified.
Response Parameters
| Field | Description |
|---|---|
| location | Asset location |
| status | Contains both external id and status name for asset status |
| description | Asset description |
| item | Contains the name, category and external id of the item the asset is linked to |
| serial_number | Asset serial number |
| created_at | Date asset was created |
| last_updated_by | User who last updated asset |
| external_id | Asset external id |
| last_scanned_by | User who last scanned asset |
| custom_fields | Asset custom fields |
| last_updated_by | User who last updated asset |
| job | Job the asset is linked to |
| customer | Customer the asset is linked to |
Example response
[ { "location":"aPlace", "status":{ "external_id":null, "name":"test" }, "description":"describingwords", "item":{ "external_id":null, "category":"Test Numero 1", "name":"Woo "}, "serial_number":"serialNo123", "created_at":1375786053000, "last_updated_by":null, "external_id":"sss32", "last_scanned_by":null, "custom_fields":null, "job":{ "job_ number":"123"}, "customer":{ "name":"john" } } ]
