Get Booking List

Get Booking List

POST [PlatformAddress]/api/1.0/venue?action=getBookingList

Get a list of bookings.

Path Parameters

Name	Type	Description
venueId	integer	The id of the venue
perPage	integer	The number of bookings to get in a single call

200

{
  "meta": {
    "totalResults": 256,
    "start": 0,
    "perPage": 1,
    "count": 1
  },
  "results": [
    {
      "id": 1,
      "venueId": 1,
      "code": "HR5ZASGMQ1",
      "name": "Some Booking",
      "eventType": "Holiday",
      "companyId": 4,
      "company": {
        "id": 4,
        "businessName": "Some Business"
      },
      "contactId": 3,
      "contact": {
        "id": 3,
        "firstName": "Quamar",
        "lastName": "Boyer",
        "email": "[e-mail]",
        "phone": "[phone]"
      },
      "isConfidential": false,
      "currentStatus": 3,
      "totalAmount": 105,
      "totalTaxAmount": 5,
      "amountOutstanding": -425.3,
      "accountTimezone": null,
      "venueTimezone": null,
      "createdDate": "2015-01-07 09:21:53 UTC",
      "modifiedDate": "2016-04-06 07:51:56 UTC",
      "lastModifiedDate": "2016-04-08 07:50:00 UTC",
      "dateEventStart": "2015-06-01 00:00:00 UTC",
      "dateEventEnd": "2015-06-04 00:00:00 UTC",
      "convertedToTentative": "2016-02-23 00:00:00 UTC",
      "convertedToConfirmed": "2016-03-05 12:49:31 UTC",
      "convertedToCancelled": "2016-02-28 00:00:00 UTC",
      "isAccommIncluded": true,
      "dateAccomStart": "2015-06-01 00:00:00 UTC",
      "dateAccomEnd": "2015-06-27 00:00:00 UTC",
      "focRoomsDenominator": 5,
      "maxNumFocRoomsPerDay: 2,
      "hasPackages": true,
      "decisionDate": "",
      "canBeMoved": false,
      "bookedById": 123,
      "beoNumbers": ["11-1", "12-1", "13-2"],
      "isBeoFinalised": true,
      "beoFinalisedDate": "2015-02-09 03:37:39 UTC",
      "otaFolioRef": "ven1234",
      "accommCutOffDate": "2019-12-04 00:00:00 UTC",
      "accommCancellationDate": "2019-01-11 00:00:00 UTC",
      "accommChargingMethod": 2,
      "accommGuaranteeRequired": false,
      "accommExternalBlockId": "test 123",
    }
  ]
}

The result from this call will be a collection of all the events the user has access to. This call also accepts the pagination and filter properties.

Example Request

Get a specific venue’s Booking List

{
  "venueId": "1",
  "perPage": 1
}

currentStatus:

One of the following values:

• 1 = Prospective

• 2 = Tentative

• 3 = Confirmed

• 4 = Cancelled

• 5 = Ordering

• 8 = Not Accepted

Additional Filter Properties

Property	Description	Type
companyId	Filter by unique id of company	integer
contactId	Filter by unique id of contact	integer
modifiedDateBefore	Filter by Modified Date	iVvy Timestamp Format
modifiedDateAfter	Filter by Modified Date	iVvy Timestamp Format