Post a Reservation Detail Search

Limitations

Access to this documentation does not provide access to the API.

Request

The following request is sent to the supplier when the Travel user selects a ground transportation reservation to get additional details.

URI

The Ground Transportation direct connect sends the relevant information to a URI that the travel supplier maintains. The standard location is:

https://{servername}/concur/groundtransportation

The URI is configured by the supplier when registering the partner application.

Request Headers - Required

Authorization header with OAuth credentials. Refer to the OAuth documentation for more information.

Request Headers - Optional

None

Request Body

The request will contain a CC_LimoReservationDetailRequest parent element, containing the following child element:

Element Name	Required/Optional	Data Type	Description
ReservationID			The unique identifier for the reservation. Returned in the ReservationID element by the response of the Post Reservation Sell function.

XML Example Request

POST /concur/groundtransportation HTTPS/1.1
Host: example.com
Authorization: Basic ...
Content-Type: application/xml
Content-Length: {length of content body}

<CC_LimoReservationDetailRequest>
 <ReservationID>1234</ReservationID>
</CC_LimoReservationDetailRequest>

Response

The supplier responds to the request by supplying the full reservation details.

Content Type

application/xml

Response Schema

The response will include a CC_LimoReservationDetailReply parent element, with the following child elements:

Element Name	Required/Optional	Description
Error	Y	The error information, if an error occurred. For information about the child elements of this parent element, see the Error elements table.
ReservationID	N	The identifier for the reservation.
Status	N	The status of the reservation. The value will be one of the following: RB: Reservation Pending RA: Reservation Accepted (Reserved) RD: Reservation Declined XB: Cancellation Pending XA: Cancellation Confirmed (Cancelled) XD: Cancellation Declined
ConfNum	N	The confirmation number for the reservation.
CancelPolicy	N	The cancellation policy for the reservation.
CancelNum	N	The cancellation number for the reservation.
PrimaryPassenger	Y	The passenger contact name for the reservation. For information about the child elements of this parent element, see the PrimaryPassenger elements table.
ServiceType	Y	The type of service requested. Will contain one of the following values: 100: Point to point 110: One way to airport 111: One way from airport 120: One way to train station 121: One way from train station 200: Hourly 300: Airport to airport
ClassOfService	N	The requested service class. Will contain one of the following values: 100: Normal 200: High 300: Highest If this value is not provided by the user, it will default to 100.
PickupLocation	Y	The pick up location. For information about the child elements of this parent element, see the PickupLocation elements table.
DropoffLocation	Y	The drop off location. For information about the child elements of this parent element, see the DropoffLocation elements table.
StartDateTime	Y	The time, in GMT, that the reservation must begin. Format: 2015-05-19T18:00:00
EndDateTime	N	The time, in GMT that the reservation will end. Provided for hourly reservations. Format: 2015-05-19T18:00:00
PickupInstructions	N	Additional instructions about the pick up request.
DropoffInstructions	N	Additional instructions about the drop off request.
LanguageCode	Y	The language of the traveler. Will be one of the following options: en: English en-us: English (US) en-gb: English (UK) fr: French fr-ca: French (Canadian) de: German pt: Portuguese es: Spanish nl: Dutch it: Italian ja: Japanese pl: Polish bt-br: Portuguese (Brazilian) ru: Russian hu: Hungarian ko: Korean sv: Swedish zh-cn: Chinese zh-tw: Traditional Chinese
Currency	Y	The 3-letter ISO 4217 currency code for the reservation amount.
NumPassengers	N	The number of passengers.
RequestedDriver	N	The name of the requested driver, if available.
SpecialServiceRequest	N	The details of the special service request, if available.
PickupServiceArrangement	N	The details of the pickup arrangement, if available.
DropoffServiceArrangement	N	The details of the dropoff arrangement, if available.
ExtraStopArrangement	N	The details of the extra stop arrangement, if available.
RateInfo	Y	The booked rate details. Refer to the Rate Information elements table for more information.
Vehicle	Y	The vehicle details. For information about the child elements of this parent element, see the Vehicle elements table.
Vendor	Y	The reservation vendor. For information about the child elements of this parent element, see the Vendor elements table.
FormOfPayment	Y	The form of payment for the reservation. For information about the child elements of this parent element, see the FormOfPayment elements table.
RateDisclaimer	N	Disclaimer text about the rate.
ProviderFeedback	N	Any additional feedback from the supplier.
AccountingInfo	N	The accounting information for the reservation. This parent element contains the following child elements: AccountingField1 through AccountingField5

Error Child Elements

Element Name	Required/Optional	Data Type	Description
ErrorCode			The code for the error. Will contain one of the following values: 400: Credential related error 700: Reservation not available 900: Unknown error
ErrorSource			The source of the error.
ErrorDescription			The additional error information.

PrimaryPassenger Child Element

