api/v1/data/zones/<zone_id>

This endpoint returns information about the zone in the venue with zone_id=<zone_id>

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/<zone_id>

cURL

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

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

-H 'Authorization: Bearer YOUR-TOKEN' \

-d '{ }'

About the endpoint

This endpoint returns information about the zone in the venue with zone_id=<zone_id>

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.

See the /zones endpoint for more information about the zones and how to fetch info about all zones.

Return Object

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