OTA Model Viewer | OTA_GroundResRetrieveRS

Type : Complex Element

Definition

The Ground Transportation Retrieve Reservation response is used to return either an exact match for one reservation (typically when a valid reservation reference ID/number has been specified) -OR- a list of reservations that match the criteria specified in the Ground Transportation Reservation Retrieve request message. This message may include a success element (and/or business warnings) with reservation details or an error message indicating why the message could not be processed. If reservation search criteria has been specified, the Reservations element may contain multiple matching reservations. Returned information includes: -A confirmation number for the ground transportation service reservation -Information about a primary passenger (who is the contact for the reservation) and additional passengers associated with the reservation -Information about the locations associated with the reservation, including pickup, interim stop(s) and drop-off details -Vehicle make and model information associated with the reservation -Rate qualifying information associated with the vehicle and/or ground transportation service reservation -Service charges, including taxes, minimum and maximum charges, and service charge calculation details -Fees that may be applied in addition to the Ground Transportation Service charges -Estimated total charges -Restrictions that apply to the vehicle and/or ground transportation service reservation -Payment rules that are applicable to the ground service reservation -Comments associated with the reservation
(Defined in file OTA_GroundResRetrieveRS.xsd , or a file it imports)

Elements
DetailedReservation	One reservation returned if a valid reservation identifier was located.Detailed information specific to a ground service reservation.
Errors	Indicates that an error occurred in the processing of the incoming request message. An error is defined as a malformed XML message that could not be processed.A collection of errors that occurred during the processing of a message.
Success	An element that is not intended to contain any data. The mere presence of a success element within the response message indicates that the incoming request message was processed successfully.Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is used in conjunction with the Warning Type to report any warnings or business errors.
SummaryReservation	One or more summary reservations that match specified reservation search criteria.Summary information about one or more ground service reservations.
TPA_Extensions	A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA).Allows extensions to be added to the OpenTravel specification per trading partner agreement.
Warnings	Indicates that the recipient of the request message identified one or more business-level warnings/errors, but the message itself was successfully processed.Collection of warnings.

Attributes
Attribute Group : OTA_PayloadStdAttributes
AltLangID	The alternate language for a customer or message encoded as ISO 639-3.
CorrelationID	Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
EchoToken	A reference for additional message identification, assigned by the requesting host system.
PrimaryLangID	The primary language preference for the message encoded as ISO 639-3.
RetransmissionIndicator	When true, indicates the message is being re-sent after a failure.
SequenceNmbr	The sequence number of the transaction assigned by the sending system for ordered message processing or message resynchronization.
Target	Test or Production target system indicator.
TargetName	The name of the Test or Production system.
TimeStamp	ISO 8601 encoded timestamp indicating the creation date and time of the message.
TransactionIdentifier	Unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction).
TransactionStatusCode	This indicates where this message falls within a sequence of messages.
Version	The OpenTravel message version indicated by a decimal value.