Now Endpoint

The now endpoint is intended for polling applications: It efficiently gets the current count of a container. The intention is that this endpoint can be polled at a rate of 1 req/s.

GET /api/1.0/now/{int:venue_id}

Synopsis:

The Now Endpoint provides a simple to use and performant way to get the current up-to-date count for a venue

Parameters:

• venue_id – The ID of the Venue to query: this is the combined count of all non-subzone zones related to the Venue

• e.g. Fetch current count for Venue 1

  GET /api/1.0/now/1 HTTP/1.1
  apikey: 123456789
  

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {"maleTotal": 100, "femaleTotal": 50}
  

GET /api/1.0/now/zone/{int:zone_id}

Synopsis:

The Now Endpoint provides a simple to use and performant way to get the current up-to-date count for a zone.

Parameters:

• zone_id – The ID of the Zone to query: if not provided, we return the current combined venue count

• e.g. Fetch current count for Zone 2

  GET /api/1.0/now/zone/2 HTTP/1.1
  apikey: 123456789
  

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {"maleTotal": 0, "femaleTotal": 50}