Developer Docs
  • Our Products
    • Channel Manager
      • Integration and Onboarding Flow
      • RG Bridge - Supply (Push)
        • Integration Overview
          • Vision of Integration
            • Commercial value and business case
          • Information Data flow
            • One way integration
            • Two Way integration – ARI Broadcast and Reservation fetch
            • Information delivery mechanism
          • Technical feasibility of integration
            • Test property setup
            • Sample reservation data
          • RG Bridge Setup
          • Contract
          • Project Plan
          • Certification
          • Monitoring and after sales support
          • Integration checklist
        • Interface Specifications – Availability and Rates Notification Service
          • RG Bridge Integration Process
          • Intended Audience
          • Typographical Conventions
          • Technical Overview
          • Operations
            • Availability Notification
              • OTA_HotelAvailNotifRQ
                • Change in Inventory count
                • Change in availability status and Restrictions
              • OTA_HotelAvailNotifRS
              • XML Usage Specification
            • Rate Change Notification
              • OTA_HotelRateAmountNotifRQ
              • XML Usage Description
              • OTA_HotelRateAmountNotifRS
              • XML Usage Specification
            • Points to remember
        • Interface Specifications – Reservation Notification Service
          • RG Bridge integration process
          • Intended audience
          • Typographical conventions
          • Technical overview
          • Operations
            • Reservation Notification
              • OTA_HotelResNotifRQ
              • XML Usage specification
              • Sample Reservation Messages
              • OTA_HotelResNotifRS
              • XML Usage specification
          • Points to remember
          • Code Lists
      • RG Bridge - Reservation Retrieval (Pull)
        • Technical overview
        • Operations
          • Reservation Retrieval
            • OTA_ReadRQ
            • XML Usage specification
            • OTA_ResRetrieveRS
            • XML Usage specification
          • Reservation Confirmation
            • OTA_NotifReportRQ
            • XML Usage specification
            • OTA_NotifReportRS
            • XML Usage specification
        • Code Lists
      • Direct Connect - Demand (Push)
        • Introduction
        • Interface Specifications – ARI Service
          • Technical Overview
          • Operation: Property List
            • HotelPropertyListGetRQ
            • HotelPropertyListGetRS
            • Test Use Cases
            • FAQ
          • Operation: Product List
            • HotelProductListGetRQ
            • HotelProductListGetRS
            • Test Use Cases
            • FAQ
          • Operation: ARI Get
            • HotelARIGetRQ
            • HotelARIGetRS
            • Test Use Cases
            • FAQ
          • Operation: ARI Update
            • HotelARIUpdateRQ
            • HotelARIUpdateRS
            • Test Use Cases
            • FAQ
          • Points to remember
          • Code Lists
        • Interface Specifications – Reservation Notification Service
          • Technical overview
            • Communication protocols
            • General design
            • Authentication
          • Operation: Reservation
            • OTA_HotelResNotifRQ
            • OTA_HotelResNotifRS
            • Test use cases
            • FAQ
    • Smart Distribution
      • Onboarding process
      • Certification - Demand
      • Authentication Method
      • Book and Cancel Reservation
        • Transaction Header Formats
        • Book API
          • Book Reservation
          • Cancel Reservation
          • Booking Reservation Request Message Format
          • Booking Reservation Response Message Format
          • Cancel Reservation Request Message Format
      • Multiavailability (Enhanced Shopping Transaction)
        • Transaction Header Formats
        • Enhanced Shopping (EST) – Detailed Rate Information
          • Requesting Specific Rates
          • UltraDirect Account Author Negotiated Rate Processing
          • Unavailable Properties
          • UltraDirect Cache Processing
          • Enhanced Shopping Transaction Request Header Format
          • Enhanced Shopping Transaction Response Message Format
      • Pre-Book
        • Transaction Header Formats
        • Pre Book API
          • Pre-Book Request message format
          • Pre-Book Response message format
      • Property list and Booking Summary
        • PropertyList API
        • Booking Summary API
  • Content
    • Integration Process
    • Certification - Demand
    • Content Retrieve
      • SOAP/HTTP
        • SOAP Envelop
        • SOAP Body
        • Date and Time
        • Specifications for Currency Amounts
      • Transaction Specifications
      • Content Retrieval Request
      • Content Retrieval Response
    • Content Update
      • Overview
      • Transaction List
      • Transaction Flow
      • Batch processing
        • File naming convention
      • Multi-lingual capabilities
      • Associating media to textual content
      • Managing images
      • GDS content updates
      • Office of Foreign Assets Control (OFAC)
      • Interface requirements
        • SOAP envelope
        • Standard element formats
      • Transaction specifications
        • Data mapping of elements
        • Area Information
        • Affiliation information
        • Media information
        • Contact information
        • TPA extensions
        • GDS information
        • Response message
      • Codes lists
        • Credit Card
        • Error and Warning codes
        • Spoken Language
        • State and Country
      • Supported language codes
      • Client application generation using WSDL tool
  • UltraDirect
    • Integration Process
    • Certification
    • Ultradirect transaction sets - XML
      • Transaction header formats
      • Booking transactions
        • Booking request message format..
        • Request message format - Cancel
        • Request message format - Commit/Rollback
        • Request message format - Modify
        • Response message format - Booking
      • Enhanced shopping (EST)
        • Requesting Specific Rates
        • Request message format
        • Response message format.
      • Rate and availability transactions
        • Standard multi-availability
          • Request & Response message format
      • Rate Rules
        • Request message format
        • Response message format
      • Reference data transactions
        • Request message format..
        • Response message format..
      • Single property availability
        • Request message format
        • Response message format
    • XML ultradirect specifications
      • Overview
        • Transaction list
      • Interface requirements
      • Transaction meta data
    • Error Codes..
    • UltraDirect Transaction Samples and Usage
      • Using UltraDirect (Seamless, a real-time transaction)
      • EST (Enhanced Shopping Transaction)
      • Rate Rules
      • Book Reservation
      • Cancellation
      • Book Reservation with session control
      • Modification
      • Booking Storage and Retrieval
      • List of Test Credit Cards
      • Test properties in UAT
      • Guarantee Type and Method Combinations
    • xml ultradirect codes
  • Get in Touch
    • Questions?
