Booking Search using the client or agent reference

How to search for an XML booking in our websites using the client reference or agent reference

In the <AddBookingRequest> the client must always pass a client reference.

The agent reference is an optional parameter.  

By client reference

Given the following <AddBookingRequest> it is possible to search for the booking using the client’s reference.  Simply take note of the details highlighted in yellow: 

<?xml version="1.0" encoding="UTF-8"?>
<Request>
    <Source>
        <RequestorID
            Client = "XXXXX"
            EMailAddress = "XXXXX"
            Password = "XXXXX"/>
        <RequestorPreferences
            Country = "GB"
            Currency = "GBP"
            Language = "en">
            <RequestMode>SYNCHRONOUS</RequestMode>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
        <AddBookingRequest Currency = "GBP">
            <BookingName/>
            <BookingReference>DM123456</BookingReference>
            <AgentReference>654321DM</AgentReference>
            <BookingDepartureDate>2014-10-03</BookingDepartureDate>
            <PaxNames>
                <PaxName PaxId = "1" PaxType = "adult">Daniel McMillan</PaxName>
            </PaxNames>
            <BookingItems>
                <BookingItem ItemType = "hotel">
                    <ItemReference>1</ItemReference>
                    <ItemCity Code = "EDI"/>
                    <Item Code = "91"/>
                    <ItemRemarks/>
                    <HotelItem>
                        <AlternativesAllowed>false</AlternativesAllowed>
                        <PeriodOfStay>
                            <CheckInDate>2014-10-03</CheckInDate>
                            <Duration><![CDATA[2]]></Duration>
                        </PeriodOfStay>
                        <HotelRooms>
                            <HotelRoom
                                Code = "SB"
                                ExtraBed = "false"
                                Id = "001:91:22759:S22229:33650:121400"
                                NumberOfCots = "0">
                                <PaxIds>
                                    <PaxId>1</PaxId>
                                </PaxIds>
                            </HotelRoom>
                        </HotelRooms>
                    </HotelItem>
                </BookingItem>
            </BookingItems>
        </AddBookingRequest>
    </RequestDetails>
</Request>

On the home page of the relevant web site, click on the ‘Booking Search’ link:

Booking search using the client or agent reference

Mandatory fields:

  • Agent ID : XXXXXX
  • Client Booking Reference:  
  • <BookingReference>DM123456</BookingReference>
  • Leave the Group field blank

Mandatory fields

Clicking on the ‘Search’ button will then bring up the booking:

'Search' button

By agent reference

On the home page of the relevant web site, click on the ‘Booking Search’ link:

Booking Search

On the booking search page enter the agent reference:

<AgentReference>654321DM</AgentReference>

Agent reference

This will bring up the booking list page, click on the ‘Booking ID’:

Booking ID

You can search in the XML your booking by running a SearchBookingRequest :

By client reference:

<?xml version="1.0" encoding="UTF-8"?>
<Request>
    <Source>
        <RequestorID
            Client = "XXXXX"
            EMailAddress = "xxxxxxxxxxxx"
            Password = "xxxxxx"/>
        <RequestorPreferences
            Country = "TW"
            Currency = "USD"
            Language = "en">
            <RequestMode>SYNCHRONOUS</RequestMode>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
        <SearchBookingRequest>
            <BookingReference ReferenceSource = "client"> DM123456</BookingReference>
            <EchoSearchCriteria>false</EchoSearchCriteria>
            <ShowPaymentStatus>false</ShowPaymentStatus>
        </SearchBookingRequest>
    </RequestDetails>
</Request>

By Agent Reference:

<?xml version="1.0" encoding="UTF-8"?>
<Request>
    <Source>
        <RequestorID
            Client = "XXXXX"
                        EMailAddress = "xxxxxxxxxxxx"
            Password = "xxxxxx"/>
        <RequestorPreferences
            Country = "TW"
            Currency = "USD"
            Language = "en">
            <RequestMode>SYNCHRONOUS</RequestMode>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
        <SearchBookingRequest>
            <BookingReference ReferenceSource = "agent">[ 654321DM] </BookingReference>
            <EchoSearchCriteria>false</EchoSearchCriteria>
            <ShowPaymentStatus>false</ShowPaymentStatus>
        </SearchBookingRequest>
    </RequestDetails>
</Request>

By Api Reference:

<?xml version="1.0" encoding="UTF-8"?>
<Request>
    <Source>
        <RequestorID
            Client = "XXXXX"
                        EMailAddress = "xxxxxxxxxxxx"
            Password = "xxxxxx"/>
        <RequestorPreferences
            Country = "TW"
            Currency = "USD"
            Language = "en">
            <RequestMode>SYNCHRONOUS</RequestMode>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
        <SearchBookingRequest>
            <BookingReference ReferenceSource = "api">12436942 </BookingReference>
            <EchoSearchCriteria>false</EchoSearchCriteria>
            <ShowPaymentStatus>false</ShowPaymentStatus>
        </SearchBookingRequest>
    </RequestDetails>
</Request>

 



Docs Navigation