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 |
---|---|---|---|---|
body |
X |
Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
X |
null |
Return Type
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns unsuccessful attempts |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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 |
---|---|---|---|---|
body |
X |
Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
X |
null |
Return Type
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns unsuccessful attempts |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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 |
---|---|---|---|---|
body |
X |
Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
X |
null |
Return Type
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns unsuccessful attempts |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns list of objects |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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 |
X |
Return Type
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns created object |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns result of the delete operation |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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 |
X |
Return Type
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns updated object |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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 |
---|---|---|---|---|
body |
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
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns unsuccessful assignments |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns true if everything is ok |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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 |
---|---|---|---|---|
body |
X |
Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id |
Corresponding event id |
X |
null |
Return Type
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns unsuccessful attempts to remove assignment |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns list of objects |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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 |
X |
Return Type
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns created object |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns true if everything is ok. |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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 |
X |
Return Type
Content Type
-
application/json
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns updated object |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
/
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns list of schemas |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
/
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns schema's details |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
/
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns schema's metadata |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
/
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns section's metadata |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
/
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns list of objects |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
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
Content Type
-
/
Responses
Code | Message | Datatype |
---|---|---|
200 |
Returns list of objects |
|
400 |
Input data is not valid |
|
403 |
Forbidden. Please use correct private key. |
Samples
3. Models
3.1. Event
Valid event object without id field
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
id |
oas_any_type_not_mapped |
uuid |
||
start |
X |
oas_any_type_not_mapped |
date-time |
|
killAfter |
oas_any_type_not_mapped |
date-time |
||
name |
oas_any_type_not_mapped |
|||
schemaId |
X |
oas_any_type_not_mapped |
int64 |
3.2. EventMetadata
Contains list of sections
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
sectors |
oas_any_type_not_mapped |
3.3. Price
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
id |
oas_any_type_not_mapped |
int64 |
||
name |
oas_any_type_not_mapped |
|||
eventId |
X |
oas_any_type_not_mapped |
uuid |
|
externalId |
oas_any_type_not_mapped |
3.4. PriceAssignment
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
capacity |
oas_any_type_not_mapped |
int32 |
||
compositeKey |
oas_any_type_not_mapped |
|||
price |
X |
oas_any_type_not_mapped |
int32 |
|
properties |
oas_any_type_not_mapped |
3.5. RowMetadata
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
key |
oas_any_type_not_mapped |
|||
name |
oas_any_type_not_mapped |
|||
seats |
oas_any_type_not_mapped |
3.6. Schema
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
id |
oas_any_type_not_mapped |
int64 |
||
capacity |
oas_any_type_not_mapped |
int32 |
||
name |
oas_any_type_not_mapped |
|||
venueId |
oas_any_type_not_mapped |
int64 |
||
eventId |
oas_any_type_not_mapped |
uuid |
3.7. SeatMetadata
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
key |
oas_any_type_not_mapped |
|||
name |
oas_any_type_not_mapped |
|||
x |
oas_any_type_not_mapped |
int32 |
||
y |
oas_any_type_not_mapped |
int32 |
||
ix |
oas_any_type_not_mapped |
int32 |
||
iy |
oas_any_type_not_mapped |
int32 |
3.8. SectorMetadata
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
key |
oas_any_type_not_mapped |
|||
name |
oas_any_type_not_mapped |
|||
x |
oas_any_type_not_mapped |
int32 |
||
y |
oas_any_type_not_mapped |
int32 |
||
width |
oas_any_type_not_mapped |
int32 |
||
height |
oas_any_type_not_mapped |
int32 |
||
angle |
oas_any_type_not_mapped |
int32 |
||
guid |
oas_any_type_not_mapped |
uuid |
||
rows |
oas_any_type_not_mapped |
|||
id |
oas_any_type_not_mapped |
int64 |
||
shapes |
oas_any_type_not_mapped |
3.9. SectorWithCoords
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
id |
oas_any_type_not_mapped |
int64 |
||
isGa |
oas_any_type_not_mapped |
|||
name |
oas_any_type_not_mapped |
|||
x |
oas_any_type_not_mapped |
|||
y |
oas_any_type_not_mapped |
|||
guid |
oas_any_type_not_mapped |
uuid |
||
left |
oas_any_type_not_mapped |
|||
top |
oas_any_type_not_mapped |
|||
angle |
oas_any_type_not_mapped |
int32 |
||
width |
oas_any_type_not_mapped |
|||
height |
oas_any_type_not_mapped |
|||
type |
oas_any_type_not_mapped |
|||
shapes |
oas_any_type_not_mapped |
3.10. Selection
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
capacity |
oas_any_type_not_mapped |
int32 |
||
compositeKey |
oas_any_type_not_mapped |
3.11. Shape
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
id |
oas_any_type_not_mapped |
uuid |
||
width |
oas_any_type_not_mapped |
|||
height |
oas_any_type_not_mapped |
|||
y |
oas_any_type_not_mapped |
|||
x |
oas_any_type_not_mapped |
|||
angle |
oas_any_type_not_mapped |
int32 |
||
groupOfSeatsGuid |
oas_any_type_not_mapped |
uuid |
||
order |
oas_any_type_not_mapped |
int32 |
||
text |
oas_any_type_not_mapped |
|||
textPosition |
oas_any_type_not_mapped |
Enum: TOP, BOTTOM, LEFT, RIGHT, |
3.12. ShapeMetadata
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
id |
oas_any_type_not_mapped |
uuid |
||
width |
oas_any_type_not_mapped |
int32 |
||
height |
oas_any_type_not_mapped |
int32 |
||
top |
oas_any_type_not_mapped |
int32 |
||
left |
oas_any_type_not_mapped |
int32 |
||
angle |
oas_any_type_not_mapped |
int32 |
||
groupOfSeatsGuid |
oas_any_type_not_mapped |
uuid |
||
order |
oas_any_type_not_mapped |
int32 |
||
text |
oas_any_type_not_mapped |
|||
textPosition |
oas_any_type_not_mapped |
Enum: TOP, BOTTOM, LEFT, RIGHT, |
3.13. Venue
Field Name | Required | Type | Description | Format |
---|---|---|---|---|
id |
oas_any_type_not_mapped |
int64 |
||
name |
oas_any_type_not_mapped |
|||
address |
oas_any_type_not_mapped |
|||
lat |
oas_any_type_not_mapped |
double |
||
lng |
oas_any_type_not_mapped |
double |