Access Users

An Access User represents a handheld or installed device like smartphones or turnstiles at your venue that should be allowed to download and scan Tickets for events.

You can grant access to all events and tickets or just a selected subset of them. Each created Access User receives a unique token that can than be used to authenticate against the API.

Please note:

The issued token can only be used to authenticate against selected /accessusers endpoints. They cannot be used against other endpoints of the vivenu API.

Endpoints

The access user object

Attributes

sellerId

Required

string

The ID of the seller that owns the access user.

name

Required

string

An internal name to identify the access user

token

Required

string

The token to authenticate against the access-control endpoints.

accessAllEvents

Required

boolean

Whether the access user can access all events of his seller

createdAt

Required

string date-time

An ISO Timestamp indicating when the access user was created.

updatedAt

Required

string date-time

An ISO Timestamp indicating when the access user was updated.

Optional Attributes

Collapse all

_id

Optional

string

active

Optional

boolean

Whether the access user is active or not.

events

Optional

array<string>

An array of events the access user can access. Only if accessAllEvents=false.

lastRequest

Optional

string date-time

An ISO Timestamp indicating when the access user made the last request.

expires

Optional

string date-time

An ISO Timestamp indicating when the access user should expire

isIntegration

Optional

boolean

Whether an integration belongs to the access user

integration

Optional

string

The type of integration belongs to this access user

simplyXaxess

deviceSettings

Optional

object

An object of settings which will be used on the device

Optional Attributes

Collapse all

deviceSettings.accessMode

Optional

string

'restricted' mode restricts access to tickets checkin table, tickets checkin chart and total tickets amount.

fullrestricted

deviceSettings.scanGroupId

Optional

string

The ID of the scan group to which the access user assigned.

__v

Optional

integer

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "token": "string",
  "accessAllEvents": true,
  "events": [
    "string"
  ],
  "lastRequest": "2030-01-23T23:00:00.123Z",
  "expires": "2030-01-23T23:00:00.123Z",
  "isIntegration": true,
  "integration": "simplyX",
  "deviceSettings": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Create an Access User

Payload

name

Required

string

An internal name to identify the access user

Optional Attributes

Collapse all

isIntegration

Optional

boolean

Whether an integration belongs to the access user

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "isIntegration": true
}

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "token": "string",
  "accessAllEvents": true,
  "events": [
    "string"
  ],
  "lastRequest": "2030-01-23T23:00:00.123Z",
  "expires": "2030-01-23T23:00:00.123Z",
  "isIntegration": true,
  "integration": "simplyX",
  "deviceSettings": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Update an Access User

Payload

name

Required

string

An internal name to identify the access user

sellerId

Required

string

The ID of the seller that owns the access user.

accessAllEvents

Required

boolean

Whether the access user can access all events of his seller

token

Required

string

The token to authenticate against the access-control endpoints.

Optional Attributes

Collapse all

events

Optional

array<string>

An array of events the access user can access. Only if accessAllEvents=false.

expires

Optional

string date-time

An ISO Timestamp indicating when the access user should expire

active

Optional

boolean

Whether the access user is active or not.

lastRequest

Optional

string date-time

An ISO Timestamp indicating when the access user made the last request.

integration

Optional

string

The type of integration belongs to this access user

simplyXaxess

deviceSettings

Optional

object

An object of settings which will be used on the device

Optional Attributes

Collapse all

deviceSettings.accessMode

Optional

string

'restricted' mode restricts access to tickets checkin table, tickets checkin chart and total tickets amount.

fullrestricted

deviceSettings.scanGroupId

Optional

string

The ID of the scan group to which the access user assigned.

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "name": "string",
  "events": [
    "string"
  ],
  "expires": "2030-01-23T23:00:00.123Z",
  "sellerId": "string",
  "active": true,
  "accessAllEvents": true,
  "token": "string",
  "lastRequest": "2030-01-23T23:00:00.123Z",
  "integration": "simplyX",
  "deviceSettings": {}
}

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "token": "string",
  "accessAllEvents": true,
  "events": [
    "string"
  ],
  "lastRequest": "2030-01-23T23:00:00.123Z",
  "expires": "2030-01-23T23:00:00.123Z",
  "isIntegration": true,
  "integration": "simplyX",
  "deviceSettings": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Delete an Access User

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "active": true,
  "name": "string",
  "token": "string",
  "accessAllEvents": true,
  "events": [
    "string"
  ],
  "lastRequest": "2030-01-23T23:00:00.123Z",
  "expires": "2030-01-23T23:00:00.123Z",
  "isIntegration": true,
  "integration": "simplyX",
  "deviceSettings": {},
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "__v": 1
}

Get all Access Users

Query

No supported query parameters

200

401

Unauthorized

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "sellerId": "string",
    "active": true,
    "name": "string",
    "token": "string",
    "accessAllEvents": true,
    "events": [
      "string"
    ],
    "lastRequest": "2030-01-23T23:00:00.123Z",
    "expires": "2030-01-23T23:00:00.123Z",
    "isIntegration": true,
    "integration": "simplyX",
    "deviceSettings": {},
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "__v": 1
  }
]

PUBLIC

Get associated Seller Id

Query

No supported query parameters

200

404

Not Found

Was this section helpful?

Yes No

{
  "sellerId": "string"
}

PUBLIC

Get all accessible Events

Returns a list of all events accessible for the device. This endpoint is often used when a user wants to select the event to do the checkin for.

Query

No supported query parameters

200

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "name": "string"
  }
]

PUBLIC

Get Tickets for an Event v2

Returns a paged response of all tickets for a given event. Devices usually fetch and page through this endpoint and persist the results on disk to provide an offline capability.

Query

top

Optional

number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

number float

The number of objects to skip for the requested result

from

Optional

string date-time

An ISO Timestamp to filter tickets where created_at | updated >= $from

until

Optional

string date-time

An ISO Timestamp to filter tickets where created_at | updated < $from

200

400

Bad Request

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "barcode": "string",
      "name": "string",
      "ticketTypeId": "string",
      "ticketName": "string",
      "priceCategoryId": "string",
      "eventId": "string",
      "sellerId": "string",
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z",
      "priceCategory": {
        "categoryId": "string",
        "description": "string"
      },
      "status": "VALID",
      "area": "string",
      "row": "string",
      "seat": "string",
      "discountId": "string",
      "discount": "string",
      "entry": [
        "string"
      ]
    }
  ],
  "total": 1
}

PUBLIC

Get Ticket with barcode

Returns the ticket for a given barcode if existent. This endpoint is typically invoked when a device needs to validate a given barcode in realtime.

Query

eventId

Optional

string

200

400

Bad Request

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "barcode": "string",
  "name": "string",
  "ticketTypeId": "string",
  "ticketName": "string",
  "categoryRef": "string",
  "priceCategoryId": "string",
  "eventId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "priceCategory": {
    "categoryId": "string",
    "description": "string"
  },
  "status": "VALID"
}

PUBLIC

Create scans

Payload

barcode

Required

string

The barcode of the ticket

scanned_at

Required

string date-time

An ISO Timestamp indicating when the ticket was scanned.

type

Required

string

Whether the scan succeeded or failed

OKFAIL

direction

Required

string

Indicates in which direction the scan was.

INOUT

Optional Attributes

Collapse all

ticketId

Optional

string

200

400

Bad Request

Was this section helpful?

Yes No

[
  {
    "ticketId": "string",
    "barcode": "string",
    "scanned_at": "2030-01-23T23:00:00.123Z",
    "type": "OK",
    "direction": "IN"
  }
]

{
  "status": "OK"
}