Vouchers
Vouchers API Endpoint
| API | Description |
|---|---|
| GET api/v1/Vouchers?VoucherCode={VoucherCode} |
Gets a voucher with the given code, if it exists |
| GET api/v1/Vouchers?AccountCode={AccountCode}&fromCreateDate={fromCreateDate}&toCreateDate={toCreateDate} |
Retrieves a list of vouchers which were created between given dates for given account |
| POST api/v1/Vouchers |
Create a new voucher |
HeartBeat
Handles requests to the /heartbeat/ endpoint
| API | Description |
|---|---|
| GET api/v1/HeartBeat |
Check TBR service status. Will return a object with Success = true if everything is working correctly. |
Quotes
Quotes API endpoint
| API | Description |
|---|---|
| POST api/v1/Quotes |
Obtain a detailed quote from the system based on the given parameters. |
Cars
Handles requests to the /cars/ endpoint
| API | Description |
|---|---|
| GET api/v1/Cars?JobID={JobID} |
Get the current status of the car associated with the given job ID |
| GET api/v1/Cars?Token={Token} |
Get the current status of the car associated with the given job tracking token |
Payments
Managing credit card payments with Payment Request
| API | Description |
|---|---|
| GET api/v1/Payments?AccountCode={AccountCode} |
Produces a token that must be used when completing Payment Request |
| POST api/v1/Payments |
Sends the payment receipt to the emails specified. |
Jobs
Jobs API endpoint
| API | Description |
|---|---|
| GET api/v1/Jobs?AccountCode={AccountCode}&q={q}&extraref={extraref}&sortBy={sortBy}&sortDirection={sortDirection}&fromDate={fromDate}&toDate={toDate}&city={city}&countryISO={countryISO}&pageStart={pageStart}&pageSize={pageSize}&includeCompleted={includeCompleted}&includeCancelled={includeCancelled}&groupbooking={groupbooking}&searchAllAddress={searchAllAddress}&passenger={passenger}&emailAddress={emailAddress}&reservationCode={reservationCode}&voucherCode={voucherCode}&includeExpiredVoucherCampaigns={includeExpiredVoucherCampaigns} |
Searches job for a number of parameters. Only AccountCode is required, all other parameters default to something meaningful. Parameters are ANDed, so more parameters make the query more specific. |
| GET api/v1/Jobs/{id} |
Queries for an existing job |
| POST api/v1/Jobs |
Create a job based on the newJobRequest data |
| PUT api/v1/Jobs/{id} |
Update a job with the given ID. |
| DELETE api/v1/Jobs/{id} |
Delete a job by a given ID |
Confirmations
Confirmations API endpoint
| API | Description |
|---|---|
| POST api/v1/Confirmations |
Sends a confirmation email to the job booker, passenger, and email addresses specified. |
Flights
| API | Description |
|---|---|
| GET api/v1/Flights?flightNumber={flightNumber}&isArrival={isArrival}&scheduledDateTime={scheduledDateTime}&accountCode={accountCode}&airportCode={airportCode} |
ClientFeedback
ClientFeedback submission endpoint
| API | Description |
|---|---|
| POST api/v1/ClientFeedback |
Post feedback |
BookableRates
Manages a list of journeys which are available in the quoting engine
| API | Description |
|---|---|
| GET api/v1/BookableRates?AccountCode={AccountCode}&Country={Country}&City={City}&PlaceType={PlaceType}&VoucherCode={VoucherCode} |
If you want to use quoting, it is advisable that you use this method to limit the user input on the UI on available jobs that can be booked |