Abstract
Private API provides unified CRUD operations to EVENT/PRICE structures. All requests are served under restricted area. You MUST specify your private key X-API-Key: {sessionId} in every request

1. Access

  • APIKey KeyParamName: X-API-Key, KeyInQuery: false, KeyInHeader: true

2. Endpoints

2.1. Booking

2.1.1. lock

POST /api/private/v1.0/booking/lock

Lock a seat or GA

Description

Seat should be available

Parameters
Body Parameter
Name Description Required Default Pattern

Selection

Selection

X
Query Parameters
Name Description Required Default Pattern

id

X

null
Return Type

array[Selection]

Content Type

  • application/json

Responses
Table 1. http response codes
Code Message Datatype

400

Input data is not valid

List[Selection]

403

Forbidden. Please use correct private key.

List[Selection]

200

Returns unsuccessful attempts

List[Selection]
Samples

2.1.2. sale

POST /api/private/v1.0/booking/sale

Transfer seat or GA to the state sold

Description

This feature applicable only in a sales control mode

Parameters
Body Parameter
Name Description Required Default Pattern

Selection

Selection

X
Query Parameters
Name Description Required Default Pattern

id

X

null
Return Type

array[Selection]

Content Type

  • application/json

Responses
Table 2. http response codes
Code Message Datatype

400

Input data is not valid

List[Selection]

403

Forbidden. Please use correct private key.

List[Selection]

200

Returns unsuccessful attempts

List[Selection]
Samples

2.1.3. unlock

POST /api/private/v1.0/booking/unlock

Unlock a seat or GA

Description

For GA unlocking capacity counter shall be specified

Parameters
Body Parameter
Name Description Required Default Pattern

Selection

Selection

X
Query Parameters
Name Description Required Default Pattern

id

X

null
Return Type

array[Selection]

Content Type

  • application/json

Responses
Table 3. http response codes
Code Message Datatype

400

Input data is not valid

List[Selection]

403

Forbidden. Please use correct private key.

List[Selection]

200

Returns unsuccessful attempts

List[Selection]
Samples

2.2. Events

2.2.1. eventAll

GET /api/private/v1.0/events/

Retrieve list of all events

Description

Getting all the events with paging

Parameters
Query Parameters
Name Description Required Default Pattern

limit

Quantity of requested items

-

50

offset

Offset for the pager

-

0
Return Type

array[Event]

Content Type

  • application/json

Responses
Table 4. http response codes
Code Message Datatype

400

Input data is not valid

List[Event]

200

Returns list of objects

List[Event]

403

Forbidden. Please use correct private key.

List[Event]
Samples

2.2.2. eventCreate

POST /api/private/v1.0/events/

Create an Event

Description

Before you start to create an Event you need to create a schema with venue.

Parameters
Body Parameter
Name Description Required Default Pattern

Event

Event

X
Return Type

Event

Content Type

  • application/json

Responses
Table 5. http response codes
Code Message Datatype

400

Input data is not valid

Event

403

Forbidden. Please use correct private key.

Event

200

Returns created object

Event
Samples

2.2.3. eventDelete

DELETE /api/private/v1.0/events/{id}

Delete an Event

Description

Deleted event shall contains valid id.

Parameters
Path Parameters
Name Description Required Default Pattern

id

Valid event identifier

X

null
Return Type

[Boolean]

Content Type

  • application/json

Responses
Table 6. http response codes
Code Message Datatype

200

Returns result of the delete operation

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]
Samples

2.2.4. eventUpdate

PUT /api/private/v1.0/events/

Update an Event

Description

Updated event shall contains valid id.

Parameters
Body Parameter
Name Description Required Default Pattern

Event

Event

X
Return Type

Event

Content Type

  • application/json

Responses
Table 7. http response codes
Code Message Datatype

200

Returns updated object

Event

400

Input data is not valid

Event

403

Forbidden. Please use correct private key.

Event
Samples

2.3. PriceAssignments

2.3.1. assignPrice

POST /api/private/v1.0/assignments/

Assign prices to event

Description

Price assignments assume using of plain representation of price. For GA sections you need to specify capacity

Parameters
Body Parameter
Name Description Required Default Pattern

PriceAssignment

PriceAssignment

X
Query Parameters
Name Description Required Default Pattern

id

Corresponding event id

X

null

clean

Clean before assign is used when you need completely renew the price assignment. It also could be cleaned with clean method

-

false
Return Type

array[PriceAssignment]

Content Type

  • application/json

Responses
Table 8. http response codes
Code Message Datatype

400

