You are on page 1of 273

SuperShuttle Web Services

API Guide

Version 2.2

This API document provides guidance for SuperShuttle trading


partners who use web services to exchange information with
SuperShuttle.

Revised: February 11, 2016


Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Contents

Contents
GETTING STARTED 4
Before You Begin 4
Important Information About Customer Pickup Times 5
SUPERSHUTTLE THREE-STEP BOOKING PROCESS 6
EXECUCAR THREE-STEP BOOKING PROCESS 30
CANCELLATION PROCESS 52
USING THE SUPERSHUTTLE TEST ENVIRONMENT 57
RESOURCES 60
OPEN TRAVEL ALLIANCE 61
SuperShuttle / ExecuCar OTA 2012A Standards Integration 61
Process Summary 61
GROUND AVAILABILITY PROCESS OVERVIEW 62
OTA_GroundAvailRQ 63
OTA_GroundAvailRS 72
GROUND BOOKING PROCESS OVERVIEW 80
OTA_GroundBookRQ 81
OTA_GroundBookRS 92
GROUND CANCELLATION PROCESS OVERVIEW 94
OTA_GroundCancelRQ 94
OTA_GroundCancelRS 97
SAMPLES 99
Get Airlines for an Airport 99
Get Serviced Airports 100
Get a List of SuperShuttle Locations 128
Get a List of Hotels and Landmarks for a SuperShuttle Location 129
ExecuCar XML Samples 131

Page ii
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Contents

ExecuCar JSON Samples 151


SuperShuttle XML Samples 188
SuperShuttle JSON Samples 222
FAQS 268

Page iii
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Getting Started

Getting Started
NOTE: Detailed API documentation is available on the OTA Website.

This API document provides guidance for SuperShuttle trading partners who use web services
to interact with SuperShuttle to perform these transactions:
l Check Availability
l Book a Reservation
l Cancel a Reservation

Before You Begin


Here is some important information you need to know before you get started:
l Access to Sandbox. The sandbox is fully functional. You can begin testing immediately. The
sandbox username is sandbox and the password is sandbox.
l Airport Codes. Airport codes (LocationCode in OTA) are standard IATA three-character
codes.
l Geocoded Information. The preference is for geocoded information, but SuperShuttle will
attempt to geocode a provided location.
l Specify the Media Type (media=) in the POST request. The POST request must specify
the media type as either either xml or json. Example: POST https://ap-
itest.vtod.com/2.0.0/Rest/GetToken?media=xml
l Direct Bill. SuperShuttle trading partners may not use the Direct Bill payment type. This
payment type is for internal use only.
l Discounts. SuperShuttle trading partners may not use discounts, because that would res-
ult in a loss of revenue for SuperShuttle. Discounts are for internal use only.
l Airline Rewards. SuperShuttle trading partners may not use airline rewards, because that
would result in a loss of revenue for SuperShuttle. Airline Rewards accounts are for internal
use only.

Page 4
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Getting Started

l Round-Trips. When determining whether a trip is a round-trip, the API looks for a pickup
and drop-off that match, and two stops that match. A trip that meets these criteria is inter-
preted as a round-trip.
l Test Database Restore Schedule. A database restore is performed every Monday, Wed-
nesday, and Friday between 8:00 am and 9:00 am Arizona time for the test database.
l Confirmation Numbers. When the VTOD API is used to call the GroundBookRQ method,
two confirmation numbers are returned in the response:
l VTOD confirmation number (represented by the first <Confirmation> element), which is
an internal record ID used only within the API and never shared with the customer
l Dispatch system confirmation number (represented by the second <Confirmation> ele-
ment with type = "DispatchConfirmation"), which is the confirmation number shared with
the customer and will be needed by the customer if they call in regarding their reservation
When canceling a reservation, the VTOD API requires the VTOD confirmation number.
When communicating with a customer, the DispatchConfirmation number is used.

Important Information About Customer Pickup


Times
Important: SuperShuttle does not guarantee a customer will make their flight unless they
use the pick-up time calculated by SuperShuttle for our shared ride (Blue Van) service.

Providing SuperShuttle with a flight time enables us to calculate realistic pickup times for a
customer. SuperShuttle's calculation takes into account many factors of which a customer
may not be aware, such as the pick-up location and needs of the other customers sharing the
same van, traffic, geography, closures, and the like. SuperShuttle's success is largely built
upon its ability to map the most efficient routes possible to limit customer travel times, while
ensuring customers get where they're going on time. When booking trips for SuperShuttle's
shared ride service (Blue Van), SuperShuttle does not guarantee a customer will make their
flight unless they use the pick-up time calculated by SuperShuttle.
SuperShuttle's ExecuCar sedan service provides additional flexibility and allows a passenger
to choose their own pick-up time.

Page 5
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

SuperShuttle Three-Step Booking Process


The SuperShuttle booking process is typically completed in three basic steps:

1. Request a Token. You request a token by submitting a username and password and
receive a response that includes a token. The token is good for up to an hour, but expires
after 20 minutes of idle time. The token is passed for all subsequent requests.
2. Request Availability. You submit an availability request and receive a response that
includes the service options relevant to your request.
3. Request Booking. You submit a request to book a trip that includes customer information,
service information and payment information. You receive a response that includes a con-
firmation for the trip along with the passenger information you submitted.
Each of these steps is discussed in more detail in this section.

Step 1: Request a Token


Here's what you need to know about tokens:
l The sandbox account is fully functional. The sandbox username is sandbox and the pass-
word is sandbox.
l Every request requires a security token
l The security token expires after one hour or 20 minutes of idle time
l The token and username are passed as HTTP headers for all subsequent requests
l The service location to generate a security token is https://ap-
itest.vtod.com/2.0.0/REST/GetToken
A token request must include:
l Fleet Type
l Target

Page 6
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

l Version
l Username
l Password

JSON Sample: Token Request


{
"Version":"2.0.0",
"Username": "####",
"Password": "####"
}

JSON Sample: Token Response

{
"CreateDateTimeUTC": "2014-08-12T19:32:54.485Z",
"SecurityKey": "8ea9f943-3b19-4b60-8de7-dfef585b5aac",
"Success": {},
"Username": "###"
}

XML Sample: Token Request


POST https://apitest.vtod.com/Test/2.0.0/Rest/GetToken?media=xml HTTP/1.1Host:
api.vtod.comContent-Length: 218Content-Type: application/xml
<?xml version="2.0" encoding="UTF-8"?>
<TokenRQ >
<Username>sandbox</Username>
<Password>sandbox</Password>
</TokenRQ>

XML Sample: Token Response


HTTP/1.1 200 OKCache-Control: private
Content-Length: 257
Content-Type: application/xml;
charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 30 Jan 2014 20:26:41 GMT
<?xml version="2.0" encoding="utf-8"?>
<TokenRS xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Username>sandbox</Username>

Page 7
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

<SecurityKey>8c92f545-30cd-48ce-ae45-bfc6cb2bb100</SecurityKey>
<Success/></TokenRS>

Step 2: Request Availability


Important: When determining whether a trip is a round-trip, the API looks for a pickup and
drop-off that match, and two stops that match. A trip that meets these criteria is interpreted
as a round-trip.

Here's what you need to know about availability requests:


l The request must include the username and token.
l Availability requests must include a version number.
l The request includes basic service information.
An availability request must include:
l Version Number
l Pickup Date and Time
l Pickup Location
l Number of Passengers
l Target (Test or Production)

JSONSample: SuperShuttle Ground Availability Request


{
"EchoToken": "",
"Target": "Test",
"Version": "${#Project#VtodApiVersion}",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 2,
"Category": {
"Value": "Adult"
}

Page 8
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

}
],
"PassengerPrefs": {},
"RateQualifiers": [
{
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false
},
"References": [],
"Service": {
"Pickup": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2015-12-28 10:15",
"CodeContext": "Domestic"
}
},
"Dropoff": {
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {

Page 9
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "${#TestCase#flightDate}",
"CodeContext": "Domestic"
}
}
}
}

JSON Sample: SuperShuttle Ground Availability Response


{
"EchoToken": "",
"GroundServices": {"GroundServices": [
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 3.72,
"UnitCharge": 3.72
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Shared Ride Van Service (Up to 7 Passengers in
Party)",
"Value": "Other_"
}},
"Reference": {
"ID": "14973",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/van.jpg",

Page 10
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [
{
"EndDateTime": "9/16/2015 2:10:53 PM",
"StartDateTime": "9/16/2015 1:55:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 1:55:53 PM",
"StartDateTime": "9/16/2015 1:40:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 1:40:53 PM",
"StartDateTime": "9/16/2015 1:25:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 1:25:53 PM",
"StartDateTime": "9/16/2015 1:10:53 PM",
"Status": "AllowPickup"
}
]},
"TripDirection": "ToAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim
and collect your luggage. Follow the instructions below for your respective
terminal and present your confirmation number to the curbside representative
for further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.
Terminal 2:Exit Door #8, at the east end of the terminal past baggage claim,
and continue east to the middle island/median.
Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will be
waiting near a sign that reads Van Service.
Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Shared
Ride Van Service.",
"ServiceLevel": {
"Code": "VAN",
"SourceName": null
},

Page 11
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"VehicleType": {"Code": "BLUEV"}


},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 23,
"UnitCharge": 23
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1,
"Total": 8,
"UnitCharge": 8
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 34.72,
"RateTotalAmount": 34.72
}
},
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 3.72,
"UnitCharge": 3.72
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Shared Ride Van Service (Up to 7 Passengers
in Party)",

Page 12
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"Value": "Other_"
}},
"Reference": {
"ID": "14973",
"TPA_Extensions": {
"ImageURL": "//cd-
n.supershuttle.com/vehicleimages/van.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [ {
"EndDateTime": "11/14/2015 5:00:53 PM",
"StartDateTime": "11/14/2015 5:00:53 PM",
"Status": "AllowPickup"
}]},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim
and collect your luggage. Follow the instructions below for your respective
terminal and present your confirmation number to the curbside representative
for further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.
Terminal 2:Exit Door #8, at the east end of the terminal past baggage claim,
and continue east to the middle island/median.
Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will be
waiting near a sign that reads Van Service.
Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Shared
Ride Van Service.",
"ServiceLevel": {
"Code": "VAN",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 23,
"UnitCharge": 23
}],

Page 13
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"ChargePurpose": {"Value": "BaseRate"},


"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1,
"Total": 8,
"UnitCharge": 8
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 34.72,
"RateTotalAmount": 34.72
}
},
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 8.52,
"UnitCharge": 8.52
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Exclusive Non-Stop Van Service (up to 7 pas-
sengers)",
"Value": "Other_"
}},
"Reference": {
"ID": "362613",
"TPA_Extensions": {
"ImageURL": "//cd-
n.supershuttle.com/vehicleimages/exc.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [

Page 14
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

{
"EndDateTime": "9/16/2015 2:35:53 PM",
"StartDateTime": "9/16/2015 2:20:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 2:20:53 PM",
"StartDateTime": "9/16/2015 2:05:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 2:05:53 PM",
"StartDateTime": "9/16/2015 1:50:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 1:50:53 PM",
"StartDateTime": "9/16/2015 1:35:53 PM",
"Status": "AllowPickup"
}
]},
"TripDirection": "ToAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage
claim and collect your luggage. Follow the instructions below for your respect-
ive terminal and present your confirmation number to the curbside rep-
resentative for further assistance. Curbside representatives are available 7
AM to 11 PM, daily. After hours, please call (602) 232-4601 for further assist-
ance.
Terminal 2:Exit Door #8, at the east end of the terminal past baggage claim,
and continue east to the middle island/median.
Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will be
waiting near a sign that reads Van Service.
Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Van Ser-
vice.",
"ServiceLevel": {
"Code": "EXC",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},

Page 15
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 71,
"UnitCharge": 71
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 79.52,
"RateTotalAmount": 79.52
}
},
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 8.52,
"UnitCharge": 8.52
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Exclusive Non-Stop Van Service (up to 7
passengers)",
"Value": "Other_"
}},
"Reference": {
"ID": "362613",

Page 16
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"TPA_Extensions": {
"ImageURL": "//cd-
n.supershuttle.com/vehicleimages/exc.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [ {
"EndDateTime": "11/14/2015 5:00:53 PM",
"StartDateTime": "11/14/2015 5:00:53 PM",
"Status": "AllowPickup"
}]},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage
claim and collect your luggage. Follow the instructions below for your respect-
ive terminal and present your confirmation number to the curbside rep-
resentative for further assistance. Curbside representatives are available 7
AM to 11 PM, daily. After hours, please call (602) 232-4601 for further assist-
ance.
Terminal 2:Exit Door #8, at the east end of the terminal past baggage claim,
and continue east to the middle island/median.
Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will be
waiting near a sign that reads Van Service.
Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Van Ser-
vice.",
"ServiceLevel": {
"Code": "EXC",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 71,
"UnitCharge": 71
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},

Page 17
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 79.52,
"RateTotalAmount": 79.52
}
}
]},
"PrimaryLangID": "en",
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%12.56"
}]
}],
"Success": {},
"TPA_Extensions": {"References": {"LinkedReferences": [
{"References": [
{"ID": "14973"},
{"ID": "14973"}
]},
{"References": [
{"ID": "362613"},
{"ID": "362613"}
]}
]}},
"Target": "Test",
"Version": "2.0.0"
}

XML Sample: SuperShuttle Ground Availability Request


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 386
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.5
<OTA_GroundAvailRQ EchoToken="" Target="Test" Version="2.0.0"

Page 18
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Service>
<Pickup>
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123" CodeContext="Domestic"
FlightDateTime="2013-11-30 21:15"/>
</Dropoff>
</Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<PassengerPrefs MeetAndGreetInd="false"/>
<ServiceType>Shuttle</ServiceType>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the Value (ex. value="20%")
indicates the gratuity is calculated as a percentage of the total. Entering a
value with no percentage symbol (ex. value="20") indicates the value is a dol-
lar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions>
</OTA_GroundAvailRQ>

XML Sample: SuperShuttle Ground Availability Response


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 1245

Page 19
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

Content-Type: application/xml; charset=utf-8


Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 30 Jan 2014 20:53:40 GMT
<OTA_GroundAvailRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service>
<ServiceLevel Code="VAN"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Shared Ride Van Service (Up to 7 Pas-
sengers in Party)" Code="Fare">Other_</Category> </RateQualifier>
<ServiceCharges Description="FirstPassengerFare" FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="24.00" Quantity="1" MaxQuantity="1"
Total="24.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="7.00" Quantity="0" MaxQuantity="6"
Total="0.00"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="4.80" Quantity="1" MaxQuantity="1"
Total="4.80"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="28.80"/>
<Reference ID="14804">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="11/30/2013 7:25:00 PM"
EndDateTime="11/30/2013 7:40:00 PM" Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>

Page 20
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

</GroundService>
<GroundService>
<Service>
<ServiceLevel Code="EXC"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Exclusive Non-Stop Van Service (up to 7
passengers)" Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare" FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="65.00" Quantity="1" MaxQuantity="1"
Total="65.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0" MaxQuantity="6"
Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="13.00" Quantity="1" MaxQuantity="1"
Total="13.00"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="78.00"/>
<Reference ID="14803">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="11/30/2013 7:30:00 PM"
EndDateTime="11/30/2013 7:45:00 PM" Status="PickupExpired" Description="The
reservation cannot be completed online, call us directly for assistance 800-
258-3826."/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.

Page 21
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

Entering a value with no percentage symbol (ex. value="20") indicates the


value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
</OTA_GroundAvailRS>

Step 3: Book a Trip


An availability request must include:
l Username
l Token
l Version number
A booking request must include:
l Version Number
l Reference ID (received from the Availability Response)
l Rate Qualifier
l Pickup Date and Time
l Pickup Location
l Number of Passengers
l Passenger Name
l Passenger Phone
l Payment Method/Information
l Gratuity (if passenger wants to include it)
l Type of Services (selected from Ground Availability Response)
l Target (Test or Production)

JSONSample:SuperShuttle Ground Booking Request


