API Create Job

https://systemsx.co.uk/products/bridge

Create a Booking Job

POST /external/deploy/booking

This endpoint allows the creation of a booking job. Either the username or the email_address parameter is required, but only one should be provided.

Body

Name	Type	Required
api_key	string	true
type	string	po,msc,tui
bookingReference	string	true
return_url	url	false
organisationName	string	required
agentName	string	required
bookingFields[]	array	true
bookingFields[username]	string	[username OR email_address]
bookingFields[email_address]	email	[username OR email_address]
bookingFields[password]	string	true

Response

200

{
  "hash": "XXXXXXXXXXXXXXXXXXXXX"
}

400

{
  "hash": "XXXXXXXXXXXXXXXXXXXXX",
  "errors": [
    "X field is Missing or Empty."
  ]
}

return_url Response

{
  "hash": "XXXXXXXX",
  "ImportDetail": {
      "importRequest": {
          "sourceReference": "",
          "bookingReference" : "",
          "bookingFields": [],
          "returnUrl": "",
          "api_key": "",
          "type": ""
      }
  }
}