Contents

Error

See the properties of an error the Apple News API returned.

Declaration

object Error

Properties

NameTypeDescription
codeCode

An error code that, in combination with the key path, uniquely identifies the error for the specified endpoint.

Returned: Always

keyPath[string]

An array of field names that uniquely identifies a field in the JSON input of the request. See Understanding the keyPath Array.

Returned: Sometimes

messagestring

A user-friendly, detailed explanation of the error code.

Returned: Sometimes

statusStatus

A code the server issues in response to a request.

Returned: Always

valuestring

If applicable, the value supplied in the request for the field that keyPath specifies.

Returned: Sometimes

Mentioned in

See Also

Errors