Contents

ErrorResponse.Errors

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

Declaration

object ErrorResponse.Errors

Properties

NameTypeDescription
code Requiredstring

A machine-readable code indicating the type of error. The code is a hierarchical value with levels of specificity separated by a period (.). This value is parseable for programmatic error handling in code.

detail Requiredstring

A detailed explanation of the error. Don’t use this field for programmatic error handling.

idstring

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.

source(JsonPointer | Parameter)

One of two possible types of values — source.Parameter when a query parameter produces the error, or source.JsonPointer when a problem with the entity produces the error.

status Requiredstring

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.

title Requiredstring

A summary of the error. Don’t use this field for programmatic error handling.

linksErrorLinks

metaErrorResponse.Errors.Meta

Topics

Dictionaries