Verify model number for a specified assetThis REST API must return the details of model number verification, based on the specified REST Object Definitions Work Order Activity Related Objects Asset Object. URL| Panel |
|---|
| borderColor | grey |
|---|
| bgColor | whitesmoke |
|---|
| borderStyle | solid |
|---|
| POST <REST Endpoint URI>
|
HTTP Request BodyThe HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Asset Object. | Insert excerpt |
|---|
| REST Object Definitions Work Order Activity Related Objects Appointment Search ObjectREST Object Definitions Work Order Activity Related Objects |
|---|
| Appointment Search Object |
|---|
| nopanel | true |
|---|
|
HTTP ResponseResponse Codes| HTTP Code | Description |
|---|
| 200 | OK. The verification for model number was successful. | | 400 | Bad Request. The server could not understand the request due to invalid data in the request. Asset Model Number Verification API will return following JSON response object. | Code Block |
|---|
| language | js |
|---|
| firstline | 1 |
|---|
| title | JSON Format |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
| {
"type": "",
"title": "",
"status": 200,
"data": [
{
//Asset Object
},
{
//Asset Object
}
],
"detail": "",
"invalidParams": [
{
"name": "",
"reason": "",
"path": "",
"value": ""
}
]
} |
Response Object Properties| Property | Type | Description |
|---|
| type | string | When the REST API response is an error, specifies a URI to a description of the error type, to help developers with debugging errors. | | title | string | When the REST API response is an error, specifies a short, human-readable summary of the problem type. | | status | integer | Specifies the HTTP status code of the response (both for success and error). | | data | collection | This collection of REST Object Definitions Work Order Activity Related Objects Asset Object provides recommendation/additional information for model numbers of a specified asset. | | detail | string | When the REST API response is an error, specifies a human-readable explanation specific to the occurrence of the problem. This field may not always be present. | | invalidParams | collection | When the REST API response is an error, specifies an array, containing a list of objects, where each object describes specific parameters that were invalid in the request that caused the error. This field may not always be present. Each object in the array has a format as shown above, with the following properties: | Property | Type | Description |
|---|
| name | string | The name of the invalid parameter. | | reason | string | A human-readable explanation of why the parameter was invalid. | | path | string | The JSON path of the invalid parameter. | | value | string | The value of the invalid parameter. |
|
| | 401 | Invalid Logon. | | 500 | Server error. An error occurred while processing the request. The HTTP response body should have more details as to the possible cause. |
On success, an HTTP response code of 200 must be returned, and the response body must contain a valid response body that is the same as would be returned from the REST Standard REST APIs Assets REST API. ServiceMobility will return the response code (and response body, if present) as the response to the initiating REST Standard REST APIs Assets REST API call. | 