Responses
Success, warnings, and errors
Each response message will indicate whether the request has been handled successfully. Therefore, directly underneath the root node, either one of the following two blocks can be found.
Success
<Success />
<Warnings>
<Warning Type="1" Code="1">The message was redundant.</Warning>
</Warnings>
| Element / @Attribute |
Parent |
Info |
Values |
Occurrence |
| Success |
Root |
The presence of the empty Success element explicitly indicates that the request message was successful. Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is used in conjunction with the Warning Type to report any warnings or business errors. |
|
0..1 (either Success or Errors is present) |
| Warnings |
Root |
Used in conjunction with the Success element to define one or more business errors. Collection of warnings. |
|
0..1 |
| Warning |
Warnings |
Used when a message has been successfully processed to report any warnings or business errors that occurred. |
|
1..n |
| @Type |
Warning |
The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". |
Refer to Code List Error and Warning Types |
1 |
| @Code |
Warning |
If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. |
Refer to Code List Error and Warning Codes |
1 |
Error
<Errors>
<Error Type="1" Code="1">Something went wrong!</Error>
</Errors>
| Element / @Attribute |
Parent |
Info |
Values |
Occurrence |
| Errors |
Root |
Errors are returned if the request was unable to be processed. A collection of errors that occurred during the processing of a message. |
|
0..1 (either Success or Errors is present) |
| Error |
Errors |
An error that occurred during the processing of a message. Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element. |
|
1..n |
| @Type |
Error |
The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. |
Refer to Code List Error and Warning Types |
1 |
| @Code |
Error |
If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. |
Refer to Code List Error and Warning Codes |
0..1 |
