Data: exc
- Namespace: http://genologics.com/ri/exception
- XML Schema File: exception.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
Element exception
- Type: exception
Exception is a descriptive error message that is returned instead of the standard response for any request that the system was unable to process.
Exception will include a code corresponding to the HTTP response code of the error. Typical response codes are 400, indicating that the submitted request was not valid and cannot be reattempted without corrective action being taken, or 500 indicating that there was an internal error in the server when attempting to process the request. Refer to the section on HTTP response codes in the API reference documentation for further details about the categories and meanings of HTTP response codes.
Exception will include a message element with a textual summary of the error, and may also provide a suggested-actions element with details on how to correct the problem.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<exc:exception xmlns:exc="http://genologics.com/ri/exception" category="..." code="...">
<message>
<!--content of type 'string'-->
...
</message>
<suggested-actions>
<!--content of type 'string'-->
...
</suggested-actions>
</exc:exception>
Type exception
Exception is a descriptive error message that is returned instead of the standard response for any request that the system was unable to process.
Exception will include a code corresponding to the HTTP response code of the error. Typical response codes are 400, indicating that the submitted request was not valid and cannot be reattempted without corrective action being taken, or 500 indicating that there was an internal error in the server when attempting to process the request. Refer to the section on HTTP response codes in the API reference documentation for further details about the categories and meanings of HTTP response codes.
Exception will include a message element with a textual summary of the error, and may also provide a suggested-actions element with details on how to correct the problem.
Attributes
| name | type | description |
|---|---|---|
| category | string | The category of the exception. |
| code | string | The HTTP response code of the exception. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| message (string) | 0/1 | A textual summary of the exception. |
| suggested-actions (string) | 0/1 | Suggested actions for how to correct the cause of the exception. |