InternalApplicationError
This page describes the InternalApplicationError type.

Error Use Case

An unexpected exception has been thrown by the application.

Properties

Required properties

Property
Expected Type
Description
@type
Text
Must always be present and set to "@type": "InternalApplicationError"
Property
Expected Type
Description
description
Text
A plain-text human-readable explanation specific to this occurrence of the problem, providing specific information about why the error occurred in this particular case. This description must not include HTML or other markup.
Example
"description": "No customer details supplied. These must be supplied for calls to C2, P, and B."
instance
URL
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
name
Text
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
Example
"name": "An unexpected exception has been thrown by the application."

Optional properties

Property
Expected Type
Description
requestId
Text
Used by technical support for diagnostics purposes.
statusCode
Integer
Must always be present and set to "statusCode": 500
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution License (CC-BY V4.0), and code samples are licensed under the MIT License, for anyone to access, use and share; using attribution "OpenActive".
Last modified 1mo ago