Element Name	Required/Optional	Data Type	Description
FirstName			The contact’s first name.
LastName			The contact’s last name.
Phone			The contact’s phone number.
Phone2			The contact’s backup phone number.
CellPhone			The contact’s cell phone number.
EmailAddress			The contact’s email address.

PickupLocation

Element Name	Required/Optional	Data Type	Description
LocationType			One of the following: 100 - Address, 200 - Airport, 300 - Train station.
Airport			Refer to the Airport elements table. Provided if the LocationType = 200.
TrainStation			Refer to the Train Station elements table. Provided if the LocationType = 300.
Address			The street address of the location. Provided if the LocationType = 100.
City			The location city.
State			The location state. Preferably 2 characters, max 10 characters.
Country			The location’s 2 character ISO 3166-1 alpha-2 country code. Example: US
PostalCode			The location postal code.
ExtraNotes			Additional notes about the location. Example: Ring doorbell, Holiday Inn, etc.

DropoffLocation

Element Name	Required/Optional	Data Type	Description
LocationType			One of the following: 100 - Address, 200 - Airport, 300 - Train station, 400 - As directed.
Airport			Refer to the Airport elements table. Provided if the LocationType = 200.
TrainStation			Refer to the Train Station elements table. Provided if the LocationType = 300.
Address			The street address of the location. Provided if the LocationType = 100.
City			The location city.
State			The location state. Preferably 2 characters, max 10 characters.
Country			The location’s 2 character ISO 3166-1 alpha-2 country code. Example: US
PostalCode			The location postal code.
ExtraNotes			Additional notes about the location. Example: Apartment Building, gravel driveway, etc.

Vehicle Child Elements

Element Name	Required/Optional	Data Type	Description
VehicleType			One of the following values: 100: Sedan 200: Limo 250: Stretch Limo 300: SUV 350: Stretch SUV 400: Van 450: Mini-Bus 500: Motor Coach 600: Shuttle 700: Trolley 800: Carriage 900: Any
Description			The vehicle description.
MaxPassengers			The maximum number of passengers for the vehicle. Must be greater than zero.
VehicleID			Information to identify the specific vehicle.

Vendor Child Elements

Element Name	Required/Optional	Data Type	Description
VendorCode			The vendor code for the vendor.
VendorName			The vendor’s name.
PhoneNumber			The vendor’s phone number.

FormOfPayment Child Elements

Element Name	Required/Optional	Data Type	Description
CreditCard			If present, the passenger will pay with credit card. Refer to the Reply Credit Card Elements table for the child elements.
Cash			If present, the passenger will pay cash.
Check			If present, the passenger will pay with a check.
DirectBilling			If present, the passenger will pay through direct billing.

Rate Information Elements

Element Name	Required/Optional	Description
RateID	Y	The rate identifier.
Rate	Y	The BasePrice + ServiceCharge + SurCharge + Tax
RateTypeCode	Y	The code for the rate type. Will be one of the following options: F: Flat rate H: Hourly E: Estimated amount N: Currently not available
CategoryCode	N	Extra information that will be passed back during sell request to help identify the rate.
Currency	Y	The 3-letter ISO 4217 currency code for the rate amount.
NoRateText	N	Explanation of rate type. Provided if RateTypeCode = N
MinHours	N	The minimum number of hours for the reservation.
DiscountType	N	The type of discount applied.
BasePrice	N	The reservation price without taxes, surcharges or service charges.
ServiceCharge	N	The service charge for the reservation.
SurCharge	N	This element contains the desc attribute, with text describing the reason for the surcharge. Example: `<SurCharge desc="fuel">`
Tax	N	The reservation tax.
ExtraPickupCharge	N	Any additional fees for the pickup service.
ExtraDropoffCharge	N	Any additional fees for the drop off service.
OptionalExtraStopCharge	N	The charge for any additional stops.
OptionalExtraTimeCharge	N	The charge for each additional hour.

Reply Credit Card Elements

Element Name	Required/Optional	Description
Type	Y	The card type.
Number	Y	The card number.
Expiration	Y	The card expiration date. Format: 2013-02-19.

Airport Elements

Element Name	Required/Optional	Data Type	Description
AirportCode			The IATA code for the airport.
Flight			The flight information. For information about the child elements of this parent element, see the Flight elements table.

Flight Child Elements

Element Name	Required/Optional	Data Type	Description
CarrierCode			The airline code.
FlightNumber			The flight number.
ArrivalDateTime			The flight arrival time. Only provided for the PickupLocation element. Format: 2015-05-19T18:00:00
DepartureDateTime			The flight departure time. Only provided for the DropoffLocation element. Format: 2015-05-19T18:00:00

Train Station Elements

Element Name	Required/Optional	Data Type	Description
StationCode			The station code.
StationName			The name of the station.
City			The city the station is located in.
State			The state the station is located in. Preferably 2 characters, max 10 characters.
Train			The train information. For information about the child elements of this parent element, see the Train elements table.

Train Child Elements

