Seating Maps

Seatmaps represent real world venues. Venues might have different versions or configurations for their seats. These various versions of a venue are called Revisions.

The Map within a Revisions stores the composition of objects for a Seatmap in a JSON based format.

Base URL:

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

Endpoints

Create a Seatmap

Payload

title

Required

string

The title of the Seatmap

200

Success

Was this section helpful?

Yes No

{
  "title": "string"
}

Get a Seatmap

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No

Update Seatmap

Payload

title

Required

string

The title of the Seatmap

200

Success

Was this section helpful?

Yes No

{
  "title": "string"
}

Get all Seatmaps

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No

The Map object

The Map within a Revisions stores the composition of objects for a Seatmap in a JSON based format.

Attributes

_id

Required

string

The ID of the object

_type

Required

number float

The type of the object

Optional Attributes

Collapse all

Optional Attributes

Collapse all

images[]._type

Optional

string

2

images[].rotation

Optional

number float

The rotation in degrees around the center point

images[].template

Optional

boolean

Whether an image should be used as a template. A template is only visible in designing tool

images[].width

Optional

number float

images[].height

Optional

number float

layers

Optional

array

An array containing all layers of this map

layers[]._id

Required

string

The ID of the object

Optional Attributes

Collapse all

layers[]._type

Optional

string

0

layers[].groups

Optional

array

An array containing all groups inside of this layer

layers[].groups[]._id

Required

string

The ID of the object

layers[].groups[].x

Required

number float

The x position of the object. Relative to parents

layers[].groups[].y

Required

number float

The y position of the object. Relative to parents

layers[].groups[]._type

Required

string

34

layers[].groups[].rowSpacing

Required

number float

The space between each row

layers[].groups[].seatSpacing

Required

number float

The space between each seat inside of each row

Optional Attributes

Collapse all

layers[].groups[].categoryId

Optional

string

The ID of the Category this object belongs to

layers[].groups[].rows

Optional

array

An array of rows, included in this group

layers[].groups[].rows[]._id

Required

string

The ID of the object

layers[].groups[].rows[].x

Required

number float

The x position of the object. Relative to parents

layers[].groups[].rows[].y

Required

number float

The y position of the object. Relative to parents

layers[].groups[].rows[]._type

Required

string

35

Optional Attributes

Collapse all

layers[].groups[].rows[].categoryId

Optional

string

The ID of the Category this object belongs to

layers[].groups[].rows[].seats

Optional

array

An array of seats, included in this row

layers[].groups[].rows[].seats[]._id

Required

string

The ID of the object

layers[].groups[].rows[].seats[].x

Required

number float

The x position of the object. Relative to parents

layers[].groups[].rows[].seats[].y

Required

number float

The y position of the object. Relative to parents

layers[].groups[].rows[].seats[]._type

Required

string

36

layers[].groups[].rows[].seats[].statusId

Required

string

This ID is identifying the state for this object. Guaranteed same for multiple events and duplicated Revisions

Optional Attributes

Collapse all

layers[].groups[].rows[].seats[].categoryId

Optional

string

The ID of the Category this object belongs to

layers[].groups[].rows[].seats[].originalX

Optional

number float

layers[].groups[].rows[].seats[].originalY

Optional

number float

layers[].groups[].rows[].seats[].seatType

Optional

string

Indicating if this is a special seat. null = normal

handicapped

layers[].groups[].rows[].seats[].sectionName

Optional

string

The name of the section this seat belongs to

layers[].groups[].rows[].seats[].groupName

Optional

string

The name of the group this seat belongs to

layers[].groups[].rows[].seats[].rowName

Optional

string

The name of the row this seat belongs to

layers[].groups[].rows[].seats[].seatName

Optional

string

The name of the seat

layers[].groups[].rows[].rotation

Optional

number float

The rotation in degrees around the center point

layers[].groups[].rows[].seatNumberingStrategy

Optional

number float

The strategy how the seats got labeled. LeftToRight = 0, RightToLeft = 1

01

layers[].groups[].rows[].seatNumberingLabels

Optional

number float

The type of labels to use labeling the seats. Numbers = 0, Alphabet = 1

01

layers[].groups[].rows[].originalX

Optional

number float

layers[].groups[].rows[].originalY

Optional

number float

layers[].groups[].rows[].name

Optional

string

The name of the row

layers[].groups[].rotation

Optional

number float

The rotation in degrees around the center point

layers[].groups[].curving

