Vehicle Availability Search Schema
Sample requests and responses for Vehicle Availability are provided below. A discussion of the required elements follows each example. Considerations for the request are then noted.
Sample Vehicle Availability Request
evaluateRQ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v02="http://opentravel.org/common/message/v02" xmlns:v1="http://www.travelport.com/schema/policy/vehicle/v1" xmlns:v021="http://opentravel.org/common/v02">
<soapenv:Body>
<neutralcar:evaluateRQ policy_Reference="100062" xmlns:neutralcar="http://www.travelport.com/schema/policy/vehicle/v1">
<neutralcar:DateLocation pickupLocation="SYD" pickupLocationCategory="City" pickupDateTime="2014-11-07T09:00:00.000+11:00" returnDateTime="2014-11-10T09:00:00.000+11:00"/>
<neutralcar:VehicleEvaluation id="1" vendorCode="ZD" airConditioningInd="true" transmissionCategory="Manual" class="Mini" category="Car">
<neutralcar:Rate amount="24.40" code="AUD" period="Daily"/>
</neutralcar:VehicleEvaluation>
<neutralcar:VehicleEvaluation id="2" vendorCode="ZD" airConditioningInd="true" transmissionCategory="Automatic" class="Special" category="Convertible">
<neutralcar:Rate amount="61.94" code="AUD" period="Daily"/>
</neutralcar:VehicleEvaluation>
…………………………
Additional VehicleEvaluation items removed for brevity
…………………………
</neutralcar:evaluateRQ>
</soapenv:Body>
</soapenv:Envelope>?
The following elements are supplied in an evaluate request:
evaluateRQ – wrapper for the whole request
attribute: policy_Reference - the identifier that tells Universal Policy which policy to apply
DateLocation – details for vehicle rental for which the search request that was made
attribute: pickupLocation – location from which the vehicle will be rented
attribute: pickupLocationCategory – category of location (Airport / City)
attribute: pickupDateTime – requested pickup date / time
attribute: returnDateTime – requested return date / time
VehicleEvaluation – details of the vehicle being rented
attribute: id – unique identifier for this VehicleEvaluation item
attribute: vendorCode – vendor code for this vehicle
attribute: airConditioningInd – indicator to show if vehicle has air conditioning (true / false)
attribute: transmissionCategory – type of transmission on vehicle (Automatic / Manual)
attribute: class – class of vehicle (Economy / Compact / Intermediate etc.).
attribute: category – category of vehicle (Car / Convertible etc.).
Rate – details of the rate for this vehicle rental
attribute: amount – amount for this rental period
attribute: code – currency code associated with amount
attribute: period – type of rental period (Daily / Weekly etc.).
Sample Vehicle Availability Response
evaluateRS
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<ns2:MessageHeader xsi:nil="true" xmlns:ns2="http://opentravel.org/common/message/v02" xmlns:ns5="http://www.travelport.com/schema/policy/common/v1" xmlns:ns6="http://www.OpenTravel.org/ns/OTA2/AppInfo_v01_00" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns3="http://opentravel.org/common/v02" xmlns:ns4="http://www.travelport.com/schema/policy/vehicle/v1"/>
</soapenv:Header>
<soapenv:Body>
<ns4:evaluateRS xmlns:ns4="http://www.travelport.com/schema/policy/vehicle/v1" xmlns:ns5="http://www.travelport.com/schema/policy/common/v1" xmlns:ns6="http://www.OpenTravel.org/ns/OTA2/AppInfo_v01_00" xmlns:ns2="http://opentravel.org/common/message/v02" xmlns:ns3="http://opentravel.org/common/v02">
<ns5:AdditionalMessage category="Info" code="0" description="Policy Applied." providerCode="PS"/>
<ns4:DateLocation pickupDateTime="2014-11-07T09:00:00.000+11:00" pickupLocation="SYD" pickupLocationCategory="City" returnDateTime="2014-11-10T09:00:00.000+11:00"/>
<ns4:VehicleEvaluation airConditioningInd="true" category="Car" class="Mini" id="1" transmissionCategory="Manual" vendorCode="ZD">
<ns4:Rate amount="24.40" code="AUD" period="Daily"/>
<ns4:Evaluation inPolicyInd="false" policyCode="201" preferredOptionInd="false"/>
</ns4:VehicleEvaluation>
<ns4:VehicleEvaluation airConditioningInd="true" category="Convertible" class="Special" id="2" transmissionCategory="Automatic" vendorCode="ZD">
<ns4:Rate amount="61.94" code="AUD" period="Daily"/>
<ns4:Evaluation inPolicyInd="false" policyCode="201" preferredOptionInd="false"/>
</ns4:VehicleEvaluation>
…………………………
Additional VehicleEvaluation items removed for brevity
…………………………
</ns4:evaluateRS>
</soapenv:Body>
</soapenv:Envelope>
As with other entries, Universal Policy returns some informational data in the AdditionalMessage elements at the top of the evaluateRS.
If policy is applied successfully, Universal Policy returns a message with a Code of 0.
<ns4:AdditionalMessage category="Info" code="0" description="Policy Applied." providerCode="PS"/>
If an error occurs in applying policy an error code and error message are returned:
<ns4:AdditionalMessage category="Warning" code="9292" description="Unable to process Policy Evaluation." providerCode="PS"/>
An Evaluation tag is inserted into the response for each VehicleEvaluation, containing the policy attributes.
The three Policy attributes that can be returned are:
The preferredOptionInd attribute is set to either true or false.
If set to true this VehicleEvaluation element is preferred.
If set to false this VehicleEvaluation element is not preferred.
The inPolicyInd attribute is set to either true or false.
If set to true this VehicleEvaluation element is in-policy.
If set to false this VehicleEvaluation element is out-of-policy.
The policyCode attribute is returned only if the inPolicyInd attribute was returned as false. It contains a numeric value that represents the reason why this VehicleEvaluation was marked as out-of-policy. See the Policy Service Return Codes V2 spreadsheet for detail.
Considerations for a Vehicle Availability Search evaluateRQ request
The order that the elements are returned in the response data is not guaranteed to be the same order that they were sent up in the request data, and if exclusions have been configured in the car policy VehicleEvaluation elements may be removed from the response. The VehicleEvaluation element supports the use of an id attribute which can be used to correlate request and response data.
Policy is applied to each evaluateRQ individually.
If you are making multiple vehicle availability search calls from your CBT and then combining them together before displaying the results back to the screen, each request will have had policy applied separately. Note that depending on the policy settings you are using this can lead to some confusing results.
Sample Request and Response
See the Downloads page to download a zip file containing the following XML files.
Sample Request:
VehicleSearchEvaluateRQ.xml
Sample Response:
VehicleSearchEvaluateRS.xml