ErrorResponse

  • This documentation details the JSON response structure returned by the DPA (Digital Platform Agent) when an error occurs.

  • The response includes an errorMessage field with a human-readable error description and a cause field with an enumerated error cause value.

  • Developers can refer to the ErrorCause enum documentation for further understanding of the error codes.

Response from the DPA in case of an error.

JSON representation
{
  "errorMessage": string,
  "cause": enum (ErrorCause)
}
Fields
errorMessage

string

A human readable string describing the error that occurred.

cause

enum (ErrorCause)

An enum capturing the cause of the error.