Hotel v2 - Descriptive Info

This API has been deprecated.

Deprecation Date: 10/14/2022

Partners and customers using a deprecated API should contact SAP Concur and discuss moving to the latest versions.

Learn more in the API Lifecycle & Deprecation Policy.

Message to retrieve descriptive details about a given hotel. This may include text and/or a number of URL pointed to hosted images. Concur does not host any hotel images.

SOAPAction	OTA Name	Message Structure
detail	HotelDescriptiveInfo	OTA_HotelDescriptiveInfoRQ

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Header xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <authentication xmlns="http://www.concur.com/webservice/auth">
      <userid>user</userid>
      <password>password</password>
    </authentication>
  </Header>
  <Body xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <OTA_HotelDescriptiveInfoRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="test_request_id" Version="3" PrimaryLangID="de" AltLangID="de">
      <POS>
        <Source ISOCurrency="USD">
          <RequestorID Type="1" ID="HTL011235"></RequestorID>
        </Source>
      </POS>
      <HotelDescriptiveInfos>
        <HotelDescriptiveInfo ChainCode="AB" HotelCode="2575"></HotelDescriptiveInfo>
      </HotelDescriptiveInfos>
    </OTA_HotelDescriptiveInfoRQ>
  </Body>
</Envelope>

OTA_HotelDescriptiveInfoRQ

Name	Type	Description
`HotelDescriptiveInfos`	`complex`	Required Collection of items for data from multiple hotels. SAP Concur will only ever send one (1) `HotelDescriptiveInfo`.

HotelDescriptiveInfos

Name	Type	Description
`HotelDescriptiveInfo`	`complex`	Required This allows the requestor to indicate which specific information is requested if complete hotel details are not required.

HotelDescriptiveInfo

Name	Type	Description
`ChainCode`	`stringLength1to8`	The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the `HotelCode` attribute.
`HotelCode`	`stringLength1to16`	Required The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.

Response

The maximum allowed size of OTA_HotelDescriptiveInfoRS is 150 KB. Any response that exceeds this limit will be dropped.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
  <soap:Body>
    <OTA_HotelDescriptiveInfoRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="3">
      <Success/>
      <HotelDescriptiveContents>
        <HotelDescriptiveContent ChainCode="ZZ" HotelCode="2575" HotelName="Torbräu">
          <HotelInfo>
            <Descriptions>
              <DescriptiveText>Hotel description</DescriptiveText>
            </Descriptions>
          </HotelInfo>
          <MultimediaDescriptions>
            <MultimediaDescription>
              <ImageItems>
                <ImageItem>
                  <ImageFormat>
                    <URL>https://production.example.com/hotel-image.jpg</URL>
                  </ImageFormat>
                </ImageItem>
              </ImageItems>
            </MultimediaDescription>
          </MultimediaDescriptions>
          <TPA_Extensions>
            <Description Name="This will be a header">
              <Text>First line of first description.</Text>
              <Text>Second line of first description.</Text>
            </Description>
            <Description>
              <Text>Second description without name.</Text>
            </Description>
          </TPA_Extensions>
        </HotelDescriptiveContent>
      </HotelDescriptiveContents>
    </OTA_HotelDescriptiveInfoRS>
  </soap:Body>
</soap:Envelope>

OTA_HotelDescriptiveInfoRS

Name	Type	Description
`HotelDescriptiveContents`	`complex`	Required Contains hotel details content which is made up of text and image URLs.

HotelDescriptiveContents

Name	Type	Description
`HotelDescriptiveContent`	`complex`	Required Contains hotel details content which is made up of text and image URLs. SAP Concur expects one (1) `HotelDescriptiveContent`.

HotelDescriptiveContent

Name	Type	Description
`HotelCode`	`stringLength1to16`	Required The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.
`HotelName`	`stringLength1to128`	Required A text field used to communicate the proper name of the hotel. SAP Concur always expects the Hotel Name to be provided.
`HotelInfo`	`complex`	Contains descriptive information about a hotel.
`TPA_Extensions`	`complex`	SAP Concur specific extensions.
`MultimediaDescriptions`	`complex`	Multimedia information about a collection of multimedia objects. SAP Concur expects one (1) `MultimediaDescription` element.

HotelInfo

Name	Type	Description
`Descriptions`	`complex`	Contains descriptive information about a hotel. SAP Concur expects one (1) `Descriptions`.

Descriptions

Name	Type	Description
`DescriptiveText`	`string`	Descriptive text that describes the hotel. SAP Concur expects one (1) `DescriptiveText`

TPA_Extensions

Name	Type	Description
`Description`	`complex`	Represents text which will be rendered in the UI in the form of a heading and a paragraph.

Description

Name	Type	Description
`name`	`stringLength1to64`	The contents of this element will be rendered as a heading on the hotel details page.
`Text`	`string`	Required The contents of this element will be rendered as a paragraph. SAP Concur expects a maximum of 20 text elements per description, which will be concatenated to into one (1) paragraph.

MultimediaDescriptions

Name	Type	Description
`MultimediaDescription`	`complex`	Holds a list of `ImageItems`, each representing a single hotel image.

MultimediaDescription

Name	Type	Description
`ImageItems`	`complex`	Holds a list of `ImageItem`, each representing a single hotel image. SAP Concur expects up to a maximum of 200 `ImageItem` elements.

ImageItems

Name	Type	Description
`ImageItem`	`complex`	One (1) `ImageItem` per hotel image.

ImageItem

Name	Type	Description
`ImageFormat`	`complex`	Format of image.

ImageFormat

Name	Type	Description
`URL`	`string`	Required Contains a HTTPS URL pointing to a hotel image. The URLs are used in a client-side gallery widget, which works best with `.png` and `.jpg` files.