OTA_ErrorRQ
This method can be called to test error code and format via GET or POST.
OTA_ErrorRQ - Request via GET - REST API
This request can be sent without parameters.
GET /ota/api/Error
and then generates an error message during authentication or alternatively with parameters for a specific hotel.
Parameters used:
AgentDutyCode(optional if IP WhiteList or HTTP Basic Auth is used)HotelCode(mandatory)
Example:
GET /ota/api/Error?AgentDutyCode=1&HotelCode=4
OTA_ErrorRQ - Request per POST
Example: OTA_PingRQ (Request)
sent to wrong endpoint (/ota/api/Error)
<?xml version="1.0" encoding="UTF-8"?>
<OTA_PingRQ EchoToken="1" PrimaryLangID="de" Target="Production" TimeStamp="" Version="1.0">
<EchoData>Are you there</EchoData>
</OTA_PingRQ>
Generates an error response wrong endpoint with the attributes
@ErrorCode="550"
@ErrorMessage="CustomError - RequestMessage (OTA_PingRQ) and Endpoint (OTA_ErrorRQ) not match.
OTA_ErrorRS - Antwort
There should always be a <Success/> in the response.
Example ** OTA_ErrorRS** (Response) - with error message
(see attributes @ErrorCode and @ErrorMessage)
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ErrorRS xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
EchoToken="188d04c25fb620a05c7d2416f208e9ee"
PrimaryLangID="de"
TimeStamp="2022-01-26T13:28:53+01:00"
Target="Production"
Version="1.000"
ErrorCode="100"
ErrorMessage="UnknownError"/>
Example ** OTA_ErrorRS** (Response) - with error message in special XML format
(see <Errors> and attributes Error@Code, Error@Type and Error@ShortText)
<?xml version="1.0" encoding="UTF-8"?>
<OTA_ErrorRS xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" EchoToken="b1e7755fe1557e71acfa1297b8899f38"
PrimaryLangID="de"
TimeStamp="2022-01-26T12:05:16+01:00"
Target="Production"
Version="2.0">
<Errors>
<Error
Code="507"
Type="Authentication error"
ShortText="Hotel not found (HotelCode 12345 / AgentDutyCode 1)"/>
</Errors>
</OTA_ErrorRS>