Optional

number float

A weight how the group got curved

layers[].groups[].name

Optional

string

The name of the group

layers[].groups[].sectionName

Optional

string

An optional section name. Usually used when group is not inside a section but anyway want to label the seats with a section name

layers[].sections

Optional

array

An array containing all sections inside of this layer

layers[].sections[]._id

Required

string

The ID of the object

layers[].sections[].x

Required

number float

The x position of the object. Relative to parents

layers[].sections[].y

Required

number float

The y position of the object. Relative to parents

layers[].sections[].name

Required

string

The name of the section. It is used for display purposes

layers[].sections[].coordinates

Required

array

An array of coordinates. If type == polygon each point respresents a real point. If type == rect coordinates[0] represents start (x,y) and coordinates[1] (width,height)

layers[].sections[].coordinates[].x

Required

number float

The x position of the point. Relative to parents

layers[].sections[].coordinates[].y

Required

number float

The y position of the point. Relative to parents

layers[].sections[]._type

Required

string

3

Optional Attributes

Collapse all

layers[].sections[].categoryId

Optional

string

The ID of the Category this object belongs to

layers[].sections[].type

Optional

string

The type of the section

rectpolygon

layers[].sections[].rotation

Optional

number float

The rotation in degrees around the center point of the shape

layers[].sections[].controlPoints

Optional

array

An array of coordinates. Set if type == polygon. The control points are used to bend the polygon path

layers[].sections[].controlPoints[].x

Required

number float

The x position of the point. Relative to parents

layers[].sections[].controlPoints[].y

Required

number float

The y position of the point. Relative to parents

layers[].sections[].groups

Optional

array

An array of all groups inside of this section

layers[].sections[].groups[]._id

Required

string

The ID of the object

layers[].sections[].groups[].x

Required

number float

The x position of the object. Relative to parents

layers[].sections[].groups[].y

Required

number float

The y position of the object. Relative to parents

layers[].sections[].groups[]._type

Required

string

34

layers[].sections[].groups[].rowSpacing

Required

number float

The space between each row

layers[].sections[].groups[].seatSpacing

Required

number float

The space between each seat inside of each row

Optional Attributes

Collapse all

layers[].sections[].groups[].categoryId

Optional

string

The ID of the Category this object belongs to

layers[].sections[].groups[].rows

Optional

array

An array of rows, included in this group

layers[].sections[].groups[].rows[]._id

Required

string

The ID of the object

layers[].sections[].groups[].rows[].x

Required

number float

The x position of the object. Relative to parents

layers[].sections[].groups[].rows[].y

Required

number float

The y position of the object. Relative to parents

layers[].sections[].groups[].rows[]._type

Required

string

35

Optional Attributes

Collapse all

layers[].sections[].groups[].rows[].categoryId

Optional

string

The ID of the Category this object belongs to

layers[].sections[].groups[].rows[].seats

Optional

array

An array of seats, included in this row

layers[].sections[].groups[].rows[].seats[]._id

Required

string

The ID of the object

layers[].sections[].groups[].rows[].seats[].x

Required

number float

The x position of the object. Relative to parents

layers[].sections[].groups[].rows[].seats[].y

Required

number float

The y position of the object. Relative to parents

layers[].sections[].groups[].rows[].seats[]._type

Required

string

36

layers[].sections[].groups[].rows[].seats[].statusId

Required

string

This ID is identifying the state for this object. Guaranteed same for multiple events and duplicated Revisions

Optional Attributes

Collapse all

layers[].sections[].groups[].rows[].seats[].categoryId

Optional

string

The ID of the Category this object belongs to

layers[].sections[].groups[].rows[].seats[].originalX

Optional

number float

layers[].sections[].groups[].rows[].seats[].originalY

Optional

number float

layers[].sections[].groups[].rows[].seats[].seatType

Optional

string

Indicating if this is a special seat. null = normal

handicapped

layers[].sections[].groups[].rows[].seats[].sectionName

Optional

string

The name of the section this seat belongs to

layers[].sections[].groups[].rows[].seats[].groupName

Optional

string

The name of the group this seat belongs to

layers[].sections[].groups[].rows[].seats[].rowName

Optional

string

The name of the row this seat belongs to

layers[].sections[].groups[].rows[].seats[].seatName

Optional

string

The name of the seat

layers[].sections[].groups[].rows[].rotation

Optional

number float

The rotation in degrees around the center point