Input data is not valid

List[PriceAssignment]

403

Forbidden. Please use correct private key.

List[PriceAssignment]

200

Returns unsuccessful assignments

List[PriceAssignment]
Samples

2.3.2. cleanAssignment

POST /api/private/v1.0/assignments/clean

Remove all price assignments from event

Description

All states including locked seats, will be cleaned up during this operation

Parameters
Query Parameters
Name Description Required Default Pattern

id

Corresponding event id

X

null
Return Type

[Boolean]

Content Type

  • application/json

Responses
Table 9. http response codes
Code Message Datatype

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]

200

Returns true if everything is ok

[Boolean]
Samples

2.3.3. removeAssignment

DELETE /api/private/v1.0/assignments/

Remove specified assignments from event

Description

To remove assignments from event we are using simplified object Selection. For GA sections use capacity field as well

Parameters
Body Parameter
Name Description Required Default Pattern

Selection

Selection

X
Query Parameters
Name Description Required Default Pattern

id

Corresponding event id

X

null
Return Type

array[Selection]

Content Type

  • application/json

Responses
Table 10. http response codes
Code Message Datatype

200

Returns unsuccessful attempts to remove assignment

List[Selection]

400

Input data is not valid

List[Selection]

403

Forbidden. Please use correct private key.

List[Selection]
Samples

2.4. Prices

2.4.1. priceAll

GET /api/private/v1.0/prices/

Retrieve all prices for event

Description

All prices

Parameters
Query Parameters
Name Description Required Default Pattern

id

X

null
Return Type

array[Price]

Content Type

  • application/json

Responses
Table 11. http response codes
Code Message Datatype

400

Input data is not valid

List[Price]

200

Returns list of objects

List[Price]

403

Forbidden. Please use correct private key.

List[Price]
Samples

2.4.2. priceCreate

POST /api/private/v1.0/prices/

Create a price for event

Description

Binds a price to event

Parameters
Body Parameter
Name Description Required Default Pattern

Price

Price

X
Return Type

Price

Content Type

  • application/json

Responses
Table 12. http response codes
Code Message Datatype

400

Input data is not valid

Price

403

Forbidden. Please use correct private key.

Price

200

Returns created object

Price
Samples

2.4.3. priceDelete

DELETE /api/private/v1.0/prices/

Delete a price for event

Description

Binds a price to event

Parameters
Query Parameters
Name Description Required Default Pattern

id

X

null
Return Type

[Boolean]

Content Type

  • application/json

Responses
Table 13. http response codes
Code Message Datatype

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]

200

Returns true if everything is ok.

[Boolean]
Samples

2.4.4. priceUpdate

PUT /api/private/v1.0/prices/

Update a price for event

Description

Binds a price to event

Parameters
Body Parameter
Name Description Required Default Pattern

Price

Price

X
Return Type

Price

Content Type

  • application/json

Responses
Table 14. http response codes
Code Message Datatype

200

Returns updated object

Price

400

Input data is not valid

Price

403

Forbidden. Please use correct private key.

Price
Samples

2.5. Venues

2.5.1. schemaAll

GET /api/private/v1.0/venues/schemas/

Retrieve list of all schemas

Description

Getting all the schemas with paging

Parameters
Query Parameters
Name Description Required Default Pattern

limit

Quantity of requested items

-

50

offset

Offset for the pager

-

0

venueId

Venue id

-

null

lastUpdated

Schemas updated after this date will be retrieved.

-

null
Return Type

array[Schema]

Content Type

  • /

Responses
Table 15. http response codes
Code Message Datatype

400

Input data is not valid

List[Schema]

200

Returns list of schemas

List[Schema]

403

Forbidden. Please use correct private key.

List[Schema]
Samples

2.5.2. schemaDetails

GET /api/private/v1.0/venues/schemas/{schemaId}/details/

Retrieve schema’s details

Description

Getting schema’s details

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null
Return Type

Schema

Content Type

  • /

Responses
Table 16. http response codes
Code Message Datatype

400

Input data is not valid

Schema

403

Forbidden. Please use correct private key.

Schema

200

Returns schema's details

Schema
Samples

2.5.3. schemaMetadata

GET /api/private/v1.0/venues/schemas/{schemaId}/

Retrieve schema’s metadata

Description

Getting schema’s metadata with \\<\\<#composite-key, Composite Key\\>\\>s

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null
Query Parameters
Name Description Required Default Pattern

numberedSections

-

false

useInternalIds

-

false
Return Type

EventMetadata

Content Type

  • /

