ErrorResponse.Errors

The details about an error that are returned when an API request isn’t successful.

Declaration

object ErrorResponse.Errors

Name	Type	Description
`code` Required	string	A machine-readable code indicating the type of error. The code is a hierarchical value with levels of specificity separated by the ‘`.`’ character. This value is parseable for programmatic error handling in code.
`status` Required	string	The HTTP status code of the error. This status code usually matches the response’s status code; however, if the request produces multiple errors, these two codes may differ.
`id`	string	The unique ID of a specific instance of an error, request, and response. Use this ID when providing feedback to or debugging issues with Apple.
`title` Required	string	A summary of the error. Do not use this field for programmatic error handling.
`detail` Required	string	A detailed explanation of the error. Do not use this field for programmatic error handling.
`source`	*	One of two possible types of values: `source.Parameter`, provided when a query parameter produced the error, or `source.JsonPointer`, provided when a problem with the entity produced the error.
`meta`	`ErrorResponse.Errors.Meta`
`links`	`ErrorLinks`

Use the code parameter for programmatic error handling. See Parsing the Error Response Code for more information. For more information about using the source parameter, see Pinpointing the Location of Errors.