JSON response status - Product Documentation: Vancouver

JSON response status

API implementation and reference > API implementation > Web services > Inbound web services >

JSON response status

JSONv2 requests may return one of several response statuses.

JSON Success Response Each JSON success response includes a record array containing the records retrieved by the given action. Each JSON object contains one or more metadata elements, prefixed with __, regarding the status for the action on each record, as illustrated in the previous examples. The JSON success responses use the following syntax:

__status

"__status": " " where is success or failure.

JSON Failure Response When the _status element returns failure, the _error element is added to identify the error and reason. "__error": { "message": " ", "reason": " "}

where is the error message text and is the reason the error was triggered.

The JSON error response contains only the error and reason elements. Generally, this indicates that the whole JSON operation failed and no records can be processed.

For example: {"_error":"Cannot update with empty sysparm_query","reason":null}

Parent Topic: JSONv2 web service