Error Result Documentation

Error results capture data for a failed request with details on what went wrong.

This data is only sent when a request cannot be processed.

Error Result Model

Result model for failed API request

• Links ( Array[Link] ) Links related to the Error Result
• ErrorDescription ( String ) Detailed error description

Link Model

Links capture data related to the current model they live on. The type of link is dependent on the rel property.

• Href ( String ) Url to a page or endpoint
• Rel ( String ) Identifier for the href url. [self] = link to the current item, [documentation] = link to related documentation, [redirect] = link to redirect page
• Method ( String , optional ) Method type of the link. If not displayed then GET is assumed.