layers[].sections[].groups[].rows[].seatNumberingStrategy

Optional

number float

The strategy how the seats got labeled. LeftToRight = 0, RightToLeft = 1

01

layers[].sections[].groups[].rows[].seatNumberingLabels

Optional

number float

The type of labels to use labeling the seats. Numbers = 0, Alphabet = 1

01

layers[].sections[].groups[].rows[].originalX

Optional

number float

layers[].sections[].groups[].rows[].originalY

Optional

number float

layers[].sections[].groups[].rows[].name

Optional

string

The name of the row

layers[].sections[].groups[].rotation

Optional

number float

The rotation in degrees around the center point

layers[].sections[].groups[].curving

Optional

number float

A weight how the group got curved

layers[].sections[].groups[].name

Optional

string

The name of the group

layers[].sections[].groups[].sectionName

Optional

string

An optional section name. Usually used when group is not inside a section but anyway want to label the seats with a section name

layers[].ga

Optional

array

An array containing all general admissions inside of this layer

layers[].ga[]._id

Required

string

The ID of the object

layers[].ga[].x

Required

number float

The x position of the object. Relative to parents

layers[].ga[].y

Required

number float

The y position of the object. Relative to parents

layers[].ga[].name

Required

string

The name of the section. It is used for display purposes

layers[].ga[].coordinates

Required

array

An array of coordinates. If type == polygon each point respresents a real point. If type == rect coordinates[0] represents start (x,y) and coordinates[1] (width,height)

layers[].ga[].coordinates[].x

Required

number float

The x position of the point. Relative to parents

layers[].ga[].coordinates[].y

Required

number float

The y position of the point. Relative to parents

layers[].ga[].statusId

Required

string

This ID is identifying the state for this object. Guaranteed same for multiple events and duplicated Revisions

layers[].ga[]._type

Required

string

7

layers[].ga[].amount

Required

number float

The amount of seats inside of this general admission

Optional Attributes

Collapse all

layers[].ga[].categoryId

Optional

string

The ID of the Category this object belongs to

layers[].ga[].type

Optional

string

The type of the section

rectpolygon

layers[].ga[].rotation

Optional

number float

The rotation in degrees around the center point of the shape

layers[].ga[].controlPoints

Optional

array

An array of coordinates. Set if type == polygon. The control points are used to bend the polygon path

layers[].ga[].controlPoints[].x

Required

number float

The x position of the point. Relative to parents

layers[].ga[].controlPoints[].y

Required

number float

The y position of the point. Relative to parents

layers[].ga[].showAvailableSeats

Optional

boolean

Whether the amount of available seats should be visible

layers[].viewPoints

Optional

array

An array containing all viewpoints inside of this layer

layers[].viewPoints[]._id

Required

string

The ID of the object

layers[].viewPoints[].x

Required

number float

The x position of the object. Relative to parents

layers[].viewPoints[].y

Required

number float

The y position of the object. Relative to parents

Optional Attributes

Collapse all

layers[].viewPoints[]._type

Optional

string

10

layers[].viewPoints[].imageType

Optional

string

FLAT

layers[].viewPoints[].image

Optional

string

focalPoint

Optional

array

An array containing all focalpoints of this map

focalPoint[]._id

Required

string

The ID of the object

focalPoint[].x

Required

number float

The x position of the object. Relative to parents

focalPoint[].y

Required

number float

The y position of the object. Relative to parents

Optional Attributes

Collapse all

focalPoint[]._type

Optional

string

9

Was this section helpful?

Yes No

