Responses
Each API request is expected to return a response. The HTTP status code of the response is 200
in case the API request processing is successful as well as if the API request processing fails, e.g. if there is an error during reservation processing, or an inventory update message fails validation. In case of such failures, details about the error are provided in the response body.
Important: In the case of errors with rate codes or category codes, details of the affected codes must be returned in the response body. These codes will also be unsynchronized, i.e. disabled.
Synchronous simple response
This response object represents the default response, in case of success.
Synchronous error response
In case of error, the response object will extend the simple response object with details about the error. In case of errors with rate codes or category codes, details of the affected codes must also be returned. See the Error codes table below for further details about specific errors, including guidance on system behaviour.
Example #1
Example #2
Example #3
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Determinines the result of the operation. |
|
| optional | Determinines if there will be following asynchronous response. |
| array of | optional | In case of |
Error
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Determines the type of error (see Error codes). |
|
| required | Error message with more details about the error. |
|
| optional | Category code which caused the error. This is required for category errors and rate category errors. The category will be automatically unsynchronized in Mews. |
|
| optional | Rate code which caused the error. This is required for rate errors and rate category errors. The rate will be automatically unsynchronized in Mews. |
Error codes
Code | Description |
---|---|
| System error Unspecified system error. Message may be re-sent after an interval of time. |
| Reservation error Reservation does not exist. When this error code is returned, it should be acknowledged and the reservation should not be re-tried. |
| Property error Property does not exist. |
|
|
|
|
| Validation error Validation error, e.g. invalid value "XXX" of field "YYY". |
| Processing error Processing error, e.g. processing of the booking would violate some internal PMS limitation. |
| Invalid authorization |
| Rate error
Rate error, e.g. rate plan XX prices updates cannot be accepted due to the settings in the channel manager extranet. The affected rate code must be supplied in the |
| Category error
Category error, e.g. space category XX availability updates cannot be accepted due to the settings in the channel manager extranet. The affected category code must be supplied in the |
| Rate category error Rate category error, e.g. category was removed from the rate plan in channel manager extranet. The affected rate code and category code must be supplied. The category will be deleted from the rate. |
| Availability error Availability configuration error, e.g. availability updates blocked from the channel manager extranet. This error automatically disables availability updates. |
| Prices error Prices configuration error, e.g. price updates blocked from the channel manager extranet. This error automatically disables price updates. |
| Restrictions error Restrictions configuration error, e.g. restriction updates blocked from the channel manager extranet. This error automatically disables restrictions updates. |
Last updated