Responses
Table 17. http response codes
Code Message Datatype

400

Input data is not valid

EventMetadata

403

Forbidden. Please use correct private key.

EventMetadata

200

Returns schema's metadata

EventMetadata
Samples

2.5.4. sectionMetadata

GET /api/private/v1.0/venues/schemas/{schemaId}/section/{sectionId}/

Retrieve section’s metadata

Description

Getting section’s metadata with ID

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null

sectionId

X

null
Return Type

SectorWithCoords

Content Type

  • /

Responses
Table 18. http response codes
Code Message Datatype

400

Input data is not valid

SectorWithCoords

200

Returns section's metadata

SectorWithCoords

403

Forbidden. Please use correct private key.

SectorWithCoords
Samples

2.5.5. venueAll

GET /api/private/v1.0/venues/

Retrieve list of all venues

Description

Getting all the venues with paging

Parameters
Query Parameters
Name Description Required Default Pattern

limit

Quantity of requested items

-

50

offset

Offset for the pager

-

0
Return Type

array[Venue]

Content Type

  • /

Responses
Table 19. http response codes
Code Message Datatype

400

Input data is not valid

List[Venue]

200

Returns list of objects

List[Venue]

403

Forbidden. Please use correct private key.

List[Venue]
Samples

2.5.6. venueById

GET /api/private/v1.0/venues/{venueId}

Retrieves a specific venue by id

Description

Getting venue by Id

Parameters
Path Parameters
Name Description Required Default Pattern

venueId

X

null
Return Type

Venue

Content Type

  • /

Responses
Table 20. http response codes
Code Message Datatype

400

Input data is not valid

Venue

200

Returns list of objects

Venue

403

Forbidden. Please use correct private key.

Venue
Samples

3. Models

3.1. Event

Valid event object without id field

Field Name Required Type Description Format

id

UUID

uuid

start

X

Date

date-time

killAfter

Date

date-time

name

X

String

schemaId

X

Long

int64

3.2. EventMetadata

Contains list of sections

Field Name Required Type Description Format

sectors

List of SectorMetadata List of sections metadata

3.3. Price

Field Name Required Type Description Format

id

Long

int64

name

X

String

eventId

X

UUID

uuid

3.4. PriceAssignment

Field Name Required Type Description Format

capacity

Integer

int32

compositeKey

X

String

price

X

Integer

int32

properties

Object

3.5. RowMetadata List of rows

Field Name Required Type Description Format

key

String

name

String

seats

List of SeatMetadata Array of SeatMetadata

3.6. Schema

Field Name Required Type Description Format

id

Long

int64

capacity

Integer

int32

name

String

venueId

Long

int64

eventId

UUID

uuid

3.7. SeatMetadata Array of SeatMetadata

Field Name Required Type Description Format

key

String

name

String

x

Integer

int32

y

Integer

int32

ix

Integer

int32

iy

Integer

int32

3.8. SectorMetadata List of sections metadata

Field Name Required Type Description Format

key

String

name

String

x

Integer

int32

y

Integer

int32

width

Integer

int32

height

Integer

int32

angle

Integer

int32

guid

UUID

uuid

rows

List of RowMetadata List of rows

id

Long

int64

shapes

List of ShapeMetadata List of shapes

3.9. SectorWithCoords

Field Name Required Type Description Format

id

Long

int64

isGa

Boolean

name

X

String

x

BigDecimal

y

BigDecimal

guid

UUID

uuid

left

BigDecimal

top

BigDecimal

angle

Integer

int32

width

BigDecimal

height

BigDecimal

type

String

shapes

List of Shape

3.10. Selection

Field Name Required Type Description Format

capacity

Integer

int32

compositeKey

X

String

3.11. Shape

Field Name Required Type Description Format

id

UUID

uuid

width

BigDecimal

height

BigDecimal

y

BigDecimal

x

BigDecimal

angle

Integer

int32

groupOfSeatsGuid

UUID

uuid

order

Integer

int32

text

String

textPosition

String

Enum: TOP, BOTTOM, LEFT, RIGHT,

3.12. ShapeMetadata List of shapes

Field Name Required Type Description Format

id

UUID

uuid

width

Integer

int32

height

Integer

int32

top

Integer

int32

left

Integer

int32

angle

Integer

int32

groupOfSeatsGuid

UUID

uuid

order

Integer

int32

text

String

textPosition

String

Enum: TOP, BOTTOM, LEFT, RIGHT,

3.13. Venue

Field Name Required Type Description Format

id

Long

int64

name

String

address

String

lat

Double

double

lng

Double

double