OTA_PingRQ / OTA_PingRS

The OTA_Ping messages are used to test the connectivity with the Hotel-Spider system:

Every time the hotel's inventory or any of its stay restrictions (Booking rules) has been changed inside the third party software, the changes (and only the changes) should be transfered to Hotel-Spider. As this is a "notif" message, it implies that the third party software client pushes the information to the Hotel-Spider servers.

Endpoints

HTTP RAW POST
- Staging: https://staging-api.hotel-spider.com/ota/2014A/OTA_PingRQ
- Production: https://api.hotel-spider.com/ota/2014A/OTA_PingRQ
SOAP
- Staging: https://staging-api.hotel-spider.com/soap/ota
  - SoapAction: hhttp://htng.org/2014A/OTAService#OTA_PingRQ
- Production: https://api.hotel-spider.com/soap/ota
  - SoapAction: http://htng.org/2014A/OTAService#OTA_PingRQ
JSON (We recommend using OTA via XML, if you want to use JSON interface please contact us)

Example request and response

OTA_HotelRatePlanNotifRQ request

<OTA_PingRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_ReadRQ.xsd" TimeStamp="2003-03-17T09:30:47-05:00" Target="Test" Version="2.0">
  <POS>
    <Source>
      <RequestorID ID="USERNAME" MessagePassword="PASSWORD"></RequestorID>
    </Source>
  </POS>
  <EchoData>Hello Moto</EchoData>
</OTA_PingRQ>

OTA_PingRS response

<OTA_PingRS xmlns="http://www.opentravel.org/OTA/2003/05" schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_PingRQ.xsd" TimeStamp="2015-11-20T07:42:35+01:00" Target="Test" CorrelationID="002564ec0dba75cb" Version="1.0">
  <EchoData>Hello Moto</EchoData>
  <Success></Success>
</OTA_PingRS>

Request structure

OTA_PingRQ

Parent: None (Root element)

Mandatory: yes

Attributes:

Name

Mandatory

Description

TimeStamp

Yes

The format should respect the ISO 8601 2015-11-16T22:23:48+00:00

Target

Yes

When sending updates to the staging environment "Test" must be used.

When sending updates to the production environment "Production" must be used.

Version

Yes

The default value should be "1.000"

Child elements: POS (when using POS authentication. See Authentication methods for more information), EchoData

EchoData

Parent: OTA_PingRQ

Mandatory: yes

Attributes: None

Child elements: None

Response structure

OTA_PingRS

Parent: None (Root element)

Mandatory: yes

Attributes:

Name	Mandatory	Description
TimeStamp	Yes	The format will respect the ISO 8601 2015-11-16T22:23:48+00:00
Target	Yes	The same value, used in the request, will be returned.
Version	Yes	The value wil be "1.000"

Child elements: Success, Warning, Errors, EchoData

EchoData

Parent: OTA_PingRS

Mandatory: No

Attributes: None

Child elements: None

Success

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: None

Warnings

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: None

Warning

Parent: Warnings

Mandatory: yes (If Warnings is provided)

Attributes:

Name	Mandatory	Description
Type	Yes	OTA EWT type code
Code	Yes	OTA ERR error code
Status	Yes	Possible values: NotProcessed \| Incomplete \| Complete \| Unknown
ShortText	Yes	Textual explanation of the error.

Child elements: None

Errors

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: Error

Error

Parent: Error

Mandatory: yes (If Errors is provided)

Attributes:

Name	Mandatory	Description
Type	Yes	OTA EWT type code
Code	Yes	OTA ERR error code
Status	Yes	Possible values: NotProcessed \| Incomplete \| Complete \| Unknown
ShortText	Yes	Textual explanation of the error.

Child elements: None