{
  "_id": "string",
  "_type": 10.5,
  "categories": [
    {
      "_id": "string",
      "_type": 1,
      "name": "string",
      "color": "string"
    }
  ],
  "images": [
    {
      "_id": "string",
      "x": 10.5,
      "y": 10.5,
      "_type": 2,
      "url": "string",
      "scaleX": 10.5,
      "scaleY": 10.5,
      "opacity": 10.5,
      "rotation": 10.5,
      "template": true,
      "width": 10.5,
      "height": 10.5
    }
  ],
  "layers": [
    {
      "_id": "string",
      "groups": [
        {
          "_id": "string",
          "x": 10.5,
          "y": 10.5,
          "categoryId": "string",
          "_type": 3,
          "rows": [
            {
              "_id": "string",
              "x": 10.5,
              "y": 10.5,
              "categoryId": "string",
              "_type": 3,
              "seats": [
                {
                  "_id": "string",
                  "x": 10.5,
                  "y": 10.5,
                  "categoryId": "string",
                  "_type": 3,
                  "statusId": "string",
                  "originalX": 10.5,
                  "originalY": 10.5,
                  "seatType": "handicapped",
                  "sectionName": "string",
                  "groupName": "string",
                  "rowName": "string",
                  "seatName": "string"
                }
              ],
              "rotation": 10.5,
              "originalX": 10.5,
              "originalY": 10.5,
              "name": "string"
            }
          ],
          "rotation": 10.5,
          "curving": 10.5,
          "rowSpacing": 10.5,
          "seatSpacing": 10.5,
          "name": "string",
          "sectionName": "string"
        }
      ],
      "sections": [
        {
          "_id": "string",
          "x": 10.5,
          "y": 10.5,
          "categoryId": "string",
          "name": "string",
          "type": "rect",
          "coordinates": [
            {
              "x": 10.5,
              "y": 10.5
            }
          ],
          "rotation": 10.5,
          "controlPoints": [
            {
              "x": 10.5,
              "y": 10.5
            }
          ],
          "_type": 3,
          "groups": [
            {
              "_id": "string",
              "x": 10.5,
              "y": 10.5,
              "categoryId": "string",
              "_type": 3,
              "rows": [
                {
                  "_id": "string",
                  "x": 10.5,
                  "y": 10.5,
                  "categoryId": "string",
                  "_type": 3,
                  "seats": [
                    {
                      "_id": "string",
                      "x": 10.5,
                      "y": 10.5,
                      "categoryId": "string",
                      "_type": 3,
                      "statusId": "string",
                      "originalX": 10.5,
                      "originalY": 10.5,
                      "seatType": "handicapped",
                      "sectionName": "string",
                      "groupName": "string",
                      "rowName": "string",
                      "seatName": "string"
                    }
                  ],
                  "rotation": 10.5,
                  "originalX": 10.5,
                  "originalY": 10.5,
                  "name": "string"
                }
              ],
              "rotation": 10.5,
              "curving": 10.5,
              "rowSpacing": 10.5,
              "seatSpacing": 10.5,
              "name": "string",
              "sectionName": "string"
            }
          ]
        }
      ],
      "ga": [
        {
          "_id": "string",
          "x": 10.5,
          "y": 10.5,
          "categoryId": "string",
          "name": "string",
          "type": "rect",
          "coordinates": [
            {
              "x": 10.5,
              "y": 10.5
            }
          ],
          "rotation": 10.5,
          "controlPoints": [
            {
              "x": 10.5,
              "y": 10.5
            }
          ],
          "statusId": "string",
          "_type": 7,
          "amount": 10.5,
          "showAvailableSeats": true
        }
      ],
      "viewPoints": [
        {
          "_id": "string",
          "x": 10.5,
          "y": 10.5,
          "_type": 10,
          "imageType": "FLAT",
          "image": "string"
        }
      ]
    }
  ],
  "focalPoint": [
    {
      "_id": "string",
      "x": 10.5,
      "y": 10.5,
      "_type": 9
    }
  ]
}

Create a Revision

Payload

seatMap

Required

object

The Map Object of the Seatmap

Optional Attributes

Collapse all

comment

Optional

string

A comment describing this Revision

200

Success

Was this section helpful?

Yes No

{
  "comment": "string",
  "seatMap": {}
}

Get a Revision

Query

includeSeatmap

Optional

boolean

Whether to include the seatmap in the response

200

Success

Was this section helpful?

Yes No

Update a Revision

Payload

seatMap

Required

object

The Map Object of the Seatmap

200

Success

Was this section helpful?

Yes No

{
  "seatMap": {}
}

Patch a Revision

Payload

comment

Required

string

A comment describing this Revision

200

Success

Was this section helpful?

Yes No

{
  "comment": "string"
}

Duplicate a Revision

Payload

Optional Attributes

Collapse all

comment

Optional

string

A comment describing this Revision

200

Success

Was this section helpful?

Yes No

{
  "comment": "string"
}

Export a Revision

Query

format

Optional

string

json

200

Success

Was this section helpful?

Yes No

Import a Revision

Payload

Optional Attributes

Collapse all

comment

Optional

string

A comment describing this Revision

200

Success

Was this section helpful?

Yes No

{
  "comment": "string"
}

Get all Seatmap's Revisions

Query

No supported query parameters

200

Success

Was this section helpful?

Yes No