Data Types

ErrorResponse

Response body for all error responses.

Structure

{
"code": String,
"details": Object,
"message": String
}
}

Example

{
"error": {
"code": "error_code",
"details": {
"body.fileSize": {
"message": "min 0",
"value": -1
},
"body.mime": {
"message": "Not match in '[a-z0-9]+/[a-z0-9]+'",
"value": "image-jpeg"
}
},
"message": "Error message."
}
}

Properties

error.code

Machine-readable error code.

Type: String

Min Length: 1

Max Length: 255

Example: "error_code"

Required: Yes

error.details

Additional machine-readable details relating to the error.

Type: Object

Required: No

error.message

Human-readable error message.

Type: String

Min Length: 1

Example: "Error message."

Required: Yes

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: