api/v1/data/zones

This endpoint is used to get information about all the zones in the venue.

Base URLhttps://api3.waved.co

AuthenticationBearer token

Contract review required

The full migrated endpoint description and response example are preserved below. They must be checked against the authoritative API contract before publication.

Migrated reference

The complete public source content is preserved below. Examples still require technical verification before launch.

GET :

api/v1/data/zones

cURL

curl -X GET https://api3.waved.co/api/v1/data/zones \

-H 'Content-Type: application/json' \

-H 'Authorization: Bearer YOUR-TOKEN' \

-d '{ }'

About the endpoint

This endpoint is used to get information about all the zones in the venue.

Each zone has a unique id, a name, and a group id. The group id is used to group zones together.

Live data and data trends can (and often should) be fetched on a zone basis and you need to use the zone_id to fetch data and send commands to the zone.

It is necessary to store the zone_ids locally to use for later, it is not recommended to fetch the zone_ids for each call.

This is to reduce the number of calls to the API and to reduce the load on our server.

We use rate-limiting to avoid abuse.

Return Object

[
  {
    "number_of_zones": "<integer>",
    "automated_zones": "<integer>",
    "zones": [
      {
        "zone_id": "<string>",
        "zone_name": "<string>",
        "automated": "<boolean>",
        "group": {
          "group_id": "<string>",
          "group_name": "<string>"
        }
      }
    ]
  }
]