Detailed availability search

Product: transport
Type: detailed_availability

Detailed availability search allows the client to obtain updated and detailed data about the selected agreement. It is also used to obtain supplement quotation.

Request

Request fields:

• search
• • @number: search number from previous availability search
• agreement
• • @code: selected agreement code from previous availability search
• additional_required_info (required if additional_required_info is returned in the availability search)
• • required_info
• • • @name: required info name as returned in availability search
• • • @value: input value from your client in the correct format as requested by the @type attribute

Request example:

<envelope>
    <header>
        <actor>exampleactor</actor>
        <user>exampleuser</user>
        <password>*****</password>
        <version>1.7.0</version>
        <timestamp>20240112150441</timestamp>
    </header>
    <query type="detailed_availability" product="transport">
        <search number="trsprts.avl65b8ea99ac0db"/>
        <agreement code="LCL.33.132.1.NjJkY2E0"/>
        <additional_required_info>
            <required_info name="dropoff_travel_departure" value="2024-02-10 14:00:00"/>
        </additional_required_info>
    </query>
</envelope>

Response

Response example:

<envelope>
    <header>
        <version port="22222" host="example.netstorming.net">1.7.0</version>
        <timestamp>20240131105234</timestamp>
    </header>
    <response type="detailed_availability" product="transport">
        <paxes required="1" optional="1" documents_required="false" leader_phone_required="true" leader_email_required="false"/>
        <additional_fields>
            <additional_field code="FLIGHT" name="Flight number" description="Please specify the flight number." type="string" compulsory="true"/>
            <additional_field code="FLIGHT_TIME" name="Flight time" description="Please specify the exact time the flight is expected to land/depart." type="datetime" compulsory="true"/>
            <additional_field code="HA-HOUR" name="Happy hour time" description="Orario dell'happy hour" type="time" compulsory="false"/>
            <additional_field code="VIP" name="VIP" description="" type="bool" compulsory="false"/>
            <additional_field code="CHD_BIRTHDATE" name="birthdate" description="Please specify child birthdate" type="date" compulsory="false"/>
        </additional_fields>
        <agreement code="LCL.33.132.1.NjJkY2E0" available="true" typology="PRIVATE" category="Economy+" vehicle="Standard car" luggage="2" deadline="2024-02-12 10:30:00" photo_url="https://d3uh87skopbdhk.cloudfront.net/aic/vehicles/1/standard/62b047d015be7.png">
            <prices>
                <nett amount="115" currency="EUR"/>
                <gross amount="115" currency="EUR"/>
            </prices>
            <cancellation_policies>
                <policy from="2024-02-12 10:30:00" percentage="100"/>
            </cancellation_policies>
            <vehicle description="Doors: 5, Max passengers: 4, Max luggage pieces: 4, Luggage dimensions: 30cmX40cmX60cm">
                <doors value="5"/>
                <luggage_dimensions value="30cmX40cmX60cm"/>
                <max_luggages value="4"/>
                <max_passengers value="4"/>
            </vehicle>
            <features>
                <feature text="Mandatory: Nightly rate charge (Included in the price)"/>
                <feature text="Available: Water bottle"/>
            </features>
            <supplements>
                <supplement code="SYS_SUPP_21@19" name="Nightly rate charge" quantity="1" max_quantity="1" type="int" prepaid="true" compulsory="true">
                    <prices>
                        <nett amount="10" currency="EUR"/>
                        <gross amount="10" currency="EUR"/>
                    </prices>
                </supplement>
                <supplement code="SYS_SUPP_24@20" name="Water bottle" quantity="0" max_quantity="5" type="int" prepaid="true" compulsory="false">
                    <prices>
                        <nett amount="2.5" currency="EUR"/>
                        <gross amount="2.5" currency="EUR"/>
                    </prices>
                </supplement>
            </supplements>
        </agreement>
    </response>
</envelope>

Response fields:

Refer to availabiliy search response for details about agreement content.

• paxes
• • @required: number of required paxes data
• • @optional: number of optional paxes data
• • @documents_required: if true paxes documents are reqiured. At the time of writing this field is not used yet.
• • @leader_phone_required: if true it is mandatory to provide traveller's phone number
• • @leader_email_required: if true it is mandatory to provide traveller's email address
• additional_fields
• • additional_field
• • • @code: additional field code
• • • @name: additional field name
• • • @description: brief description of required data
• • • @type: additional field type. Could be string, int, bool, date (YYYY-mm-dd), time (HH:ii), datetime (YYYY-mm-dd HH:ii:ss), choice.
• • • @compulsory: if true, this value is mandatory for booking
• • • choices: only present if additional_field@type is choice
• • • • choice@value: allowed values for this additional_field