Object

Error

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

Properties

code

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

message
string

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

Returned: Sometimes

status

A code issued by the server in response to a request.

Returned: Always

value
string

If applicable, the value supplied in the request for the field that is specified by keyPath.

Returned: Sometimes

See Also

Errors

About Apple News API Error Messages

Understand the error message format for the Apple News API.

object Warning

See the properties of a warning returned by the Apple News API.

type Code

See the error codes returned by the Apple News API.

type Status

See the HTTP status codes returned by the Apple News API.