Skip to main content
GET
/
zones
/
all
Retrieve Zones
curl --request GET \
  --url https://api.nuwebgroup.com/v1/zones/all \
  --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": 7,
        "question": "Notes",
        "type": "long_text",
        "required": true
      }
    ],
    "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

ā€‹
eventId
integer
required

The ID of the event to retrieve zone 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
ā€‹
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. eventZones.name. Can be used in conjunction with except providing both parameters don't reference the same resource.

ā€‹
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. eventZones.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successful request to fetch live zone data for an event.

ā€‹
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[]
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": 7,
        "question": "Notes",
        "type": "long_text",
        "required": true
      }
    ],
    "createdAt": "2021-11-22T11:59:00.000000Z",
    "updatedAt": "2021-11-22T11:59:00.000000Z",
    "deletedAt": null
  }
]