GET api/v1/Jobs/{id}

Queries for an existing job

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the job	integer	Required

Body Parameters

None.

Response Information

Resource Description

A Job object specified by the TBR ID

Job

Name	Description	Type	Additional information
JobID	Unique TBR Job identifier	integer	None.
ReferenceNumber	Unique TBR Reference, in the form of 21-01234567	string	None.
Status	Job Status. CONFIRMED, POB, etc.	string	None.
ProjectCode	An Project Code 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 Extra Reference which will be included in all responses and on the invoice. Can be used for reference purposes	string	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.
UDFs	Same as UserDefinedFields just nicer	Dictionary of string [key] and string [value]	None.
GroupBookingName	If the jobrequest is part of a larger group booking, i.e you are creating 10 jobs in a row for the same passenger and you would like one invoice	string	None.
Bookers	The list of contacts on the job or group booking.	Collection of Booker	None.
RouteType	The type of job; Transfer or As Directed	string	None.
NotesToReservations	Notes for the reservation agent in the back office	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.
DDI	The assigned DDI full phone number (if requested)	string	None.
Passengers	A list of all passengers.	Collection of Passenger	None.
Pickup	Pickup Details	Pickup	None.
Midpoints	A list of Stops / Midpoints	Collection of Midpoint	None.
Dropoff	Dropoff details	Dropoff	None.
VehicleType	The assigned vehicle type. First class, etc	string	None.
VehicleModel	The assigned vehicle model. BMW, etc	string	None.
MeetingInstructions	Meeting instructions for the passenger	string	None.
NotesToPassenger	Location specific notes to the passenger, i.e Curbside Pickup	string	None.
NotesToDriver	Location specific notes for the driver	string	None.
NotesForDriverView	Read Only Driver Notes	string	None.
DriverName	Name of the driver assigned to the job	string	None.
DriverMobile	Mobile number of the Driver assigned on the job	string	None.
TimeONSITE	Time when the car arrived onsite	string	None.
TimePOB	Time when the passenger entered the car	string	None.
TimeDROPPED	Time when the driver dropped of the passenger at the final destination	string	None.
CarRegistration	Registration Number of the car (if known)	string	None.
Version	Update number of the job. Will be incremented as soon as something significant changes.	integer	None.
CreditCard	If job is paid with a credit card, we include the abbreviated details only	CreditCard	None.
Partner	Information about the provider / partner of the job	Partner	None.
AccountCode	This account code specifies under which TBR client the job is to be created. Could be an integer, ie one of 2573, 7070, 7165, 7145 or any other identifier	string	None.
ShareCar	Whether the booker wants to make the car available to other travellers from the same company	boolean	None.
TicketClass	Airline ticket class I, O, Z etc	string	None.
ExpectedPassengerCount	Total expected number of Passengers.	integer	None.
Supplier	Supplier of the driver of the job	string	None.
LongVersion	A long version number uniquely identifying the record. If the record has changed, you will see a higher value.	integer	None.
Charge	If there have been charges for this job (usually the passenger) and if there is anything outstanding. Null if N/A	Charge	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.
JobQuoteDetail	Quote / price details for the job (if available)	JobQuoteDetail	None.
ReservationCode	Unique code given to users to identify job.	string	None.
VoucherCode	Voucher code used to book this job (if available)	string	None.
UpdateJobThresholdHours	Minimum amount of hours the booking has to be in the future to be updateable. The difference in hours between job local pickup time and job local current time cannot be less than this threshold. You will receive an exception if you are trying to update a booking which is below the threshold.	integer	None.
CancelJobThresholdHours	Minimum amount of hours the booking has to be in the future to be canceable free of charge. The difference in hours between job local pickup time and job local current time cannot be less than this threshold. You will not receive and exception if you attempt to cancel a booking below the threshold but the job will be marked as a late cancellation and may be chargeable.	integer	None.
PaymentUrl	URL to payment page, using correct job token.	string	None.
JobCreatedDate	Date of submission/creation of the job.	date	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.

