JSON response status
-
- UpdatedJan 30, 2025
- 1 minute read
- Yokohama
- API implementation
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
where <value> is success or failure.
JSON Failure Response
_status
element returns failure, the _error
element
is added to identify the error and
reason.where <error value>
is the error message text and <reason
value>
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.