Versions Compared

Key

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

...

Parking space states API provides data on the current occupancy of the selected spaces with optional filters. The filters are:

  • Project

    • Project ID

  • Zone

    • Zone ID

  • Level

    • Level

    floor
    • ID

    • Floor number

  • Group

    • Group

    custom
    • ID

    • Custom ID

  • Position network

    Position occupancy
    • Network ID

    • Label ID

  • Position label

    • Label name

    • Occupancy status

Code Block
languagebash
curl -v -H 'x-Auth-Token: 1234567890ABCDEF' 'https://api.nwave.io/analytics/v1/realtime/state'

...

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

    • LevelI D

    Level floor
    • Floor number

  • Group

    • Group

    custom
    • ID

    • Custom ID

  • Position network

    Position occupancy
    • Network ID

  • Position label

    • Label name

    • Occupancy status

  • Session start time

  • Session end time

Code Block
curl -v -H 'x-Auth-Token: 1234567890ABCDEF' 'https://api.nwave.io/analytics/v1/history/sessions'

The endpoint returns a list of parking session object objects in the following format:

Code Block
languagejson
{
      "parking_session_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "involved_positions": [
        {
          "network_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "custom_id": "string",
          "latitude": 0,
          "longitude": 0,
          "group": {
            "id": 0,
            "type": "string",
            "name": "string",
            "custom_id": "string",
            "zone_id": 0,
            "level_id": 0,
            "floor_number": 0
          },
          "group_inner_id": 0
        }
      ],
      "session_start": "2021-07-12T18:34:18.354Z",
      "session_end": "2021-07-12T18:34:18.354Z",
      "authorization": {
        "id": "string",
        "type": "sdi_tag",
        "registration_time": "2021-07-12T18:34:18.354Z"
      }
    }

...

Utilization history API provides the following filters:

  • Project

    • Project ID

  • Zone

    • Zone ID

  • Level

    • Level

    floor
    • ID

    • Floor number

  • Group

    • Group

    custom
    • ID

    • Custom ID

  • Position network

    • Network ID

    Position label
    • Label name

  • Days of week - allows calculating utilization only by working days

  • Date period

  • Calculation hours window - allows calculating only between 8:00 and 18:00

...

API provides the following filters:

  • Project

    • Project ID

  • Zone

    • Zone ID

  • Level

    • Level

    floor
    • ID

    • Floor number

  • Group

    • Group

    custom
    • ID

    • Custom ID

  • Position network

    • Network ID

    Position label
    • Label name

  • Days of week - allows calculating utilization only for selected days of week, e.g. working days Mon-Fri

  • Date period

  • Calculation hours window - allows calculating only between 8:00 and 18:00

...

API provides the following filters:

  • Project

    • Project ID

  • Zone

    • Zone ID

  • Level

    • Level

    floor
    • ID

    • Floor number

  • Group

    • Group

    custom
    • ID

    • Custom ID

  • Position network

    • Network ID

    Position label
    • Label name

  • Date period

  • Days of week - allows calculating utilization only by working days

  • Calculation hours window - allows calculating only between 8:00 and 18:00

...

API provides the following filters:

  • Project

    • Project ID

  • Zone

    • Zone ID

  • Level

    • Level

    floor
    • ID

    • Floor number

  • Group

    • Group

    custom
    • ID

    • Custom ID

  • Position network

    • Network ID

    Position label
    • Label name

  • Date period

  • Days of week - allows calculating utilization only by working days

  • Calculation hours window - allows calculating only between 8:00 and 18:00

...

API provides the following optional filters:

  • Project

    • Project ID

  • Zone

    • Zone ID

Example request that filter by project with id 1 and zone with 2:

...

Response

Code Block
languagejson
{
  "zone_id": 314,
  "day_of_week": ["mon"], 
  "start_hours": "08:00:00", 
  "finish_hours": "20:00:00"
}

...