The API returns errors in the following format:
{
"RequestGUID": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"StatusCode": "integer",
"Details": "varies"
}| Name | Type | Description |
|---|---|---|
RequestGUID | string | A unique identifier for the request |
ErrorCode | string | A code representing the specific error. |
ErrorMessage | string | A human-readable message describing the error. |
StatusCode | integer | The HTTP status code associated with the error. |
Details | varies | Additional details about the error. This varies depending on the type of error. |
When the error is a validation error, the Details field follows this structure:
[
{
"Field": "string",
"Constraint": "string",
"Message": "string"
}
]| Name | Type | Description |
|---|---|---|
Field | string | The name of the field that caused the validation error. |
Constraint | string | The specific validation constraint that failed. |
Message | string | A message describing the validation error. |