MIDAS API

get_venue

Returns venue information
Required ParametersPossible ValuesDescription
venueVenue name | Venue IDVenue name or internal venue ID
Optional ParametersPossible ValuesDescription
matchexact | looseAllows specifying the closeness of the match.
If match is set "exact" and "venue" is set to "Meeting Room", only venues with named "Meeting Room" will be returned.
If match is set to "loose" and "venue" is set to "Meeting Room", any venue containing the name "Meeting Room" (such as "Meeting Room 1", "Meeting Room 2", "Meeting Room 3", etc will be returned.
If the match parameter is omitted only exact matches are returned
Example Response
↓ Show
[
	{
	"id":"1",
	"venue":"Room 1",
	"capacity":"20",
	"description":"A small meeting room",
	"requestable":"1",
	"rates":[
		{
		"Mon":[
			{
			"rate":"100.00",
			"rate_length":"1",
			"rate_type":"Hourly"
			},
			{
			"rate":"80.00",
			"rate_length":"4",
			"rate_type":"Hourly"
			},
			{
			"rate":"450.00",
			"rate_length":"6",
			"rate_type":"Booking"
			}
			],
		"Tue":[
			{
			"rate":"20.00",
			"rate_type":"Hourly"
			}
			],
		"Wed":[
			{
			"rate":"20.00",
			"rate_type":"Hourly"
			}
			],
		"Thu":[
			{
			"rate":"20.00",
			"rate_type":"Hourly"
			}
			],
		"Fri":[
			{
			"rate":"20.00",
			"rate_type":"Hourly"
			}
			],
		"Sat":[
			{
			"rate":"20.00",
			"rate_type":"Hourly"
			}
			],
		"Sun":[
			{
			"rate":"20.00",
			"rate_type":"Hourly"
			}
			]
		}
		],
	"operating_hours":[
		{
		"day":"Mon",
		"closed":"0000-0800,2100-2400",
		},
		{
		"day":"Tue",
		"closed":"0000-0800,2100-2400",
		},
		{
		"day":"Wed",
		"closed":"0000-0800,2100-2400",
		},
		{
		"day":"Thu",
		"closed":"0000-0800,2100-2400",
		},
		{
		"day":"Fri",
		"closed":"0000-0800,2100-2400",
		},
		{
		"day":"Sat",
		"closed":"0000-0930,2000-2400",
		},
		{
		"day":"Sun",
		"closed":"0000-1000,1600-2400"
		}
		],
	"closed_from":"",
	"closed_until":"1/4/2015",
	"managers":"Jane Doe,Joe Bloggs",
	"member_of":"Group A,Group B",
	"blocks":"Room 4",
	"alternatives":"Room 2,Room 3"
	}
]
Variables ReturnedDescription
idInternal venue ID
venueVenue name
capacityThe maximum occupancy of the venue
descriptionThe venue's description
requestableWhether the venue is available for public requesting
ratesThe room rate/hire charge for each day of the week
<day>Can be one of the following: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" to denote subsequent rate information for each day of the week
rateThe room/rate hire charge amount
rate_lengthThe minimum length of the booking the rate applies to (in hours)
rate_typeIf "Hourly", the rate is per-hour, if "Daily", the rate is per-day, if "Booking", the rate is per-booking
operating_hoursThe times between which the venue is closed during each day of the week
dayThe day of the week
closedA comma separated list of the times (24 hour format) the venue is closed
closed_fromThe date after which the venue is considered closed
closed_untilThe date until which the venue is considered closed
managersA comma separated list of user who are "Managers" of the venue i.e. can approve Booking Requests for the venue
member_ofA comma separated list of Venue Groups to which the venue belongs to
blocksA comma separated list of venues which are automatically blocked (Unavailable) when this venue has an ongoing booking
alternativesA comma separated list of venues which should be considered as alternatives to this venue