Skip to main content
POST
/
zones
/
check
Check Zone Item Eligibility
curl --request POST \
  --url https://api.nuwebgroup.com/v1/zones/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "barcode": "ABC123",
  "zoneId": "1",
  "scan": "in",
  "latitude": "51.51645100",
  "longitude": "-0.15260220",
  "ignoreAgeRestrictions": false,
  "ignoreCapacity": false
}
'
{
  "status": "valid",
  "attendance": 50,
  "capacity": 500,
  "barcode": "ABC123",
  "nfcId": null,
  "firstName": "John",
  "lastName": "Doe",
  "order": {
    "reference": "AB12345678"
  },
  "scansIn": 4,
  "scansOut": 3,
  "scansInMax": 4,
  "averageSecondsSpent": 1800,
  "accessToZones": [
    {
      "id": 1,
      "name": "Entry"
    },
    {
      "id": 1,
      "name": "Zone B"
    }
  ],
  "lastScannedIn": "2021-11-22T11:59:00.000000Z",
  "lastScannedOut": "2021-11-22T11:59:00.000000Z",
  "dateOfBirth": "1990-01-01",
  "dataCaptureQuestions": [
    {
      "id": -1,
      "question": "Customer Notes"
    },
    {
      "id": 123,
      "question": "Custom Ticket Data Capture Question 1"
    },
    {
      "id": 345,
      "question": "Custom Ticket Data Capture Question 2"
    }
  ],
  "dataCaptureAnswers": [
    {
      "id": -2,
      "answer": "Custom Ticket Label"
    },
    {
      "id": -1,
      "answer": "These are notes made against the customer"
    },
    {
      "id": 0,
      "answer": "1 x Product A (QA: A1, QB: A2),\\n1 x Product B"
    },
    {
      "id": 123,
      "answer": "Answer to custom ticket data capture question 1"
    },
    {
      "id": 345,
      "answer": "Answer to custom ticket data capture question 2"
    }
  ],
  "customerId": 1,
  "timeslot": {
    "id": null,
    "name": 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.

Body

application/json

Request body for scanning a ticket into a zone

barcode
string

The tickets barcode. Will be ignored if an NFC ID is given.

nfcId
string

The tickets NFC ID. This always takes precedence over a given barcode.

zoneId
string

The ID of the zone that you are scanning in/out of.

scan
enum<string>

The scan mode

Available options:
in,
out,
auto
latitude
string

The latitude of the scanning device

longitude
string

The longitude of the scanning device

ignoreAgeRestrictions
string

Force the scan regardless of any age restrictions that may be set on the zone

ignoreCapacity
string

Force the scan regardless of the capacity that may be set on the zone

Response

Successful zone scan request.

status
string
statusDetail
string
attendance
integer
capacity
integer
barcode
string
nfcId
string
firstName
string
lastName
string
scansIn
integer
scansOut
integer
scansInMax
integer
order
object
averageSecondsSpent
integer
accessToZones
any[]
lastScannedIn
string
lastScannedOut
string
dateOfBirth
string
dataCaptureQuestions
any[]
dataCaptureAnswers
any[]
customerId
integer
timeslot
object