POST smartlot/v2/OccupanciesByWards/{APIKey}/{siteCode}

This method returns all the occupancies for the given site filtered by List of wards provided in the request

Request Information

Parameters

NameDescriptionAdditional information
siteCode
The code of the site you have access to and whose data you want to retrieve. Available on settings page.

Define this parameter in the request URI.

wards
List of wards for the given site

Define this parameter in the request body.

APIKey
The API key provided during registration. Available on settings page.

Define this parameter in the request URI.

Request body formats

application/json, text/json

Sample:
[
  "sample string 1",
  "sample string 2",
  "sample string 3"
]

application/xml, text/xml

Sample:
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
  <string>sample string 3</string>
</ArrayOfstring>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "LotCode": "sample string 1",
    "Free": 2,
    "Occupied": 3,
    "IsOffline": true
  },
  {
    "LotCode": "sample string 1",
    "Free": 2,
    "Occupied": 3,
    "IsOffline": true
  },
  {
    "LotCode": "sample string 1",
    "Free": 2,
    "Occupied": 3,
    "IsOffline": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfOccupancy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartAPI.Entities.V2">
  <Occupancy>
    <Free>2</Free>
    <IsOffline>true</IsOffline>
    <LotCode>sample string 1</LotCode>
    <Occupied>3</Occupied>
  </Occupancy>
  <Occupancy>
    <Free>2</Free>
    <IsOffline>true</IsOffline>
    <LotCode>sample string 1</LotCode>
    <Occupied>3</Occupied>
  </Occupancy>
  <Occupancy>
    <Free>2</Free>
    <IsOffline>true</IsOffline>
    <LotCode>sample string 1</LotCode>
    <Occupied>3</Occupied>
  </Occupancy>
</ArrayOfOccupancy>