Powered by GitBook
On this page
  1. Our Products
  2. Channel Manager
  3. Direct Connect - Demand (Push)
  4. Interface Specifications – ARI Service
  5. Operation: Property List

HotelPropertyListGetRS

  • HotelPropertyListGetRS:

    • OTA should respond to the HotelPropertyListGetRQ request by returning a HotelPropertyListGetRS message.

Validation and Errors:

  • If the OTA is not able to validate a message at the application level, it should still return a HotelPropertyListGetRS message.

  • Failure Response: Response messages indicating failures must contain at least one error element. More than one error element can be returned if necessary.

Successful Response:

  • After validating the chain code or login credentials, the OTA should:

    • Return a HotelPropertyListGetRS message with a single Success element.

    • Include the list of properties in the Hotels element.

  • Single Property Account:

    • If the OTA does not use multi-property accounts, it should return information regarding the one hotel identified by the request.

Element/@Attribute

Parent Xpath

Description

Mandatory

@TimeStamp

/HotelPropertyListGetRS

Time of the transaction in XML schema date-time format.

Y

@Target

/HotelPropertyListGetRS

The environment to target this message to. For this version of the specification always set to “Production”.

Y

@Version

/HotelPropertyListGetRS

The version of the message. For this version of the specification set to “1.0”.

Y

Success

/HotelPropertyListGetRS

If included, this element will indicate that the request message was successfully processed.

If this element is returned, a hotel element must also be returned. Either a Success element or an Errors element is required in every response.

Y?

Errors

/HotelPropertyListGetRS

If included, this element will indicate that the request message could not be processed.

Either a Success element or an Errors element is required in every response.

Y?

Error

/HotelPropertyListGetRS/Errors

Description of cause for a fatal problem during request message processing.

*If an Errors element is included, at least one Error element is required.

Y

@Type

/HotelPropertyListGetRS/Errors/Error

This is an enumeration of error types. See Code Lists below for supported values. Code list Error Types.

Y

@Code

/HotelPropertyListGetRS/Errors/Error

This is an enumeration of error codes. See Code Lists below for supported values. Code list Error Codes.

Y

Hotels

/HotelPropertyListGetRS

This element contains a list of hotels. This element is used to return the list of all hotels that belong to the chain that can be updated using these login credentials.

Y?

@ChainCode

/HotelPropertyListGetRS/Hotels

The code identifies the hotel chain. All the hotels returned belong to this chain of hotels. This code is assigned by the OTA.

If you don’t support this Code then a blank value will be passed in this attribute of the request.

N

Hotel

/HotelPropertyListGetRS/Hotels

This element contains information about one hotel.

Y

@HotelCode

/HotelPropertyListGetRS/Hotels/Hotel

This element identifies the hotel. The OTA must assign a code that identifies the hotel across all chains of hotels. The chain code is not passed in other transactions. Therefore the code must uniquely identify the hotel independent of the chain code.

Y

@Name

/HotelPropertyListGetRS/Hotels/Hotel

The name of the hotel.

Y

Last updated 3 months ago