Skip to main content

Resterror

Details of an individual error. Clients should inspect errorCode and errorReason to branch on failure category, and errorSource to surface the offending field or resource to the caller.

errorCodeint32

Domain-specific numeric error code that uniquely identifies this failure across all modules. Use this together with errorReason to programmatically branch on failure type.

Example: 10002
errorReasonstring

For more information on your error message, refer to API Response and Error Codes

Example: INVALID_PARAMETERS
errorSourcestring

JSON pointer, field name, or rule identifier that locates the cause of the error in the request, so clients can highlight the offending input back to end users.

Example: filterCriteria[0].field
Resterror
{
  "errorCode": 1,
  "errorReason": "INVALID_PARAMETERS",
  "errorSource": "filterCriteria[0].field"
}