{
"EchoToken": "",
"Target": "Test",
"Version": "${#Project#VtodApiVersion}",
"PrimaryLangID": "en",
"POS": {"Source": {
"ISOCountry": "US",

Page 22
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"ISOCurrency": "USD"
}},
"References": [{"ID": "${GroundAvail#Re-
sponseAsXml#//*:Response/*:GroundServices/*:GroundServices/*:e[1]/*:Re-
ference/*:ID}"}],
"GroundReservations": [
{
"Passenger": {
"Primary": {
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [
{
"CountryAccessCode": "001",
"AreaCityCode": "602",
"PhoneNumber": "555-1234"
}
],
"Emails": [
{
"Value": ""
}
]
}
},
"Service": {
"Location": {
"Pickup": {
"Remark": "Some remarks",
"DateTime": "${GroundAvail#Re-
sponseAsXml#//*:Response/*:GroundServices/*:GroundServices/*:e[1]/*:Re-
ference/*:TPA_Extensions/*:PickupTimes/*:PickupTimes/*:e[1]/*:StartDateTime}",
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "${GroundAvail#Re-
sponseAsXml#//*:Response/*:GroundServices/*:GroundServices/*:e[1]

Page 23
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

/*:Reference/*:TPA_Extensions/*:PickupTimes/*:PickupTimes/*:e[1]
/*:StartDateTime}",
"CodeContext": "Domestic"
}
},
"Dropoff": {
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
}
}
},
"RateQualifiers": [
{
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
]
}
],
"Payments": {
"Payments": [
{
"DirectBill": {
"ID": "20319",
"BillingNumber": "001SUPEF"

Page 24
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

}
}
]
},
"TPA_Extensions":{
"Passengers":[
{
"Quantity":1,
"Category":{
"Value":"Adult"
}
}
],
"Confirmations":[

],
"MemberID":"",
"RateQualifiers":[

],
"Source":"zTrip",
"Device":"iPhone",
"PickMeUpNow":false
}
}

JSONSample: SuperShuttle Ground Booking Response


{
"EchoToken": "",
"PrimaryLangID": "en",
"Reservations": [ {
"Confirmation": {
"ID": "72500",
"TPA_Extensions": {"Confirmations": [ {
"ID": "7619188",
"Type": "DispatchConfirmation"
}]}
},
"Passenger": {"Primary": {
"Emails": [{"Value": ""}],
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},

Page 25
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

"Telephones": [ {
"AreaCityCode": "602",
"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}]
}},
"Service": {"Location": {
"Dropoff": {"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"CountryName": {"Code": "US"},
"Latitude": "33.475609",
"LocationType": {"Value": "HomeResidence"},
"Longitude": "-112.188570",
"PostalCode": "85035",
"StateProv": {"StateCode": "AZ"}
}},
"Pickup": {
"Airline": {
"Code": "WN",
"CodeContext": "Domestic",
"FlightDateTime": "10/7/2015 5:58:22 PM",
"FlightNumber": "551"
},
"AirportInfo": {"Arrival": {"LocationCode": "PHX"}},
"DateTime": "10/7/2015 5:58:22 PM",
"Remark": "Some remarks"
}
}},
"TPA_Extensions": {"Contacts": {"Items": [ {
"Name": "SuperShuttle",
"Telephone": {"PhoneNumber": "8002583826"},
"Type": "Dispatch"
}]}}
}],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

XML Sample: SuperShuttle Ground Booking Request


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Book?media=xml HTTP/1.1
Content-Type: application/xml
Username: sandbox
SecurityKey: 18e56386-ddc8-42f8-96cc-560094347929

Page 26
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

Content-Length: 1887
Host: api.vtod.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference Type="Confirmation" ID="14804"/>
<GroundReservation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<Email>janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="2/8/2014 8:11:57 AM">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123"
CodeContext="Domestic" FlightDateTime="2014-02-08T10:01:57"/>
</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="SuperShuttle">

Page 27
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
</GroundReservation>
<Payments>
<Payment>
<PaymentCard ExpireDate="11/30/2016">
<CardHolderName>Jane Test</CardHolderName>
<CardType Description="MasterCard">MC</CardType>
<CardNumber>
<PlainText>5555555555554444</PlainText>
<LastFourDigit>4444</LastFourDigit>
</CardNumber>
<SeriesCode>
<PlainText>123</PlainText>
</SeriesCode>
</PaymentCard>
</Payment>
</Payments>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
<MemberID>1054462</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions>
</OTA_GroundBookRQ>

XML Sample: SuperShuttle Ground Booking Response


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 1310
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 30 Jan 2014 20:53:46 GMT
<OTA_GroundBookRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>

Page 28
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
SuperShuttle Three-Step Booking Process

<Confirmation ID="2339">
<TPA_Extensions>
<Confirmations>
<Confirmation Type="DispatchConfirmation" ID="5903129"/>
</Confirmations>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602" PhoneNum-
ber="5551234"/>
<Email ShareMarketInd="false">janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service>
<Location>
<Pickup DateTime="2/10/2014 11:57:28 PM">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<LocationType>HomeResidence</LocationType>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123"
FlightDateTime="2014-02-11T01:47:28" CodeContext="Domestic"/>
</Dropoff>
</Location>
</Service>
</Reservation>
</OTA_GroundBookRS>

Page 29
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

ExecuCar Three-Step Booking Process


The ExecuCar booking process is typically completed in three basic steps:

1. Request a Token. You request a token and receive a response that includes a username
and password. The token is good for up to an hour, but expires after 20 minutes of idle
time. The username and password are passed for all subsequent requests.
2. Request Availability. You submit an availability request and receive a response that
includes the services options relevant to your request.
3. Request Booking. You submit a request to book a trip that includes customer information,
service information, payment information. You receive a response that includes a con-
firmation for the trip along with the passenger information you submitted.
Each of these steps is discussed in more detail in this section.

Step 1: Request a Token


Here's what you need to know about tokens:
l The sandbox account is fully functional. The sandbox username is sandbox and the pass-
word is sandbox.
l Every request requires a security token
l The security token expires after one hour or 20 minutes of idle time
l The token and username are passed as HTTP headers for all subsequent requests
l The service location to generate a security token is https://ap-
itest.vtod.com/2.0.0/REST/GetToken
A token request must include:
l Fleet Type
l Target

Page 30
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

l Version
l Username
l Password

JSON Sample: Token Request


{
"Version":"2.0.0",
"Username": "####",
"Password": "####"
}

JSON Sample: Token Response

{
"CreateDateTimeUTC": "2014-08-12T19:32:54.485Z",
"SecurityKey": "8ea9f943-3b19-4b60-8de7-dfef585b5aac",
"Success": {},
"Username": "###"
}

XML Sample: Token Request


POST https://apitest.vtod.com/Test/2.0.0/Rest/GetToken?media=xml HTTP/1.1Host:
api.vtod.comContent-Length: 218Content-Type: application/xml<?xml
version="2.0" encoding="UTF-8"?>
<TokenRQ >
<Username>sandbox</Username>
<Password>sandbox</Password>
</TokenRQ>

XML Sample: Token Response


HTTP/1.1 200 OKCache-Control: privateContent-Length: 257Content-Type: applic-
ation/xml;
charset=utf-8
Server: Microsoft-IIS/7.5X-AspNet-Version: 4.0.30319X-Powered-By: ASP.NETDate:
Thu, 30 Jan 2014 20:26:41 GMT
<?xml version="2.0" encoding="utf-8"?>
<TokenRS xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Username>sandbox</Username>
<SecurityKey>8c92f545-30cd-48ce-ae45-bfc6cb2bb100</SecurityKey>
<Success/></TokenRS>

Page 31
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

Step 2: Request Availability


Important: When determining whether a trip is a round-trip, the API looks for a pickup and
drop-off that match, and two stops that match. A trip that meets these criteria is interpreted
as a round-trip.

An availability request must include:


l Username
l Token
l Version number
l Basic service information
An availability request must include:
l Version Number
l Pickup Date and Time
l Pickup Location
l Number of Passengers
l Target (Test or Production)

JSON Sample: ExecuCar Ground Availability Request


{ "EchoToken": "12345", "Target": "Test",
"Version": "1.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 1,
"Category": {
"Value": "Adult"
}
}
],
"PassengerPrefs": {},

Page 32
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

"RateQualifiers": [
{
"RateQualifierValue": "ExecuCar",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false
},
"References": [],
"Service": {
"Pickup": {
"DateTime": "11/30/2013 5:25:00 PM",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Dropoff": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},

Page 33
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2013-11-30 21:15",
"CodeContext": "Domestic"
}
}
}
}

JSON Sample: ExecuCar Ground Availability Response


{
"EchoToken": "12345",
"GroundServices": {
"GroundServices": [
{
"Fees": [],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "ExecuCar Sedan Service (Up to 4 passengers)",
"Value": "Other_"
}
},
"Reference": {
"ID": "27700",
"TPA_Extensions": {
"MaxPassengers": 4,
"PickupTimes": {
"PickupTimes": [
{
"EndDateTime": "12/30/2013 5:40:00 PM",
"StartDateTime": "12/30/2013 5:25:00 PM",
"Status": "AllowPickup"
}
]
}
}
},
"Service": {
"ServiceLevel": {
"Code": "ATF",
"SourceName": null
},

Page 34
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 59.0,
"UnitCharge": 59.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 3
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"RateTotalAmount": 59.0
}
},
{
"Fees": [],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "ExecuCar SUV Service (Up to 6 passengers)",
"Value": "Other_"
}
},

Page 35
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

"Reference": {
"ID": "152698",
"TPA_Extensions": {
"MaxPassengers": 6,
"PickupTimes": {
"PickupTimes": [
{
"EndDateTime": "12/30/2013 5:40:00 PM",
"StartDateTime": "12/30/2013 5:25:00 PM",
"Status": "AllowPickup"
}
]
}
}
},
"Service": {
"ServiceLevel": {
"Code": "SUV",
"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 80.0,
"UnitCharge": 80.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 5
}

Page 36
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"RateTotalAmount": 80.0
}
},
{
"Fees": [],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "ExecuCar Van Service (Up to 10 passengers)",
"Value": "Other_"
}
},
"Reference": {
"ID": "113658",
"TPA_Extensions": {
"MaxPassengers": 10,
"PickupTimes": {
"PickupTimes": [
{
"EndDateTime": "12/30/2013 5:40:00 PM",
"StartDateTime": "12/30/2013 5:25:00 PM",
"Status": "AllowPickup"
}
]
}
}
},
"Service": {
"ServiceLevel": {
"Code": "VEC",
"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},

Page 37
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 99.0,
"UnitCharge": 99.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 9
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"RateTotalAmount": 99.0
}
}
]
},
"PrimaryLangID": "en",
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

XMLSample: ExecuCar Ground Availability Request


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Avail?media=xml
HTTP/1.1Accept-Encoding: gzip,deflateContent-Type: applic-
ation/xml;charset=UTF-8Username: sandboxSecurityKey: 292fb9ec-788f-4979-bc38-
853a3136dbea
<OTA_GroundAvailRQ EchoToken="" Target="Test" Version="2.0.0"

Page 38
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Service>
<Pickup DateTime="2014-01-29T02:59:45">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123" CodeContext="Domestic"
FlightDateTime="2013-11-30 21:15"/>
</Dropoff>
</Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<PassengerPrefs MeetAndGreetInd="false"/>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="15%"/>
</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions></OTA_GroundAvailRQ>

XMLSample: ExecuCar Ground Availability Response


HTTP/1.1 200 OKCache-Control: privateContent-Length: 1245Content-Type: applic-
ation/xml; charset=utf-8Server: Microsoft-IIS/7.5X-AspNet-Version: 4.0.30319X-
Powered-By: ASP.NETDate: Thu, 30 Jan 2014 20:53:40 GMT
<OTA_GroundAvailRS EchoToken="" Target="Test" Version="2.0.0"

Page 39
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service>
<ServiceLevel Code="ATF"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="Standard Sedan"
Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="59.00" Quantity="1" MaxQuant-
ity="1" Total="59.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="3" Total="0"/>
</ServiceCharges><-- Entering a percentage (%) symbol as part
of the gratuity value (ex. value="20%") indicates the gratuity is calculated
as a percentage of the total. Entering a value with no percentage symbol (ex.
value="20") indicates the value is a dollar amount. --> <Fees
Description="Gratuity">
<Calculation UnitCharge="8.85" Quantity="1" MaxQuant-
ity="1" Total="8.85"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="67.85"/>
<Reference ID="27700">
<TPA_Extensions>
<MaxPassengers>4</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>

Page 40
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

<GroundService>
<Service>
<ServiceLevel Code="SUV"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="Standard SUV"
Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="80.00" Quantity="1" MaxQuant-
ity="1" Total="80.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="5" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="12.00" Quantity="1" MaxQuant-
ity="1" Total="12.00"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="92.00"/>
<Reference ID="152698">
<TPA_Extensions>
<MaxPassengers>6</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="MinAd-
vanceNoticeExceeded" Description="The reservation cannot be completed online,
call us directly for assistance 800-258-3826."/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service>
<ServiceLevel Code="VEC"/>
<VehicleType Code="ECAR"/>
</Service>

Page 41
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

<RateQualifier>
<Category Description="ExecuCar Van Service (Up to 10
passengers)" Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="99.00" Quantity="1" MaxQuant-
ity="1" Total="99.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="9" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="14.85" Quantity="1" MaxQuant-
ity="1" Total="14.85"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="113.85"/>
<Reference ID="113658">
<TPA_Extensions>
<MaxPassengers>10</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="MinAd-
vanceNoticeExceeded" Description="The reservation cannot be completed online,
call us directly for assistance 800-258-3826."/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. --> <SpecialInputs Name="Gratuity"
Value="15%"/>
</RateQualifier>
</OTA_GroundAvailRS>

Step 3: Book a Trip

Page 42
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

An availability request must include:


l Username
l Token
l Version number
A booking request must include:
l Version Number
l Reference ID (received from the Availability Response)
l Rate Qualifier
l Pickup Date and Time
l Pickup Location
l Number of Passengers
l Passenger Name
l Passenger Phone
l Payment Method/Information
l Gratuity (if passenger wants to include it)
l Type of Services (selected from Ground Availability Response)
l Target (Test or Production)

JSONSample: ExecuCar Ground Booking Request


{
"EchoToken":"12345",
"Target":"Test",
"Version":"1.0.0",
"PrimaryLangID":"en",
"POS":{
"Source":{
"ISOCountry":"US",
"ISOCurrency":"USD"
}
},
"References":[
{
"ID":"27903"
}

Page 43
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

],
"GroundReservations":[
{
"Passenger":{
"Primary":{
"PersonName":{
"GivenName":"Test",
"Surname":"Test"
},
"Telephones":[
{
"CountryAccessCode":"001",
"AreaCityCode":"602",
"PhoneNumber":"555-1234"
}
],
"Emails":[
{
"Value":"a@aa.aa"
}
]
}
},
"Service":{
"Location":{
"Pickup":{
"DateTime":"12/28/2013 9:15:00 PM",
"AirportInfo":{
"Arrival":{
"LocationCode":"PHX"
}
},
"Airline":{
"Code":"WN",
"FlightNumber":"551",
"FlightDateTime":"2013-12-28 21:15",
"CodeContext":"Domestic"
}
},
"Dropoff":{
"Address":{
"AddressLine":"8930 S Beck Ave",
"CityName":"Tempe",
"PostalCode":"85284",

Page 44
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

"LocationType":{
"Value":"HomeResidence"
},
"StateProv":{
"StateCode":"AZ"
},
"CountryName":{
"Code":"US"
},
"Latitude":"33.475654",
"Longitude":"-112.188643"
}
}
}
},
"RateQualifiers":[
{
"RateQualifierValue":"ExecuCar",
"SpecialInputs":[
{
"Name":"Gratuity",
"Value":"%12.56"
}
]
}
]
}
],
"Payments":{
"Payments":[
{
"PaymentCard":{
"ExpireDate":"11/30/2016",
"CardType":{
"Value":"MC",
"Description":"MasterCard"
},
"CardHolderName":"Joe Hogen",
"CardNumber":{
"ID":"212424",
"EncryptedValue":"+u67EHGjm+JJzl89bbs6C+vJqZOgDGAh"
}
}
}

Page 45
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

]
},
"TPA_Extensions":{
"Passengers":[
{
"Quantity":1,
"Category":{
"Value":"Adult"
}
}
],
"Confirmations":[

],
ReferrerMemberID : "1077186", // string
ReferrerCreditAmount : 15.50 //Decimal
"MemberID":"1077186",
"RateQualifiers":[

],
"Source":"zTrip 1.8",
"Device":"iPhone",
"PickMeUpNow":false
}
}

JSON Sample: ExecuCar Ground Booking Response


{
"EchoToken": "12345",
"PrimaryLangID": "en",
"Reservations": [
{
"Confirmation": {
"ID": "483",
"TPA_Extensions": {
"Confirmations": [
{
"ID": "5194334",
"Type": "DispatchConfirmation"
}
]
}
},
"Passenger": {

Page 46
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

"Primary": {
"Emails": [],
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [
{
"AreaCityCode": "602",
"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}
]
}
},
"Service": {
"Location": {
"Dropoff": {
"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"CountryName": {
"Code": "US"
},
"LocationType": {
"Value": "HomeResidence"
},
"PostalCode": "85284",
"StateProv": {
"StateCode": "AZ"
}
}
},
"Pickup": {
"Airline": {
"Code": "WN",
"CodeContext": "Domestic",
"FlightDateTime": "2013-12-27 21:15",
"FlightNumber": "551"
},
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}

Page 47
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

},
"DateTime": "12/27/2013 9:15:00 PM"
}
}
}
}
],
"Success": {},
"Target": "Test",
"Version": "1.0.0"
}

XML Sample: ExecuCar Ground Booking Request


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Book?media=xml HTTP/1.1
Content-Type: application/xml
Username: sandbox
SecurityKey: 18e56386-ddc8-42f8-96cc-560094347929
Content-Length: 1887
Host: api.vtod.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference Type="Confirmation" ID="27700"/>
<GroundReservation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001"
AreaCityCode="602" PhoneNumber="555-1234"/>
<Email>a@aa.aa</Email>
</Primary>
</Passenger>
<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="1/29/2014 2:59:45 AM">
<Address Latitude="33.475609" Lon-
gitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>

Page 48
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123" CodeContext="Domestic"
FlightDateTime="2013-11-30 21:15"/>
</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="15%"/>
</RateQualifier>
</GroundReservation>
<Payments>
<Payment>
<DirectBill ID="20319" BillingNumber="001SUPEF"/>
</Payment>
</Payments>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
<MemberID>1054462</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions>
</OTA_GroundBookRQ>

XML Sample: ExecuCar Ground Booking Response


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 1310
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.5

Page 49
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Thu, 30 Jan 2014 20:53:46 GMT
<OTA_GroundBookRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<Confirmation ID="2179">
<TPA_Extensions>
<Confirmations>
<Confirmation Type="DispatchConfirmation"
ID="5902953"/>
</Confirmations>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602"
PhoneNumber="5551234"/>
<Email
ShareMarketInd="false">janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service>
<Location>
<Pickup DateTime="1/29/2014 2:59:45 AM">
<Address Latitude="33.475609" Longitude="-
112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<LocationType>HomeResidence</LocationType>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>

Page 50
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
ExecuCar Three-Step Booking Process

</AirportInfo>
<Airline Code="AA" FlightNumber="123"
FlightDateTime="2013-11-30 21:15" CodeContext="Domestic"/>
</Dropoff>
</Location>
</Service>
</Reservation>
</OTA_GroundBookRS>

Page 51
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Cancellation Process

Cancellation Process
The process of canceling a booked trip is an easy one. A request is sent to SuperShuttle and a
cancellation confirmation is returned.
Cancellation requests must include:
l Version Number
l Confirmation Number
l Target (Test or Production)
l Passenger Name or Passenger Phone or Postal Code

JSONSample: SuperShuttle GroundCancellationRequest


{
"EchoToken": "12345",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}},
"Reservation": {
"CancelType": "Cancel",
"UniqueID": [ {
"Type": "DispatchConfirmation",
"ID": "${GroundBook#ResponseAsXml#//*:Response/*:Reservations/*:e[1]
/*:Confirmation/*:TPA_Extensions/*:Confirmations/*:e[1]/*:ID}"
}],
"Verification": {
"AddressInfo": {
"PostalCode": "${GroundBook#Re-
sponseAsXml#//*:Response/*:Reservations/*:e[1]/*:Ser-
vice/*:Location/*:Pickup/*:Address/*:PostalCode}"
}
}
},
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],

Page 52
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Cancellation Process

"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": []
}]
}
}

JSONSample:SuperShuttle Ground Cancellation Response


{
"EchoToken": "12345",
"PrimaryLangID": "en",
"Reservation": {"CancelConfirmation": {"UniqueID": {
"ID": "72467",
"Type": "Confirmation"
}}},
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

XMLSample: SuperShuttle Ground Cancellation Request


<OTA_GroundCancelRQ EchoToken="" Target="Test|Production" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reservation CancelType="Cancel">
<UniqueID ID="2901"/>
<Verification>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<TelephoneInfo CountryAccessCode="1" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<AddressInfo>
<PostalCode>85035</PostalCode>
</AddressInfo>
</Verification>
</Reservation>
<TPA_Extensions>
<RateQualifier RateQualifier="SuperShuttle"/>
</TPA_Extensions>

Page 53
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Cancellation Process

</OTA_GroundCancelRQ>

XMLSample: SuperShuttle Ground CancellationResponse


<OTA_GroundCancelRS EchoToken="" Target="Test|Production" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<CancelConfirmation>
<UniqueID ID="2901"/>
</CancelConfirmation>
</Reservation>
</OTA_GroundCancelRS>

JSON Sample: ExecuCar Cancellation Request


{
"EchoToken": "12345",
"Target": "Test|Production",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Reservation": {
"CancelType": "Cancel",
"UniqueID": [
{
"Type": "Confirmation",
"ID": "2901"
}
],
"Verification": {
"PersonName": {
"GivenName": "Jane",
"Surname": "test"
},
"TelephoneInfo": {
"CountryAccessCode": "1",
"AreaCityCode": "602",
"PhoneNumber": "555-1234"
},

Page 54
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Cancellation Process

"AddressInfo": {
"PostalCode": "85035"
}
}
},
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [
{
"RateQualifierValue": "ExecuCar",
"SpecialInputs": []
}
]
}
}

JSON Sample: ExecuCar Cancellation Response


{
"EchoToken": "12345",
"PrimaryLangID": "en",
"Reservation": {
"CancelConfirmation": {
"UniqueID": {
"ID": "330",
"Type": "Confirmation"
}
}
},
"Success": {},
"Target": "Test|Production",
"Version": "2.0.0"
}

XMLSample: ExecuCar Cancellation Request


<OTA_GroundCancelRQ EchoToken="" Target="Test|Production" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reservation CancelType="Cancel">
<UniqueID Type="DispatchConfirmation" ID="5902948"/>
<Verification>
<PersonName>
<GivenName>Jane</GivenName>

Page 55
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Cancellation Process

<Surname>Test</Surname>
</PersonName>
<TelephoneInfo CountryAccessCode="1" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<AddressInfo>
<PostalCode>85035</PostalCode>
</AddressInfo>
</Verification>
</Reservation>
<TPA_Extensions>
<RateQualifier RateQualifier="ExecuCar"/>
</TPA_Extensions>
</OTA_GroundCancelRQ>

XMLSample: ExecuCar CancellationResponse


<OTA_GroundCancelRS EchoToken="" Target="Test|Production" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<CancelConfirmation>
<UniqueID Type="DispatchConfirmation" ID="5902948"/>
</CancelConfirmation>
</Reservation>
</OTA_GroundCancelRS>

Page 56
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Using the SuperShuttle Test Environment

Using the SuperShuttle Test Environment


Important: In the SuperShuttle test environment, all reservations must have a last name
value of Test.

SuperShuttle provides a test environment for our trading partners to use when developing
apps that interact with SuperShuttle reservations systems.

OTA-Compliant Actions
This is a list of OTA compliant actions are the URLs used to access them.

Action Location
Book a Reservation https://apitest.vtod.com/2.0.0/REST/Ground/Book
Cancel a Reservation https://apitest.vtod.com/2.0.0/REST/Ground/Cancel
Retrieve a Reservation https://apitest.vtod.com/2.0.0/REST/Ground/ResRetrieve
Check Availability https://apitest.vtod.com/2.0.0/REST/Ground/Avail

Valid Credit Card Numbers for Testing


The test system will only accept the credit card numbers defined in this table.

Card Type Card Number


Visa 4111 1111 1111 1111
Visa 4005 5192 0000 0004
Visa 4009 3488 8888 1881
Visa 4012 0000 3333 0026
Visa 4012 0000 7777 7777
Visa 4012 8888 8888 1881
Visa 4217 6511 1111 1119
Visa 4500 6000 0000 0061
MasterCard 5555 5555 5555 4444
American Express 3782 822463 10005
American Express 3714 496353 98431
Discover 6011 1111 1111 1117
JCB 3530 1113 3330 0000

Page 57
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Using the SuperShuttle Test Environment

Test Environment Restrictions


Important: In the SuperShuttle test environment, all reservations must have a last name
value of Test.

Last name must be Test. The purpose of using Test as the last name is to ensure that a
production instance is not accidentally pointed to the test environment. If this occurs when
booking a reservation, the customer receives a message indicating the reservation did not
save properly.

Service Location to Generate a Security Token


The service location to generate a security token is
https://apitest.vtod.com/2.0.0/REST/GetToken

How the API Key is Passed to the Server


When SuperShuttle receives the token, it is put into the Header request. Here is an example of
the C# code:
Dictionary<string, string> token = new Dictionary<string, string>();
token.Add("Username", username);
token.Add("SecurityKey", securityKey);
//...
WebRequest request = WebRequest.Create(url);
foreach (var item in headers)
{
request.Headers.Add(item.Key + ":" + item.Value);
}
Difference Between Test and Production URLs
The test URLs contain the word Test in the link. Remove Test from the link as shown in this
example:
Test URL: https://apitest.vtod.com/2.0.0/REST/GetToken
Production URL: https://api.vtod.com/2.0.0/REST/GetToken

XML or JSON Version Must Match the Version in the URLs


The XML or JSON version must match the version in the URLs being used. As an example, if the
URL is https://apitest.vtod.com/2.0.0/Rest/GetToken, the version in JSON must also be 2.0.0.

XML or JSON
We recommend you use JSON, because if the response becomes too large, XML

Page 58
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Using the SuperShuttle Test Environment

serialization/deserialization can be very slow.

XML or JSON: No Mixed Serialization


There is no support for mixed serialization. If a message is sent using XML the response will
also be in XML. If a message is sent using JSON, the response will also be in JSON.

Default Message Handling is JSON


The default message handling is for the JSON message format. To use the XML message
formats, append media=xml to the query string, as shown here:
https://apitest.vtod.com/2.0.0/Rest/GetToken?media=xml

Accessing the Utility Service


The utility service offers various data lookup actions and is located at
https://api.vtod.com/2.0.0/REST/Utility/GetServicesAirports.

Page 59
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Resources

Resources
l Open Travel Code List and Specifications
l Ground Availability Request Schema Definition
l Ground Availability Response Schema Definition
l Ground Booking Request Schema Definition
l Ground Booking Response Schema Definition
l Ground Cancellation Request Schema Definition
l Ground Cancellation Response Schema Definition

Page 60
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Open Travel Alliance

Open Travel Alliance


The Open Travel Alliance (OTA) has established a standard accepted architecture for
electronic communication that allow organizations to transfer information more effectively. In
the case of SuperShuttle this automates the process business partners such as travel
websites use to check availability of vehicles, and make or cancel a reservation.

SuperShuttle / ExecuCar OTA 2012A Standards


Integration
Completing a reservation using the OTA standard is done by first requesting the availability
for a service type and then using the information returned to send a booking request along
with payment.

Process Summary
1. Send a request for availability.
2. Choose options from the availability response pickup time, service, etc.
3. Send the booking information, selected options from availability and payment information.
4. Present the customer with the returned confirmation numbers.

Page 61
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

Ground Availability Process Overview


The Ground Availability process is the initialization of the booking process. The
GroundAvailRQ method is used to send an availability request to SuperShuttle. The process
overview and the data included in the request and response is shown here.

In this section:
OTA_GroundAvailRQ 63
OTA_GroundAvailRS 72

Page 62
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

OTA_GroundAvailRQ
Important: When determining whether a trip is a round-trip, the API looks for a pickup and
drop-off that match, and two stops that match. A trip that meets these criteria is interpreted
as a round-trip.

Ground availability requests are sent using (Open Travel Alliance) OTA Ground Transportation
v2012A. All service calls for the reservation process conform to this specification.
This section provides more details regarding the Ground Availability Request.
Service location:
XML: https://apitest.vtod.com/2.0.0/Rest/Ground/Availmedia=xml
JSON: https://apitest.vtod.com/2.0.0/Rest/Ground/Avail

Service vs. Shuttle


While the OTA spec treats the Service and Shuttle attributes differently, all reservations
regardless of type should be sent using the Service element. If the service is to or from an
airport, it is automatically treated as a shuttle service.

Pickup, Dropoff and Stops


The Service element contains two required elements (Pickup and Dropoff), as well as an
optional Stop element that can contain one or more stops.
Pickup and Dropoff in this context are used to identify the absolute pick-up and absolute final
drop-off point of a trip. This means a round trip is defined using two additional Stop elements
to form all segments of the trip.

Pickup
The Pickup element indicates the location where the customer will initiate their ground trip. A
building and unit number should be provided, if applicable, so the driver knows precisely
where to pick the customer up. The building and unit number can be included using the
BldgRoom element as part of the address.

JSONSample: Pickup at an Address


"Pickup": {
"DateTime": "${#TestCase#flightDate}",
"Address": {

Page 63
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

"AddressLine": "2543 N 60th Ave",


"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}

JSONSample: Pickup at an Airport


"Pickup": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2015-12-28 10:15",
"CodeContext": "Domestic"
}
},

XML Sample: Pickup at an Address

Note: A building and unit number should be provided, if applicable, so the driver knows precisely
where to pick the customer up. The building and unit number can be included using the BldgRoom
element as part of the address.
<Pickup DateTime="8/27/2013 8:35:00 AM">
<Address Latitude="33.501985"Longitude="-111.951930">
<AddressLine>1 central park w</AddressLine>
<BldgRoom>1121</BldgRoom>
<CityName>NEW YORK</CityName>
<PostalCode>10023</PostalCode>
<StateProv StateCode="NY"/>
<CountryName Code="US"/>
<LocationType>Other_</LocationType>

Page 64
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

<LocationName>TRUMP INTERNATIONAL HOTEL</LocationName>


</Address></Pickup>

XML Sample: Pickup at an Airport


<Pickup>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="WN" FlightNumber="551" CodeContext="Domestic"
FlightDateTime="2013-12-06T10:22:36"/>
</Pickup>

Dropoff
The Dropoff element indicates the destination for a passenger's ground trip, and may be
either an address or an airport.

Important: The FlightDateTime value of the Airline element is extremely important and
while shown as optional in the specification it is required for our purposes. This value is used
to determine suggested or available pickup times for our services.

JSONSample:Dropoff at an Address
"Dropoff": {
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
}

JSONSample: Dropoff at an Airport


"Dropoff": {

Page 65
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "${#TestCase#flightDate}",
"CodeContext": "Domestic"
}
}
}

XML Sample: Dropoff at an Address


<Dropoff>
<Address Latitude="33.501985"
Longitude="-111.951930">
<AddressLine>1 Central park</AddressLine>
<BldgRoom>1121</BldgRoom>
<CityName>New York</CityName>
<PostalCode>10023</PostalCode>
<StateProv StateCode="NY"/>
<CountryName Code="US"/>
<LocationType/>
<LocationName/>
</Address>
</Dropoff>

XML Sample: Dropoff at an Airport


Important: The flight date time value of the Airline element is extremely important and
while shown as optional in the specification it is required for our purposes. This value is used
to determine suggested or available pickup times for our services.

<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline FlightDateTime="2013-08-29T12:20:14" CodeContext="Inter-
national" FlightNumber="2363" Code="DL"/>
</Dropoff>

Stops

Page 66
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

Stops are used for round trip reservations to show the flow of the trip.
The Stops element envelopes the individual stops, which are identified using the Stop
element.

JSONSample:Stops
"Stops": {
"Stops": [{
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "1156",
"FlightDateTime": "${#TestCase#flightDate}",
"CodeContext": "International"
}
},
{
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "2256",
"FlightDateTime": "${#TestCase#flightDateReturn}",
"CodeContext": "International"
}
}]
},

XML Sample: Stops


<Stops>
<Stop>
<Address Latitude="33.501985"Longitude="-111.951930">
<AddressLine>8930 S Beck Ave</AddressLine>
<BldgRoom>Suite 101</BldgRoom>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>

Page 67
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

<LocationType>HomeResidence</LocationType>
</Address> </Stop> <Stop>
<Address Latitude="33.501985"Longitude="-111.951930">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Stop>
</Stops>

Passenger Definitions
SuperShuttle defines Child and Infant passenger types as children three years of age or
younger. These passenger types are the only types considered non-paying. All other
passenger category types are considered paying passengers.

JSONSample:Passengers Category
"Passengers": [
{
"Quantity": 5,
"Category": {
"Value": "Adult"
}
}
],

XML Sample: Passengers Category


<Passengers>
<Category>Adult</Category>
</Passengers>

Passenger Quantity
Identifying the number of passengers is not required to retrieve base rates, but the number
of passengers the vehicle is required to support may limit the available rates. Though children
and infants are non-paying customers, they must be included in the number of passengers to
ensure the availability of a service is not given if it does not meet the customers
requirements.

JSONSample:Passengers Quantity

Page 68
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

"Passengers": [
{
"Quantity": 5,
"Category": {
"Value": "Adult"
}
}
],

XML Sample: Passengers Quantity


<Passengers Quantity="3">

Passenger and Service Preferences


Passenger preferences are used to fine tune the type of service being requested. ExecuCar
passengers can specify whether they require Meet and Greet service.

JSONSample:Passenger Preferences
"PassengerPrefs MeetAndGreetInd": "false",

XML Sample: Passenger Preferences


<PassengerPrefs MeetAndGreetInd="false"/>

Vehicle Accessibility: Passengers with Disabilities


The DisabilityInfo element is where passengers can describe their accessibility needs. Setting
the RequiredInd attribute to true indicates a wheelchair accessible vehicle is required.

JSONSample:Passengers with Disabilities


"Service": {
"DisabilityInfo RequiredInd": false,
}

XMLSample: Passengers with Disabilities


<DisabilityInfo RequiredInd="true"/>

Rate Qualifier
The RateQualifier element is used to associate special rates to a reservation, such as
promotion codes.

Page 69
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

IMPORTANT: SuperShuttle trading partners are not permitted to use promotion codes,
because they result in a loss in revenue for SuperShuttle.

Use the RateQualifier element to filter the returned services. These are the values you can
use with the RateQualifier element. The gratuity can be entered in the form of a percentage
(15%) or a dollar amount (15).

Value Results Returned


SuperShuttleSharedRideOnly Only SuperShuttle shared ride availability
SuperShuttle SuperShuttle availability only
ExecuCar ExecuCar availability only
SuperShuttle_ExecuCar Both SuperShuttle and ExecuCar availability

JSONSample:Rate Qualifier
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%12.56"
}]
}]

XML Sample: Rate Qualifier


<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>

TPA Extensions
For tracking and reporting purposes we ask all partners to include the following information,
though it is not required to complete a reservation.

Data Description
Source The Source element is used to include additional information about where this
request originated.

Page 70
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

Data Description
Device The Device element is used to specify the type of device (iPhone, S3, Nexus) used to
make the request.

Important: SuperShuttle trading partners are not permitted to use airline rewards, because
that would result in a loss in revenue for SuperShuttle.

JSONSample:TPAExtensions
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false
},

XML Sample: TPA_Extensions


<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions>

Resources
l Ground Availability Request Schema Definition
l "JSON Sample: SuperShuttle Ground Availability Request - To the Airport " on page 222
l "JSON Sample: SuperShuttle Ground Availability Request - From the Airport " on page 229
l "JSON Sample: SuperShuttle Ground Availability Request - Between Non-Airport Locations "
on page 235
l "JSON Sample: SuperShuttle Ground Availability Request - Round-Trip " on page 238
l "XML Sample: SuperShuttle Ground Availability Request - To the Airport" on page 188
l "XML Sample: SuperShuttle Ground Availability Request - From the Airport" on page 193
l "XML Sample: SuperShuttle Ground Availability Request - Between Non-Airport Locations"
on page 191
l "XML Sample: SuperShuttle Ground Availability Request - Round-Trip" on page 196

Page 71
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

OTA_GroundAvailRS
Ground availability responses are sent using OTA Ground Transportation v2012A. The TPA_
Extension element returned by this service contains important information regarding
available or suggested pickup times. All SuperShuttle brands must use only a time returned in
the PickupTimes TPA_Extension element.

Ground Services
The response will contain all available ground services that meet the criteria specified in the
availability request.

JSONSample: Service
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and collect
your luggage. Follow the instructions below for your respective terminal and
present your confirmation number to the curbside representative for further
assistance. Curbside representatives are available 7 AM to 11 PM, daily. After
hours, please call (602) 232-4601 for further assistance.Terminal 2:Exit Door
#8, at the east end of the terminal past baggage claim, and continue east to
the middle island/median.Terminal 3: Exit via Door 9 (North Curb) and cross
the street. The CSR will be waiting near a sign that reads Van Ser-
vice.Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Shared
Ride Van Service.",
"ServiceLevel": {
"Code": "VAN",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},

XML Sample: Service


<Service>
<ServiceLevel Code="VAN"/>
<VehicleType Code="BLUEV"/>
</Service>

Rate Qualifier
This element contains a Category element that describes the service. Due to the limited
number of XSD defined categories, all services are returned as type Other_ and use the

Page 72
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

description to detail the type of service it represents.

Important: SuperShuttle trading partners are not permitted to use promotion codes,
because they result in a loss in revenue for SuperShuttle.

The SpecialInputs element can be included in the RateQualifier element to allow the
passenger to specify a gratuity (tip) amount. The gratuity can be entered in the form of a
percentage (15%) or a dollar amount (15).

JSONSample: RateQualifier
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Exclusive Non-Stop Van Service (up to 7 passengers)",
"Value": "Other_"
}},

XML Sample: RateQualifier


<RateQualifier>
<Category Description="Exclusive Non-Stop Van Service (up to 7 pas-
sengers)" Code="Fare">Other_</Category>
</RateQualifier>

Restrictions
The Restrictions element contains information about the minimum advanced notice
required to book a service of this type. Time unit will always return as minutes with the
multiplier specifying how many minutes are required.

JSONSample:Restrictions
"Restrictions": {
"AdvancedBookingInd": "False",
},

XML Sample: Restrictions


<Restrictions AdvancedBookingInd="false"/>

Service Charges
Each service will contain one or more service charges. Each service charge contains a
description and a breakdown of how the charge is calculated.

JSONSample: ServiceCharges

Page 73
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 24,
"UnitCharge": 24
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 4,
"Total": 32,
"UnitCharge": 8
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],

XML Sample: ServiceCharges


<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="15.00"Quantity="1" MaxQuantity="1"Total="15.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="15.00"Quantity="2"MaxQuantity="10"Total="30.00"/>
</ServiceCharges>

Fees
The Fees element describes additional charges applied that may not be directly related to the
service itself. Taxes are calculated for the service as a whole, not per service charge, so all
taxes are represented by a Fee element using a ChargePurpose element set to Tax.

JSONSample: Fees
"Fees": [{
"Calculations": [{
"MaxQuantity": 1,

Page 74
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

"Quantity": 1,
"Total": 8.64,
"UnitCharge": 8.64
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],

XML Sample: Fees


<Fees Description="Gratuity">
<Calculation UnitCharge="4.80" Quantity="1" MaxQuantity="1" Total="4.80"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<Fees Description="County Tax">
<Calculation UnitCharge="2.19" Quantity="1"MaxQuantity="1"Total="2.19"/>
</Fees>
<Fees Description="State Tax">
<Calculation UnitCharge="1.80"Quantity="1"MaxQuantity="1"Total="1.80"/>
</Fees>

Total Charge
The TotalCharge element is shows the total amount being charged to the passenger,
including any fees or taxes.

JSONSample: TotalCharge
"TotalCharge": {
"EstimatedTotalAmount": 80.64,
"RateTotalAmount": 80.64
}

XML Sample: TotalCharge


<TotalCharge RateTotalAmount="48.99"/>

Reference
The Reference element contains an ID attribute that contains the ID of the rate as
represented in SuperShuttle's reservation system. Once a rate is selected, the ID value for
that rate must be provided in the booking request. The reference also contains the available
pickup times for this service in the form of TPA_Extensions. The start and end time for the
pickup window are returned. However, when booking the reservation, only the start time
needs to be returned in the booking request.

Page 75
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

Note: A Reference ID with a minus (-) before it indicates a hotel special rate.

JSONSample: Reference
"Reference": {
"ID": "14803",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/exc.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [
{
"EndDateTime": "9/10/2015 2:48:00 PM",
"StartDateTime": "9/10/2015 2:33:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 2:33:00 PM",
"StartDateTime": "9/10/2015 2:18:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 2:18:00 PM",
"StartDateTime": "9/10/2015 2:03:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 2:03:00 PM",
"StartDateTime": "9/10/2015 1:48:00 PM",
"Status": "AllowPickup"
}
]},
"TripDirection": "ToAirport"
}
},

XML Sample: Reference


<Reference ID="-48315">
<TPA_Extensions>
<MaxPassengers>11</MaxPassengers>
<MaxAccessibleGuests>4</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="8/23/2013 6:35:00
AM"EndDateTime="8/23/2013 6:50:00 AM"Status="AllowPickup"/>
<PickupTime StartDateTime="8/23/2013 5:35:00

Page 76
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

AM"EndDateTime="8/23/2013 5:50:00 AM"Status="AllowPickup"/>


<PickupTime StartDateTime="8/23/2013 4:35:00
AM"EndDateTime="8/23/2013 4:50:00 AM"Status="AllowPickup"/>
<PickupTime StartDateTime="8/23/2013 3:35:00
AM"EndDateTime="8/23/2013 3:50:00 AM"Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>

Trading Partner Extensions (TPA Extensions)


TPA Extensions are temporary extension points used to extend the OTA standards to
accommodate a business's need to exchange data.

MaxPassengers
The MaxPassengers element returns the maximum number of passengers the requested
vehicle can accommodate.

JSONSample: MaxPassengers
"TPA_Extensions": {
"MaxPassengers": 7,
},

XML Sample: MaxPassengers


<MaxPassengers>11</MaxPassengers>

MaxAccessibleGuests
The MaxAccessibleGuests element returns the vehicle's maximum capacity for customers
who require accessibility features.

JSONSample: MaxAccessbileGuests
"TPA_Extensions": {
"MaxAccessibleGuests": 7,
},

XML Sample: MaxAccessibleGuests


<MaxAccessibleGuests>4</MaxAccessibleGuests>

Pickup Times
The PickupTimes element returns one or more pickup times based on the services the

Page 77
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

passenger is requesting.

If... Then...
The request is for van A list of pickup time options is returned and the passenger
(SuperShuttle) service... can select the best time for them.
The request is for car An exact pickup time is returned.
(ExecuCar) service...
The request included a flight An exact pickup time is returned.
time...
The request included Meet and An exact pickup time is returned.
Greet service...

JSONSample: PickupTimes
"TPA_Extensions": {
"PickupTimes": {"PickupTimes": [
{
"EndDateTime": "9/10/2015 2:28:00 PM",
"StartDateTime": "9/10/2015 2:13:00 PM",
"Status": "AllowPickup"
},

XML Sample: PickupTimes


<PickupTimes>
<PickupTime StartDateTime="11/30/2013 7:25:00 PM" EndDateTime="11/30/2013
7:40:00 PM" Status="PickupExpired" Description="The reservation cannot be com-
pleted online, call us directly for assistance 800-258-3826."/>
</PickupTimes>

Resources
l Ground Availability Response Schema Definition
l "JSON Sample: SuperShuttle Ground Availability Response - To the Airport " on page 224
l "JSON Sample: SuperShuttle Ground Availability Response - From the Airport " on page 231
l "JSON Sample: SuperShuttle Ground Availability Response - Between Non-Airport Locations
" on page 237
l "JSON Sample: SuperShuttle Ground Availability Response - Round-Trip " on page 241
l "XML Sample: SuperShuttle Ground Availability Response - To the Airport" on page 189

Page 78
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Availability Process Overview

l "XML Sample: SuperShuttle Ground Availability Response - From the Airport" on page 194
l "XML Sample: SuperShuttle Ground Availability Response - Between Non-Airport Locations"
on page 192
l "XML Sample: SuperShuttle Ground Availability Response - Round-Trip" on page 198

Page 79
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

Ground Booking Process Overview


The Ground Booking Request process occurs after the Ground Booking Availability response
is received. The Ground Booking Request is initiated using the GroundBookRQ method. This
high-level data flow and the information sent and received is shown here.

In this section:
OTA_GroundBookRQ 81
OTA_GroundBookRS 92

Page 80
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

OTA_GroundBookRQ
The GroundBook request is used to book a trip based on the services returned in the ground
availability response.
Service location:
XML: https://apitest.vtod.com/2.0.0/Rest/Ground/Book?media=xml
JSON: https://apitest.vtod.com/2.0.0/Rest/Ground/Book

POS
The POS element defines the country (ISOCountry) and currency (ISOCurrency) for the
service location.

JSONSample: POS
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},

XML Sample: POS


<POS>
<Source ISOCountry="US"ISOCurrency="USD"/>
</POS>

Reference
Note: A Reference ID with a minus (-) before it indicates a hotel special rate.

The Reference element contains an ID attribute that contains the ID of the selected rate as
represented in SuperShuttle's system.
Note: In the GroundBookRQ, the Reference element must include the Type="Confirmation"
attribute. A Reference ID with a minus (-) before it indicates a hotel special rate.

JSONSample: Reference
"References": [{
"ID": "14973"
},

Page 81
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

XML Sample: Reference


Note: In the GroundBookRQ, the Reference element must include the Type="Confirmation"
attribute. A Reference ID with a minus (-) before it indicates a hotel special rate.

<Reference Type="Confirmation" ID="-48315">


</Reference>

Passengers
The Passenger element contains information for primary and additional passengers.
SuperShuttle uses only the primary passenger information. The Email element contains a
ShareMarketInd attribute. When indicated, this allows us to market both our products and
any affiliate products to this email address.

JSONSample: Passenger
"Passenger": {"Primary": {
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},

XML Sample: Passenger


<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001" AreaCityCode="602"
PhoneNumber="555-1234"/>
<Email>janedtester123@gmail.com</Email>
</Primary>
</Passenger>

Service
The Service element contains all information required for the selected service. The Location
element and disability indicator (DisabilityVehicleInd attribute) are only used as required by
the OTA specification.

JSONSample: Service
"Service": {

Page 82
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

"Location": {
"Pickup": {
"DateTime": "${GroundAvail#Re-
sponseAsXml#//*:Response/*:GroundServices/*:GroundServices/*:e[1]/*:Re-
ference/*:TPA_Extensions/*:PickupTimes/*:PickupTimes/*:e[1]/*:StartDateTime}",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Dropoff": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"FlightDateTime": "${#TestCase#flightDate}",
"CodeContext": "Domestic"
}
}
}
},

XML Sample: Service


<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="1/29/2014 2:59:45 AM">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>

Page 83
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123" CodeContext="Domestic"
FlightDateTime="2013-11-30 21:15"/>
</Dropoff>
</Location>
</Service>

Pickup
The Pickup element with the DateTime attribute is the pickup time the passenger selected
from those returned in the PickupTimes element, included in the TPA_Extensions element of
the Ground Availability Response (GroundAvailRS).

JSONSample: Pickup
"Pickup": {
"DateTime": "${GroundAvail#Re-
sponseAsXml#//*:Response/*:GroundServices/*:GroundServices/*:e[1]/*:Re-
ference/*:TPA_Extensions/*:PickupTimes/*:PickupTimes/*:e[1]/*:StartDateTime}",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},

XML Sample: Pickup

Page 84
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

<Pickup DateTime="12/5/2013 10:52:43 AM">


<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>

Address
The address contains the street address information for a location. Only the Address or the
AirportInfo element should be specified, never both.

Note: Any building or unit number associated with a pickup address should be included as
part of the address using the BldgRoom element.

JSONSample: Address
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},

XML Sample: Address


<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>

Page 85
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

Airport
The AirportInfo element contains the location code of the airport. Only the Address or the
AirportInfo element should be specified, never both.

JSONSample: Airport
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
}

XML Sample: Airport


<AirportInfo>
<Arrival LocationCode="LGA"/>
</AirportInfo>

Dropoff
The Dropoff element indicates the destination for a passenger's ground trip, and may be
either an address or an airport.
Important: The FlightDateTime value of the Airline element is extremely important and
while shown as optional in the specification it is required for our purposes. This value is used
to determine suggested or available pickup times for our services.

JSONSample: Dropoff
"Dropoff": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"FlightDateTime": "${#TestCase#flightDate}",
"CodeContext": "Domestic"
}
}

XML Sample: Dropoff

Important: The FlightDateTime value of the Airline element is extremely important and while shown

Page 86
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

as optional in the specification it is required for our purposes. This value is used to determine
suggested or available pickup times for our services.
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="WN" FlightNumber="551" CodeContext="Domestic"
FlightDateTime="2013-12-05T10:52:43"/>
</Dropoff>

Rate Qualifier
The RateQualifier element is used to associate special rates to a reservation, such as
promotion codes.

Important: SuperShuttle trading partners are not permitted to use promotion codes,
because they result in a loss in revenue for SuperShuttle.

The SpecialInputs element can be included in the RateQualifier element to allow the
passenger to specify a gratuity (tip) amount. The gratuity can be entered in the form of a
percentage (15%) or a dollar amount (15).

JSONSample: Rate Qualifier


"RateQualifiers": [
{
"RateQualifierValue": "SuperShuttle_ExecuCar",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%15"
}
]
}
]

XML Sample: RateQualifier


<RateQualifier AccountID="001UNIF" PromotionCode="72MMA" RateQualifier="Super-
ShuttleSharedRideOnly">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="2.50"/>

Page 87
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

</RateQualifier>

Stops
Stops are used for round trip reservations to show the flow of the trip.
The Stops element envelopes the individual stops, which are identified using the Stop
element.

JSONSample: Stops
"Stops": {
"Stops": [{
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "1156",
"FlightDateTime": "${#TestCase#flightDate}",
"CodeContext": "International"
}
},
{
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "2256",
"FlightDateTime": "${#TestCase#flightDateReturn}",
"CodeContext": "International"
}
}]
},

XML Sample: Stops


<Stops>
<Stop>
<Address>
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>

Page 88
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Stop>
<Stop DateTime="8/25/2013 11:04:52 PM">
<Address>
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Stop>
</Stops>

Payment
The Payment element contains information used to collect payment for the reservation.
Currently, only the PaymentCard and DirectBill elements are supported. Note that some
direct bill clients use a password (DirectBill_ID), and it must be included only if the client has a
password associated with their direct billing account.

IMPORTANT: The DirectBill payment type is not available to SuperShuttle trading partners.

SuperShuttle accepts these cards.

Card Code Card Name


AZ American Express
DN Diners Club
DS Discover Card
JC Japanese Credit Bureau
MC MasterCard
VI VISA

JSONSample: Payments
"Payments":{
"Payments":[
{

Page 89
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

"PaymentCard":{
"ExpireDate":"11/30/2016",
"CardType":{
"Value":"MC",
"Description":"MasterCard"
},
"CardHolderName":"Joe Hogen",
"CardNumber":{
"ID":"212424",
"EncryptedValue":"+u67EHGjm+JJzl89bbs6C+vJqZOgDGAh"
}
}
}
]
},

XML Sample: Payments

Note: The <SeriesCode> element sends the CVV code from the back of the payment card.
<Payments>
<Payment>
<PaymentCard ExpireDate="11/30/2016">
<CardHolderName>Jane Test</CardHolderName>
<CardType Description="MasterCard">MC</CardType>
<CardNumber>
<PlainText>5555555555554444</PlainText>
<LastFourDigit>4444</LastFourDigit>
</CardNumber>
<SeriesCode>
<PlainText>123</PlainText>
</SeriesCode>
</PaymentCard>
</Payment>
</Payments>

TPA Extensions
Passenger information must be included in the TPA Extensions, because the rate returned in
the Ground Availability Response is a base rate, not a quote for service. The final booking
request must contain the number of passengers and any airline rewards being applied to this
trip.
The acceptable values for the PickMeUpNow element are:

Page 90
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

l True
l False

JSONSample: TPAExtensions
"TPA_Extensions":{
"Passengers":[
{
"Quantity":1,
"Category":{
"Value":"Adult"
}
}
],
"Confirmations":[
],
"MemberID":"",
"RateQualifiers":[
],
"Source":"zTrip",
"Device":"iPhone",
"PickMeUpNow":false
}

XML Sample: TPA Extensions


Note: The MemberID is used by solely by SuperShuttle and is not accessible to outside
parties.

<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
<MemberID>1054462</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions>

Resources
l Ground Booking Request Schema Definition
l "JSON Sample: SuperShuttle Ground Booking Request - To the Airport " on page 255
l "JSON Sample: SuperShuttle Ground Booking Request - From the Airport " on page 258

Page 91
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

l "JSON Sample: SuperShuttle Ground Booking Request - Between Non-Airport Locations " on
page 262
l "JSON Sample: SuperShuttle Ground Booking Request - Round-Trip " on page 250
l "XML Sample: SuperShuttle Ground Booking Request - To the Airport" on page 209
l "XML Sample: SuperShuttle Ground Booking Request - From the Airport" on page 215
l "XML Sample: SuperShuttle Ground Booking Request - Between Non-Airport Locations" on
page 212
l "XML Sample: SuperShuttle Ground Booking Request - Round-Trip" on page 217

OTA_GroundBookRS
The ground booking response contains all the information sent (except for payment
information), but includes one additional element named Confirmation.

Confirmation
The ID attribute of the Confirmation element contains the confirmation number of the
reservation. The extensions of Confirmation contain an element named
ReturnConfirmation with an ID attribute containing the second confirmation number for
round trip reservations.

JSONSample: Confirmations
"TPA_Extensions": {"Confirmations": [
{
"ID": "7726528",
"Type": "DispatchConfirmation"
},
{
"ID": "73178",
"Type": "ReturnConfirmation"
},
{
"ID": "7726529",
"Type": "DispatchReturnConfirmation"
}
]}

XML Sample: Confirmation


<Confirmation ID="1102">

Page 92
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Booking Process Overview

Resources
l Ground Booking Response Schema Definition
l "JSON Sample: SuperShuttle Ground Booking Response - To the Airport " on page 257
l "JSON Sample: SuperShuttle Ground Booking Response - From the Airport " on page 261
l "JSON Sample: SuperShuttle Ground Booking Response - Between Non-Airport Locations "
on page 264
l "JSON Sample: SuperShuttle Ground Booking Response - Round-Trip " on page 253
l "XML Sample: SuperShuttle Ground Booking Response - To the Airport" on page 211
l "XML Sample: SuperShuttle Ground Booking Response - From the Airport" on page 216
l "XML Sample: SuperShuttle Ground Booking Response - Between Non-Airport Locations" on
page 214
l "XML Sample: SuperShuttle Ground Booking Response - Round-Trip" on page 219

Page 93
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Cancellation Process Overview

Ground Cancellation Process Overview


A Ground Cancellation Request is initiated to cancel a reservation using the GroundCancelRQ
method. A high-level data flow and the information sent and received is shown here.

In this section:
OTA_GroundCancelRQ 94
OTA_GroundCancelRS 97

OTA_GroundCancelRQ
The GroundCancel request is used to cancel a trip.
Service location:
XML: https://apitest.vtod.com/2.0.0/Rest/Ground/Cancel?media=xml
JSON: https://apitest.vtod.com/2.0.0/Rest/Ground/Cancel

Page 94
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Cancellation Process Overview

Minimum Information
The minimum required information for the Ground Cancellation Request (OTA_
GroundCancelRQ) includes the confirmation number of the trip booked and one other
personal identifier, such as last name, telephone number, or postal code.

POS
The POS element defines the country (ISOCountry) and currency (ISOCurrency) for the
service location.

JSONSample:POS
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}},

XML Sample: POS


<POS>
<Source ISOCountry="US"ISOCurrency="USD"/>
</POS>

Reservation
When used in the cancellation request, the Reservation element defines the type of
cancellation.

JSONSample: Reservation
"Reservation": {
"CancelType": "Cancel",
"UniqueID": [ {
"Type": "DispatchConfirmation",
"ID": "${GroundBook#ResponseAsXml#//*:Response/*:Reservations/*:e[1]
/*:Confirmation/*:TPA_Extensions/*:Confirmations/*:e[1]/*:ID}"
}],
"Verification": {
"AddressInfo": {
"PostalCode": "${GroundBook#ResponseAsXml#//*:Response/*:Reservations/*:e
[1]/*:Service/*:Location/*:Pickup/*:Address/*:PostalCode}"
}
}
},

Page 95
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Cancellation Process Overview

XMLSample:Reservation
<Reservation CancelType="Cancel"></Reservation>

Unique ID
Canceling a reservation requires the confirmation number given during the booking process
to be used as the value of the ID attribute in the UniqueID element.

JSONSample: UniqueID
"UniqueID": [ {
"Type": "DispatchConfirmation",
"ID": "${GroundBook#ResponseAsXml#//*:Response/*:Reservations/*:e[1]
/*:Confirmation/*:TPA_Extensions/*:Confirmations/*:e[1]/*:ID}"
}],

XML Sample: UniqueID


<UniqueID Type="DispatchConfirmation" ID="5902948"/>

TPA Extensions
The RateQualifier element is required by the VTOD API to distinguish between systems.

JSONSample: RateQualifier
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": []
}]

XML Sample: RateQualifier


<TPA_Extensions>
<RateQualifier RateQualifier="SuperShuttle"/>
</TPA_Extensions>

Verification
JSONSample: Verification
"Verification": {
"AddressInfo": {
"PostalCode": "${GroundBook#ResponseAsXml#//*:Response/*:Reservations/*:e[1]
/*:Service/*:Location/*:Pickup/*:Address/*:PostalCode}"
}

Page 96
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Cancellation Process Overview

XML Sample: Verification


<Verification>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<TelephoneInfo CountryAccessCode="1" AreaCityCode="602" PhoneNumber="555-
1234"/>
<AddressInfo>
<PostalCode>85035</PostalCode>
</AddressInfo>
</Verification>

Resources
l Ground Cancellation Request Schema Definition
l "JSON Sample: SuperShuttle Ground Cancellation Request " on page 266
l "XML Sample: SuperShuttle Ground Cancellation Request" on page 221

OTA_GroundCancelRS
The Ground Cancellation Response (OTA_GroundCancelRS) includes only the
CancelConfirmation element with the UniqueID indicator for the reservation.

Cancel Confirmation
The Ground Cancellation Response (OTA_GroundCancelRS) includes only the
CancelConfirmation element with the UniqueID indicator for the reservation.

JSONSample:

XML Sample: CancelConfirmation


<CancelConfirmation>
<UniqueID Type="DispatchConfirmation" ID="5902948"/>
</CancelConfirmation>

Resources

Page 97
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Ground Cancellation Process Overview

l Ground Cancellation Response Schema Definition


l "JSON Sample: SuperShuttle Ground Cancellation Response " on page 267
l "XML Sample: SuperShuttle Ground Cancellation Response" on page 222

Page 98
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Samples
This section contains samples for various requests and responses.

In this section:
Get Airlines for an Airport 99
Get Serviced Airports 100
Get a List of SuperShuttle Locations 128
Get a List of Hotels and Landmarks for a SuperShuttle Location 129
ExecuCar XML Samples 131
ExecuCar JSON Samples 151
SuperShuttle XML Samples 188
SuperShuttle JSON Samples 222

Get Airlines for an Airport


The examples in this section show the request and response for getting a list of airlines that
service an airport. The addresses are:
XML: https://apitest.vtod.com/2.0.0/Rest/Utility/GetAirlinesByAirport?media=xml
JSON: https://apitest.vtod.com/2.0.0/Rest/Utility/GetAirlinesByAirport

JSON Sample: Get Airlines by Airport Request


{
"AirportCode": "LAX",
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en"
}
JSON Sample: Get Airlines by Airport Response
Note: In this example, only the first three airlines returned are shown.
{
"Airlines": [
{
"Code": "GB",
"CompanyShortName": "ABX AIR, INC."
},

Page 99
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

{
"Code": "EI",
"CompanyShortName": "AER LINGUS"
},
{
"Code": "SU",
"CompanyShortName": "AEROFLOT RUSSIAN AIRLINES"
}]
}
XML Sample: Get Airlines by Airport Request
<?xml version="1.0"encoding="UTF-8"?>
<UtilityGetAirlinesByAirportRQ
EchoToken=""Target="Test"Version="2.0.0"PrimaryLangID="en">
<AirportCode>LAX</AirportCode>
</UtilityGetAirlinesByAirportRQ>
XML Sample: Get Airlines by Airport Response
Note: In this example, only the first three airlines returned are shown.
<UtilityGetAirlinesByAirportRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<Airlines>
<Airline Code="GB" CompanyShortName="ABX AIR, INC." />
<Airline Code="EI" CompanyShortName="AER LINGUS" />
<Airline Code="SU" CompanyShortName="AEROFLOT RUSSIAN AIRLINES" />
</Airlines>
<Success />
</UtilityGetAirlinesByAirportRS>

Get Serviced Airports


The GetServicedAirports request gets a list of airports serviced by SuperShuttle.
Service location:
XML: https://apitest.vtod.com/2.0.0/Rest/Utility/GetServicedAirports?media=xml
JSON: https://apitest.vtod.com/2.0.0/Rest/Utility/GetServicedAirports

JSON Sample: Get Serviced Airports Request


{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en"

Page 100
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}
JSON Sample: Get Serviced Airports Response
Note: In this example, only the first two airports returned are shown.
{

"Airports": [
{
"AirportCode": "ABQ",
"AirportName": "Albuquerque, New Mexico",
"City": "Albuquerque",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "35.049625",
"Longitude": "-106.617195",
"PortType": "0",
"Serviced": 1,
"State": "NM"
},
{
"AirportCode": "ATL",
"AirportName": "Atlanta, Georgia",
"City": "Atlanta",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "33.63672",
"Longitude": "-84.428066",
"PortType": "0",
"Serviced": 1,
"State": "GA"
},
{
"AirportCode": "AUS",
"AirportName": "Austin TX (Bergstrom)",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Austin",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "30.2133",

Page 101
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Longitude": "-97.6685",
"PortType": "0",
"Serviced": 1,
"State": "TX"
},
{
"AirportCode": "BWI",
"AirportName": "Baltimore Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Baltimore",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "39.1765",
"Longitude": "-76.6697",
"PortType": "0",
"Serviced": 1,
"State": "MD"
},
{
"AirportCode": "BOS",
"AirportName": "Boston, Massachusetts",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Boston",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "42.362972",
"Longitude": "-71.006416",
"PortType": "0",
"Serviced": 1,
"State": "MA"
},
{
"AirportCode": "BUR",
"AirportName": "Burbank CA",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Burbank",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,

Page 102
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Latitude": "34.2013",
"Longitude": "-118.3575",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "SJD",
"AirportName": "Cabo San Lucas, Mexico",
"City": "San Lucas",
"Country": "Mexico",
"CountryCode": "MX",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "23.061388",
"Longitude": "-109.708055",
"PortType": "0",
"Serviced": 1,
"State": "MX"
},
{
"AirportCode": "CUN",
"AirportName": "Cancun, Mexico",
"City": "Cancun",
"Country": "Mexico",
"CountryCode": "MX",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "21.037007",
"Longitude": "-86.873752",
"PortType": "0",
"Serviced": 1,
"State": "MX"
},
{
"AirportCode": "CLT",
"AirportName": "Charlotte, North Carolina",
"City": "Charlotte",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "35.21374",
"Longitude": "-80.949069",

Page 103
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"PortType": "0",
"Serviced": 1,
"State": "NC"
},
{
"AirportCode": "CHO",
"AirportName": "Charlottesville-Albemarle Airport",
"City": "Charlottesville",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "38.138638",
"Longitude": "-78.452861",
"PortType": "0",
"Serviced": 1,
"State": "VA"
},
{
"AirportCode": "MDW",
"AirportName": "Chicago, Illinois-Midway",
"City": "Chicago",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "41.785972",
"Longitude": "-87.752416",
"PortType": "0",
"Serviced": 1,
"State": "IL"
},
{
"AirportCode": "ORD",
"AirportName": "Chicago, OHare Apt, Illinios",
"City": "Chicago",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "41.980904",
"Longitude": "-87.906654",
"PortType": "0",
"Serviced": 1,

Page 104
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"State": "IL"
},
{
"AirportCode": "COS",
"AirportName": "Colorado Springs Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Colorado Springs",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "38.803685",
"Longitude": "-104.711263",
"PortType": "0",
"Serviced": 1,
"State": "CO"
},
{
"AirportCode": "DAL",
"AirportName": "Dallas Love Field",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Dallas",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "32.844",
"Longitude": "-96.848",
"PortType": "0",
"Serviced": 1,
"State": "TX"
},
{
"AirportCode": "DFW",
"AirportName": "Dallas-Ft Worth DFW Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Dallas",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "32.884",
"Longitude": "-97.04",
"PortType": "0",

Page 105
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Serviced": 1,
"State": "TX"
},
{
"AirportCode": "DEN",
"AirportName": "Denver Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Denver",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "39.8615",
"Longitude": "-104.6764",
"PortType": "0",
"Serviced": 1,
"State": "CO"
},
{
"AirportCode": "DTW",
"AirportName": "Detroit Metro Airport",
"City": "Detroit",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "42.20781",
"Longitude": "-83.35605",
"PortType": "0",
"Serviced": 1,
"State": "MI"
},
{
"AirportCode": "FLL",
"AirportName": "Fort Lauderdale, Florida",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Fort Lauderdale",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "26.07467",
"Longitude": "-80.150549",
"PortType": "0",

Page 106
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "HNL",
"AirportName": "Honolulu International Airport",
"City": "Honolulu",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "21.318681",
"Longitude": "-157.922428",
"PortType": "0",
"Serviced": 1,
"State": "HI"
},
{
"AirportCode": "IAH",
"AirportName": "Houston Intercontinental Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Houston",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "30",
"Longitude": "-95.338594",
"PortType": "0",
"Serviced": 1,
"State": "TX"
},
{
"AirportCode": "HOU",
"AirportName": "Houston-Hobby TX Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Houston",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "29.6461",
"Longitude": "-95.2763",
"PortType": "0",

Page 107
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Serviced": 1,
"State": "TX"
},
{
"AirportCode": "JAX",
"AirportName": "Jacksonville, Florida",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Jacksonville",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "30.491487",
"Longitude": "-81.68437",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "MCI",
"AirportName": "Kansas City Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Kansas City",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "39.297605",
"Longitude": "-94.713906",
"PortType": "0",
"Serviced": 1,
"State": "MO"
},
{
"AirportCode": "LAS",
"AirportName": "Las Vegas McCarran Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Los Vegas",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "36.085055",
"Longitude": "-115.151054",

Page 108
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"PortType": "0",
"Serviced": 1,
"State": "NV"
},
{
"AirportCode": "LCY",
"AirportName": "London City Airport",
"City": "London",
"Country": "United Kingdom",
"CountryCode": "UK",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "51.50341",
"Longitude": "0.048769",
"PortType": "0",
"Serviced": 1,
"State": ""
},
{
"AirportCode": "LGW",
"AirportName": "London Gatwick Airport",
"City": "London",
"Country": "United Kingdom",
"CountryCode": "UK",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "51.1481",
"Longitude": "0.1903",
"PortType": "0",
"Serviced": 1,
"State": ""
},
{
"AirportCode": "LHR",
"AirportName": "London Heathrow Airport",
"City": "London",
"Country": "United Kingdom",
"CountryCode": "UK",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "51.4775",
"Longitude": "0.4614",
"PortType": "0",
"Serviced": 1,

Page 109
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"State": ""
},
{
"AirportCode": "LGB",
"AirportName": "Long Beach Airport CA",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Long Beach",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "33.818",
"Longitude": "-118.1521",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "ISP",
"AirportName": "Long Island (Islip) Airport, NY",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Ronkonkoma",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "40.795601",
"Longitude": "-73.093903",
"PortType": "0",
"Serviced": 1,
"State": "NY"
},
{
"AirportCode": "LAX",
"AirportName": "Los Angeles Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Los Angeles",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "33.9438",
"Longitude": "-118.4025",
"PortType": "0",

Page 110
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "MHT",
"AirportName": "Manchester, N. H.",
"City": "Manchester",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "42.932804",
"Longitude": "-71.435739",
"PortType": "0",
"Serviced": 1,
"State": "NH"
},
{
"AirportCode": "MEM",
"AirportName": "Memphis International Airport",
"City": "Memphis",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "35.04458",
"Longitude": "-89.98226",
"PortType": "0",
"Serviced": 1,
"State": "TN"
},
{
"AirportCode": "MIA",
"AirportName": "Miami Int'l Airport FL",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Miami",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "25.795361",
"Longitude": "-80.290111",
"PortType": "0",
"Serviced": 1,

Page 111
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"State": "FL"
},
{
"AirportCode": "MKE",
"AirportName": "Milwaukee, General Mitchell Int'l",
"City": "Milwaukee",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "42.9472",
"Longitude": "-87.8967",
"PortType": "0",
"Serviced": 1,
"State": "WI"
},
{
"AirportCode": "MSP",
"AirportName": "Minneapolis St Paul Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Minneapolis",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "44.8841",
"Longitude": "-93.2058",
"PortType": "0",
"Serviced": 1,
"State": "MN"
},
{
"AirportCode": "BNA",
"AirportName": "Nashville Airport, TN",
"City": "Nashville",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "36.130001",
"Longitude": "-86.668198",
"PortType": "0",
"Serviced": 1,
"State": "TN"

Page 112
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

},
{
"AirportCode": "MSY",
"AirportName": "New Orleans, Louisiana",
"City": "New Orleans",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "29.9847",
"Longitude": "-90.2575",
"PortType": "0",
"Serviced": 1,
"State": "LA"
},
{
"AirportCode": "LGA",
"AirportName": "New York - LaGuardia Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "New York",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "40.7764",
"Longitude": "-73.8749",
"PortType": "0",
"Serviced": 1,
"State": "NY"
},
{
"AirportCode": "JFK",
"AirportName": "New York, JFK Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "New York",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "40.6477",
"Longitude": "-73.7896",
"PortType": "0",
"Serviced": 1,
"State": "NY"

Page 113
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

},
{
"AirportCode": "EWR",
"AirportName": "Newark Liberty Airport NJ",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Newark",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "40.6926",
"Longitude": "-74.1744",
"PortType": "0",
"Serviced": 1,
"State": "NJ"
},
{
"AirportCode": "PHF",
"AirportName": "Newport News/Williamsburg International",
"City": "Newport News",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "37.131888",
"Longitude": "-76.492972",
"PortType": "0",
"Serviced": 1,
"State": "VA"
},
{
"AirportCode": "ORF",
"AirportName": "Norfolk International",
"City": "Norfolk",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "36.894611",
"Longitude": "-76.201222",
"PortType": "0",
"Serviced": 1,
"State": "VA"
},

Page 114
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

{
"AirportCode": "ECP",
"AirportName": "Northwest Florida Beaches International",
"City": "Panama City",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "30.357803",
"Longitude": "-85.79892",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "VPS",
"AirportName": "Northwest Florida Regional",
"City": "Eglin AFB",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "30.4833",
"Longitude": "-86.5253",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "OAK",
"AirportName": "Oakland Airport CA",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Oakland",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "37.717",
"Longitude": "-122.2114",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{

Page 115
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"AirportCode": "ONT",
"AirportName": "Ontario Airport CA",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Ontario",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "34.0578",
"Longitude": "-117.601977",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "SNA",
"AirportName": "Orange County-John Wayne",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Santa Ana",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "33.6753",
"Longitude": "-117.8678",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "MCO",
"AirportName": "Orlando Airport FL",
"AllowASAPRequests": true,
"City": "Orlando",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "28.431383",
"Longitude": "-81.308437",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{

Page 116
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"AirportCode": "SFB",
"AirportName": "Orlando Sanford Airport FL",
"City": "Orlando",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "28.774842",
"Longitude": "-81.243008",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "PNS",
"AirportName": "Pensacola International",
"City": "Pensacola",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "30.4734",
"Longitude": "-87.1866",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "PHL",
"AirportName": "Philadelphia Int'l Airport",
"City": "Philadelphia",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "47.449888",
"Longitude": "-122.311777",
"PortType": "0",
"Serviced": 1,
"State": "PA"
},
{
"AirportCode": "PHX",
"AirportName": "Phoenix Sky Harbor Airport",
"AllowASAPRequests": true,

Page 117
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"AllowWMVRequests": true,
"City": "Phoenix",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "33.436",
"Longitude": "-112.00986",
"PortType": "0",
"Serviced": 1,
"State": "AZ"
},
{
"AirportCode": "AZA",
"AirportName": "Phoenix-Mesa Gateway",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Mesa",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "33.3074",
"Longitude": "-111.661102",
"PortType": "0",
"Serviced": 1,
"State": "AZ"
},
{
"AirportCode": "PIT",
"AirportName": "Pittsburgh Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Pittsburgh",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "40.4914",
"Longitude": "-80.2328",
"PortType": "0",
"Serviced": 1,
"State": "PA"
},
{
"AirportCode": "PDX",
"AirportName": "Portland International",

Page 118
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"City": "Portland",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "45.5886",
"Longitude": "-122.596869",
"PortType": "0",
"Serviced": 1,
"State": "OR"
},
{
"AirportCode": "PVD",
"AirportName": "Providence, Rhode Island",
"City": "Providence",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "41.723999",
"Longitude": "-71.428221",
"PortType": "0",
"Serviced": 1,
"State": "RI"
},
{
"AirportCode": "RDU",
"AirportName": "Raleigh-Durham Airport NC",
"City": "Morrisville",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "35.87528",
"Longitude": "-78.781944",
"PortType": "0",
"Serviced": 1,
"State": "NC"
},
{
"AirportCode": "RIC",
"AirportName": "Richmond International",
"City": "Richmond",
"Country": "United States of America",

Page 119
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "37.505166",
"Longitude": "-77.319666",
"PortType": "0",
"Serviced": 1,
"State": "VA"
},
{
"AirportCode": "SMF",
"AirportName": "Sacramento Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Sacramento",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "38.6893",
"Longitude": "-121.5907",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "SAN",
"AirportName": "San Diego Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "San Diego",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "32.733555",
"Longitude": "-117.189666",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "SFO",
"AirportName": "San Francisco Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,

Page 120
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"City": "San Francisco",


"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "37.619",
"Longitude": "-122.3874",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "SJC",
"AirportName": "San Jose Airport CA",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "San Jose",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "37.3642",
"Longitude": "-121.9272",
"PortType": "0",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "AG1",
"AirportName": "Seattle ASIG FOC",
"City": "Seattle",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "47.53",
"Longitude": "-122.301972",
"PortType": "0",
"Serviced": 1,
"State": "WA"
},
{
"AirportCode": "BFI",
"AirportName": "Seattle Boeing Field Airport",
"City": "Seattle",
"Country": "United States of America",

Page 121
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "47.53",
"Longitude": "-122.301972",
"PortType": "0",
"Serviced": 1,
"State": "WA"
},
{
"AirportCode": "SEA",
"AirportName": "Seattle Tacoma Airport",
"City": "Seattle",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "39.872249",
"Longitude": "-75.240865",
"PortType": "0",
"Serviced": 1,
"State": "WA"
},
{
"AirportCode": "PIE",
"AirportName": "St. Petersburg-Clearwater Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Clearwater",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "27.9101",
"Longitude": "-82.6875",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "TPA",
"AirportName": "Tampa Airport FL",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Tampa",

Page 122
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Country": "United States of America",


"CountryCode": "US",
"ECARServiced": true,
"Latitude": "27.9681",
"Longitude": "-82.5391",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "IAD",
"AirportName": "Washington DC Dulles Airport",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Washington",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "38.9341",
"Longitude": "-77.4518",
"PortType": "0",
"Serviced": 1,
"State": "DC"
},
{
"AirportCode": "DCA",
"AirportName": "Washington National",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Washington",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "38.8506",
"Longitude": "-77.038",
"PortType": "0",
"Serviced": 1,
"State": "DC"
},
{
"AirportCode": "PBI",
"AirportName": "West Palm Beach Airport FL",
"AllowASAPRequests": true,
"AllowWMVRequests": true,

Page 123
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"City": "West Palm Beach",


"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "26.684237",
"Longitude": "-80.095875",
"PortType": "0",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "LBH",
"AirportName": "Long Beach Harbor",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Long Beach",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "33.74004",
"Longitude": "-118.281419",
"PortType": "1",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "LAH",
"AirportName": "Los Angeles Harbor",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Los Angeles",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "33.74004",
"Longitude": "-118.281419",
"PortType": "1",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "PC1",
"AirportName": "Port Canaveral FL",
"City": "Port Canaveral",

Page 124
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Country": "United States of America",


"CountryCode": "US",
"ECARServiced": true,
"Latitude": "28.427802",
"Longitude": "-80.618847",
"PortType": "1",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "PE1",
"AirportName": "Port Everglades",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Fort Lauderdale",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "26.09722",
"Longitude": "-80.121384",
"PortType": "1",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "PM1",
"AirportName": "Port of Miami",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Miami",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "25.77551",
"Longitude": "-80.165284",
"PortType": "1",
"Serviced": 1,
"State": "FL"
},
{
"AirportCode": "AM2",
"AirportName": "Amtrak BWI",
"AllowASAPRequests": true,
"AllowWMVRequests": true,

Page 125
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"City": "Baltimore",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "39.1924",
"Longitude": "-76.6943",
"PortType": "2",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "AM3",
"AirportName": "Baltimore Penn Station",
"AllowASAPRequests": true,
"AllowWMVRequests": true,
"City": "Baltimore",
"Country": "United States of America",
"CountryCode": "US",
"ECARServiced": true,
"Latitude": "39.3074",
"Longitude": "-76.6156",
"PortType": "2",
"Serviced": 1,
"State": "CA"
},
{
"AirportCode": "SP1",
"AirportName": "London St Pancras Train Station",
"City": "London",
"Country": "United Kingdom",
"CountryCode": "UK",
"ECARServiced": true,
"IsAffiliate": true,
"Latitude": "51.5412",
"Longitude": "0.125",
"PortType": "2",
"Serviced": 1,
"State": ""
}
],
"EchoToken": "12345",
"PrimaryLangID": "en",
"Success": {},
"Target": "Test",

Page 126
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Version": "1.0.0"
}

XML Sample: Get Serviced Airports Request


<?xml version="1.0"encoding="UTF-8"?>
<UtilityGetServicedAirportsRQ
EchoToken=""Target="Test"Version="2.0.0"PrimaryLangID="en" />
XML Sample: Get Serviced Airports Response
Note: In this example, only the first two airports returned are shown.
<UtilityGetServicedAirportsRS
EchoToken=""Target="Test"Version="2.0.0"PrimaryLangID="en">
<Success />
<Airports>
<Airport Latitude="35.049625"Longitude="-106.617195">
<AirportCode>ABQ</AirportCode>
<AirportName>Albuquerque, New Mexico</AirportName>
<AllowASAPRequests>false</AllowASAPRequests>
<AllowChildSeatInput>false</AllowChildSeatInput>
<AllowInfantSeatInput>false</AllowInfantSeatInput>
<AllowWMVRequests>false</AllowWMVRequests>
<CountryCode>US</CountryCode>
<ECARServiced>true</ECARServiced>
<IsAffiliate>true</IsAffiliate>
<IsDefaultAirport>false</IsDefaultAirport>
<PortType>0</PortType>
<Serviced>1</Serviced>
</Airport>
<Airport Latitude="33.63672"Longitude="-84.428066">
<AirportCode>ATL</AirportCode>
<AirportName>Atlanta, Georgia</AirportName>
<AllowASAPRequests>false</AllowASAPRequests>
<AllowChildSeatInput>false</AllowChildSeatInput>
<AllowInfantSeatInput>false</AllowInfantSeatInput>
<AllowWMVRequests>false</AllowWMVRequests>
<CountryCode>US</CountryCode>
<ECARServiced>true</ECARServiced>
<IsAffiliate>true</IsAffiliate>
<IsDefaultAirport>false</IsDefaultAirport>
<PortType>0</PortType>
<Serviced>1</Serviced>
</Airport>
</Airports>
</UtilityGetServicedAirportsRS>

Page 127
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Get a List of SuperShuttle Locations


The GetLocationList request returns a list of SuperShuttle locations.
Service location:
XML: https://apitest.vtod.com/2.0.0/Rest/Utility/GetLocationList?media=xml
JSON: https://apitest.vtod.com/2.0.0/Rest/Utility/GetLocationList

JSON Sample: Get Location List Request


{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en"
}
JSON Sample: Get Location List Response
Note: In this example, only the first two locations returned are shown.
{
"EchoToken": "",
"Locations": [
{
"Address": {
"LocationName": "Austin, TX"
},
"ID": 1
},
{
"Address": {
"LocationName": "Boulder, CO"
},
"ID": 19
}]
}
XML Sample: Get Location List Request
<?xml version="1.0"encoding="UTF-8"?>
<UtilityGetLocationListRQ
EchoToken=""Target="Test"Version="2.0.0"PrimaryLangID="en" />
XML Sample: Get Location List Response
Note: In this example, only the first two locations returned are shown.

Page 128
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<UtilityGetLocationListRS
EchoToken=""Target="Test"Version="2.0.0"PrimaryLangID="en">
<Locations>
<Location>
<ID>1</ID>
<Address>
<LocationName>Austin, TX</LocationName>
</Address>
</Location>
<Location>
<ID>19</ID>
<Address>
<LocationName>Boulder, CO</LocationName>
</Address>
</Location>
</Locations>
<Success />
</UtilityGetLocationListRS>

Get a List of Hotels and Landmarks for a


SuperShuttle Location
The SearchLocation request is dependant on the result from the GetLocationsList response.
The SearchLocation response includes a list of hotels and landmarks based on the location
IDs returned from the GetLocationsList request. See Get a List of SuperShuttle Locations.
Service location:
XML: https://apitest.vtod.com/2.0.0/Rest/Utility/SearchLocation?media=xml
JSON: https://apitest.vtod.com/2.0.0/Rest/Utility/SearchLocation

JSON Sample: Search Location Request


{
"LocationId": 13,
"SearchExpression": "Hilton",
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en"
}
JSON Sample: Search Location Response
{

Page 129
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"EchoToken": "",
"Locations": [
{
"Address": {
"AddressLine": "4th St",
"CityName": "Santa Monica",
"CountryName": {
"Code": "US"
},
"Latitude": "34.011951",
"LocationName": "Doubletree by Hilton SM",
"Longitude": "-118.489810",
"PostalCode": "90401",
"StateProv": {
"StateCode": "CA"
},
"StreetNmbr": "1707"
},
"Telephone": {
"CountryAccessCode": "",
"PhoneNumber": "3103953332"
}
}]
}
XML Sample: Search Location Request
<?xml version="1.0"encoding="UTF-8"?>
<UtilitySearchLocationRQ
EchoToken=""Target="Test"Version="2.0.0"PrimaryLangID="en">
<LocationId>13</LocationId>
<SearchExpression>Hilton</SearchExpression>
</UtilitySearchLocationRQ>
XML Sample: Search Location Response
<UtilitySearchLocationRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<Locations>
<Location>
<Address Latitude="34.011951" Longitude="-118.489810">
<StreetNmbr>1707</StreetNmbr>
<AddressLine>4th St</AddressLine>
<CityName>Santa Monica</CityName>
<PostalCode>90401</PostalCode>
<LocationName>Doubletree by Hilton SM</LocationName>
<StateProv StateCode="CA" />
<CountryName Code="US" />
</Address>

Page 130
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Telephone CountryAccessCode="" PhoneNumber="3103953332" />


</Location>
</Locations>
<Success />
</UtilitySearchLocationRS>

ExecuCar XML Samples


The following samples are specific to ExecuCar (black car) services.

XML Sample: ExecuCar Ground Availability Request To the Airport


<OTA_GroundAvailRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS> <Service>
<Pickup DateTime="2014-01-29T02:59:45">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123" CodeContext="Domestic"
FlightDateTime="2013-11-30 21:15"/>
</Dropoff> </Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<PassengerPrefs MeetAndGreetInd="false"/>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="15%"/>

Page 131
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions>
</OTA_GroundAvailRQ>

XML Sample: ExecuCar Ground Availability Response - To the Airport


<OTA_GroundAvailRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service>
<ServiceLevel Code="ATF"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="Standard Sedan"
Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="59.00" Quantity="1" MaxQuant-
ity="1" Total="59.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="3" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="8.85" Quantity="1" MaxQuant-
ity="1" Total="8.85"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="67.85"/>
<Reference ID="27700">
<TPA_Extensions>
<MaxPassengers>4</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014

Page 132
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="AllowPickup"/>


</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service>
<ServiceLevel Code="SUV"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="Standard SUV"
Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="80.00" Quantity="1" MaxQuant-
ity="1" Total="80.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="5" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="12.00" Quantity="1" MaxQuant-
ity="1" Total="12.00"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="92.00"/>
<Reference ID="152698">
<TPA_Extensions>
<MaxPassengers>6</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="MinAd-
vanceNoticeExceeded" Description="The reservation cannot be completed online,
call us directly for assistance 800-258-3826."/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>

Page 133
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<GroundService>
<Service>
<ServiceLevel Code="VEC"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar Van Service (Up to 10
passengers)" Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="99.00" Quantity="1" MaxQuant-
ity="1" Total="99.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="9" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="14.85" Quantity="1" MaxQuant-
ity="1" Total="14.85"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="113.85"/>
<Reference ID="113658">
<TPA_Extensions>
<MaxPassengers>10</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="MinAd-
vanceNoticeExceeded" Description="The reservation cannot be completed online,
call us directly for assistance 800-258-3826."/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.

Page 134
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Entering a value with no percentage symbol (ex. value="20") indicates the


value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="15%"/>
</RateQualifier>
</OTA_GroundAvailRS>

XML Sample: ExecuCar Ground Availability Request - Between Non-Airport Loca-


tions
<OTA_GroundAvailRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Service>
<Pickup DateTime="2014-01-29T02:18:51">
<Address Latitude="33.475654" Longitude="-112.188643">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<Address Latitude="33.479324" Longitude="-112.221352">
<AddressLine>2820 N 75th Ave</AddressLine>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>Business</LocationType>
</Address>
</Dropoff>
</Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<PassengerPrefs MeetAndGreetInd="false"/>
<RateQualifier RateQualifier="ExecuCar">
<SpecialInputs Name="Gratuity" Value="12.56"/>
</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>

Page 135
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

</TPA_Extensions>
</OTA_GroundAvailRQ>

XML Sample: ExecuCar Ground Availability Response - Between Non-Airport Loca-


tions
<OTA_GroundAvailRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service>
<ServiceLevel Code="ECH" SourceName="PHX"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar Sedan Service (Up to 4
passengers)" Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="BaseRate" FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="55.00" Quantity="1" MaxQuant-
ity="1" Total="55.00"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="7.15" Quantity="1" MaxQuant-
ity="1" Total="7.15"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="62.15"/>
<Reference ID="1">
<TPA_Extensions>
<MaxPassengers>4</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:18:51 AM" Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex.

Page 136
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

value="20%") indicates the gratuity is calculated as a percentage of the


total. Entering a value with no percentage symbol (ex. value="20") indicates
the value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="12.56"/>
</RateQualifier></OTA_GroundAvailRS>

XML Sample: ExecuCar Ground Availability Request - From the Airport


<OTA_GroundAvailRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Service>
<Pickup>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="551" CodeContext="Domestic"
FlightDateTime="2014-01-29T02:59:45"/>
</Pickup>
<Dropoff>
<Address Latitude="33.475654" Longitude="-112.188643">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Dropoff>
</Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions>
</OTA_GroundAvailRQ>

Page 137
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

XML Sample: ExecuCar Ground Availability Response - From the Airport


<OTA_GroundAvailRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service>
<ServiceLevel Code="EWC"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="Standard Sedan"
Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="48.00" Quantity="1" MaxQuant-
ity="1" Total="48.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="3" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="9.60" Quantity="1" MaxQuant-
ity="1" Total="9.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="57.60"/>
<Reference ID="28039">
<TPA_Extensions>
<MaxPassengers>4</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>

Page 138
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Service>
<ServiceLevel Code="EMG"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="Meet &amp; Greet Sedan"
Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="73.00" Quantity="1" MaxQuant-
ity="1" Total="73.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="3" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="14.60" Quantity="1" MaxQuant-
ity="1" Total="14.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="87.60"/>
<Reference ID="27903">
<TPA_Extensions>
<MaxPassengers>4</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service>
<ServiceLevel Code="SUW"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar SUV Will Call (Up to 6

Page 139
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Passengers)call upon arrival" Code="Fare">Other_</Category>


</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="74.00" Quantity="1" MaxQuant-
ity="1" Total="74.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="5" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="14.80" Quantity="1" MaxQuant-
ity="1" Total="14.80"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="88.80"/>
<Reference ID="341293">
<TPA_Extensions>
<MaxPassengers>6</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="MinAd-
vanceNoticeExceeded" Description="The reservation cannot be completed online,
call us directly for assistance 800-258-3826."/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service>
<ServiceLevel Code="SUM"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="Meet &amp; Greet SUV"
Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>

Page 140
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Calculation UnitCharge="99.00" Quantity="1" MaxQuant-


ity="1" Total="99.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="5" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="19.80" Quantity="1" MaxQuant-
ity="1" Total="19.80"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="118.80"/>
<Reference ID="152923">
<TPA_Extensions>
<MaxPassengers>6</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="MinAd-
vanceNoticeExceeded" Description="The reservation cannot be completed online,
call us directly for assistance 800-258-3826."/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service>
<ServiceLevel Code="VMG"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar Van Service Meet and
Greet (Up to 10 Passengers)" Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"
FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="170.00" Quantity="1" MaxQuant-
ity="1" Total="170.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"

Page 141
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0"
MaxQuantity="9" Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="34.00" Quantity="1" MaxQuant-
ity="1" Total="34.00"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="204.00"/>
<Reference ID="114006">
<TPA_Extensions>
<MaxPassengers>10</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="1/29/2014
2:59:45 AM" EndDateTime="1/29/2014 3:14:45 AM" Status="MinAd-
vanceNoticeExceeded" Description="The reservation cannot be completed online,
call us directly for assistance 800-258-3826."/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
</OTA_GroundAvailRS>

XML Sample: ExecuCar Ground Booking Request - To the Airport


<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference Type="Confirmation" ID="27700"/>
<GroundReservation>
<Passenger>
<Primary>
<PersonName>

Page 142
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001"
AreaCityCode="602" PhoneNumber="555-1234"/>
<Email>janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="1/29/2014 2:59:45 AM">
<Address Latitude="33.475609" Lon-
gitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123" CodeContext="Domestic"
FlightDateTime="2013-11-30 21:15"/>
</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="15%"/>
</RateQualifier>
</GroundReservation>
<Payments>
<Payment>
<DirectBill ID="20319" BillingNumber="001SUPEF"/>
</Payment>
</Payments>
<TPA_Extensions>

Page 143
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<PickMeUpNow>false</PickMeUpNow>
<MemberID>1054462</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions>
</OTA_GroundBookRQ>

XML Sample: ExecuCar Ground Booking Response - To the Airport


<OTA_GroundBookRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<Confirmation ID="2179">
<TPA_Extensions>
<Confirmations>
<Confirmation Type="DispatchConfirmation"
ID="5902953"/>
</Confirmations>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602"
PhoneNumber="5551234"/>
<Email
ShareMarketInd="false">janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service>
<Location>
<Pickup DateTime="1/29/2014 2:59:45 AM">
<Address Latitude="33.475609" Longitude="-
112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<LocationType>HomeResidence</LocationType>
<StateProv StateCode="AZ"/>

Page 144
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<CountryName Code="US"/>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123"
FlightDateTime="2013-11-30 21:15" CodeContext="Domestic"/>
</Dropoff>
</Location>
</Service>
</Reservation>
</OTA_GroundBookRS>

XML Sample: ExecuCar Ground Booking Request - From the Airport


<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference Type="Confirmation" ID="28039"/>
<GroundReservation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001"
AreaCityCode="602" PhoneNumber="555-1234"/>
<Email>janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="1/29/2014 2:59:45 AM">
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="WN" FlightNumber="551"
CodeContext="Domestic" FlightDateTime="2014-02-28 21:15"/>
</Pickup>
<Dropoff>
<Address Latitude="33.475654" Longitude="-112.188643">

Page 145
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<AddressLine>8930 S Beck Ave</AddressLine>


<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
</GroundReservation>
<Payments>
<Payment>
<PaymentCard ExpireDate="11/30/2016">
<CardHolderName>Jane Test</CardHolderName>
<CardType
Description="MasterCard">MC</CardType>
<CardNumber>
<PlainText>5555555555554444</PlainText>
<LastFourDigit>4444</LastFourDigit>
</CardNumber>
</PaymentCard>
</Payment>
</Payments>
<TPA_Extensions>
<Source>zTrip</Source>
<Device>iPhone</Device>
<PickMeUpNow>false</PickMeUpNow>
<MemberID>1096512</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions>
</OTA_GroundBookRQ>

XML Sample: ExecuCar Ground Booking Response - From the Airport


<OTA_GroundBookRS EchoToken="" Target="Test" Version="2.0.0"

Page 146
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<Confirmation ID="2175">
<TPA_Extensions>
<Confirmations>
<Confirmation Type="DispatchConfirmation"
ID="5902949"/>
</Confirmations>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602"
PhoneNumber="5551234"/>
<Email
ShareMarketInd="false">janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service>
<Location>
<Pickup DateTime="1/29/2014 2:59:45 AM">
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="WN" FlightNumber="551"
FlightDateTime="2014-02-28 21:15" CodeContext="Domestic"/>
</Pickup>
<Dropoff>
<Address Latitude="33.475654" Longitude="-
112.188643">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<LocationType>HomeResidence</LocationType>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Dropoff>
</Location>

Page 147
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

</Service>
</Reservation>
</OTA_GroundBookRS>

XML Sample: ExecuCar Ground Booking Request - Between Non-Airport Locations


<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference Type="Confirmation" ID="1"/>
<GroundReservation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<Email>janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="1/29/2014 2:18:51 AM">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<Address Latitude="33.479324" Longitude="-112.221352">
<AddressLine>2820 N 75th Ave</AddressLine>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>Business</LocationType>
</Address>

Page 148
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="ExecuCar">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="12.56"/>
</RateQualifier>
</GroundReservation>
<Payments>
<Payment>
<DirectBill ID="20319" BillingNumber="001SUPEF"/>
</Payment> </Payments> <TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
<MemberID>1096512</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions>
</OTA_GroundBookRQ>

XML Sample: ExecuCar Ground Booking Response - Between Airport Locations


<OTA_GroundBookRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<Confirmation ID="2174">
<TPA_Extensions>
<Confirmations>
<Confirmation Type="DispatchConfirmation"
ID="5902948"/>
</Confirmations>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602"

Page 149
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

PhoneNumber="5551234"/>
<Email
ShareMarketInd="false">janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service>
<Location>
<Pickup DateTime="1/29/2014 2:18:51 AM">
<Address Latitude="33.475609" Longitude="-
112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<LocationType>HomeResidence</LocationType>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Pickup>
<Dropoff>
<Address Latitude="33.479324" Longitude="-
112.221352">
<AddressLine>2820 N 75th Ave</AddressLine>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<LocationType>Business</LocationType>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Dropoff>
</Location>
</Service>
</Reservation>
</OTA_GroundBookRS>

XML Sample: ExecuCar Ground Cancellation Request - Between Non-Airport Loca-


tions
<OTA_GroundCancelRQ EchoToken="" Target="Test|Production" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reservation CancelType="Cancel">
<UniqueID Type="DispatchConfirmation" ID="5902948"/>
<Verification>

Page 150
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<TelephoneInfo CountryAccessCode="1" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<AddressInfo>
<PostalCode>85035</PostalCode>
</AddressInfo>
</Verification>
</Reservation>
<TPA_Extensions>
<RateQualifier RateQualifier="ExecuCar"/>
</TPA_Extensions>
</OTA_GroundCancelRQ>

XML Sample: ExecuCar Ground Cancellation Response - Between Non-Airport


Locations
<OTA_GroundCancelRS EchoToken="" Target="Test|Production" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<CancelConfirmation>
<UniqueID Type="DispatchConfirmation" ID="5902948"/>
</CancelConfirmation>
</Reservation>
</OTA_GroundCancelRS>

ExecuCar JSON Samples


The following samples are specific to ExecuCar (black car) services.

JSON Sample: ExecuCar Ground Availability Request - To the Airport


{
"EchoToken": "12345",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",

Page 151
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 1,
"Category": {
"Value": "Adult"
}
}
],
"PassengerPrefs": {},
"RateQualifiers": [
{
"RateQualifierValue": "ExecuCar",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false
},
"References": [],
"Service": {
"Pickup": {
"DateTime": "11/30/2013 5:25:00 PM",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {

Page 152
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Dropoff": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2013-11-30 21:15",
"CodeContext": "Domestic"
}
}
}
}

JSON Sample: ExecuCar Ground Availability Response - To the Airport


{
"EchoToken": "12345",
"GroundServices": {
"GroundServices": [
{
"Fees": [],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "ExecuCar Sedan Service (Up to 4 passengers)",
"Value": "Other_"
}
},
"Reference": {
"ID": "27700",
"TPA_Extensions": {
"MaxPassengers": 4,
"PickupTimes": {
"PickupTimes": [
{

Page 153
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"EndDateTime": "12/30/2013 5:40:00 PM",


"StartDateTime": "12/30/2013 5:25:00 PM",
"Status": "AllowPickup"
}
]
}
}
},
"Service": {
"ServiceLevel": {
"Code": "ATF",
"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 59.0,
"UnitCharge": 59.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 3
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],

Page 154
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"TotalCharge": {
"RateTotalAmount": 59.0
}
},
{
"Fees": [],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "ExecuCar SUV Service (Up to 6 passengers)",
"Value": "Other_"
}
},
"Reference": {
"ID": "152698",
"TPA_Extensions": {
"MaxPassengers": 6,
"PickupTimes": {
"PickupTimes": [
{
"EndDateTime": "12/30/2013 5:40:00 PM",
"StartDateTime": "12/30/2013 5:25:00 PM",
"Status": "AllowPickup"
}
]
}
}
},
"Service": {
"ServiceLevel": {
"Code": "SUV",
"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 80.0,

Page 155
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"UnitCharge": 80.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 5
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"RateTotalAmount": 80.0
}
},
{
"Fees": [],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "ExecuCar Van Service (Up to 10 passengers)",
"Value": "Other_"
}
},
"Reference": {
"ID": "113658",
"TPA_Extensions": {
"MaxPassengers": 10,
"PickupTimes": {
"PickupTimes": [
{
"EndDateTime": "12/30/2013 5:40:00 PM",
"StartDateTime": "12/30/2013 5:25:00 PM",
"Status": "AllowPickup"
}

Page 156
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

]
}
}
},
"Service": {
"ServiceLevel": {
"Code": "VEC",
"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 99.0,
"UnitCharge": 99.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 9
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"RateTotalAmount": 99.0
}
}

Page 157
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

]
},
"PrimaryLangID": "en",
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: ExecuCar Ground Availability Request - Between Non-Airport Loca-


tions
{
"EchoToken": "12345",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 1,
"Category": {
"Value": "Adult"
}
}
],
"PassengerPrefs": {},
"RateQualifiers": [
{
"RateQualifierValue": "ExecuCar",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],

Page 158
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"RateQualifiers": [],
"PickMeUpNow": false
},
"References": [],
"Service": {
"Pickup": {
"DateTime": "12/20/2014 5:25:00 PM",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475654",
"Longitude": "-112.188643"
}
},
"Dropoff": {
"Address": {
"AddressLine": "2820 N 75th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "Business"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.479324",
"Longitude": "-112.221352"
}
}
}
}

Page 159
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

JSON Sample: ExecuCar Ground Availability Response - Between Non-Airport Loca-


tions
{
"GroundServices": {
"GroundServices": [
{
"Fees": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 1.88,
"UnitCharge": 1.88
}
],
"ChargePurpose": {
"Value": "Gratuity"
},
"Description": "Gratuity"
}
],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "Sedan (4 Pax)",
"Value": "Other_"
}
},
"Reference": {
"ID": "1",
"TPA_Extensions": {
"ImageURL": "//www.su-
pershuttle.com/cdn/reservations/images/execucar/en/ECH.jpg",
"MaxPassengers": 4,
"PickupTimes": {
"PickupTimes": [
{
"Description": "The reservation cannot be completed online,
call Supper Shuttle directly for assistance.",
"StartDateTime": "12/20/2014 5:25:00 PM",
"Status": "PickupExpired"

Page 160
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}
]
}
}
},
"Service": {
"ServiceLevel": {
"Code": "ECH",
"SourceName": "PHX"
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 15.0,
"UnitCharge": 15.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "BaseRate"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 16.88,
"RateTotalAmount": 16.88
}
}
]
},
"RateQualifiers": [
{
"RateQualifierValue": "ExecuCar",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"

Page 161
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}
]
}
],
"Success": {},
"Version": "2.0.0"
}

JSON Sample: ExecuCar Ground Availability Request - From the Airport


{
"EchoToken": "12345",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 1,
"Category": {
"Value": "Adult"
}
}
],
"RateQualifiers": [
{
"RateQualifierValue": "ExecuCar",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false

Page 162
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

},
"References": [],
"Service": {
"Pickup": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2014-12-28 21:15",
"CodeContext": "Domestic"
}
},
"Dropoff": {
"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"PostalCode": "85284",
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475654",
"Longitude": "-112.188643"
}
}
}
}

JSON Sample: ExecuCar Ground Availability Response - From the Airport


{
"GroundServices": {
"GroundServices": [
{
"Fees": [
{
"Calculations": [
{
"MaxQuantity": 1,

Page 163
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Quantity": 1,
"Total": 5.76,
"UnitCharge": 5.76
}
],
"ChargePurpose": {
"Value": "Gratuity"
},
"Description": "Gratuity"
}
],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "Sedan (4 Pax)",
"Value": "Other_"
}
},
"Reference": {
"ID": "28039",
"TPA_Extensions": {
"ImageURL": "//www.su-
pershuttle.com/cdn/reservations/images/execucar/en/EWC.jpg",
"MaxPassengers": 4,
"PickupTimes": {
"PickupTimes": [
{
"Description": "The reservation cannot be completed online,
call Supper Shuttle directly for assistance.",
"EndDateTime": "12/28/2014 9:30:00 PM",
"StartDateTime": "12/28/2014 9:15:00 PM",
"Status": "PickupExpired"
}
]
},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Please call 1 (602) 232-4606 upon arrival. From Terminals
2, 3 or 4, follow the signs to the Courtesy & Prearranged designated pick up
location situated on the center island.",
"ServiceLevel": {
"Code": "EWC",

Page 164
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 48.0,
"UnitCharge": 48.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 3
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 53.76,
"RateTotalAmount": 53.76
}
},
{
"Fees": [
{
"Calculations": [
{
"MaxQuantity": 1,

Page 165
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Quantity": 1,
"Total": 8.16,
"UnitCharge": 8.16
}
],
"ChargePurpose": {
"Value": "Gratuity"
},
"Description": "Gratuity"
}
],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "SUV (6 Pax)",
"Value": "Other_"
}
},
"Reference": {
"ID": "341293",
"TPA_Extensions": {
"ImageURL": "//www.su-
pershuttle.com/cdn/reservations/images/execucar/en/SUW.jpg",
"MaxPassengers": 6,
"PickupTimes": {
"PickupTimes": [
{
"Description": "The reservation cannot be completed online,
call Supper Shuttle directly for assistance.",
"EndDateTime": "12/28/2014 9:30:00 PM",
"StartDateTime": "12/28/2014 9:15:00 PM",
"Status": "PickupExpired"
}
]
},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Please call 1 (602) 232-4606 upon arrival. From Terminals
2, 3 or 4, follow the signs to the Courtesy & Prearranged designated pick up
location situated on the center island.",
"ServiceLevel": {
"Code": "SUW",

Page 166
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 68.0,
"UnitCharge": 68.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 5
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 76.16,
"RateTotalAmount": 76.16
}
},
{
"Fees": [
{
"Calculations": [
{
"MaxQuantity": 1,

Page 167
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Quantity": 1,
"Total": 8.76,
"UnitCharge": 8.76
}
],
"ChargePurpose": {
"Value": "Gratuity"
},
"Description": "Gratuity"
}
],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "Sedan Meet & Greet (4 Pax)",
"Value": "Other_"
}
},
"Reference": {
"ID": "27903",
"TPA_Extensions": {
"ImageURL": "//www.su-
pershuttle.com/cdn/reservations/images/execucar/en/EMG.jpg",
"MaxPassengers": 4,
"PickupTimes": {
"PickupTimes": [
{
"Description": "The reservation cannot be completed online,
call Supper Shuttle directly for assistance.",
"EndDateTime": "12/28/2014 9:30:00 PM",
"StartDateTime": "12/28/2014 9:15:00 PM",
"Status": "PickupExpired"
}
]
},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Upon landing, please follow the signs to the baggage
claim. Your driver will meet you at the baggage claim with a sign displaying
your name. If for any reason you need assistance locating the driver, or if
you have any questions, please call 1 (602) 232-4606.",
"ServiceLevel": {

Page 168
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Code": "EMG",
"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 73.0,
"UnitCharge": 73.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 3
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 81.76,
"RateTotalAmount": 81.76
}
},
{
"Fees": [
{
"Calculations": [
{

Page 169
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"MaxQuantity": 1,
"Quantity": 1,
"Total": 11.16,
"UnitCharge": 11.16
}
],
"ChargePurpose": {
"Value": "Gratuity"
},
"Description": "Gratuity"
}
],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "SUV Meet & Greet (6 Pax)",
"Value": "Other_"
}
},
"Reference": {
"ID": "152923",
"TPA_Extensions": {
"ImageURL": "//www.su-
pershuttle.com/cdn/reservations/images/execucar/en/SUM.jpg",
"MaxPassengers": 6,
"PickupTimes": {
"PickupTimes": [
{
"Description": "The reservation cannot be completed online,
call Supper Shuttle directly for assistance.",
"EndDateTime": "12/28/2014 9:30:00 PM",
"StartDateTime": "12/28/2014 9:15:00 PM",
"Status": "PickupExpired"
}
]
},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Upon landing, please follow the signs to the baggage
claim. Your driver will meet you at the baggage claim with a sign displaying
your name. If for any reason you need assistance locating the driver, or if
you have any questions, please call 1 (602) 232-4606.",

Page 170
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"ServiceLevel": {
"Code": "SUM",
"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 93.0,
"UnitCharge": 93.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 5
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 104.16,
"RateTotalAmount": 104.16
}
},
{
"Fees": [
{
"Calculations": [

Page 171
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 20.4,
"UnitCharge": 20.4
}
],
"ChargePurpose": {
"Value": "Gratuity"
},
"Description": "Gratuity"
}
],
"RateQualifier": {
"Category": {
"Code": "Fare",
"Description": "Van Meet & Greet (10 Pax)",
"Value": "Other_"
}
},
"Reference": {
"ID": "114006",
"TPA_Extensions": {
"ImageURL": "//www.su-
pershuttle.com/cdn/reservations/images/execucar/en/VMG.jpg",
"MaxPassengers": 10,
"PickupTimes": {
"PickupTimes": [
{
"Description": "The reservation cannot be completed online,
call Supper Shuttle directly for assistance.",
"EndDateTime": "12/28/2014 9:30:00 PM",
"StartDateTime": "12/28/2014 9:15:00 PM",
"Status": "PickupExpired"
}
]
},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Upon landing, please follow the signs to the baggage
claim. Your driver will meet you at the baggage claim with a sign displaying
your name. If for any reason you need assistance locating the driver, or if

Page 172
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

you have any questions, please call 1 (602) 232-4606.",


"ServiceLevel": {
"Code": "VMG",
"SourceName": null
},
"VehicleType": {
"Code": "ECAR"
}
},
"ServiceCharges": [
{
"Calculations": [
{
"MaxQuantity": 1,
"Quantity": 1,
"Total": 170.0,
"UnitCharge": 170.0
}
],
"ChargePurpose": {
"Value": "BaseRate"
},
"Description": "FirstPassengerFare"
},
{
"Calculations": [
{
"MaxQuantity": 9
}
],
"ChargePurpose": {
"Value": "AdditionalPassengers"
},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 190.4,
"RateTotalAmount": 190.4
}
}
]
},
"RateQualifiers": [

Page 173
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

{
"RateQualifierValue": "ExecuCar",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],
"Success": {},
"Version": "2.0.0"
}

JSON Sample: ExecuCar Ground Booking Request - To the Airport


{
"EchoToken": "12345",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"References": [
{
"ID": "27700"
}
],
"GroundReservations": [
{
"Passenger": {
"Primary": {
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [
{
"CountryAccessCode": "001",
"AreaCityCode": "602",

Page 174
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"PhoneNumber": "555-1234"
}
],
"Emails": [
{
"Value": "a@aa.aa"
}
]
}
},
"Service": {
"Location": {
"Pickup": {
"DateTime": "2013-12-08 21:15",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Dropoff": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"FlightDateTime": "2013-12-08 21:15",
"CodeContext": "Domestic"
}
}
}
},

Page 175
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"RateQualifiers": [
{
"RateQualifierValue": "ExecuCar",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
]
}
],
"Payments": {
"Payments": [
{
"PaymentCard": {
"ExpireDate": "11/30/2016",
"CardType": {
"Value": "MC",
"Description": "MasterCard"
},
"CardHolderName": "Joe Hogen",
"CardNumber": {
"ID": "213571",
"EncryptedValue": "tNR8Vc6WxW4Yzo3Q4aj2xHLzikHYwwnu"
}
}
}
]
},
"TPA_Extensions":{
"Passengers":[
{
"Quantity":1,
"Category":{
"Value":"Adult"
}
}
],
"Confirmations":[

],
"MemberID":"1077186",

Page 176
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"RateQualifiers":[

],
"Source":"zTrip",
"Device":"iPhone",
"PickMeUpNow":false
}
}

JSON Sample: ExecuCar Ground Booking Response - To the Airport


{
"EchoToken": "12345",
"PrimaryLangID": "en",
"Reservations": [
{
"Confirmation": {
"ID": "478",
"TPA_Extensions": {
"Confirmations": [
{
"ID": "5194332",
"Type": "DispatchConfirmation"
}
]
}
},
"Passenger": {
"Primary": {
"Emails": [],
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [
{
"AreaCityCode": "602",
"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}
]
}
},
"Service": {
"Location": {

Page 177
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Dropoff": {
"Airline": {
"Code": "WN",
"CodeContext": "Domestic",
"FlightDateTime": "2013-12-30 21:15",
"FlightNumber": "551"
},
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
}
},
"Pickup": {
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"CountryName": {
"Code": "US"
},
"LocationType": {
"Value": "HomeResidence"
},
"PostalCode": "85035",
"StateProv": {
"StateCode": "AZ"
}
},
"DateTime": "12/30/2013 5:25:00 PM"
}
}
}
}
],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: ExecuCar Ground Booking Request - Between Non-Airport Loca-


tions
{
"EchoToken": "12345",

Page 178
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}},
"References": [{"ID": "1"}],
"GroundReservations": [ {
"Passenger": {"Primary": {
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [ {
"CountryAccessCode": "1",
"AreaCityCode": "647",
"PhoneNumber": "253-4966"
}],
"Emails": [{"Value": "iriunprzac@test.com"}],
"Addresses": []
}},
"Service": {"Location": {
"Pickup": {
"DateTime": "06/30/2015 10:55:39 AM",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {"Value": "HomeResidence"},
"StateProv": {"StateCode": "AZ"},
"CountryName": {"Code": "US"},
"Latitude": "33.475654",
"Longitude": "-112.188643"
}
},
"Dropoff": {"Address": {
"AddressLine": "2820 N 75th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {"Value": "Business"},
"StateProv": {"StateCode": "AZ"},
"CountryName": {"Code": "US"},
"Latitude": "33.479324",

Page 179
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Longitude": "-112.221352"
}}
}},
"RateQualifiers": [ {
"RateQualifierValue": "ExecuCar",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%17.0"
}]
}]
}],
"Payments": {"Payments": [{"DirectBill": {
"ID": "20319",
"BillingNumber": "001SUPEF"
}}]},
"TPA_Extensions": {
"ReferrerMemberID" : "1301513",
"ReferrerCreditAmount" : "100.6",
"Passengers": [ {
"Quantity": "2",
"Category": {"Value": "Adult"}
}],
"Confirmations": [],
"MemberID": "1301526",
"RateQualifiers": [],
"PickMeUpNow": "false"
}
}

JSON Sample: ExecuCar Ground Booking Response - Between Non-Airport Loca-


tions
{
"EchoToken": "12345",
"PrimaryLangID": "en",
"Reservations": [
{
"Confirmation": {
"ID": "240",
"TPA_Extensions": {
"Confirmations": [
{
"ID": "4766283",
"Type": "DispatchConfirmation"
}

Page 180
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

]
}
},
"Passenger": {
"Primary": {
"Emails": [],
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [
{
"AreaCityCode": "602",
"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}
]
}
},
"Service": {
"Location": {
"Dropoff": {
"Address": {
"AddressLine": "2820 N 75th Ave",
"CityName": "Phoenix",
"CountryName": {
"Code": "US"
},
"LocationType": {
"Value": "Business"
},
"PostalCode": "85035",
"StateProv": {
"StateCode": "AZ"
}
}
},
"Pickup": {
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"CountryName": {
"Code": "US"
},

Page 181
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"LocationType": {
"Value": "HomeResidence"
},
"PostalCode": "85035",
"StateProv": {
"StateCode": "AZ"
}
},
"DateTime": "10/20/2013 5:25:00 PM"
}
}
}
}
],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: ExecuCar Ground Booking Request - From the Airport


{
"EchoToken":"12345",
"Target":"Test",
"Version":"2.0.0",
"PrimaryLangID":"en",
"POS":{
"Source":{
"ISOCountry":"US",
"ISOCurrency":"USD"
}
},
"References":[
{
"ID":"27903"
}
],
"GroundReservations":[
{
"Passenger":{
"Primary":{
"PersonName":{
"GivenName":"Test",
"Surname":"Test"
},

Page 182
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Telephones":[
{
"CountryAccessCode":"001",
"AreaCityCode":"602",
"PhoneNumber":"555-1234"
}
],
"Emails":[
{
"Value":"a@aa.aa"
}
]
}
},
"Service":{
"Location":{
"Pickup":{
"DateTime":"12/28/2013 9:15:00 PM",
"AirportInfo":{
"Arrival":{
"LocationCode":"PHX"
}
},
"Airline":{
"Code":"WN",
"FlightNumber":"551",
"FlightDateTime":"2013-12-28 21:15",
"CodeContext":"Domestic"
}
},
"Dropoff":{
"Address":{
"AddressLine":"8930 S Beck Ave",
"CityName":"Tempe",
"PostalCode":"85284",
"LocationType":{
"Value":"HomeResidence"
},
"StateProv":{
"StateCode":"AZ"
},
"CountryName":{
"Code":"US"
},

Page 183
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Latitude":"33.475654",
"Longitude":"-112.188643"
}
}
}
},
"RateQualifiers":[
{
"RateQualifierValue":"ExecuCar",
"SpecialInputs":[
{
"Name":"Gratuity",
"Value":"%12.56"
}
]
}
]
}
],
"Payments":{
"Payments":[
{
"PaymentCard":{
"ExpireDate":"11/30/2016",
"CardType":{
"Value":"MC",
"Description":"MasterCard"
},
"CardHolderName":"Joe Hogen",
"CardNumber":{
"ID":"212424",
"EncryptedValue":"+u67EHGjm+JJzl89bbs6C+vJqZOgDGAh"
}
}
}
]
},
"TPA_Extensions":{
"Passengers":[
{
"Quantity":1,
"Category":{
"Value":"Adult"
}

Page 184
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}
],
"Confirmations":[

],
ReferrerMemberID : "1077186", // string
ReferrerCreditAmount : 15.50 //Decimal
"MemberID":"1077186",
"RateQualifiers":[

],
"Source":"zTrip 1.8",
"Device":"iPhone",
"PickMeUpNow":false
}
}

JSON Sample: ExecuCar Ground Booking Response - From the Airport


{
"EchoToken": "12345",
"PrimaryLangID": "en",
"Reservations": [
{
"Confirmation": {
"ID": "483",
"TPA_Extensions": {
"Confirmations": [
{
"ID": "5194334",
"Type": "DispatchConfirmation"
}
]
}
},
"Passenger": {
"Primary": {
"Emails": [],
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [
{
"AreaCityCode": "602",

Page 185
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}
]
}
},
"Service": {
"Location": {
"Dropoff": {
"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"CountryName": {
"Code": "US"
},
"LocationType": {
"Value": "HomeResidence"
},
"PostalCode": "85284",
"StateProv": {
"StateCode": "AZ"
}
}
},
"Pickup": {
"Airline": {
"Code": "WN",
"CodeContext": "Domestic",
"FlightDateTime": "2013-12-27 21:15",
"FlightNumber": "551"
},
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"DateTime": "12/27/2013 9:15:00 PM"
}
}
}
}
],
"Success": {},
"Target": "Test",

Page 186
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Version": "2.0.0"
}

JSON Sample: ExecuCar Ground Cancellation Request


{
"EchoToken": "12345",
"Target": "Test|Production",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Reservation": {
"CancelType": "Cancel",
"UniqueID": [
{
"Type": "Confirmation",
"ID": "330"
}
],
"Verification": {
"PersonName": {
"GivenName": "test",
"Surname": "test"
},
"TelephoneInfo": {
"CountryAccessCode": "1",
"AreaCityCode": "602",
"PhoneNumber": "5551234"
},
"AddressInfo": {
"PostalCode": "90031"
}
}
},
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [
{
"RateQualifierValue": "ExecuCar",

Page 187
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"SpecialInputs": []
}
]
}
}

JSON Sample: ExecuCar Ground Cancellation Response


{
"EchoToken": "12345",
"PrimaryLangID": "en",
"Reservation": {
"CancelConfirmation": {
"UniqueID": {
"ID": "330",
"Type": "Confirmation"
}
}
},
"Success": {},
"Target": "Test|Production",
"Version": "2.0.0"
}

SuperShuttle XML Samples


The following samples are specific to SuperShuttle (blue van) services.

XML Sample: SuperShuttle Ground Availability Request - To the Airport


<OTA_GroundAvailRQ EchoToken="" Target=" Test"Version="0.4.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US"ISOCurrency="USD"/>
</POS>
<Service>
<Pickup>
<Address Latitude="33.475609"Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>

Page 188
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline
Code="AA"FlightNumber="123"CodeContext="Domestic"FlightDateTime="2014-06-
21T10:48:18"/>
</Dropoff>
</Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<PassengerPrefs MeetAndGreetInd="false"/>
<RateQualifier RateQualifier="SuperShuttle">
<SpecialInputs Name="Gratuity"Value="%20"/>
</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions>
</OTA_GroundAvailRQ>

XML Sample: SuperShuttle Ground Availability Response - To the Airport


<OTA_GroundAvailRS EchoToken=""Target="Test"Version="0.4.0"PrimaryLangID="en"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.or-
g/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service>
<ServiceLevel Code="VAN"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Shared Ride Van Service (Up to 7 Passengers
in Party)"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation
UnitCharge="24.00"Quantity="1"MaxQuantity="1"Total="24.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation

Page 189
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Quantity="0"MaxQuantity="6"Total="0.00"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation
UnitCharge="4.80"Quantity="1"MaxQuantity="1"Total="4.80"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="28.80"/>
<Reference ID="14804">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="6/21/2014 8:58:18
AM"EndDateTime="6/21/2014 9:13:18 AM"Status="AllowPickup"/>
<PickupTime StartDateTime="6/21/2014 8:43:18
AM"EndDateTime="6/21/2014 8:58:18 AM"Status="AllowPickup"/>
<PickupTime StartDateTime="6/21/2014 8:28:18
AM"EndDateTime="6/21/2014 8:43:18 AM"Status="AllowPickup"/>
<PickupTime StartDateTime="6/21/2014 8:13:18
AM"EndDateTime="6/21/2014 8:28:18 AM"Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service>
<ServiceLevel Code="EXC"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Exclusive Non-Stop Van Service (up to 7 pas-
sengers)"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare"FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation
UnitCharge="65.00"Quantity="1"MaxQuantity="1"Total="65.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0"Quantity="0"MaxQuantity="6"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation

Page 190
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Quantity="1"MaxQuantity="1"Total="13.00"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="78.00"/>
<Reference ID="14803">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="6/21/2014 9:03:18
AM"EndDateTime="6/21/2014 9:18:18 AM"Status="AllowPickup"/>
<PickupTime StartDateTime="6/21/2014 8:48:18
AM"EndDateTime="6/21/2014 9:03:18 AM"Status="AllowPickup"/>
<PickupTime StartDateTime="6/21/2014 8:33:18
AM"EndDateTime="6/21/2014 8:48:18 AM"Status="AllowPickup"/>
<PickupTime StartDateTime="6/21/2014 8:18:18
AM"EndDateTime="6/21/2014 8:33:18 AM"Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="SuperShuttle">
<SpecialInputs Name="Gratuity"Value="%20"/>
</RateQualifier>
</OTA_GroundAvailRS>

XML Sample: SuperShuttle Ground Availability Request - Between Non-Airport


Locations
<OTA_GroundAvailRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS> <Service>
<Pickup DateTime="2014-02-11T01:47:28">
<Address Latitude="33.475654" Longitude="-112.188643">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>

Page 191
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Dropoff>
<Address Latitude="33.479324" Longitude="-112.221352">
<AddressLine>2820 N 75th Ave</AddressLine>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>Business</LocationType>
</Address>
</Dropoff>
</Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<PassengerPrefs MeetAndGreetInd="false"/>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="15%"/>
</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions>
</OTA_GroundAvailRQ>

XML Sample: SuperShuttle Ground Availability Response - Between Non-Airport


Locations
<OTA_GroundAvailRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service>
<ServiceLevel Code="ECH" SourceName="PHX"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="Sedan (4 Pax)" Code="Fare">Other_</Cat-
egory>
</RateQualifier>
<ServiceCharges Description="BaseRate" FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>

Page 192
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Calculation UnitCharge="55.00" Quantity="1" MaxQuantity="1"


Total="55.00"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="8.25" Quantity="1" MaxQuantity="1"
Total="8.25"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="63.25"/>
<Reference ID="1">
<TPA_Extensions>
<MaxPassengers>4</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="2/11/2014 1:47:28 AM"
Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="15%"/>
</RateQualifier>
</OTA_GroundAvailRS>

XML Sample: SuperShuttle Ground Availability Request - From the Airport


<OTA_GroundAvailRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Service>
<Pickup>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="551" CodeContext="Domestic"
FlightDateTime="2014-02-12T01:04:39"/>
</Pickup> <Dropoff>
<Address Latitude="33.475654" Longitude="-112.188643">

Page 193
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<AddressLine>8930 S Beck Ave</AddressLine>


<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Dropoff>
</Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions></OTA_GroundAvailRQ>

XML Sample: SuperShuttle Ground Availability Response - From the Airport


<OTA_GroundAvailRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service>
<ServiceLevel Code="VAN"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Shared Ride Van Service (Up to 7 Pas-
sengers in Party)" Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare" FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="23.00" Quantity="1" MaxQuantity="1"
Total="23.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"

Page 194
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="7.00" Quantity="0" MaxQuantity="6"
Total="0.00"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="4.60" Quantity="1" MaxQuantity="1"
Total="4.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="27.60"/>
<Reference ID="14973">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="2/12/2014 1:04:39 AM"
EndDateTime="2/12/2014 1:04:39 AM" Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service>
<ServiceLevel Code="EXC"/>
<VehicleType Code="BLUEV"/>
</Service> <RateQualifier>
<Category Description="Exclusive Non-Stop Van Service (up to 7
passengers)" Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare" FreeDistance="0">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="64.00" Quantity="1" MaxQuantity="1"
Total="64.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers"
FreeDistance="0">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="0" Quantity="0" MaxQuantity="6"
Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="12.80" Quantity="1" MaxQuantity="1"
Total="12.80"/>
<ChargePurpose>Gratuity</ChargePurpose>

Page 195
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

</Fees>
<TotalCharge RateTotalAmount="76.80"/>
<Reference ID="362613">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="2/12/2014 1:04:39 AM"
EndDateTime="2/12/2014 1:04:39 AM" Status="AllowPickup"/>
</PickupTimes>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
</OTA_GroundAvailRS>

XML Sample: SuperShuttle Ground Availability Request - Round-Trip


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Avail?media=xml HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml;charset=UTF-8
Username: MobileWeb
SecurityKey: 7a55db9a-8ddd-4a30-ae82-a00f0c1abc82
Content-Length: 1561
Host: apitest.vtod.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
<OTA_GroundAvailRQ EchoToken=""Target="Test"Version="2.0.0"PrimaryLangID="en">
<POS>
<Source ISOCountry="US"ISOCurrency="USD"/>
</POS>
<Service>
<Pickup DateTime="2015-04-19T12:32:46">
<Address Longitude="-112.188643"Latitude="33.475654">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>

Page 196
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<LocationType/>
<LocationName/>
</Address>
</Pickup>
<Stops>
<Stop>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline
Code="AA"FlightNumber="123"CodeContext="Domestic"FlightDateTime="2015-04-
19T14:32:46"/>
</Stop>
<Stop>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline
Code="AA"FlightNumber="123"CodeContext="Domestic"FlightDateTime="2015-04-
21T10:32:46"/>
</Stop>
</Stops>
<Dropoff>
<Address Longitude="-112.188643"Latitude="33.475654">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType/>
<LocationName/>
</Address>
</Dropoff>
</Service>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
<PassengerPrefs MeetAndGreetInd="false"/>
<RateQualifier RateQualifier="SuperShuttle_ExecuCar">
<SpecialInputs Value="%20"Name="Gratuity"/>
</RateQualifier>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
</TPA_Extensions>
</OTA_GroundAvailRQ>

Page 197
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

XML Sample: SuperShuttle Ground Availability Response - Round-Trip


<OTA_GroundAvailRS Version="2.0.0" xmlns:xsd="http://www.w3.or-
g/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<GroundServices>
<GroundService>
<Service Notes="N/A">
<ServiceLevel Code="ATF"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar Sedan Service (Up to 3 passengers)
"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="48.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="48.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation
UnitCharge="0"Quantity="0"MinQuantity="0"MaxQuantity="2"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="9.60"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="9.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="57.60"EstimatedTotalAmount="57.60"/>
<Reference ID="27767">
<TPA_Extensions>
<MaxPassengers>3</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/19/2015 12:32:46
PM"EndDateTime="4/19/2015 12:47:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>ToAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

Page 198
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<ImageURL>//cdn.supershuttle.com/vehicleimages/atf.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service Notes="Please call 1 (602) 232-4606 upon arrival. From Ter-
minals 2, 3 or 4, follow the signs to the Courtesy &amp; Prearranged des-
ignated pick up location situated on the center island.">
<ServiceLevel Code="EWC"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar Sedan Will Call (up to 3 guests)
call upon arrival"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="48.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="48.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation
UnitCharge="0"Quantity="0"MinQuantity="0"MaxQuantity="2"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="9.60"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="9.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="57.60"EstimatedTotalAmount="57.60"/>
<Reference ID="28039">
<TPA_Extensions>
<MaxPassengers>3</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/21/2015 10:32:46
AM"EndDateTime="4/21/2015 10:47:46
AM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>FromAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

Page 199
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<ImageURL>//cdn.supershuttle.com/vehicleimages/ewc.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service Notes="N/A">
<ServiceLevel Code="ATF"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar Sedan Service (Up to 3 passengers)
"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="48.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="48.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation
UnitCharge="0"Quantity="0"MinQuantity="0"MaxQuantity="2"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="9.60"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="9.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="57.60"EstimatedTotalAmount="57.60"/>
<Reference ID="27767">
<TPA_Extensions>
<MaxPassengers>3</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/19/2015 12:32:46
PM"EndDateTime="4/19/2015 12:47:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>ToAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

<ImageURL>//cdn.supershuttle.com/vehicleimages/atf.jpg</ImageURL>
</TPA_Extensions>
</Reference>

Page 200
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

</GroundService>
<GroundService>
<Service Notes="Please call 1 (602) 232-4606 upon arrival. From Ter-
minals 2, 3 or 4, follow the signs to the Courtesy &amp; Prearranged des-
ignated pick up location situated on the center island.">
<ServiceLevel Code="SUW"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar SUV Will Call (Up to 5 Passengers)
call upon arrival"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="68.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="68.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation
UnitCharge="0"Quantity="0"MinQuantity="0"MaxQuantity="4"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="13.60"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="13.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="81.60"EstimatedTotalAmount="81.60"/>
<Reference ID="341293">
<TPA_Extensions>
<MaxPassengers>5</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/21/2015 10:32:46
AM"EndDateTime="4/21/2015 10:47:46
AM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>FromAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

<ImageURL>//cdn.supershuttle.com/vehicleimages/suw.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>

Page 201
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<GroundService>
<Service Notes="N/A">
<ServiceLevel Code="ATF"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar Sedan Service (Up to 3 passengers)
"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="48.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="48.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation
UnitCharge="0"Quantity="0"MinQuantity="0"MaxQuantity="2"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="9.60"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="9.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="57.60"EstimatedTotalAmount="57.60"/>
<Reference ID="27767">
<TPA_Extensions>
<MaxPassengers>3</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/19/2015 12:32:46
PM"EndDateTime="4/19/2015 12:47:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>ToAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

<ImageURL>//cdn.supershuttle.com/vehicleimages/atf.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service Notes="Upon landing, please follow the signs to the baggage

Page 202
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

claim. Your driver will meet you at the baggage claim with a sign displaying
your name. If for any reason you need assistance locating the driver, or if
you have any questions, please call 1 (602) 232-4606.">
<ServiceLevel Code="EMG"/>
<VehicleType Code="ECAR"/>
</Service>
<RateQualifier>
<Category Description="ExecuCar Sedan Service Meet and Greet (Up
to 3 Passengers)"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="73.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="73.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation
UnitCharge="0"Quantity="0"MinQuantity="0"MaxQuantity="2"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="14.60"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="14.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="87.60"EstimatedTotalAmount="87.60"/>
<Reference ID="27903">
<TPA_Extensions>
<MaxPassengers>3</MaxPassengers>
<MaxAccessibleGuests>0</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/21/2015 10:32:46
AM"EndDateTime="4/21/2015 10:47:46
AM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>FromAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

<ImageURL>//cdn.supershuttle.com/vehicleimages/emg.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service Notes="Upon arrival, follow the signs to the baggage claim

Page 203
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

and collect your luggage. Follow the instructions below for your respective
terminal and present your confirmation number to the curbside representative
for further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assist-
ance.&lt;br/>&lt;b>Terminal 2:&lt;/b>Exit Door #8, at the east end of the ter-
minal past baggage claim, and continue east to the middle
island/median.&lt;br/>&lt;b>Terminal 3:&lt;/b> Exit via Door 6 (South Curb) or
Door 9 (North Curb) and cross the street. The CSR will be waiting near a sign
that reads Van Service.&lt;br/>&lt;b>Terminal 4:&lt;/b>Exit Door 3 (North
Curb) or Door 4 (South Curb) and cross the street to the median. The CSR will
be waiting near a sign that says Shared Ride Van Service.">
<ServiceLevel Code="VAN"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Shared Ride Van Service (Up to 7 Passengers
in Party)"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="23.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="23.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="8.00"Quantity="0"MinQuantity="0"MaxQuant-
ity="6"Total="0.00"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="4.60"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="4.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="27.60"EstimatedTotalAmount="27.60"/>
<Reference ID="14973">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/19/2015 12:27:46
PM"EndDateTime="4/19/2015 12:42:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
<PickupTime StartDateTime="4/19/2015 12:12:46
PM"EndDateTime="4/19/2015 12:27:46

Page 204
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

="AllowPickup"AdvanceNoticeMinutes="0"/>
<PickupTime StartDateTime="4/19/2015 11:57:46
AM"EndDateTime="4/19/2015 12:12:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
<PickupTime StartDateTime="4/19/2015 11:42:46
AM"EndDateTime="4/19/2015 11:57:46
AM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>ToAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

<ImageURL>//cdn.supershuttle.com/vehicleimages/van.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service Notes="Upon arrival, follow the signs to the baggage claim
and collect your luggage. Follow the instructions below for your respective
terminal and present your confirmation number to the curbside representative
for further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assist-
ance.&lt;br/>&lt;b>Terminal 2:&lt;/b>Exit Door #8, at the east end of the ter-
minal past baggage claim, and continue east to the middle
island/median.&lt;br/>&lt;b>Terminal 3:&lt;/b> Exit via Door 6 (South Curb) or
Door 9 (North Curb) and cross the street. The CSR will be waiting near a sign
that reads Van Service.&lt;br/>&lt;b>Terminal 4:&lt;/b>Exit Door 3 (North
Curb) or Door 4 (South Curb) and cross the street to the median. The CSR will
be waiting near a sign that says Shared Ride Van Service.">
<ServiceLevel Code="VAN"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Shared Ride Van Service (Up to 7 Passengers
in Party)"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="23.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="23.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation UnitCharge="8.00"Quantity="0"MinQuantity="0"

Page 205
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

MaxQuantity="6"Total="0.00"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="4.60"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="4.60"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="27.60"EstimatedTotalAmount="27.60"/>
<Reference ID="14973">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/21/2015 10:32:46
AM"EndDateTime="4/21/2015 10:32:46
AM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>FromAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

<ImageURL>//cdn.supershuttle.com/vehicleimages/van.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service Notes="Upon arrival, follow the signs to the baggage claim
and collect your luggage. Follow the instructions below for your respective
terminal and present your confirmation number to the curbside representative
for further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assist-
ance.&lt;br/>&lt;b>Terminal 2:&lt;/b>Exit Door #8, at the east end of the ter-
minal past baggage claim, and continue east to the middle
island/median.&lt;br/>&lt;b>Terminal 3:&lt;/b> Exit via Door 6 (South Curb) or
Door 9 (North Curb) and cross the street. The CSR will be waiting near a sign
that reads Van Service.&lt;br/>&lt;b>Terminal 4:&lt;/b>Exit Door 3 (North
Curb) or Door 4 (South Curb) and cross the street to the median. The CSR will
be waiting near a sign that says Shared Ride Van Service.">
<ServiceLevel Code="EXC"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Exclusive Non-Stop Van Service (up to 7 pas-
sengers)"Code="Fare">Other_</Category>
</RateQualifier>

Page 206
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="71.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="71.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation
UnitCharge="0"Quantity="0"MinQuantity="0"MaxQuantity="6"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="14.20"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="14.20"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="85.20"EstimatedTotalAmount="85.20"/>
<Reference ID="362613">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/19/2015 12:52:46
PM"EndDateTime="4/19/2015 1:07:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
<PickupTime StartDateTime="4/19/2015 12:37:46
PM"EndDateTime="4/19/2015 12:52:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
<PickupTime StartDateTime="4/19/2015 12:22:46
PM"EndDateTime="4/19/2015 12:37:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
<PickupTime StartDateTime="4/19/2015 12:07:46
PM"EndDateTime="4/19/2015 12:22:46
PM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>ToAirport</TripDirection>
<LuggageQty xsi:nil="true"/>

<ImageURL>//cdn.supershuttle.com/vehicleimages/exc.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>
<GroundService>
<Service Notes="Upon arrival, follow the signs to the baggage claim

Page 207
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

and collect your luggage. Follow the instructions below for your respective
terminal and present your confirmation number to the curbside representative
for further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assist-
ance.&lt;br/>&lt;b>Terminal 2:&lt;/b>Exit Door #8, at the east end of the ter-
minal past baggage claim, and continue east to the middle
island/median.&lt;br/>&lt;b>Terminal 3:&lt;/b> Exit via Door 6 (South Curb) or
Door 9 (North Curb) and cross the street. The CSR will be waiting near a sign
that reads Van Service.&lt;br/>&lt;b>Terminal 4:&lt;/b>Exit Door 3 (North
Curb) or Door 4 (South Curb) and cross the street to the median. The CSR will
be waiting near a sign that says Shared Ride Van Service.">
<ServiceLevel Code="EXC"/>
<VehicleType Code="BLUEV"/>
</Service>
<RateQualifier>
<Category Description="Exclusive Non-Stop Van Service (up to 7 pas-
sengers)"Code="Fare">Other_</Category>
</RateQualifier>
<ServiceCharges Description="FirstPassengerFare">
<ChargePurpose>BaseRate</ChargePurpose>
<Calculation UnitCharge="71.00"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="71.00"/>
</ServiceCharges>
<ServiceCharges Description="AdditionalPassengers">
<ChargePurpose>AdditionalPassengers</ChargePurpose>
<Calculation
UnitCharge="0"Quantity="0"MinQuantity="0"MaxQuantity="6"Total="0"/>
</ServiceCharges>
<Fees Description="Gratuity">
<Calculation UnitCharge="14.20"Quantity="1"MinQuantity="0"MaxQuant-
ity="1"Total="14.20"/>
<ChargePurpose>Gratuity</ChargePurpose>
</Fees>
<TotalCharge RateTotalAmount="85.20"EstimatedTotalAmount="85.20"/>
<Reference ID="362613">
<TPA_Extensions>
<MaxPassengers>7</MaxPassengers>
<MaxAccessibleGuests>7</MaxAccessibleGuests>
<PickupTimes>
<PickupTime StartDateTime="4/21/2015 10:32:46
AM"EndDateTime="4/21/2015 10:32:46
AM"Status="AllowPickup"AdvanceNoticeMinutes="0"/>
</PickupTimes>
<SubscribeToPromotions xsi:nil="true"/>
<TripDirection>FromAirport</TripDirection>

Page 208
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<LuggageQty xsi:nil="true"/>

<ImageURL>//cdn.supershuttle.com/vehicleimages/exc.jpg</ImageURL>
</TPA_Extensions>
</Reference>
</GroundService>
</GroundServices>
<RateQualifier RateQualifier="SuperShuttle_ExecuCar">
<SpecialInputs Name="Gratuity"Value="%20"/>
</RateQualifier>
<TPA_Extensions>
<References>
<LinkedReference>
<Reference ID="27767"/>
<Reference ID="28039"/>
</LinkedReference>
<LinkedReference>
<Reference ID="27767"/>
<Reference ID="341293"/>
</LinkedReference>
<LinkedReference>
<Reference ID="27767"/>
<Reference ID="27903"/>
</LinkedReference>
<LinkedReference>
<Reference ID="14973"/>
<Reference ID="14973"/>
</LinkedReference>
<LinkedReference>
<Reference ID="362613"/>
<Reference ID="362613"/>
</LinkedReference>
</References>
<SubscribeToPromotions xsi:nil="true"/>
<LuggageQty xsi:nil="true"/>
</TPA_Extensions>
</OTA_GroundAvailRS>

XML Sample: SuperShuttle Ground Booking Request - To the Airport


<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference Type="Confirmation" ID="14804"/>

Page 209
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<GroundReservation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<Email>janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="2/8/2014 8:11:57 AM">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123"
CodeContext="Domestic" FlightDateTime="2014-02-08T10:01:57"/>
</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
</GroundReservation>
<Payments>
<Payment>
<PaymentCard ExpireDate="11/30/2016">

Page 210
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<CardHolderName>Jane Test</CardHolderName>
<CardType Description="MasterCard">MC</CardType>
<CardNumber>
<PlainText>5555555555554444</PlainText>
<LastFourDigit>4444</LastFourDigit>
</CardNumber>
<SeriesCode>
<PlainText>123</PlainText>
</SeriesCode>
</PaymentCard>
</Payment>
</Payments>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
<MemberID>1054462</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions>
</OTA_GroundBookRQ>

XML Sample: SuperShuttle Ground Booking Response - To the Airport


<OTA_GroundBookRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<Confirmation ID="2339">
<TPA_Extensions>
<Confirmations>
<Confirmation Type="DispatchConfirmation" ID="5903129"/>
</Confirmations>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602" PhoneNum-
ber="5551234"/>
<Email ShareMarketInd="false">janedtester123@gmail.com</Email>
</Primary>
</Passenger>

Page 211
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Service>
<Location>
<Pickup DateTime="2/10/2014 11:57:28 PM">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<LocationType>HomeResidence</LocationType>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Pickup>
<Dropoff>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123"
FlightDateTime="2014-02-11T01:47:28" CodeContext="Domestic"/>
</Dropoff>
</Location>
</Service>
</Reservation>
</OTA_GroundBookRS>

XML Sample: SuperShuttle Ground Booking Request - Between Non-Airport Loca-


tions
<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference Type="Confirmation" ID="1"/>
<GroundReservation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<Email>janedtester123@gmail.com</Email>
</Primary>
</Passenger>

Page 212
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="2/11/2014 1:47:28 AM">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Pickup>
<Dropoff>
<Address Latitude="33.479324" Longitude="-112.221352">
<AddressLine>2820 N 75th Ave</AddressLine>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>Business</LocationType>
</Address>
</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="15%"/>
</RateQualifier>
</GroundReservation>
<Payments>
<Payment>
<PaymentCard ExpireDate="11/30/2016">
<CardHolderName>Jane Test</CardHolderName>
<CardType Description="MasterCard">MC</CardType>
<CardNumber>
<PlainText>5555555555554444</PlainText>
<LastFourDigit>4444</LastFourDigit>
</CardNumber> <SeriesCode>
<PlainText>123</PlainText>
</SeriesCode>
</PaymentCard>

Page 213
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

</Payment>
</Payments>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
<MemberID>1096512</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions></OTA_GroundBookRQ>

XML Sample: SuperShuttle Ground Booking Response - Between Non-Airport Loca-


tions
<OTA_GroundBookRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<Confirmation ID="2341">
<TPA_Extensions>
<Confirmations>
<Confirmation Type="DispatchConfirmation" ID="5903131"/>
</Confirmations>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602" PhoneNum-
ber="5551234"/>
<Email ShareMarketInd="false">janedtester123@gmail.com</Email>
</Primary>
</Passenger>
<Service>
<Location>
<Pickup DateTime="2/11/2014 1:47:28 AM">
<Address Latitude="33.475609" Longitude="-112.188570">
<AddressLine>2543 N 60th Ave</AddressLine>
<BldgRoom>Unit 12</BldgRoom>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<LocationType>HomeResidence</LocationType>
<StateProv StateCode="AZ"/>

Page 214
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<CountryName Code="US"/>
</Address> </Pickup>
<Dropoff>
<Address Latitude="33.479324" Longitude="-112.221352">
<AddressLine>2820 N 75th Ave</AddressLine>
<CityName>Phoenix</CityName>
<PostalCode>85035</PostalCode>
<LocationType>Business</LocationType>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Dropoff>
</Location>
</Service>
</Reservation></OTA_GroundBookRS>

XML Sample: SuperShuttle Ground Booking Request - From the Airport


<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference Type="Confirmation" ID="14973"/>
<GroundReservation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="001" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<Email>janedtester123@gmail.com</Email>
</Primary> </Passenger>
<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="2/12/2014 1:04:39 AM">
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="WN" FlightNumber="551"
CodeContext="Domestic" FlightDateTime="2014-02-12T01:04:39"/>
</Pickup> <Dropoff>
<Address Latitude="33.475654" Longitude="-112.188643">
<AddressLine>8930 S Beck Ave</AddressLine>

Page 215
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType>HomeResidence</LocationType>
</Address>
</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="SuperShuttle">
<-- Entering a percentage (%) symbol as part of the gratuity value (ex. value-
e="20%") indicates the gratuity is calculated as a percentage of the total.
Entering a value with no percentage symbol (ex. value="20") indicates the
value is a dollar amount. -->
<SpecialInputs Name="Gratuity" Value="20%"/>
</RateQualifier>
</GroundReservation>
<Payments>
<Payment>
<PaymentCard ExpireDate="11/30/2016">
<CardHolderName>Jane Test</CardHolderName>
<CardType Description="MasterCard">MC</CardType>
<CardNumber>
<PlainText>5555555555554444</PlainText>
<LastFourDigit>4444</LastFourDigit>
</CardNumber> <SeriesCode>
<PlainText>123</PlainText>
</SeriesCode>
</PaymentCard>
</Payment>
</Payments>
<TPA_Extensions>
<Source>zTrip</Source>
<Device>iPhone</Device>
<PickMeUpNow>false</PickMeUpNow>
<MemberID>1096512</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers> </TPA_Extensions></OTA_GroundBookRQ>

XML Sample: SuperShuttle Ground Booking Response - From the Airport


<OTA_GroundBookRS EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/> <Reservation>

Page 216
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Confirmation ID="2344">
<TPA_Extensions>
<Confirmations>
<Confirmation Type="DispatchConfirmation" ID="5903135"/>
</Confirmations>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602" PhoneNum-
ber="5551234"/>
<Email ShareMarketInd="false">janedtester123@gmail.com</Email>
</Primary> </Passenger> <Service> <Loca-
tion>
<Pickup DateTime="2/12/2014 1:04:39 AM">
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="WN" FlightNumber="551"
FlightDateTime="2014-02-12T01:04:39" CodeContext="Domestic"/>
</Pickup> <Dropoff>
<Address Latitude="33.475654" Longitude="-112.188643">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<LocationType>HomeResidence</LocationType>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Dropoff>
</Location>
</Service>
</Reservation>
</OTA_GroundBookRS>

XML Sample: SuperShuttle Ground Booking Request - Round-Trip


Note: When booking a round-trip, the API looks for a pickup and dropoff location that
matches, and two stops that match. A round-trip booking request for a SuperShuttle van
must use the same type of service for both legs of the trip.

Page 217
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

POST https://apitest.vtod.com/2.0.0/Rest/Ground/Book?media=xml HTTP/1.1Accept-


Encoding: gzip, deflateContent-Type: application/xmlUsername: MobileWebSecur-
ityKey: 7a55db9a-8ddd-4a30-ae82-a00f0c1abc82Content-Length: 2171Host:
apitest.vtod.comConnection: Keep-AliveUser-Agent: Apache-HttpClient/4.1.1
(java 1.5)
<OTA_GroundBookRQ EchoToken="" Target="Test" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reference ID="14973"/>
<Reference ID="14973"/>
<GroundReservation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Test</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone CountryAccessCode="1" AreaCityCode="602" PhoneNumber="5551234"/>
<Email>testsupershuttlemobile@test1.com</Email>
</Primary>
</Passenger>
<Service DisabilityVehicleInd="false">
<Location>
<Pickup DateTime="4/19/2015 12:27:46 PM">
<Address Longitude="-112.188643" Latitude="33.475654"> <AddressLine>8930
S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType/>
<LocationName/>
</Address>
</Pickup>
<Stops>
<Stop>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123" CodeContext="Domestic"
FlightDateTime="2015-04-19T14:32:46"/>
</Stop>
<Stop DateTime="4/21/2015 10:32:46 AM">

Page 218
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA" FlightNumber="123" CodeContext="Domestic"
FlightDateTime="2015-04-21T10:32:46"/>
</Stop>
</Stops><Dropoff>
<Address Longitude="-112.188643" Latitude="33.475654">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
<LocationType/>
<LocationName/>
</Address>
</Dropoff>
</Location>
</Service>
<RateQualifier RateQualifier="SuperShuttle">
<SpecialInputs Value="%20" Name="Gratuity"/>
</RateQualifier></GroundReservation>
<Payments>
<Payment>
<DirectBill BillingNumber="001supef"/>
</Payment> </Payments>
<TPA_Extensions>
<PickMeUpNow>false</PickMeUpNow>
<Source>zTrip 2.3</Source>
<Device>iPhone</Device>
<MemberID>1054462</MemberID>
<Passengers Quantity="1">
<Category>Adult</Category>
</Passengers>
</TPA_Extensions>
</OTA_GroundBookRQ>

XML Sample: SuperShuttle Ground Booking Response - Round-Trip


<OTA_GroundBookRS EchoToken=""Target="Test"Version="2.0.0"PrimaryLangID="en"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.or-
g/2001/XMLSchema-instance">
<Success/>
<Reservation>
<Confirmation ID="29479">
<TPA_Extensions>

Page 219
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Confirmations>
<Confirmation Type="DispatchConfirmation"ID="5313874"/>
<Confirmation Type="ReturnConfirmation"ID="29480"/>
<Confirmation Type="DispatchReturnConfirmation"ID="5313875"/>
</Confirmations>
<SubscribeToPromotions xsi:nil="true"/>
<LuggageQty xsi:nil="true"/>
</TPA_Extensions>
</Confirmation>
<Passenger>
<Primary>
<PersonName>
<GivenName>Test</GivenName>
<Surname>Test</Surname>
</PersonName>
<Telephone
CountryAccessCode="1"AreaCityCode="602"PhoneNumber="5551234"/>
<Email
ShareMarketInd="false">testsupershuttlemobile@test1.com</Email>
</Primary>
</Passenger>
<Service>
<Location>
<Pickup DateTime="4/19/2015 12:27:46 PM">
<Address Latitude="33.475654"Longitude="-112.188643">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<LocationName/>
<LocationType/>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Pickup>
<Dropoff>
<Address Latitude="33.475654"Longitude="-112.188643">
<AddressLine>8930 S Beck Ave</AddressLine>
<CityName>Tempe</CityName>
<PostalCode>85284</PostalCode>
<LocationName/>
<LocationType/>
<StateProv StateCode="AZ"/>
<CountryName Code="US"/>
</Address>
</Dropoff>

Page 220
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

<Stops>
<Stop>
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA"FlightNumber="123"FlightDateTime="2015-04-
19T14:32:46"CodeContext="Domestic"/>
</Stop>
<Stop DateTime="4/21/2015 10:32:46 AM">
<AirportInfo>
<Arrival LocationCode="PHX"/>
</AirportInfo>
<Airline Code="AA"FlightNumber="123"FlightDateTime="2015-04-
21T10:32:46"CodeContext="Domestic"/>
</Stop>
</Stops>
</Location>
</Service>
</Reservation>
</OTA_GroundBookRS>

XML Sample: SuperShuttle Ground Cancellation Request


<OTA_GroundCancelRQ EchoToken="" Target="Test|Production" Version="2.0.0"
PrimaryLangID="en">
<POS>
<Source ISOCountry="US" ISOCurrency="USD"/>
</POS>
<Reservation CancelType="Cancel">
<UniqueID ID="2901"/>
<Verification>
<PersonName>
<GivenName>Jane</GivenName>
<Surname>Test</Surname>
</PersonName>
<TelephoneInfo CountryAccessCode="1" AreaCityCode="602" PhoneNum-
ber="555-1234"/>
<AddressInfo>
<PostalCode>85035</PostalCode>
</AddressInfo>
</Verification>
</Reservation>
<TPA_Extensions>
<RateQualifier RateQualifier="SuperShuttle"/>
</TPA_Extensions></OTA_GroundCancelRQ>

Page 221
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

XML Sample: SuperShuttle Ground Cancellation Response


<OTA_GroundCancelRS EchoToken="" Target="Test|Production" Version="2.0.0"
PrimaryLangID="en" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success/>
<Reservation>
<CancelConfirmation>
<UniqueID ID="2901"/>
</CancelConfirmation>
</Reservation>
</OTA_GroundCancelRS>

SuperShuttle JSON Samples


The following samples are specific to SuperShuttle (blue van) services.

JSON Sample: SuperShuttle Ground Availability Request - To the Airport


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Avail HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox
SecurityKey: ca046a39-920c-4c98-8ae1-92241c8a556c
Content-Length: 1408

{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 2,
"Category": {
"Value": "Adult"

Page 222
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}
}
],
"PassengerPrefs": {},
"RateQualifiers": [
{
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false
},
"References": [],
"Service": {
"Pickup": {
"DateTime": "2016-01-28T15:50:12",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Dropoff": {
"AirportInfo": {

Page 223
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2016-01-28T15:50:12",
"CodeContext": "Domestic"
}
}
}
}

JSON Sample: SuperShuttle Ground Availability Response - To the Airport


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 990
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:50:17 GMT

{
"EchoToken": "",
"GroundServices": {"GroundServices": [
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 6.72,
"UnitCharge": 6.72
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Shared Ride Van Service (Up to 7 Passengers in
Party)",
"Value": "Other_"
}},

Page 224
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Reference": {
"ID": "14804",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/van.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [
{
"EndDateTime": "9/10/2015 2:28:00 PM",
"StartDateTime": "9/10/2015 2:13:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 2:13:00 PM",
"StartDateTime": "9/10/2015 1:58:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 1:58:00 PM",
"StartDateTime": "9/10/2015 1:43:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 1:43:00 PM",
"StartDateTime": "9/10/2015 1:28:00 PM",
"Status": "AllowPickup"
}
]},
"TripDirection": "ToAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and
collect your luggage. Follow the instructions below for your respective ter-
minal and present your confirmation number to the curbside representative for
further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.Terminal
2:Exit Door #8, at the east end of the terminal past baggage claim, and con-
tinue east to the middle island/median.Terminal 3: Exit via Door 9 (North
Curb) and cross the street. The CSR will be waiting near a sign that reads Van
Service.Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross
the street to the median. The CSR will be waiting near a sign that says Shared
Ride Van Service.",
"ServiceLevel": {

Page 225
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Code": "VAN",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 24,
"UnitCharge": 24
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 4,
"Total": 32,
"UnitCharge": 8
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 62.72,
"RateTotalAmount": 62.72
}
},
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 8.64,
"UnitCharge": 8.64
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {

Page 226
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Code": "Fare",
"Description": "Exclusive Non-Stop Van Service (up to 7 pas-
sengers)",
"Value": "Other_"
}},
"Reference": {
"ID": "14803",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/exc.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [
{
"EndDateTime": "9/10/2015 2:48:00 PM",
"StartDateTime": "9/10/2015 2:33:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 2:33:00 PM",
"StartDateTime": "9/10/2015 2:18:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 2:18:00 PM",
"StartDateTime": "9/10/2015 2:03:00 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/10/2015 2:03:00 PM",
"StartDateTime": "9/10/2015 1:48:00 PM",
"Status": "AllowPickup"
}
]},
"TripDirection": "ToAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and
collect your luggage. Follow the instructions below for your respective ter-
minal and present your confirmation number to the curbside representative for
further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.Terminal
2:Exit Door #8, at the east end of the terminal past baggage claim, and con-
tinue east to the middle island/median.Terminal 3: Exit via Door 9 (North

Page 227
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Curb) and cross the street. The CSR will be waiting near a sign that reads Van
Service.Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross
the street to the median. The CSR will be waiting near a sign that says Van
Service.",
"ServiceLevel": {
"Code": "EXC",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 72,
"UnitCharge": 72
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 4
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 80.64,
"RateTotalAmount": 80.64
}
}
]},
"PrimaryLangID": "en",
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%12.56"
}]
}],

Page 228
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: SuperShuttle Ground Availability Request - From the Airport


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Avail HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox
SecurityKey: 8fc67d7c-f371-4bdc-b728-e47894ce8437
Content-Length: 1538

{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 2,
"Category": {
"Value": "Adult"
}
}
],
"PassengerPrefs": {},
"RateQualifiers": [
{
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],

Page 229
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false
},
"References": [],
"Service": {
"Pickup": {
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2016-02-18T16:22:46",
"CodeContext": "Domestic"
}
},
"Dropoff": {
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2016-02-18T16:22:46",
"CodeContext": "Domestic"

Page 230
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}
}
}
}

JSON Sample: SuperShuttle Ground Availability Response - From the Airport


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 4030
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:51:54 GMT
{
"EchoToken": "",
"GroundServices": {"GroundServices": [
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 3.84,
"UnitCharge": 3.84
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Shared Ride Van Service (Up to 7 Passengers in
Party)",
"Value": "Other_"
}},
"Reference": {
"ID": "14804",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/van.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [ {
"EndDateTime": "12/28/2015 10:15:00 AM",
"StartDateTime": "12/28/2015 10:15:00 AM",
"Status": "AllowPickup"

Page 231
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}]},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and
collect your luggage. Follow the instructions below for your respective ter-
minal and present your confirmation number to the curbside representative for
further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.
Terminal 2:Exit Door #8, at the east end of the terminal past baggage claim,
and continue east to the middle island/median.
Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will be
waiting near a sign that reads Van Service.
Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Shared
Ride Van Service.",
"ServiceLevel": {
"Code": "VAN",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 24,
"UnitCharge": 24
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1,
"Total": 8,
"UnitCharge": 8
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}

Page 232
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

],
"TotalCharge": {
"EstimatedTotalAmount": 35.84,
"RateTotalAmount": 35.84
}
},
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 8.64,
"UnitCharge": 8.64
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Exclusive Non-Stop Van Service (up to 7 pas-
sengers)",
"Value": "Other_"
}},
"Reference": {
"ID": "14803",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/exc.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [ {
"EndDateTime": "12/28/2015 10:15:00 AM",
"StartDateTime": "12/28/2015 10:15:00 AM",
"Status": "AllowPickup"
}]},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and
collect your luggage. Follow the instructions below for your respective ter-
minal and present your confirmation number to the curbside representative for
further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.
Terminal 2:Exit Door #8, at the east end of the terminal past baggage claim,

Page 233
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

and continue east to the middle island/median.


Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will be
waiting near a sign that reads Van Service.
Terminal 4:Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Van Ser-
vice.",
"ServiceLevel": {
"Code": "EXC",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 72,
"UnitCharge": 72
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 80.64,
"RateTotalAmount": 80.64
}
}
]},
"PrimaryLangID": "en",
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%12.56"

Page 234
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}]
}],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: SuperShuttle Ground Availability Request - Between Non-Airport


Locations
POST https://apitest.vtod.com/2.0.0/Rest/Ground/Avail HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox
SecurityKey: cb9101c3-3c8c-4c05-a00e-490362092fc3
Content-Length: 1534

{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 2,
"Category": {
"Value": "Adult"
}
}
],
"PassengerPrefs": {},
"RateQualifiers": [
{
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}

Page 235
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

]
}
],
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false
},
"References": [],
"Service": {
"Pickup": {
"DateTime": "2016-01-27T16:32:00",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475654",
"Longitude": "-112.188643"
}
},
"Dropoff": {
"Address": {
"AddressLine": "2820 N 75th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "Business"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},

Page 236
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Latitude": "33.479324",
"Longitude": "-112.221352"
}
}
}
}

JSON Sample: SuperShuttle Ground Availability Response - Between Non-Airport


Locations
HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 1164
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:53:54 GMT

{
"EchoToken": "",
"GroundServices": {"GroundServices": [ {
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 12.56,
"UnitCharge": 12.56
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "BLUE Van Charter",
"Value": "Other_"
}},
"Reference": {
"ID": "1",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/cht.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [ {
"StartDateTime": "12/20/2015 5:25:00 PM",

Page 237
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Status": "AllowPickup"
}]}
}
},
"Service": {
"ServiceLevel": {
"Code": "CHT",
"SourceName": "PHX"
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 100,
"UnitCharge": 100
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "BaseRate"
}],
"TotalCharge": {
"EstimatedTotalAmount": 112.56,
"RateTotalAmount": 112.56
}
}]},
"PrimaryLangID": "en",
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%12.56"
}]
}],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: SuperShuttle Ground Availability Request - Round-Trip


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Book HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox

Page 238
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

SecurityKey: 857bec9e-f357-4d4e-b8d3-232b028fbc98
Content-Length: 2693

{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"References": [{
"ID": "14973"
},
{
"ID": "14973"
}],
"GroundReservations": [ {
"Passenger": {"Primary": {
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [ {
"CountryAccessCode": "001",
"AreaCityCode": "602",
"PhoneNumber": "555-1234"
}],
"Emails": [{"Value": "test@supershuttle.com"}]
}},
"Service": {"Location": {
"Pickup": {
"DateTime": "1/28/2016 12:08:25 PM",
"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"PostalCode": "85284",
"LocationName": "",
"LocationType": {

},
"StateProv": {

Page 239
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475654",
"Longitude": "-112.188643"
}
},
"Stops": {
"Stops": [{
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "1156",
"FlightDateTime": "2016-01-28T14:13:25",
"CodeContext": "Domestic"
}
},
{
"DateTime": "1/30/2016 5:13:25 PM",
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "2256",
"FlightDateTime": "2016-01-30T17:13:25",
"CodeContext": "Domestic"
}
}]
},
"Dropoff": {
"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"PostalCode": "85284",
"LocationName": "",

Page 240
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"LocationType": {

},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475654",
"Longitude": "-112.188643"
}
}
}
},
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%15"
}]
}]
}],
"Payments": {"Payments": [{"DirectBill": {
"ID": "20319",
"BillingNumber": "001SUPEF"
}}]},
"TPA_Extensions": {
"Passengers": [ {
"Quantity": 1,
"Category": {"Value": "Adult"}
}],
"Confirmations": [],
"RateQualifiers": [],
"Source": "",
"PickMeUpNow": false
}
}

JSON Sample: SuperShuttle Ground Availability Response - Round-Trip


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 8617
Content-Type: application/json; charset=utf-8

Page 241
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:54:41 GMT

{
"EchoToken": "",
"GroundServices": {"GroundServices": [
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 3.72,
"UnitCharge": 3.72
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Shared Ride Van Service (Up to 7 Passengers in
Party)",
"Value": "Other_"
}},
"Reference": {
"ID": "14973",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/van.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [
{
"EndDateTime": "9/16/2015 2:10:53 PM",
"StartDateTime": "9/16/2015 1:55:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 1:55:53 PM",
"StartDateTime": "9/16/2015 1:40:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 1:40:53 PM",

Page 242
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"StartDateTime": "9/16/2015 1:25:53 PM",


"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 1:25:53 PM",
"StartDateTime": "9/16/2015 1:10:53 PM",
"Status": "AllowPickup"
}
]},
"TripDirection": "ToAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and
collect your luggage. Follow the instructions below for your respective ter-
minal and present your confirmation number to the curbside representative for
further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.
Terminal 2: Exit Door #8, at the east end of the terminal past baggage claim,
and continue east to the middle island/median.
Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will
be waiting near a sign that reads Van Service.
Terminal 4: Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Shared
Ride Van Service.",
"ServiceLevel": {
"Code": "VAN",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 23,
"UnitCharge": 23
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {

Page 243
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"MaxQuantity": 6,
"Quantity": 1,
"Total": 8,
"UnitCharge": 8
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 34.72,
"RateTotalAmount": 34.72
}
},
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 3.72,
"UnitCharge": 3.72
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Shared Ride Van Service (Up to 7 Passengers in
Party)",
"Value": "Other_"
}},
"Reference": {
"ID": "14973",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/van.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [ {
"EndDateTime": "11/14/2015 5:00:53 PM",
"StartDateTime": "11/14/2015 5:00:53 PM",
"Status": "AllowPickup"
}]},
"TripDirection": "FromAirport"
}

Page 244
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and
collect your luggage. Follow the instructions below for your respective ter-
minal and present your confirmation number to the curbside representative for
further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.
Terminal 2: Exit Door #8, at the east end of the terminal past baggage claim,
and continue east to the middle island/median.
Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will
be waiting near a sign that reads Van Service.
Terminal 4: Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Shared
Ride Van Service.",
"ServiceLevel": {
"Code": "VAN",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 23,
"UnitCharge": 23
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1,
"Total": 8,
"UnitCharge": 8
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 34.72,

Page 245
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"RateTotalAmount": 34.72
}
},
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 8.52,
"UnitCharge": 8.52
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Exclusive Non-Stop Van Service (up to 7 pas-
sengers)",
"Value": "Other_"
}},
"Reference": {
"ID": "362613",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/exc.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [
{
"EndDateTime": "9/16/2015 2:35:53 PM",
"StartDateTime": "9/16/2015 2:20:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 2:20:53 PM",
"StartDateTime": "9/16/2015 2:05:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 2:05:53 PM",
"StartDateTime": "9/16/2015 1:50:53 PM",
"Status": "AllowPickup"
},
{
"EndDateTime": "9/16/2015 1:50:53 PM",

Page 246
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"StartDateTime": "9/16/2015 1:35:53 PM",


"Status": "AllowPickup"
}
]},
"TripDirection": "ToAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and
collect your luggage. Follow the instructions below for your respective ter-
minal and present your confirmation number to the curbside representative for
further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.
Terminal 2: Exit Door #8, at the east end of the terminal past baggage claim,
and continue east to the middle island/median.
Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will
be waiting near a sign that reads Van Service.
Terminal 4: Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Van Ser-
vice.",
"ServiceLevel": {
"Code": "EXC",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 71,
"UnitCharge": 71
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"

Page 247
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}
],
"TotalCharge": {
"EstimatedTotalAmount": 79.52,
"RateTotalAmount": 79.52
}
},
{
"Fees": [ {
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 8.52,
"UnitCharge": 8.52
}],
"ChargePurpose": {"Value": "Gratuity"},
"Description": "Gratuity"
}],
"RateQualifier": {"Category": {
"Code": "Fare",
"Description": "Exclusive Non-Stop Van Service (up to 7 pas-
sengers)",
"Value": "Other_"
}},
"Reference": {
"ID": "362613",
"TPA_Extensions": {
"ImageURL": "//cdn.supershuttle.com/vehicleimages/exc.jpg",
"MaxAccessibleGuests": 7,
"MaxPassengers": 7,
"PickupTimes": {"PickupTimes": [ {
"EndDateTime": "11/14/2015 5:00:53 PM",
"StartDateTime": "11/14/2015 5:00:53 PM",
"Status": "AllowPickup"
}]},
"TripDirection": "FromAirport"
}
},
"Service": {
"Notes": "Upon arrival, follow the signs to the baggage claim and
collect your luggage. Follow the instructions below for your respective ter-
minal and present your confirmation number to the curbside representative for
further assistance. Curbside representatives are available 7 AM to 11 PM,
daily. After hours, please call (602) 232-4601 for further assistance.
Terminal 2: Exit Door #8, at the east end of the terminal past baggage claim,

Page 248
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

and continue east to the middle island/median.


Terminal 3: Exit via Door 9 (North Curb) and cross the street. The CSR will
be waiting near a sign that reads Van Service.
Terminal 4: Exit Door 3 (North Curb) or Door 4 (South Curb) and cross the
street to the median. The CSR will be waiting near a sign that says Van Ser-
vice.",
"ServiceLevel": {
"Code": "EXC",
"SourceName": null
},
"VehicleType": {"Code": "BLUEV"}
},
"ServiceCharges": [
{
"Calculations": [ {
"MaxQuantity": 1,
"Quantity": 1,
"Total": 71,
"UnitCharge": 71
}],
"ChargePurpose": {"Value": "BaseRate"},
"Description": "FirstPassengerFare"
},
{
"Calculations": [ {
"MaxQuantity": 6,
"Quantity": 1
}],
"ChargePurpose": {"Value": "AdditionalPassengers"},
"Description": "AdditionalPassengers"
}
],
"TotalCharge": {
"EstimatedTotalAmount": 79.52,
"RateTotalAmount": 79.52
}
}
]},
"PrimaryLangID": "en",
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%12.56"

Page 249
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}]
}],
"Success": {},
"TPA_Extensions": {"References": {"LinkedReferences": [
{"References": [
{"ID": "14973"},
{"ID": "14973"}
]},
{"References": [
{"ID": "362613"},
{"ID": "362613"}
]}
]}},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: SuperShuttle Ground Booking Request - Round-Trip


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Avail HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox
SecurityKey: 0d2a5bbe-5e8f-4ae7-90b9-eecae127ae11
Content-Length: 1902

{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {
"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}
},
"Passengers": [
{
"Quantity": 2,
"Category": {
"Value": "Adult"
}
}
],

Page 250
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"PassengerPrefs": {},
"RateQualifiers": [
{
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
],
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [],
"PickMeUpNow": false
},
"References": [],
"Service": {
"Pickup": {
"DateTime": "2016-01-28T12:34:47",
"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"PostalCode": "85284",
"LocationName": "",
"LocationType": {

},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475654",
"Longitude": "-112.188643"
}
},
"Stops": {
"Stops": [{
"AirportInfo": {
"Arrival": {

Page 251
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "1156",
"FlightDateTime": "2016-01-28T14:34:47",
"CodeContext": "Domestic"
}
},
{
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "2256",
"FlightDateTime": "2016-01-30T16:34:47",
"CodeContext": "Domestic"
}
}]
},
"Dropoff": {
"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"PostalCode": "85284",
"LocationName": "",
"LocationType": {

},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475654",
"Longitude": "-112.188643"
}
}
}

Page 252
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

JSON Sample: SuperShuttle Ground Booking Response - Round-Trip


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 1604
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:54:44 GMT

{
"EchoToken": "",
"PrimaryLangID": "en",
"Reservations": [ {
"Confirmation": {
"ID": "73177",
"TPA_Extensions": {"Confirmations": [
{
"ID": "7726528",
"Type": "DispatchConfirmation"
},
{
"ID": "73178",
"Type": "ReturnConfirmation"
},
{
"ID": "7726529",
"Type": "DispatchReturnConfirmation"
}
]}
},
"Passenger": {"Primary": {
"Emails": [{"Value": "gchiovari@supershuttle.com"}],
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [ {
"AreaCityCode": "602",
"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}]

Page 253
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}},
"Service": {"Location": {
"Dropoff": {"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"CountryName": {"Code": "US"},
"Latitude": "33.475654",
"LocationName": "",
"LocationType": {},
"Longitude": "-112.188643",
"PostalCode": "85284",
"StateProv": {"StateCode": "AZ"}
}},
"Pickup": {
"Address": {
"AddressLine": "8930 S Beck Ave",
"CityName": "Tempe",
"CountryName": {"Code": "US"},
"Latitude": "33.475654",
"LocationName": "",
"LocationType": {},
"Longitude": "-112.188643",
"PostalCode": "85284",
"StateProv": {"StateCode": "AZ"}
},
"DateTime": "9/20/2015 12:27:32 PM"
},
"Stops": {"Stops": [
{
"Airline": {
"Code": "WN",
"CodeContext": "Domestic",
"FlightDateTime": "2015-09-20T14:32:32",
"FlightNumber": "1156"
},
"AirportInfo": {"Arrival": {"LocationCode": "PHX"}}
},
{
"Airline": {
"Code": "WN",
"CodeContext": "Domestic",
"FlightDateTime": "2015-09-22T10:32:32",
"FlightNumber": "2256"
},

Page 254
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"AirportInfo": {"Arrival": {"LocationCode": "PHX"}},


"DateTime": "9/22/2015 10:32:32 AM"
}
]}
}},
"TPA_Extensions": {"Contacts": {"Items": [ {
"Name": "SuperShuttle",
"Telephone": {"PhoneNumber": "8002583826"},
"Type": "Dispatch"
}]}}
}],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: SuperShuttle Ground Booking Request - To the Airport


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Book HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox
SecurityKey: 4c45b8b9-1f60-4e22-8bea-c56dc4896b8a
Content-Length: 1996

{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}},
"References": [{"ID": "14804"}],
"GroundReservations": [ {
"Passenger": {"Primary": {
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [ {
"CountryAccessCode": "001",
"AreaCityCode": "602",

Page 255
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"PhoneNumber": "555-1234"
}],
"Emails": [{"Value": "test@supershuttle.com"}]
}},
"Service": {"Location": {
"Pickup": {
"DateTime": "1/27/2016 2:47:54 PM",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {"Value": "HomeResidence"},
"StateProv": {"StateCode": "AZ"},
"CountryName": {"Code": "US"},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Dropoff": {
"AirportInfo": {"Arrival": {"LocationCode": "PHX"}},
"Airline": {
"FlightDateTime": "2016-01-27T16:52:54",
"CodeContext": "Domestic"
}
}
}},
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle_ExecuCar",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%15"
}]
}]
}],
"Payments": {"Payments": [{"DirectBill": {
"ID": "20319",
"BillingNumber": "001SUPEF"
}}]},
"TPA_Extensions": {
"Passengers": [ {
"Quantity": 1,
"Category": {"Value": "Adult"}
}],
"Confirmations": [],

Page 256
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"RateQualifiers": [],
"Source": "Expedia",
"PickMeUpNow": false
}
}

JSON Sample: SuperShuttle Ground Booking Response - To the Airport


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 990
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:50:17 GMT

{
"EchoToken": "",
"PrimaryLangID": "en",
"Reservations": [ {
"Confirmation": {
"ID": "72238",
"TPA_Extensions": {"Confirmations": [ {
"ID": "7619002",
"Type": "DispatchConfirmation"
}]}
},
"Passenger": {"Primary": {
"Emails": [{"Value": ""}],
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [ {
"AreaCityCode": "602",
"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}]
}},
"Service": {"Location": {
"Dropoff": {
"Airline": {
"CodeContext": "Domestic",
"FlightDateTime": "2015-09-12T15:42:31"

Page 257
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

},
"AirportInfo": {"Arrival": {"LocationCode": "PHX"}}
},
"Pickup": {
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"CountryName": {"Code": "US"},
"Latitude": "33.475609",
"LocationType": {"Value": "HomeResidence"},
"Longitude": "-112.188570",
"PostalCode": "85035",
"StateProv": {"StateCode": "AZ"}
},
"DateTime": "9/12/2015 3:42:31 PM"
}
}},
"TPA_Extensions": {"Contacts": {"Items": [ {
"Name": "ExecuCar",
"Telephone": {"PhoneNumber": "8004104444"},
"Type": "Dispatch"
}]}}
}],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: SuperShuttle Ground Booking Request - From the Airport


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Book HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox
SecurityKey: 58970753-600d-4542-8d77-89e0f062fe14
Content-Length: 2383

{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"

Page 258
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

}},
"References": [{"ID": "14804"}],
"GroundReservations": [
{
"Passenger": {
"Primary": {
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [
{
"CountryAccessCode": "001",
"AreaCityCode": "602",
"PhoneNumber": "555-1234"
}
],
"Emails": [
{
"Value": "test@supershuttle.com"
}
]
}
},
"Service": {
"Location": {
"Pickup": {
"Remark": "Some remarks",
"DateTime": "2/18/2016 5:12:40 PM",
"AirportInfo": {
"Arrival": {
"LocationCode": "PHX"
}
},
"Airline": {
"Code": "WN",
"FlightNumber": "551",
"FlightDateTime": "2/18/2016 5:12:40 PM",
"CodeContext": "Domestic"
}
},
"Dropoff": {
"Address": {
"AddressLine": "2543 N 60th Ave",

Page 259
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "HomeResidence"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
}
}
},
"RateQualifiers": [
{
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [
{
"Name": "Gratuity",
"Value": "%12.56"
}
]
}
]
}
],
"Payments": {
"Payments": [
{
"DirectBill": {
"ID": "20319",
"BillingNumber": "001SUPEF"
}
}
]
},
"TPA_Extensions":{
"Passengers":[
{
"Quantity":1,

Page 260
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Category":{
"Value":"Adult"
}
}
],
"Confirmations":[

],
"MemberID":"",
"RateQualifiers":[

],
"Source":"",
"Device":"iPhone",
"PickMeUpNow":false
}
}

JSON Sample: SuperShuttle Ground Booking Response - From the Airport


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 1050
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:51:58 GMT

{
"EchoToken": "",
"PrimaryLangID": "en",
"Reservations": [ {
"Confirmation": {
"ID": "72500",
"TPA_Extensions": {"Confirmations": [ {
"ID": "7619188",
"Type": "DispatchConfirmation"
}]}
},
"Passenger": {"Primary": {
"Emails": [{"Value": ""}],
"PersonName": {
"GivenName": "Test",

Page 261
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Surname": "Test"
},
"Telephones": [ {
"AreaCityCode": "602",
"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}]
}},
"Service": {"Location": {
"Dropoff": {"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"CountryName": {"Code": "US"},
"Latitude": "33.475609",
"LocationType": {"Value": "HomeResidence"},
"Longitude": "-112.188570",
"PostalCode": "85035",
"StateProv": {"StateCode": "AZ"}
}},
"Pickup": {
"Airline": {
"Code": "WN",
"CodeContext": "Domestic",
"FlightDateTime": "10/7/2015 5:58:22 PM",
"FlightNumber": "551"
},
"AirportInfo": {"Arrival": {"LocationCode": "PHX"}},
"DateTime": "10/7/2015 5:58:22 PM",
"Remark": "Some remarks"
}
}},
"TPA_Extensions": {"Contacts": {"Items": [ {
"Name": "SuperShuttle",
"Telephone": {"PhoneNumber": "8002583826"},
"Type": "Dispatch"
}]}}
}],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: SuperShuttle Ground Booking Request - Between Non-Airport Loca-


tions
POST https://apitest.vtod.com/2.0.0/Rest/Ground/Book HTTP/1.1

Page 262
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox
SecurityKey: 9911378d-f408-4c7d-9aba-a785c08ca798
Content-Length: 2155

{
"EchoToken": "",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}},
"References": [{"ID": "1"}],
"GroundReservations": [ {
"Passenger": {"Primary": {
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [ {
"CountryAccessCode": "001",
"AreaCityCode": "602",
"PhoneNumber": "555-1234"
}],
"Emails": [{"Value": "test@supershuttle.com"}]
}},
"Service": {"Location": {
"Pickup": {
"DateTime": "1/27/2016 5:11:30 PM",
"Address": {
"AddressLine": "2543 N 60th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {"Value": "HomeResidence"},
"StateProv": {"StateCode": "AZ"},
"CountryName": {"Code": "US"},
"Latitude": "33.475609",
"Longitude": "-112.188570"
}
},
"Dropoff": {

Page 263
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"Address": {
"AddressLine": "2820 N 75th Ave",
"CityName": "Phoenix",
"PostalCode": "85035",
"LocationType": {
"Value": "Business"
},
"StateProv": {
"StateCode": "AZ"
},
"CountryName": {
"Code": "US"
},
"Latitude": "33.479324",
"Longitude": "-112.221352"
}
}
}},
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": [ {
"Name": "Gratuity",
"Value": "%15"
}]
}]
}],
"Payments": {"Payments": [{"DirectBill": {
"ID": "20319",
"BillingNumber": "001SUPEF"
}}]},
"TPA_Extensions": {
"Passengers": [ {
"Quantity": 1,
"Category": {"Value": "Adult"}
}],
"Confirmations": [],
"RateQualifiers": [],
"Source": "Expedia",
"PickMeUpNow": false
}
}

JSON Sample: SuperShuttle Ground Booking Response - Between Non-Airport


Locations
HTTP/1.1 200 OK

Page 264
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

Cache-Control: private
Content-Length: 1079
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:58:48 GMT

{
"EchoToken": "",
"PrimaryLangID": "en",
"Reservations": [ {
"Confirmation": {
"ID": "72492",
"TPA_Extensions": {"Confirmations": [ {
"ID": "7619182",
"Type": "DispatchConfirmation"
}]}
},
"Passenger": {"Primary": {
"Emails": [{"Value": ""}],
"PersonName": {
"GivenName": "Test",
"Surname": "Test"
},
"Telephones": [ {
"AreaCityCode": "602",
"CountryAccessCode": "1",
"PhoneNumber": "5551234"
}]
}},
"Service": {"Location": {
"Dropoff": {"Address": {
"AddressLine": "2820 N 75th Ave",
"CityName": "Phoenix",
"CountryName": {"Code": "US"},
"Latitude": "33.479324",
"LocationType": {"Value": "Business"},
"Longitude": "-112.221352",
"PostalCode": "85035",
"StateProv": {"StateCode": "AZ"}
}},
"Pickup": {
"Address": {

Page 265
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"AddressLine": "2543 N 60th Ave",


"CityName": "Phoenix",
"CountryName": {"Code": "US"},
"Latitude": "33.475609",
"LocationType": {"Value": "HomeResidence"},
"Longitude": "-112.188570",
"PostalCode": "85035",
"StateProv": {"StateCode": "AZ"}
},
"DateTime": "12/20/2015 5:25:00 PM"
}
}},
"TPA_Extensions": {"Contacts": {"Items": [ {
"Name": "SuperShuttle",
"Telephone": {"PhoneNumber": "8002583826"},
"Type": "Dispatch"
}]}}
}],
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

JSON Sample: SuperShuttle Ground Cancellation Request


POST https://apitest.vtod.com/2.0.0/Rest/Ground/Cancel HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json;charset=UTF-8
Username: Sandbox
SecurityKey: 8fc67d7c-f371-4bdc-b728-e47894ce8437
Content-Length: 645

{
"EchoToken": "12345",
"Target": "Test",
"Version": "2.0.0",
"PrimaryLangID": "en",
"POS": {"Source": {
"ISOCountry": "US",
"ISOCurrency": "USD"
}},
"Reservation": {
"CancelType": "Cancel",
"UniqueID": [ {
"Type": "DispatchConfirmation",

Page 266
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
Samples

"ID": "1607319"
}],
"Verification": {
"AddressInfo": {
"PostalCode": "85035"
}
}
},
"TPA_Extensions": {
"Passengers": [],
"Confirmations": [],
"RateQualifiers": [ {
"RateQualifierValue": "SuperShuttle",
"SpecialInputs": []
}]
}
}

JSON Sample: SuperShuttle Ground Cancellation Response


HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 186
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 27 Jan 2016 22:50:19 GMT

{
"EchoToken": "12345",
"PrimaryLangID": "en",
"Reservation": {"CancelConfirmation": {"UniqueID": {
"ID": "72467",
"Type": "Confirmation"
}}},
"Success": {},
"Target": "Test",
"Version": "2.0.0"
}

Page 267
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
FAQs

FAQs
The section provides answers to frequently-asked questions (FAQs).

How do I get Sandbox access?


The sandbox is fully functional. You can begin testing immediately using the instructions in
this document. See Getting Started (on page 8). The sandbox username is sandbox and the
password is sandbox.

Is there a regular database maintenance window for the test environment?


A database restore is performed every Monday, Wednesday, and Friday between 8:00 am and
9:00 am Arizona time for the test database.

What OTA-compliant actions are available?


This is a list of OTA compliant actions are the URLs used to access them.

Action Location
Book a Reservation https://apitest.vtod.com/2.0.0/REST/Ground/Book
Cancel a Reservation https://apitest.vtod.com/2.0.0/REST/Ground/Cancel
Retrieve a Reservation https://apitest.vtod.com/2.0.0/REST/Ground/ResRetrieve
Check Availability https://apitest.vtod.com/2.0.0/REST/Ground/Avail

What credit card numbers can I use for testing?


Please see Valid Credit Card Numbers for Testing.

What if I get an error when saving a reservation?


If you are using the test environment, be sure the customer's last name on the reservation is
Test. If the last name is anything other than Test, the reservation will fail.
The purpose of using Test as the last name is to ensure that a production instance is not
accidentally pointed to the test environment. If this occurs when booking a reservation, the
customer receives a message indicating the reservation did not save properly.

What are the restrictions of the test environment?


In the SuperShuttle test environment, all reservations must have a last name value of Test.

Page 268
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
FAQs

The purpose of using Test as the last name is to ensure that a production instance is not
accidentally pointed to the test environment. If this occurs when booking a reservation, the
customer receives a message indicating the reservation did not save properly.

What is the service location to generate a security token?


The service location to generate a security token is
https://apitest.vtod.com/2.0.0/REST/GetToken

How is the API Key passed to the server?


When SuperShuttle receives the token, it is put into the Header request. Here is an example of
the C# code:
Dictionary<string, string> token = new Dictionary<string, string>();
token.Add("Username", username);
token.Add("SecurityKey", securityKey);
//...
WebRequest request = WebRequest.Create(url);
foreach (var item in headers)
{
request.Headers.Add(item.Key + ":" + item.Value);
}
What is the difference between the Test and Production URLs?
The test URLs contain the word Test in the link. Remove Test from the link as shown in this
example:
Test URL: https://apitest.vtod.com/2.0.0/REST/GetToken
Production URL: https://api.vtod.com/2.0.0/REST/GetToken

Does the XML or JSON version have to match the version in the URLs?
The XML or JSON version must match the version in the URLs being used. As an example, if the
URL is https://apitest.vtod.com/2.0.0/Rest/GetToken, the version in JSON must also be 2.0.0.

Is it better to use XML or JSON?


We recommend you use JSON, because if the response becomes too large, XML
serialization/deserialization can be very slow.

Is the default message handling XML or JSON?


The default message handling is for the JSON message format.
To use the XML message formats, append media=xml to the query string, as shown here:

Page 269
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
FAQs

https://apitest.vtod.com/2.0.0/Rest/GetToken?media=xml

How do I access the utility service?


The utility service offers various data lookup actions and is located at
https://apitest.vtod.com/2.0.0/REST/Utility/GetServicesAirports

What values can be used with the EchoToken attribute, and is this required?
The EchoToken attribute links a partner's request to our system. It can be a GUID or a
customer table ID, however, it is not required.

Are all Address attributes required?


The answer to this question depends on the dispatch system being used, so best practice is
to include all these attributes:
l Latitude
l Longitude
l AddressLine
l CityName
l PostalCode
l StateCode
l CountryName
l LocationType

Is a value required for LocationType element?


No, this value is not required.

What attributes are required for the Airline element?


The FlightDateTime and CodeContext attributes are required. However, because the Airline
information may be used by various dispatch systems best practice is to also send the Code
and FlightNumber attributes.

How is the Target attribute used?


The Target attribute indicates which environment is being used. However, since SuperShuttle
uses two separate endpoints for its test and production environments, this attribute is not
checked when a request is processed.

Page 270
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
FAQs

Can partners use the MemberID attribute?


No, the MemberID is exclusive to SuperShuttle and may not be used by external entities.

What currencies does SuperShuttle support?


Currently, SuperShuttle supports only US Dollars (USD) and Euros (EUR).

Does gratuity information have to be included in the GroundAvailRQ?


The Ground Availability Request (GroundAvailRQ) should include gratuity, but you can set the
amount to 0.

What are the guidelines for international phone numbers?


When sending international phone numbers:
l Omit leading zeros before the country code
l The phone number may be split to separate the city code from the remainder of the phone
number

Is there a test direct bill account that can be used by partners?


Not at this time.

What do I enter when the API asks for both DirectBill ID and Billing Number?
Enter the ID given to you by the SuperShuttle Marketing Team in the BillingNumber attribute
and omit the DirectBillID.

What should I enter in the Type attribute for a Cancellation request?


When sending a Cancellation Request, the Type attribute of the UniqueID element should be
Confirmation, as shown in this example.
<UniqueID Type="Confirmation" ID="5903131"/>

Does SuperShuttle require any testing before we go live?


Yes, the SuperShuttle QA Team will review the integration and use cases before you are given
credentials to the live environment.

Why is it important to provide the unit number as part of the address?


If the customer is being picked up from a multi-unit community (apartment, condo,
townhome), not including the unit number would require the driver to call the customer,
possibly with a van full of other passengers. Sedan customers expect the driver to find the

Page 271
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
FAQs

unit and be waiting outside. It's very important to our quality of service to meet our
customer's expectations and know precisely where to pick them up.

Why do I receive the error message "The Reference ID doesn't match any rate for
the trip"?
Booking requests and cancellations must include the attribute Type="Confirmation" and the
reference number must be the VTOD reference number returned in the response. See XML
Sample: Reference.

Why do I have to provide SuperShuttle with a flight time?


Important: SuperShuttle does not guarantee a customer will make their flight unless they
use the pick-up time calculated by SuperShuttle for our shared ride (Blue Van) service.

Providing SuperShuttle with a flight time enables us to calculate realistic pickup times for a
customer. SuperShuttle's calculation takes into account many factors of which a customer
may not be aware, such as the pick-up location and needs of the other customers sharing the
same van, scheduled hotel service times, traffic, geography, closures, and the like.
SuperShuttle's success is largely built upon it's ability to map the most efficient routes
possible to limit customer travel times, while ensuring customers get where they're going on
time. When booking trips for SuperShuttle's shared ride service (Blue Van), SuperShuttle does
not guarantee a customer will make their flight unless they use the pick-up time calculated by
SuperShuttle.
SuperShuttle's ExecuCar sedan service provides additional flexibility and allows a passenger
to choose their own pick-up time.

Which credit cards does SuperShuttle accept and what are the correct codes to
pass for each?
SuperShuttle accepts these cards.

Card Code Card Name


AMEX American Express
DISC Discover Card
JCB Japanese Credit Bureau (JCB)
MC MasterCard
VISA VISA

Page 272
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.
SuperShuttle Web Services API Documentation
FAQs

What is the difference between an API confirmation number and a dispatch con-
firmation number?
When a SuperShuttle partner uses the VTOD API to call the GroundBookRQ method, two
confirmation numbers are returned in the response:
l VTOD confirmation number (represented by the first <Confirmation> element), which is
an internal record ID used only within the API and never shared with the customer
l Dispatch system confirmation number (represented by the second <Confirmation> ele-
ment with type = "DispatchConfirmation"), which is the confirmation number shared with
the customer and will be needed by the customer if they call in regarding their reservation
When canceling a reservation, the VTOD API requires the VTOD confirmation number. When
communicating with a customer, the DispatchConfirmation number is used.

How does SuperShuttle identify duplicate reservations?


Duplicates are identified based on these criteria:
l Same airport
l Same direction of travel (to airport or from airport)
l Same service type (shared ride van, exclusive van, meet and greet)
l Same service address
l Same travel date and time
l Same passenger counts
l Same first and last name
l Existing reservation not canceled

Page 273
Revised: February 11, 2016
Copyright 2015 SuperShuttle Inc.