Seating Objects

The Objects API is used to read and manage the state of Event Objects. An object represents a Seat or a General Admission and keeps track of the corresponding state.

Base URL:

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

Endpoints

The Object Status

Attributes

status
Required
string

The status indicating whether bookings are currently accepted on this object

freebookednotforsalereservedforsale

Optional Attributes

Collapse all
Was this section helpful?
YesNo
Example
{
"status": "free",
"booked": 1
}

Get Object Status

Get the status of an object for a given Event. If your requested object is of type General Admission than you will get the booked seats amount for the section aswell.

Query

No supported query parameters
Responses
200

Was this section helpful?

YesNo
get
/api/event/{id}/status/{objectId}
Response
application/json
{
"status": "free",
"booked": 1
}

Update Object Status

Update the status for several objects for a given Event. The provided objects have to be all from the same type.
Caution: The status depends on the type of object. Seats have different status as General Admissions.

For General Admissions you can change the booked amount by providing a bookedChange amount. The General Admissions booked amount will be increased by the amount. You can provide a negative number in order to decrease the booked amount.

Payload

One of
Only one of the following types
objects
Required
array<string>

An array of Status-IDs to change the status for

status
Required
string

The target status

freebookednotforsalereserved
Responses
200
Success

Was this section helpful?

YesNo
post
/api/event/{id}/status
{
"objects": [
"string"
],
"status": "free"
}
Response
application/json
{
"message": "ok"
}

Get Object Status Logs

Get the status logs of an object for a given Event. Whenever a status change is performed for an object the system creates a log entry.

Query

No supported query parameters
Responses
200

Was this section helpful?

YesNo
get
/api/event/{id}/status/{objectId}/logs
Response
application/json
[
{
"type": "ObjectStatusChange",
"eventId": "string",
"objectId": "string",
"before": "free",
"after": "booked",
"userId": "string",
"api": true,
"_owner": "string",
"bookedChange": 10.5,
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
}
]