Vehicle Matrix

The Vehicle Matrix transaction provides a basic Vehicle Search Availability request that returns a maximum amount of vehicle rates in the fastest time possible. This transaction supports web-based applications that display a table of vehicle rates where the axes represent vehicle suppliers by vehicle types. The Vehicle Matrix response provides all of the data necessary to complete this grid in one transaction. Additional (Get More) transactions are not required to obtain all response data.

Important! Wordspan (1P) do not support Vehicle Matrix functionality. If a Vehicle Matrix request is sent to Worldspan (1P), the Matrix-specific request attributes are ignored and a standard Vehicle Search response is returned with a warning message: ReturnAllRates not supported by Worldspan, and has been ignored.

Schema

See the following transactions for Vehicle Search:

Request

VehicleSearchAvailabilityReq is used to request Vehicle Matrix searches. The Vehicle Matrix request is similar to a standard Vehicle Search request, but is differentiated by a Return All Rates indicator. The response returns all response items in a single call, but typically includes truncated response data for individual Vehicle items.

Note: Vehicle Matrix is equivalent to the CarMatrix transaction in GWS.

Set ReturnAllRates to "True" to return a Vehicle Matrix response.

For a more specific response:

A single VehicleDateLocation/PickupLocation and /PickupLocationNumber item can be requested. Only one PickupLocationType is currently supported by Universal API, and should be considered when using Vehicle Matrix. Only one specific ReturnLocation is currently supported when using Vehicle Matrix.

VehicleSearchModifiers/ReferencePoint is not supported for the Vehicle Matrix request; reference points are supported in the response only. Reference point data is ignored if it is sent in the request.

Only Vehicle Class 'A' is supported, so VehicleType must begin with an 'A'. See Vehicle Search by Vehicle Type for a list of supported Vehicle Types.

VehicleSearchModifiers @PreferredCurrency can be specified to request vehicle rates in a user's preferred currency. E.g., PreferredCurrency="EUR". All converted rates are returned, regardless of the providers to whom the request was submitted. See the response for details.

NextResultReference data is not included in Vehicle Matrix requests because all data is returned in one response.

Requests can include an exact pickup, exact return, or exact pickup and return locations.

All schema versions support submitting exact pickup and return locations.

Response

A Vehicle Matrix response is returned when ReturnAllRates is set to "True". The response contains all rates in VehicleSearchAvailabilityRsp. If ReturnAllRates is set to "False", a standard Vehicle Search response is returned, based on existing Universal API functionality.

Exceptions