/booking/status

v1.0.0

Get the booking status for multiple items based on different criteria

This service:

is ideally be used in software for bulk updates of pending bookings
returns a maximum of 1000 bookings (narrow your search if you expect a greater number of results)
will return both live and test bookings
rate limited to one request every 30 minutes
For more information, see:

Exceeding the rate limit

You will receive the following error message if you exceed the rate limit allowed for this service. Set test to true to bypass this limit:

javascript

{    "data": null    "vmid": 221002    "errorMessage": ["Access allowed every 30 minutes"]    "errorType": "EXCEPTION"    "dateStamp": "2013-03-26T10:28:51+0000"    "errorReference": 55315512721712161381352771    "errorMessageText": ["Access allowed every 30 minutes"]    "success": false    "totalCount": 1    "errorName": "PollingDeniedException"  }

Input

{
  "type": "object",
  "properties": {
    "Accept-Language": {
      "type": "string"
    },
    "bookingDateFrom": {
      "type": "string",
      "description": "**earliest date** for *this* booking (must be in the future)"
    },
    "bookingDateTo": {
      "type": "string",
      "description": "**latest date** for *this* booking (must be in the future)"
    },
    "distributorItemRefs": {
      "type": "array",
      "description": "**array** of partner-defined distributor item reference identifiers e.g. `['refItem1','refItem2','refItem3']`",
      "items": {
        "type": "string"
      }
    },
    "distributorRefs": {
      "type": "array",
      "description": "**array** of partner-defined distributor reference identifiers",
      "items": {
        "type": "string"
      }
    },
    "itemIds": {
      "type": "array",
      "description": "**array** of item identifiers to check",
      "items": {
        "type": "integer",
        "description": "**numeric item identifier**"
      }
    },
    "leadFirstName": {
      "type": "string",
      "description": "**first name** of the lead traveler"
    },
    "leadSurname": {
      "type": "string",
      "description": "**surname** of the lead traveler"
    },
    "test": {
      "type": "boolean",
      "description": "**specifier**:\n- `true`: bypass the poll limit in the prelive environment only (recommended for testing)\n- `false`: (default)\n"
    }
  },
  "required": [
    "Accept-Language"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object"
}