Seating Events

Seating Events are used manage the status of objects within a map for given event. An event represents a Seatmap + Revision and keeps track of the state. The state includes all the Objects of the Map.

Base URL:

https://seatmap.vivenu.com/api or https://seatmap.vivenu.dev/api

Endpoints

Create an Event

In order to create a new event, you will have to create first a Seatmap and Revision.
If you already have a seatmap and a revision created you can create a new event with this endpoint.

Payload

seatMapId

Required

string

The ID of the Seatmap to be used

revisionId

Required

string

The ID of the Revision of the seatmap for the event

200

Success

Was this section helpful?

Yes No

{
  "seatMapId": "string",
  "revisionId": "string"
}

{
  "_id": "string",
  "seatMapId": "string",
  "revisionId": "string",
  "_owner": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get an Event

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No

{
  "_id": "string",
  "seatMapId": "string",
  "revisionId": "string",
  "_owner": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all Events

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "seatMapId": "string",
    "revisionId": "string",
    "_owner": "string",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
]

The Contingent object

Attributes

name

Required

string

The name of the Contingent

eventId

Required

string

The ID of the event this Contingent belongs to

Optional Attributes

Collapse all

blockedUntil

Optional

string date-time

An ISO timestamp indicating until when this Contingent is blocked. Unlimited if empty

objects

Optional

array<string>

An array of Status-IDs blocked through this contingent

generalAdmission

Optional

boolean

Whether the contingent is for General Admissions only

amount

Optional

number float

if generalAdmission = true. The amount of blocked seats inside of the General Admission

createdAt

Optional

string date-time

An ISO timestamp indicating when the contingent was created

updatedAt

Optional

string date-time

An ISO timestamp indicating when the contingent was updated

Was this section helpful?

Yes No

{
  "name": "string",
  "eventId": "string",
  "blockedUntil": "2030-01-23T23:00:00.123Z",
  "objects": [
    "string"
  ],
  "generalAdmission": true,
  "amount": 10.5,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Create a Contingent

Payload

Optional Attributes

Collapse all

name

Optional

string

The name of the Contingent

blockedUntil

Optional

string date-time

An ISO timestamp indicating until when this Contingent is blocked. Unlimited if empty

objects

Optional

array<string>

An array of Status-IDs blocked through this contingent

generalAdmission

Optional

boolean

Whether the contingent is for General Admissions only

amount

Optional

number float

if generalAdmission = true. The amount of blocked seats inside of the General Admission

200

Success

Was this section helpful?

Yes No

{
  "name": "string",
  "blockedUntil": "2030-01-23T23:00:00.123Z",
  "objects": [
    "string"
  ],
  "generalAdmission": true,
  "amount": 10.5
}

{
  "name": "string",
  "eventId": "string",
  "blockedUntil": "2030-01-23T23:00:00.123Z",
  "objects": [
    "string"
  ],
  "generalAdmission": true,
  "amount": 10.5,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update a Contingent

Payload

Optional Attributes

Collapse all

name

Optional

string

The name of the Contingent

blockedUntil

Optional

string date-time

An ISO timestamp indicating until when this Contingent is blocked. Unlimited if empty

objects

Optional

array<string>

An array of Status-IDs blocked through this contingent

generalAdmission

Optional

boolean

Whether the contingent is for General Admissions only

amount

Optional

number float

if generalAdmission = true. The amount of blocked seats inside of the General Admission

200

Success

Was this section helpful?

Yes No

{
  "name": "string",
  "blockedUntil": "2030-01-23T23:00:00.123Z",
  "objects": [
    "string"
  ],
  "generalAdmission": true,
  "amount": 10.5
}

{
  "name": "string",
  "eventId": "string",
  "blockedUntil": "2030-01-23T23:00:00.123Z",
  "objects": [
    "string"
  ],
  "generalAdmission": true,
  "amount": 10.5,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Delete a Contingent

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No

Get a Contingent

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No

{
  "name": "string",
  "eventId": "string",
  "blockedUntil": "2030-01-23T23:00:00.123Z",
  "objects": [
    "string"
  ],
  "generalAdmission": true,
  "amount": 10.5,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get all Contingents

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No

[
  {
    "name": "string",
    "eventId": "string",
    "blockedUntil": "2030-01-23T23:00:00.123Z",
    "objects": [
      "string"
    ],
    "generalAdmission": true,
    "amount": 10.5,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z"
  }
]

Reserve (best available) objects

This endpoint is intended for internal use only. It can be used to reserve specific objects directly or to reserve the best available seats within specified seating categories.

Payload

One of

Only one of the following types

statusIds

Required

array<string>

The Status-ID of the objects to reserve

Optional Attributes

Collapse all

childEventIds

Optional

array<string>

An array of Event-IDs the reservation affects too

token

Optional

string

A token to identify the reservation. Initially empty, provided in the response

config

Optional

object

Optional Attributes

Collapse all

config.availabilityMode

Optional

string

config.allowedContingents

Optional

array<string>

200

Success

Was this section helpful?

Yes No

{
  "childEventIds": [
    "string"
  ],
  "token": "string",
  "config": {},
  "statusIds": [
    "string"
  ]
}

{
  "reservation": {
    "eventId": "string",
    "childEventIds": [
      "string"
    ],
    "objects": [
      "string"
    ],
    "validUntil": "2030-01-23T23:00:00.123Z",
    "token": "string",
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "_owner": "string"
  },
  "info": {
    "isSplit": true
  }
}