POST api/v1/Confirmations

Sends a confirmation email to the job booker, passenger, and email addresses specified.

Request Information

URI Parameters

None.

Body Parameters

ConfirmationRequest
NameDescriptionTypeAdditional information
JobIDs

TBR Job identifiers, to send the confirmation for a the given jobs. If omitted, group booking name must be given

 Collection of integer

None.
GroupBookingName

TBR Identifier for a group of jobs, will send confirmation for all jobs in this group of bookings. If specified, jobIDs are used as a filter.

 string

None.
AdditionalEmails

List of emails addresses to receive the confirmation in addition to the booker / passenger (if enabled)

 Collection of string

None.
AdditionalMobileNumbers

List of mobile numbers to receive the confirmation in addition to the booker / passenger (if enabled)

 Collection of string

None.
BookerEmailConfirmation

Set if you want to send an email to the booker

 boolean

None.
BookerSMSConfirmation

Set if you want to send an SMS to the booker

 boolean

None.
PassengerEmailConfirmation

Set if you want to send an email to the passenger

 boolean

None.
PassengerSMSConfirmation

Set if you want to send an SMS to the passenger

 boolean

None.
ExtUserID

External User ID (for audit purposes) in the querying system.

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "jobIDs": [
    1,
    2
  ],
  "groupBookingName": "sample string 1",
  "additionalEmails": [
    "sample string 1",
    "sample string 2"
  ],
  "additionalMobileNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "bookerEmailConfirmation": true,
  "bookerSMSConfirmation": true,
  "passengerEmailConfirmation": true,
  "passengerSMSConfirmation": true,
  "extUserID": "sample string 6"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A Confirmation object with the message field updated.

Confirmation
NameDescriptionTypeAdditional information
Recipient

Returns a list if sending to a specific recipient worked successfully to the user.

 Dictionary of string [key] and string [value]

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: 
{
  "recipient": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "extRefID": "sample string 1"
}