Venues: Block Venues

Updated June 14, 2023 15:56

Block Venues

POST /v2/venue/add/booking

Allows you to block off up to 10 venues at a time so that these can be added to an event. Each booking is defined by the parameters below in an array.

Parameter

VenueId Long

The Id of the venue you would like to block.

StateDate DateTime

The start date and time range of the venue booking.

EndDate DateTime

The end date and time range of the venue booking.

SetUpType Object {Id, Name}

The Set-Up being added. This Set-Up must exist in your Priava account. Passed in JSON format where:
Id=the Id of the Set Up.
Name= the name of the Set Up

SetUpDuration Integer

The duration of time required for set up in minutes.

SetDownType Object {Id, Name}

The Set Down being added. This Set Down must exist in your Priava account. Passed in JSON format where:
Id= the Id of the Set Down.
Name= the name of the Set Down.

SetDownDuration Integer

The duration of time required for set down in minutes.

VenuePax Integer

The number of persons who will be attending or present at the event/venue.

VenueBookingType Object {Id, Name}

The Booking Type to be associated with this venue booking. The Booking Type must exist in your Priava Account. Passed in JSON format where:
Id = the Id of the booking type.
Name = the name of the booking type.

VenueBookingStatus Object {Id, Name}

The Event Status to be associated with this venue booking. The Event Status must exist in your Priava Account. Passed in JSON format where:
Id = the Id of the event status.
Name = the name of the event status.

VenueComment String

The comment to be added to the venue booking.

ignoreWarning boolean

The warnings to be ignored or considered. (Note: This is a query parameter).

ExtendedBlockTime boolean

If the ExtendedBlockTime value is provided as true, then blocking time for the venues while creating the event will be 20 mins instead of 5 mins.

JSON(Scenario 1)

Params:
ignoreWarning=true 

Request Body:
[
   {
      "VenueId": 100301605,
      "StartDate": "6/12/2019 13:00:00",
      "EndDate": "7/12/2019 14:00:00",
      "VenuePax": 7,
      "SetUpDuration": 10,
      "SetUpType": {
         "Id": 100007547,
         "Name": "Dock actual setup"
      },
      "SetDownDuration": 10,
      "SetDownType": {
         "Id": 100007548,
         "Name": "Dock actual setdown"
      },
      "VenueBookingType": {
         "Id": 41,
         "Name": "Function"
      },
      "VenueBookingStatus": {
         "Id": 45,
         "Name": "Confirmed"
      },
      "VenueComment": "This is venue comment"
   }
   "ExtendedBlockTime":false
]

Response:

In response, the venue is blocked successfully. Blocked is provided as true and booking timeout in seconds is provided in the BookingTimeout property.

{
    "success": true,
    "result": [
      {
         "StartDate": "06/12/2019 13:00",
         "IsSetup": false,
         "IsSetDown": false,
         "AssociatedBookingId": 0,
         "BookingTimeout": 300,
         "VenueBlockId": 2,
         "VenueId": 100301605,
         "EndDate": "07/12/2019 14:00",
         "Blocked": true,
         "Reason": "",
         "IsWarning":false
      },
      {
         "StartDate": "06/12/2019 12:50",
         "IsSetUp": true,
         "IsSetDown": false,
         "AssociatedBookingId": 2,
         "BookingTimeout": 300,
         "VenueBlockId": 3,
         "VenueId": 100301605,
         "EndDate": "06/12/2019 13:00",
         "Blocked": true,
         "Reason": "",
         "IsWarning":false
      },
      {
         "StartDate": "07/12/2019 14:00",
         "IsSetUp": false,
         "IsSetDown": true,
         "AssociatedBookingId": 2,
         "BookingTimeout": 300,
         "VenueBlockId": 4,
         "VenueId": 100301605,
         "EndDate": "07/12/2019 14:10",
         "Blocked": true,
         "Reason": "",
         "IsWarning":false
      }
   ]
}

JSON(Scenario 2)

Params:
ignoreWarning=true 

[
   {
      "VenueId": 100301605,
      "StartDate": "6/12/2019 13:00:00",
      "EndDate": "7/12/2019 14:00:00",
      "VenuePax": 7,
      "SetUpDuration": 10,
      "SetUpType": {
         "Id": 100007547,
         "Name": "Dock actual setup"
      },
      "SetDownDuration": 10,
      "SetDownType": {
         "Id": 100007548,
         "Name": "Dock actual setdown"
      },
      "VenueBookingType": {
         "Id": 41,
         "Name": "Function"
      },
      "VenueBookingStatus": {
         "Id": 45,
         "Name": "Confirmed"
      },
      "VenueComment": "This is venue comment"
   }
]

Response:

In the response, when the blocking of venue is failed, Blocked is false and the reason is being provided in the Reason property.

{
    "success": true,
    "result": [
      {
         "StartDate": "06/12/2019 13:00",
         "IsSetup": false,
         "IsSetDown": false,
         "AssociatedBookingId": 0,
         "BookingTimeout": 0,
         "VenueBlockId": 0,
         "VenueId": 100301605,
         "EndDate": "07/12/2019 14:00",
         "Blocked": false,
         "Reason": "Venue Booking is conflicting with existing booking",
         "IsWarning":false
      },
      {
         "StartDate": "06/12/2019 12:50",
         "IsSetUp": true,
         "IsSetDown": false,
         "AssociatedBookingId": 0,
         "BookingTimeout": 0,
         "VenueBlockId": 0,
         "VenueId": 100301605,
         "EndDate": "06/12/2019 13:00",
         "Blocked": false,
         "Reason": "Venue Booking is conflicting with existing booking",
         "IsWarning":false
      },
      {
         "StartDate": "07/12/2019 14:00",
         "IsSetUp": false,
         "IsSetDown": true,
         "AssociatedBookingId": 0,
         "BookingTimeout": 0,
         "VenueBlockId": 0,
         "VenueId": 100301605,
         "EndDate": "07/12/2019 14:10",
         "Blocked": false,
         "Reason": "Venue Booking is conflicting with existing booking",
         "IsWarning":false
      }
   ]
}

Was this article helpful?

Have more questions? Submit a request