GET v3/instances/{id}/status/areas?includeLockInformation={includeLockInformation}&includeChildPlans={includeChildPlans}

Returns an overview of the current availability status of a number of specific areas for an instance

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required
areaIds		Collection of string	Required
includeLockInformation	If true, includes the lock information for seats available to the current user	boolean	Default value is False
includeChildPlans		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

InstancePlanStatus

Name	Type	Additional information
Name	string	None.
Available	integer	None.
WheelchairAvailable	integer	None.
SpecialAvailable	integer	None.
Capacity	integer	None.
Bands	Collection of Band	None.
InBasket	integer	None.
Unavailable	integer	None.
LockInfoAvailable	Collection of LockedSeatQuantity	None.
LockInfoSpecialAvailable	Collection of LockedSeatQuantity	None.

Response Formats

application/json

Sample:

{
  "name": "sample string 1",
  "available": 2,
  "wheelchairAvailable": 3,
  "specialAvailable": 4,
  "capacity": 26,
  "inBasket": 5,
  "unavailable": 12,
  "lockInfoAvailable": null,
  "lockInfoSpecialAvailable": null
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.