POST api/GetOccupancy

POST implementation of GetOccupancy

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
APIKey	An active API Key for the APT.MobileAPI service	string	None.
FacilityNo	The facility number of the target carpark	integer	None.
Carpark	The carpark you are requesting occupancy for	unsigned integer	None.
Type	The type of count to request	CountType	None.
Index	Identifies the index of the Category or Storey you are requesting (for example Index 1 = Short-term, Index 3 = Total)	unsigned integer	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "FacilityNo": 2,
  "Carpark": 3,
  "Type": 1,
  "Index": 4
}

Response Information

Resource Description

GetOccupancyResponse

Name	Description	Type	Additional information
FacilityNo	The facility number of the carpark	integer	None.
Designation	The descriptive name given to the Category or Storey	string	None.
Carpark	The carpark number this message relates to	unsigned integer	None.
Type	The type of count this messsage relates to.	CountType	None.
Index	The index of the Category or Storey this message relates to	unsigned integer	None.
Capacity	The total capacity for the Category/Storey	integer	None.
Occupied	The total capacity for the Category/Storey	integer	None.
Free	The number of available spaces for the Category/Storey	integer	None.
Status	Contains a value of 'Free' or 'Full' to indicate the status of the Category or Storey. When the status is 'Full' vehicles are unable to enter the carpark	string	None.

Response Formats

application/json, text/json

Sample:

{
  "FacilityNo": 1,
  "Designation": "sample string 2",
  "Carpark": 3,
  "Type": 1,
  "Index": 4,
  "Capacity": 5,
  "Occupied": 6,
  "Free": 7,
  "Status": "sample string 8"
}