Levels, entries, capacities

Build the seating-map tree after creating the map. See Seating maps. Create and update wrap fields in input. Levels and entries are translatable (language is a sibling of input). Capacities are not.

Levels (organization dimensions)

getSeatingChartOrganizationDimension

Get one level of a seating map, for example Section, Row or Seat.

ArgumentTypeRequiredDescription
idstringYesOrganization dimension id

createSeatingChartOrganizationDimension

Create a level on a seating map, for example Section, Row or Seat. Level names are unique within a map. order sorts the levels from outermost to innermost; public controls whether guests see the level.

ArgumentTypeRequiredDescription
inputobjectYesOrganization dimension fields
input.seatingChartIdstringYesSeating map the level belongs to
input.labelstringYesLevel name, e.g. "Section", "Row", "Seat"
input.orderintegerNoSort order, outermost level first
input.publicbooleanNoShown to guests
languagestringNoLanguage the name is written in. Leave out to use the museum's default language.

updateSeatingChartOrganizationDimension

Update a level by id — only the fields you pass change. Pass language with a label to save it as a translation. Level names stay unique within the map.

ArgumentTypeRequiredDescription
inputobjectYesOrganization dimension fields to change
input.idstringYesOrganization dimension id
input.labelstringNoLevel name, e.g. "Section", "Row", "Seat"
input.orderintegerNoSort order, outermost level first
input.publicbooleanNoShown to guests
languagestringNoLeave out to change the item's own text. Pass a two-letter code to save a translation; empty text removes that translation.

deleteSeatingChartOrganizationDimension

Remove a level from a seating map. Not possible while entries still use the level.

ArgumentTypeRequiredDescription
idstringYesOrganization dimension id

Entries (organization nodes)

getSeatingChartOrganizationNode

Get one entry of a seating map, e.g. Section "A", Row "3" or Seat "12".

ArgumentTypeRequiredDescription
idstringYesOrganization node id

createSeatingChartOrganizationNode

Create an entry on a seating map, e.g. Section "A", Row "3" or Seat "12". organizationDimensionId is the level the entry sits on; parentId is the entry one level up (top-level entries have none); value is the label shown; order sorts siblings.

ArgumentTypeRequiredDescription
inputobjectYesOrganization node fields
input.seatingChartIdstringYesSeating map the entry belongs to
input.organizationDimensionIdstringNoLevel the entry sits on
input.parentIdstringNoEntry one level up. Omit for a top-level entry.
input.valuestringNoLabel, e.g. "A", "3", "12"
input.orderintegerNoSort order among siblings
languagestringNoLanguage the name is written in. Leave out to use the museum's default language.

updateSeatingChartOrganizationNode

Update an entry by id — only the fields you pass change (pass null to clear one). organizationDimensionId is the level; parentId is the entry one level up; value is the label, pass language with it to save a translation; order sorts siblings.

ArgumentTypeRequiredDescription
inputobjectYesOrganization node fields to change
input.idstringYesOrganization node id
input.organizationDimensionIdstringNoLevel the entry sits on
input.parentIdstringNoEntry one level up. Pass null for a top-level entry.
input.valuestringNoLabel, e.g. "A", "3", "12"
input.orderintegerNoSort order among siblings
languagestringNoLeave out to change the item's own text. Pass a two-letter code to save a translation; empty text removes that translation.

deleteSeatingChartOrganizationNode

Remove an entry from a seating map. Remove its child entries first.

ArgumentTypeRequiredDescription
idstringYesOrganization node id

Capacities

getSeatingChartCapacityNode

Get one capacity of a seating map.

ArgumentTypeRequiredDescription
idstringYesCapacity node id

createSeatingChartCapacityNode

Set a capacity (at least 1) on an entry of a seating map. Attach it to the entry that is sold as one unit, e.g. a row of 12 seats or a standing section for 200.

ArgumentTypeRequiredDescription
inputobjectYesCapacity node fields
input.organizationNodeIdstringYesEntry the capacity is attached to
input.capacityintegerNoNumber of places, at least 1

updateSeatingChartCapacityNode

Update a capacity by id — only the fields you pass change. Capacity is at least 1.

ArgumentTypeRequiredDescription
inputobjectYesCapacity node fields to change
input.idstringYesCapacity node id
input.organizationNodeIdstringNoEntry the capacity is attached to
input.capacityintegerNoNumber of places, at least 1

deleteSeatingChartCapacityNode

Remove a capacity from a seating map.

ArgumentTypeRequiredDescription
idstringYesCapacity node id
Previous
Seating Charts
Next
Templates