Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Parking space states - filtered list of parking spaces with current occupancy information.

  • Current occupancy summary

  • Current utilization statistics.

  • Historical parking statistics - historical utilization data about parking projects, zones, levels and groups. This kind of data can be aggregated in different ways. You can find more details below.

  • History of completed parking sessions - a simple list of parking sessions, which can be filtered by session start and session end time.

...

You can find more information about the Parking space states API here.

History of completed parking sessions

...

Current occupancy summary

This API provides wide spectrum of grouping and filtering of information about current spaces occupancy. API returns chort information about parking objects and counters of occupied and free spaces.

The API provides the following filters:

  • Project

    • Project ID

  • Zone

    • Zone ID

  • Level

    • LevelI Level D

    • Floor number

  • Group

    • Group ID

    • Custom ID

  • Position

    • Network ID

    • Label name

    • Occupancy status

Also, this API allows to configure grouping and ordering options:

  • Grouping by parking object types:

    • Project

    • Zone

    • Level

    • Group

    • Label

  • Ordering by

    • Name of parking object

    • Number of

      • Parking spaces (total)

      • Occupied spaces

      • Available spaces

      • Spaces in undefined state

    • Order direction

The following example shows how to call the API for getting information about occupancy of EV spaces in zone 123 with splitting by levels:

Code Block
languagebash
curl -H 'x-Auth-Token: 1234567890ABCDEF' 'https://api.nwave.io/analytics/v1/realtime/occupancy_summary?zone_id=123&labels=EV&group_by=level

Response:

Code Block
languagejson
{
   "message":null,
   "data":{
      "grouped_by":"level",
      "total":3,
      "data":[
         {
            "level":{
               "id":111,
               "name":"A",
               "floor_number":1
            },
            "summary":{
               "total":16,
               "occupied":6,
               "available":10,
               "undefined":0
            }
         },
         {
            "level":{
               "id":112,
               "name":"B",
               "floor_number":2
            },
            "summary":{
               "total":53,
               "occupied":43,
               "available":10,
               "undefined":0
            }
         },
         {
            "level":{
               "id":113,
               "name":"C",
               "floor_number":3
            },
            "summary":{
               "total":45,
               "occupied":44,
               "available":1,
               "undefined":0
            }
         }
      ]
   },
   "reason":"ok"
}

You can find more information about the Parking spaces states API here.

History of completed parking sessions

This API returns a list of filtered parking session objects. The API allows to filter sessions by the following parameters:

  • Project

    • Project ID

  • Zone

    • Zone ID

  • Level

    • Level D

    • Floor number

  • Group

    • Group ID

    • Custom ID

  • Position

    • Network ID

    • Label name

    • Occupancy status

  • Session start time

  • Session end time

...