Updated: 07 Aug 2017 | Edit on Github

Method Goals

This method aims to return all the available destinations for the selected carrier.

Remarks

This method should be cached internally and only called once a week and in most cases once a month. The hierarchically structure of the tree is defined by the provider.

DestinationsTreeRQ Example

    <DestinationsTreeRQ>
        <timeoutMilliseconds>60000</timeoutMilliseconds>
        <source>
            <agencyCode>test</agencyCode>
            <languageCode>es</languageCode>
        </source>
        <filterAuditData>
            <registerTransactions>false</registerTransactions>
        </filterAuditData>
        <Configuration codeProvider = "XXX">
            <Credentials user = "XXX" password = "XXX">
                <UrlGeneric>XXX</UrlGeneric>
                <UrlIdentification xsi:nil = "true"/>
                <UrlAvailability xsi:nil = "true"/>
                <UrlRateRule xsi:nil = "true"/>
                <UrlBook xsi:nil = "true"/>
                <UrlsSpecific xsi:nil = "true"/>
            </Credentials>
            <Attributes></Attributes>
        </Configuration>
    </DestinationsTreeRQ>

DestinationsTreeRQ Description

The request just contains the elements of BaseRQ.

Element Number Type Description
DestinationsTreeRQ 1   Root node.

DestinationsTreeRS Example

    <DestinationsTreeRS>
        <auditData>
            <timeStamp>2014-09-11T15:08:20.7037707+01:00</timeStamp>
            <processTimeMilliseconds>0</processTimeMilliseconds>
        </auditData>
        <operationImplemented>true</operationImplemented>
        <Destination code="000" name = "xxxx" type="CTY" avail = "true">
            <Child code="111" />
            <Child code="222" />
        </Destination>
        <Destination code="111" name = "Xxxx" type="ARP" avail = "true">
            <Child code="444" />
            <Child code="222" />
        </Destination>
        <Destination code="222" name = "Xxxx" type="ZON" avail = "true">
            <Child code="444" />
            <Child code="333" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
        </Destination>
        <Destination code="333" name = "Xxxx" type="OTH" avail = "false">
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
            <Child code="XXX" />
        </Destination>
        <Destination code = "444" name = "Xxxx" type = "HOT" avail = "true"/>
    ...
    </DestinationsTreeRS>

DestinationsTreeRS Description

The response returns a list of Destination with a code that identifies it in the provider’s system. The Destination object also contains a list of Child , these children contain the code that identifies the destinations that hang from that “Parent” destination. Usually not all Destination are available for booking so we added the boolean avail that indicates if this code can be used on the Availability method.

Element Number Type Description
DestinationsTreeRS 1   Root Node.
DestinationsTreeRS/Destination 1..n Destination Contains a list of Destinations. Each destination contains its own information and a list of children (destinations of a lower level that belong to this destination).
@Destination/code 1 String Contains the code that must be used in Availability in order to Search for this location.
@Destination/name 1 String It is the full name of the destination in the provider’s system.
@Destination/type 1 eLocationType Indicates the type of location. This information must be sent in the AvailabilityRQ too. The possible values are: CTY; ZON; ARP; STA; PRT; HOT; PDI and OTH.
@Destination/avail 1 Boolean Indicates if this code can be used on the Availability method in order to obtain results.
@Destination/Child 0..n Child Contains a list of children (destinations of a lower level that belong to this destination).
@Child/code 1 String Indicates the destination code of the child. The information of the child is explained in the specific destination with this code.
@Destination/Position 1 Position This object contains the geolocation coordinates of the destination.
@Position/latitude 1 String Indicates latitude value of geolocation.
@Position/longitude 1 String Indicates longitude value of geolocation.