Name | Description | Type | Additional information |
---|---|---|---|
JobID |
Unique TBR Job identifier |
integer |
Required |
ProjectCode |
An ProjectCode which will be included in all responses and on the invoice. Can be used for reference purposes |
string |
None. |
CostCentre |
A Cost Centre code which will be included in all responses and on the invoice. Can be used for reference purposes |
string |
None. |
PurchaseOrder |
A purchase order code which will be included in all responses and on the invoice. Can be used for reference purposes |
string |
None. |
ExtraReference |
An AccountCode which will be included in all responses and on the invoice. Can be used for reference purposes |
string |
None. |
NotesToReservations |
Notes for the reservation agent in the back office |
string |
None. |
NotesToPassenger |
Location specific notes to the passenger, i.e Curbside Pickup |
string |
None. |
NotesToDriver |
Location specific notes for the driver |
string |
None. |
NotesToControl |
Notes to the internal Control Staff. |
string |
None. |
Itinerary |
The itinerary for the job (can be self-contained HTML) |
string |
None. |
Signboard |
The text on the signboard to be displayed at the pickup location |
string |
None. |
RequiresDDI |
Whether you require a permanent forward to the drivers' cell |
boolean |
None. |
BookerEmailConfirmation |
Whether this booking requires an automatic email to the booker |
boolean |
None. |
BookerSMSConfirmation |
Whether this booking requires an automatic SMS to the booker |
boolean |
None. |
PassengerEmailConfirmation |
Whether this booking requires an automatic email to the passenger |
boolean |
None. |
PassengerSMSConfirmation |
Whether this booking requires an automatic SMS to the passenger |
boolean |
None. |
PassengerLanguage |
Specifies the language of outgoing communication using standard language ISO codes ([language[-territory]], i.e ja-JP) |
string |
None. |
CreditCardToken |
A token which can be used to store a credit card to be used for the job |
string |
None. |
PaymentRequest |
Payment details with a nonce from the client (you need to call /Payments/?AccountCode=XXX first to get a server nonce) ref:https://developers.braintreepayments.com/javascript+dotnet/start/hello-server |
PaymentRequest |
None. |
TicketClass |
Airline ticket class I, O, Z etc |
string |
None. |
JobQuoteID |
If the job is based on a quote, please pass in your quote rate ID to get the price you were initially given. |
integer |
None. |
AdditionalJobQuoteIDs |
If you have generated additional quotes that you would like to persist, you can use this list of IDs. The quotes will be stored against the job and can be queried later. |
Collection of integer |
None. |
Currency |
The preferred/selected currency. We fallback to this if the PaymentRequest and PaymentRequest.Currency is not set. If the client has a sales account with this currency then it will be saved against the job. |
string |
None. |
RouteType |
The type of job; Transfer or AsDirected. String from the Enum of RouteType |
string |
Required |
ShareCar |
Whether the booker wants to make the car available to other travellers from the same company |
boolean |
None. |
Passengers |
A list of all passengers. |
Collection of Passenger |
None. |
Pickup |
Pickup Details |
Pickup |
Required |
Midpoints |
A list of Stops / Midpoints |
Collection of Midpoint |
None. |
Dropoff |
Dropoff Details |
Dropoff |
Required |
VehicleType |
The requested vehicle type. String based on Enum in Constants.VehicleType |
string |
Required |
ExpectedPassengerCount |
Total expected number of Passengers. |
integer |
None. |
UserDefinedFields |
An arbitrary collection of keys and values, allowing you to pass in any number of references you wish. Will be included in the invoice |
Collection of UserDefinedField |
None. |
VoucherCode |
Voucher code to use |
string |
None. |
SelectedExtras |
A list of selected extras from the quote which you wish to include. These will be added to the price you are charged. |
Collection of SelectedQuoteExtra |
None. |
ExtRefID |
An external reference provided by you returned to you. This should not be visible to the end user and only serves the purpose to link up different system. |
string |
None. |
ExtUserID |
External User ID (for audit purposes) in the querying system. |
string |
Required |