Element Name	Required/Optional	Data Type	Description
CarrierCode			The code of the train carrier.
CarrierName			The name of the train carrier.
TrainNumber			The train number.
ArrivalDateTime			The train arrival time. Only provided for the PickupLocation element. Format: 2015-05-19T18:00:00
DepartureDateTime			The train departure time. Only provided for the DropoffLocation element. Format: 2015-05-19T18:00:00

XML Example of Successful Response

HTTPS/1.1 200 OK
Content-Type: application/xml
Content-Length: {length of content body}

<CC_LimoReservationDetailReply>
  <Error>
    <ErrorCode />
    <ErrorSource />
    <ErrorDescription />
  </Error>
  <ReservationID>1234</ReservationID>
  <Status>RB</Status>
  <ConfNum>4444</ConfNum>
  <CancelPolicy />
  <CancelNum>55555</CancelNum>
  <PrimaryPassenger>
    <FirstName>Chris</FirstName>
    <LastName>Miller</LastName>
    <Phone>5551234567</Phone>
    <Phone2>5551234568</Phone2>
    <CellPhone>5551234569</CellPhone>
    <EmailAddress>cmiller@example.com</EmailAddress>
  </PrimaryPassenger>
  <ServiceType>110</ServiceType>
  <ClassOfService />
  <PickupLocation>
    <LocationType>100</LocationType>
    <Airport>
      <AirportCode />
      <Flight>
        <CarrierCode />
        <FlightNumber />
        <ArrivalDateTime />
      </Flight>
    </Airport>
    <TrainStation>
      <StationCode />
      <StationName />
      <City />
      <State />
      <Train>
        <CarrierCode />
        <CarrierName />
        <TrainNumber />
        <ArrivalDateTime />
      </Train>
    </TrainStation>
    <Address>209 Madison St</Address>
    <City>Alexandria</City>
    <State>VA</State>
    <Country>US</Country>
    <PostalCode>22314</PostalCode>
    <ExtraNotes />
  </PickupLocation>
  <DropoffLocation>
    <LocationType>200</LocationType>
    <Airport>
      <AirportCode>DCA</AirportCode>
      <Flight>
        <CarrierCode>UA</CarrierCode>
        <FlightNumber>333</FlightNumber>
        <DepartureDateTime>2012-02-19T11:29:00</DepartureDateTime>
      </Flight>
    </Airport>
    <TrainStation>
      <StationCode />
      <StationName />
      <City />
      <State />
      <Train>
        <CarrierCode />
        <CarrierName />
        <TrainNumber />
        <DepartureDateTime />
      </Train>
    </TrainStation>
    <Address />
    <City />
    <State />
    <Country />
    <PostalCode />
    <ExtraNotes />
  </DropoffLocation>
  <StartDateTime>2012-02-19T09:00:00</StartDateTime>
  <EndDateTime />
  <PickupInstructions>pick me up</PickupInstructions>
  <DropoffInstructions>None</DropoffInstructions>
  <LanguageCode>en-us</LanguageCode>
  <Currency>USD</Currency>
  <NumPassengers>1</NumPassengers>
  <RequestedDriver />
  <SpecialServiceRequest />
  <PickupServiceArrangement />
  <DropoffServiceArrangement />
  <ExtraStopArrangement />
  <RateInfo>
    <RateID>5</RateID>
    <Rate>42.50</Rate>
    <RateTypeCode>E</RateTypeCode>
    <CategoryCode />
    <MinHours />
    <Currency>USD</Currency>
    <NoRateText />
    <DiscountType />
    <BasePrice>35.00</BasePrice>
    <ServiceCharge>5.00</ServiceCharge>
    <SurCharge desc="fuel">1.00</SurCharge>
    <Tax>1.50</Tax>
    <ExtraPickupCharge />
    <ExtraDropoffCharge />
    <OptionalExtraStopCharge />
    <OptionalExtraTimeCharge />
    <Message />
  </RateInfo>
  <RateDisclaimer />
  <Vehicle>
    <VehicleType>100</VehicleType>
    <Description>This is a Sedan.</Description>
    <MaxPassengers>1</MaxPassengers>
    <VehicleID>12</VehicleID>
  </Vehicle>
  <Vendor>
    <VendorCode>LML</VendorCode>
    <VendorName>LimoVendor</VendorName>
    <PhoneNumber>4354654654</PhoneNumber>
  </Vendor>
  <ProviderFeedback />
  <FormOfPayment>
    <Cash />
    <Check />
    <DirectBilling />
    <CreditCard>
      <Type>VI</Type>
      <Number>XXXXXXXXXXXX1111</Number>
      <Expiration>2013-02-19</Expiration>
    </CreditCard>
  </FormOfPayment>
  <AccountingInfo>
    <AccountingField1>715</AccountingField1>
    <AccountingField2>temp@outtask.com</AccountingField2>
    <AccountingField3>11</AccountingField3>
    <AccountingField4>Development</AccountingField4>
    <AccountingField5/>
  </AccountingInfo>
</CC_LimoReservationDetailReply>