Skip to main content
GET
/
zone
Retrieve a single zone
curl --request GET \
  --url https://api.nuwebgroup.com/v1/zone \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "name": "Entry",
    "accessPermission": [
      "Ticket A",
      "Ticket B",
      "Product A"
    ],
    "attendance": 10,
    "uniqueScansIn": 12,
    "totalScansIn": 15,
    "totalScansOut": 2,
    "averageSecondsSpent": null,
    "capacity": 200,
    "openingDate": "2021-11-22T11:59:00.000000Z",
    "closingDate": "2021-11-22T11:59:00.000000Z",
    "maxAge": null,
    "minAge": null,
    "scan": "in&out",
    "hideAttendees": false,
    "hasMandatoryDataCapture": false,
    "hasOptionalDataCapture": false,
    "hasNoDataCapture": false,
    "dataCaptureFields": [
      {
        "id": 91,
        "name": "Standard Day Ticket",
        "type": "ticket",
        "attendance": 54,
        "uniqueScansIn": 42,
        "totalScansIn": 67,
        "totalScansOut": 13,
        "averageSecondsSpent": 140
      }
    ],
    "createdAt": "2021-11-22T11:59:00.000000Z",
    "updatedAt": "2021-11-22T11:59:00.000000Z",
    "deletedAt": null
  }
]

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
zoneId
integer
required

The ID of the zone to retrieve data for.

ā€‹
withTrashed
enum<string>

Controls records returned depending on their deletedAt status. This is a global flag, so will apply to all resources, including relationships such as resources returned under the included attribute.

  • true to include deleted records
  • false to exclude deleted records (or leave blank)

Available options:
true,
false

Response

Successful request to fetch live zone data for a single zone.

ā€‹
id
integer
ā€‹
name
integer
ā€‹
accessPermission
any[]
ā€‹
attendance
integer
ā€‹
uniqueScansIn
integer
ā€‹
totalScansIn
integer
ā€‹
totalScansOut
integer
ā€‹
averageSecondsSpent
integer
ā€‹
capacity
integer
ā€‹
openingDate
string
ā€‹
closingDate
string
ā€‹
maxAge
integer
ā€‹
minAge
integer
ā€‹
scan
string

'in', 'in&out', 'auto'

ā€‹
hideAttendees
boolean
ā€‹
hasMandatoryDataCapture
boolean
ā€‹
hasOptionalDataCapture
boolean
ā€‹
hasNoDataCapture
boolean
ā€‹
dataCaptureFields
object[]
ā€‹
items
object[]
Example:
[
  {
    "id": 1,
    "name": "Entry",
    "accessPermission": ["Ticket A", "Ticket B", "Product A"],
    "attendance": 10,
    "uniqueScansIn": 12,
    "totalScansIn": 15,
    "totalScansOut": 2,
    "averageSecondsSpent": null,
    "capacity": 200,
    "openingDate": "2021-11-22T11:59:00.000000Z",
    "closingDate": "2021-11-22T11:59:00.000000Z",
    "maxAge": null,
    "minAge": null,
    "scan": "in&out",
    "hideAttendees": false,
    "hasMandatoryDataCapture": false,
    "hasOptionalDataCapture": false,
    "hasNoDataCapture": false,
    "dataCaptureFields": [
      {
        "id": 91,
        "name": "Standard Day Ticket",
        "type": "ticket",
        "attendance": 54,
        "uniqueScansIn": 42,
        "totalScansIn": 67,
        "totalScansOut": 13,
        "averageSecondsSpent": 140
      }
    ],
    "createdAt": "2021-11-22T11:59:00.000000Z",
    "updatedAt": "2021-11-22T11:59:00.000000Z",
    "deletedAt": null
  }
]