Data Types
XML Schema (XSD)
XML Schema formally describes what a given XML document contains,
typically expressed in terms of constraints on the structure and content
of documents of that type. More about XML Schema you can find at
http://www.w3.org/XML/Schema
GLink XML Schema is available on http://api.groundlink.com/schema.
Every GLink request/response pair are validated against GLink XML schema.
Location
| name |
String |
Yes |
Yes |
Full location name |
| address |
String |
|
|
Address line (number and street name) |
| city |
String |
|
|
City or town |
| postal-code |
String |
|
|
Zip or postal code |
| region |
String |
|
|
State or province |
| country |
String |
|
|
ISO 2 digit country code or country name |
| latitude |
Double |
Yes |
Yes |
WGS-84 format latitude |
| longitude |
Double |
Yes |
Yes |
WGS-84 format longitude |
| category |
String |
|
|
Location category, such as Address, Airport, Hotel etc. |
Flight
| airline |
String |
|
Yes |
Airline company |
| number |
String |
|
Yes |
Flight number |
| arrival-from |
String |
|
|
Arrival from |
| terminal |
String |
|
|
Airport terminal |
| meeting-area |
String |
|
Yes |
Meeting area |
| track-flight |
Boolean |
|
Yes |
Track flight and update schedule time |
TravelPoint
| location |
Location |
Yes |
Yes |
Location element |
| flight |
Flight |
|
|
Flight element |
LimoService
| type* |
Integer |
- |
- |
- |
- |
0 - Point to Point, 1 - By The Hour |
| pickup |
TravelPoint |
Yes |
Yes |
Yes |
Yes |
Pickup |
| destination |
TravelPoint |
Yes |
|
Yes |
|
Destination |
| stops |
TravelPoint[] |
|
|
|
|
Stops array |
| round-trip |
Boolean |
|
|
|
|
Round trip |
| hours |
Integer |
|
Yes |
|
Yes |
Number of hours for By The Hour service |
| event |
String |
|
|
|
|
Event name for By The Hour service |
| schedule-time |
DateTime |
|
|
Yes |
Yes |
Date and time of ride (format: M/dd/yyyy hh:mm aa) |
| vehicle-type |
String |
|
|
Yes |
Yes |
Vehicle type, such as BD, LX, VIP |
| adults |
Integer |
|
|
Yes |
Yes |
Number of adults |
| babies |
Integer |
|
|
Yes |
Yes |
Number of babies |
| luggage |
Integer |
|
|
Yes |
Yes |
Luggage count |
| passengers |
Person[] |
|
|
Yes |
Yes |
Array of passengers |
| coupon |
String |
|
|
|
|
Coupon promotion code |
| search-id |
String |
|
|
Yes |
Yes |
Search response Id |
* - Type is always required field and validation of other fields are dependent on type selection
LimoResult
| Field |
Type |
Description |
| id |
Integer |
Unique Id |
| vehicle-type |
String |
Vehicle type, such as BD, LX, VIP etc |
| description |
String |
Description about vehicle |
| image-url |
String |
Vehicle URL image |
| notes |
String |
Notes about service |
| base-fare |
Money |
Base fare (price without additional charges) |
| total-fare |
Money |
All inclusive price |
Reservation
| id |
Integer |
|
Unique Id |
| service |
Service |
Yes |
Service elemenent |
| status |
ReservationStatus |
|
Status Type |
Booking
| id |
Integer |
|
Unique Id |
| reservations |
Reservation[] |
Yes |
Array of reservations |
| booker |
Person |
Yes |
Booker information |
| payment |
Payment |
Yes |
Payment information |
| notice |
String |
|
Text notice |
Payment
| type |
Integer |
Yes |
0 - Credit Card, 1 - Account |
| credit-card |
CreditCard |
Yes |
Credit card element |
| account |
Account |
Yes |
Account element |
CreditCard
| type |
String |
Yes |
AE, VI, MC, DC |
| number |
String |
Yes |
Credit card number |
| expiration |
String |
Yes |
Expiration date (format: MM/yyyy or MM/yy) |
| security-code |
String |
|
Security code (CVV) |
| holder-name |
String |
Yes |
Name on credit card |
Account
| number |
String |
Yes |
Account number |
| authorization-code |
String |
Yes |
Authorization code for account |
| requirements |
Requirement[] |
|
Array of requirements |
Requirement
| key |
String |
Yes |
Requirement key |
| value |
String |
Yes |
Requirement value |
Person
| name |
String |
Yes |
First, Middle and Last name |
| email |
String |
Yes |
Email address |
| phones |
String[] |
Yes |
Array of telephones |
LocationResponse
| Field |
Type |
Description |
| locations |
Location |
Array of locations |
SearchRequest
| limo |
LimoService |
Yes |
LimoService specification |
SearchResponse
| Field |
Type |
Description |
| limo-results |
LimoResult[] |
Array of limo results |
BookingRequest
| booking |
Booking |
Yes |
Booking Request |
BookingResponse
| Field |
Type |
Description |
| booking |
Booking |
Booking response |
CancelRequest
| booking |
Booking |
Yes |
Cancel Request |
CancelResponse
| Field |
Type |
Description |
| cancellations |
Cancellation[] |
Array of cancellations |
Cancellation
| Field |
Type |
Description |
| cancellation-id |
Integer |
Unique cancellation id |
| booking-id |
Integer |
Booking id |
| reservation-id |
Integer |
Reservation id |
| charge |
Decimal |
Cancellation charge |
| description |
String |
Cancellation description |
