Document toolboxDocument toolbox

Standard Response Object

Owned by Andrew Hill (Deactivated)
Last updated: Sept 30, 2024 by Jason Andrew
1 min read

Standard Response Object

Unless otherwise noted in the documentation for a REST API, all ServiceMobility REST API calls return the following standard JSON response object:

On this page:

Standard Response Object Formats

JSON Format 
{
	"type": "",
	"title": "",
	"status": 200,
	"detail": "",
	"invalidParams": [
		{
			"name": "",
			"reason": "",
			"path": "",
			"value": ""
		}
	]
}

Standard Response Object Properties

PropertyTypeDescription
typestringWhen the REST API response is an error, specifies a URI to a description of the error type, to help developers with debugging errors.
titlestringWhen the REST API response is an error, specifies a short, human-readable summary of the problem type.
statusintegerSpecifies the HTTP status code of the response (both for success and error).
detailstringWhen 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.
invalidParamsarray

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:

PropertyTypeDescription
namestring

The name of the invalid parameter.

reasonstring

A human-readable explanation of why the parameter was invalid.

pathstringThe JSON path of the invalid parameter.
valuestringThe value of the invalid parameter.