Response Formats

application/json, text/json

Sample:

{
  "jobID": 1,
  "referenceNumber": "sample string 2",
  "status": "sample string 3",
  "projectCode": "sample string 4",
  "costCentre": "sample string 5",
  "purchaseOrder": "sample string 6",
  "extraReference": "sample string 7",
  "userDefinedFields": [
    {
      "key": "sample string 1",
      "value": "sample string 2",
      "visibility": "sample string 3"
    },
    {
      "key": "sample string 1",
      "value": "sample string 2",
      "visibility": "sample string 3"
    }
  ],
  "udFs": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "groupBookingName": "sample string 8",
  "bookers": [
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "mobile": "sample string 3",
      "landline": "sample string 4"
    },
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "mobile": "sample string 3",
      "landline": "sample string 4"
    }
  ],
  "routeType": "sample string 9",
  "notesToReservations": "sample string 10",
  "itinerary": "sample string 11",
  "signboard": "sample string 12",
  "ddi": "sample string 13",
  "passengers": [
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "mobile": "sample string 3",
      "company": "sample string 4"
    },
    {
      "name": "sample string 1",
      "email": "sample string 2",
      "mobile": "sample string 3",
      "company": "sample string 4"
    }
  ],
  "pickup": {
    "dateTime": "2024-07-27T06:43:43.9037209+00:00",
    "tbc": true,
    "address": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    },
    "connection": {
      "connectionType": "sample string 1",
      "number": "sample string 2",
      "origin": "sample string 3",
      "destination": "sample string 4",
      "dateTime": "2024-07-27T06:43:43.9037209Z",
      "directionType": "sample string 5",
      "terminal": "sample string 6",
      "verified": true,
      "signatureFlight": true
    }
  },
  "midpoints": [
    {
      "dateTime": "2024-07-27T06:43:43.9037209+00:00",
      "address": {
        "airportCode": "sample string 1",
        "addressLine1": "sample string 2",
        "addressLine2": "sample string 3",
        "addressLine3": "sample string 4",
        "postcode": "sample string 5",
        "city": "sample string 6",
        "country": "sample string 7",
        "state": "sample string 8",
        "longitude": 9.1,
        "latitude": 10.1,
        "postalAddress": "sample string 11",
        "googlePlaceID": "sample string 12",
        "googleUserInputAddress": "sample string 13",
        "locationType": "sample string 14"
      }
    },
    {
      "dateTime": "2024-07-27T06:43:43.9037209+00:00",
      "address": {
        "airportCode": "sample string 1",
        "addressLine1": "sample string 2",
        "addressLine2": "sample string 3",
        "addressLine3": "sample string 4",
        "postcode": "sample string 5",
        "city": "sample string 6",
        "country": "sample string 7",
        "state": "sample string 8",
        "longitude": 9.1,
        "latitude": 10.1,
        "postalAddress": "sample string 11",
        "googlePlaceID": "sample string 12",
        "googleUserInputAddress": "sample string 13",
        "locationType": "sample string 14"
      }
    }
  ],
  "dropoff": {
    "dateTime": "2024-07-27T06:43:43.9037209+00:00",
    "address": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    },
    "connection": {
      "connectionType": "sample string 1",
      "number": "sample string 2",
      "origin": "sample string 3",
      "destination": "sample string 4",
      "dateTime": "2024-07-27T06:43:43.9037209Z",
      "directionType": "sample string 5",
      "terminal": "sample string 6",
      "verified": true,
      "signatureFlight": true
    }
  },
  "vehicleType": "sample string 14",
  "vehicleModel": "sample string 15",
  "meetingInstructions": "sample string 16",
  "notesToPassenger": "sample string 17",
  "notesToDriver": "sample string 18",
  "notesForDriverView": "sample string 19",
  "driverName": "sample string 20",
  "driverMobile": "sample string 21",
  "timeONSITE": "sample string 22",
  "timePOB": "sample string 23",
  "timeDROPPED": "sample string 24",
  "carRegistration": "sample string 25",
  "version": 26,
  "creditCard": {
    "nameOnCard": "sample string 1",
    "number": "sample string 2",
    "cvv": "sample string 3",
    "expiryDate": "sample string 4",
    "type": "sample string 5",
    "billingAddress": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    }
  },
  "partner": {
    "name": "sample string 1",
    "address": {
      "airportCode": "sample string 1",
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "postcode": "sample string 5",
      "city": "sample string 6",
      "country": "sample string 7",
      "state": "sample string 8",
      "longitude": 9.1,
      "latitude": 10.1,
      "postalAddress": "sample string 11",
      "googlePlaceID": "sample string 12",
      "googleUserInputAddress": "sample string 13",
      "locationType": "sample string 14"
    },
    "email": "sample string 2",
    "websiteURL": "sample string 3",
    "bookingWebsiteURL": "sample string 4",
    "notesToBooker": "sample string 5",
    "notes": "sample string 6",
    "phone": "sample string 7"
  },
  "accountCode": "sample string 27",
  "shareCar": true,
  "ticketClass": "sample string 29",
  "expectedPassengerCount": 30,
  "supplier": "sample string 31",
  "longVersion": 32,
  "charge": {
    "amountPaid": 1.0,
    "amountOutstanding": 2.0,
    "currency": "sample string 3",
    "chargeDetails": [
      {
        "transactionID": "sample string 1",
        "amount": 2.0,
        "transTime": "2024-07-27T06:43:43.9037209Z",
        "nameOnCard": "sample string 4",
        "cardType": "sample string 5",
        "lastDigits": 6,
        "currency": "sample string 7",
        "description": "sample string 8",
        "isRefundable": true,
        "reasonCode": "sample string 10"
      },
      {
        "transactionID": "sample string 1",
        "amount": 2.0,
        "transTime": "2024-07-27T06:43:43.9037209Z",
        "nameOnCard": "sample string 4",
        "cardType": "sample string 5",
        "lastDigits": 6,
        "currency": "sample string 7",
        "description": "sample string 8",
        "isRefundable": true,
        "reasonCode": "sample string 10"
      }
    ]
  },
  "bookerEmailConfirmation": true,
  "bookerSMSConfirmation": true,
  "passengerEmailConfirmation": true,
  "passengerSMSConfirmation": true,
  "passengerLanguage": "sample string 37",
  "jobQuoteDetail": {
    "quoteRateID": 1,
    "cancellationPolicy": "sample string 2",
    "chargeExcess": 3.0,
    "chargeHire": 4.0,
    "chargeHoliday": 5.0,
    "chargeNight": 6.0,
    "chargeWaiting": 7.0,
    "chargeWeekend": 8.0,
    "chargeExcessDistance": 9.0,
    "chargeExcessTime": 10.0,
    "chargeTotalNet": 11.0,
    "chargeTotalGross": 12.0,
    "chargeTotalTaxAmount": 13.0,
    "totalSavings": 14.0,
    "discountHirePercentage": 15.0,
    "distanceAdjust": 16,
    "distanceBooked": 17,
    "distanceTotal": 18,
    "distanceUnit": "sample string 19",
    "distanceExcess": 20,
    "excessRateDistance": 21.0,
    "excessRateTime": 22.0,
    "currency": "sample string 23",
    "includedDistance": 24,
    "includedTime": "sample string 25",
    "timeAdjust": "sample string 26",
    "timeBooked": "sample string 27",
    "timeExcess": "sample string 28",
    "timeTotal": "sample string 29",
    "timeWaiting": "sample string 30",
    "vehicleType": "sample string 31",
    "vehicleModel": "sample string 32",
    "rateType": "sample string 33",
    "vehiclePhotoURL": "sample string 34",
    "canBeBooked": true,
    "maxVehiclePassengers": 36,
    "maxVehicleLuggage": 37,
    "availableCurrencies": [
      {
        "currencyCode": "sample string 1",
        "chargeExcess": 2.0,
        "chargeExcessGross": 3.0,
        "chargeExcessTaxAmount": 4.0,
        "chargeHire": 5.0,
        "chargeHireGross": 6.0,
        "chargeHireTaxAmount": 7.0,
        "chargeHoliday": 8.0,
        "chargeNight": 9.0,
        "chargeWaiting": 10.0,
        "chargeWeekend": 11.0,
        "chargeTotalNet": 12.0,
        "chargeTotalGross": 13.0,
        "chargeTotalTaxAmount": 14.0,
        "totalSavings": 15.0,
        "paymentMethods": [
          "sample string 1",
          "sample string 2"
        ],
        "extras": [
          {
            "name": "sample string 1",
            "price": 2.0,
            "chargeTotalNet": 3.0,
            "chargeTotalGross": 4.0,
            "chargeTotalTaxAmount": 5.0,
            "optional": true,
            "included": true
          },
          {
            "name": "sample string 1",
            "price": 2.0,
            "chargeTotalNet": 3.0,
            "chargeTotalGross": 4.0,
            "chargeTotalTaxAmount": 5.0,
            "optional": true,
            "included": true
          }
        ],
        "chargeHireTaxRate": 16.0
      },
      {
        "currencyCode": "sample string 1",
        "chargeExcess": 2.0,
        "chargeExcessGross": 3.0,
        "chargeExcessTaxAmount": 4.0,
        "chargeHire": 5.0,
        "chargeHireGross": 6.0,
        "chargeHireTaxAmount": 7.0,
        "chargeHoliday": 8.0,
        "chargeNight": 9.0,
        "chargeWaiting": 10.0,
        "chargeWeekend": 11.0,
        "chargeTotalNet": 12.0,
        "chargeTotalGross": 13.0,
        "chargeTotalTaxAmount": 14.0,
        "totalSavings": 15.0,
        "paymentMethods": [
          "sample string 1",
          "sample string 2"
        ],
        "extras": [
          {
            "name": "sample string 1",
            "price": 2.0,
            "chargeTotalNet": 3.0,
            "chargeTotalGross": 4.0,
            "chargeTotalTaxAmount": 5.0,
            "optional": true,
            "included": true
          },
          {
            "name": "sample string 1",
            "price": 2.0,
            "chargeTotalNet": 3.0,
            "chargeTotalGross": 4.0,
            "chargeTotalTaxAmount": 5.0,
            "optional": true,
            "included": true
          }
        ],
        "chargeHireTaxRate": 16.0
      }
    ],
    "extras": [
      {
        "name": "sample string 1",
        "price": 2.0,
        "chargeTotalNet": 3.0,
        "chargeTotalGross": 4.0,
        "chargeTotalTaxAmount": 5.0,
        "optional": true,
        "included": true
      },
      {
        "name": "sample string 1",
        "price": 2.0,
        "chargeTotalNet": 3.0,
        "chargeTotalGross": 4.0,
        "chargeTotalTaxAmount": 5.0,
        "optional": true,
        "included": true
      }
    ],
    "notes": "sample string 38",
    "disclaimers": [
      {
        "label": "sample string 1",
        "text": "sample string 2",
        "locale": "sample string 3"
      },
      {
        "label": "sample string 1",
        "text": "sample string 2",
        "locale": "sample string 3"
      }
    ],
    "taxLabel": "sample string 39",
    "chargeHireTaxRate": 40.0,
    "newBookingThresholdHours": 41,
    "updateBookingThresholdHours": 42,
    "cancelBookingThresholdHours": 43
  },
  "reservationCode": "sample string 38",
  "voucherCode": "sample string 39",
  "updateJobThresholdHours": 40,
  "cancelJobThresholdHours": 41,
  "paymentUrl": "sample string 42",
  "jobCreatedDate": "2024-07-27T06:43:43.9037209Z",
  "extRefID": "sample string 44"
}