Protocol Documentation

artists.proto
- Artist
- ArtistsRequest
events.proto
generic.proto
geo.proto
meta_events.proto
- MetaEvent
- MetaEventsRequest
mods.proto
seats.proto
service.proto
- Simple
tags.proto
venues.proto
- Map
- Map.Seat
- Map.Seat.Point
- Map.Sector
- Map.SvgEntry
- MapsRequest
- Venue
- VenuesRequest
Scalar Value Types

artists.proto

Artist

Artist structure.

Field	Type	Label	Description
id	string		Artist id (oid)
name	string		Artist name

ArtistsRequest

Request for Artists.

Field	Type	Label	Description
ids	string	repeated	Filtering by Artist id

Top

events.proto

Deal

Field	Type	Description
id	string	Deal id
org	Percentage	Share (percent) of the organizer
agent	Percentage	Share of nominal ticket price got by agent
extra	Percentage	Share in excess of nominal ticket price, got by agent

Event

Event structure.

Field	Type	Label	Description
id	string		Event id
meta	string		[O] Event group id (absent for single Events)
name	string		Event title
description	string		[O] description
status	EventStatus		status
org	string		Organizer id
venue	string		Venue id
map	string		[O] Auditorium map id
lifetime	Lifetime		Event start and end datetime
category	string		Event category id
tags	string	repeated	Event genres id
artists	string	repeated	id of artists participating
age_rating	string		[O] Age restrictions
media	Media		Media covers
deal	Deal		[O] deal, if request is performed by agent
org_extra	Percentage		[O] commission percentage, if request is performed by organizer
legal_ru	LegalRu		[O] seller's bank details
sets	TicketSet	repeated	ticket sets
tickets_amount	uint32		total amount of tickets in the Event
tickets_amount_vacant	uint32		amount of vacant tickets in the Event
smart_tickets	SmartTicketSetting		smart tickets settings
mods	Mod	repeated	extra info on discounts
additional	google.protobuf.Any		reserved field(s)

EventsRequest

Request for Events.

Field	Type	Label	Description
ids	string	repeated	Filtering by Event id
meta	string		Filtering by Event group id
without_meta	bool		Filter to get only single Events, that are not included into groups
org	string		Filtering by organizer id
status	EventsRequest.Status		Filtering by Event status
lifetime	LiftimeFilter

LegalRu

Field	Type	Description
id	string	Legal id
type	LegalRu.Type	Legal type
name	string	Name
inn	string	Tax ID
address	string	Legal address
ogrn	string	State registry number
ogrnip	string	Individual Enterpreneur state registry number

TicketSet

Ticket set structure.

Field	Type	Label	Description
id	string		Set id
name	string		Set name
description	string		[O] Description
pos	int32		Set ordinal number
sector	string		[O] sector id
with_seats	bool		Whether tickets are bound to seats
amount	uint32		Total amount of tickets in set
amount_vacant	uint32		Amount of tickets available for sale in set
rules	TicketSet.Rule	repeated	Price rules for set

TicketSet.Rule

Field	Type	Description
id	string	Sales rule id
type	TicketSet.Rule.Type	Rule type
lifetime	Lifetime
simple	TicketSet.Rule.SimpleType

TicketSet.Rule.SimpleType

Field	Type	Label	Description
price	uint64		Price for ticket set

EventStatus

Supported Event statuses.

Name	Number	Description
STAND_BY	0	Sales are temporarily suspended
PUBLIC	1	Sales are going

EventsRequest.Status

Name	Number	Description
ANY	0	No filtering by status
STAND_BY	1	Sales are temporarily suspended
PUBLIC	2	Sales are going

LegalRu.Type

Name	Number	Description
LTD	0	Limited Liability Company
IP	1	Individual Enterpreneur

SmartTicketSetting

Smart tickets options.

Name	Number	Description
NONE	0	Smart tickets are not used on the Event
ONLY	1	Smart tickets are the only used on the Event
ANY	2	Both smart and usual tickets can be sold for the Event

TicketSet.Rule.Type

Name	Number	Description
SIMPLE	0	Simple rule: sales rules are going one after another.

Top

generic.proto

Coordinates

Geo coordinates

Field	Type	Label	Description
longitude	double
latitude	double

Lifetime

Field	Type	Label	Description
start	google.protobuf.Timestamp
finish	google.protobuf.Timestamp

LiftimeFilter

Field	Type	Label	Description
start	TimestampFilter
finish	TimestampFilter

Media

Field	Type	Description
cover	string	[O]
cover_small	string	[O]
cover_original	string	[O]

Percentage

Field	Type	Label	Description
units	int32		Whole units part of the amount
nanos	fixed32		Nano units of the amount (10^-9). Must be same sign as units

TimestampFilter

Field	Type	Label	Description
gte	google.protobuf.Timestamp
gt	google.protobuf.Timestamp
lte	google.protobuf.Timestamp
lt	google.protobuf.Timestamp

Top

geo.proto

CitiesRequest

Request for cities.

Field	Type	Label	Description
ids	int32	repeated	Filtering by city id
name	string		Filtering ny city name
suggest	string		Prefix search
country	string		Filtering by country

City

Field	Type	Description
id	int32	City id
name	string	Name
country	string	Country id
timezone	string	Timezone
coordinates	Coordinates	Coordinates
population	int64	City population

CountriesRequest

Request for countries.

Field	Type	Label	Description
ids	string	repeated	Filtering by country id

Country

Field	Type	Description
id	string	Country id
name	string	Name
currency	string	Currency
iso	string	ISO 3166-1 code
iso3	string	ISO 3166-3 code
iso_numeric	uint32	ISO 3166-1 numeric code

Top

meta_events.proto

MetaEvent

Field	Type	Description
id	string	Group id
name	string	Group name
description	string	[O] Description
org	string	Organizer id
age_rating	string	[O] Age restrictions
media	Media	Media cover
first_start	google.protobuf.Timestamp	Time when the first Event begins
last_finish	google.protobuf.Timestamp	Time when the last Event ends
additional	google.protobuf.Any	Reserved field(s)

MetaEventsRequest

Request for Event groups.

Field	Type	Label	Description
ids	string	repeated	Filtering by group id

Top

mods.proto

Mod

Field	Type	Description
id	string
type	ModType
promotion	ModPromotionType	Promotion settings

ModPromotionType

Field	Type	Label	Description
lifetime	Lifetime
sets	string	repeated	Ticket sets discount is related to
discount_percentage	Percentage		Percentage discount
discount_fix	uint64		Fixed discount
levels_percentage	ModPromotionType.LevelsPercentage		Levels for percentage discount
levels_fix	ModPromotionType.LevelsFix		Levels for fixed discount

ModPromotionType.LevelsFix

Field	Type	Label	Description
levels	ModPromotionType.LevelsFix.Level	repeated

ModPromotionType.LevelsFix.Level

Field	Type	Label	Description
level	uint64
value	uint64

ModPromotionType.LevelsPercentage

Field	Type	Label	Description
levels	ModPromotionType.LevelsPercentage.Level	repeated

ModPromotionType.LevelsPercentage.Level

Field	Type	Label	Description
level	uint64
value	Percentage

ModType

Discount modifier type.

Name	Number	Description
PROMOTION	0

Top

seats.proto

Seat

Field	Type	Description
sector	string	Sector id
row	string	Row number
number	string	Seat number
event	string	Event id
set	string	Ticket set id
ticket	string	Ticket id
status	TicketStatus	Ticket status
ticket_reserved_till	google.protobuf.Timestamp	[O] Reserve expiration time, only for tickets wits status='RESERVED'

SeatsRequest

Request for seats.

Field	Type	Label	Description
sector	string
row	string
number	string
event	string		Filtering by Event id (required)
sets	string	repeated
tickets	string	repeated
status	SeatsRequest.Status

SeatsRequest.Status

Name	Number	Description
ANY	0	Any ticket status
VACANT	1	Ticket is available for sell
RESERVED	2	Ticket is reserved
SOLD	3	Ticket is sold

TicketStatus

Name	Number	Description
VACANT	0	Ticket is available for sell
RESERVED	1	Ticket is reserved
SOLD	2	Ticket is sold

Top

service.proto

Simple

Method Name	Request Type	Response Type
Countries	.CountriesRequest	.Country stream
Cities	.CitiesRequest	.City stream
Venues	.VenuesRequest	.Venue stream
Maps	.MapsRequest	.Map stream
Categories	.CategoriesRequest	.Category stream
Tags	.TagsRequest	.Tag stream
Artists	.ArtistsRequest	.Artist stream
Events	.EventsRequest	.Event stream
MetaEvents	.MetaEventsRequest	.MetaEvent stream
Seats	.SeatsRequest	.Seat stream

Top

tags.proto

CategoriesRequest

Request for categories.

Field	Type	Label	Description
ids	string	repeated	Filtering by category id

Tag

Field	Type	Description
id	string	Genre id
category	string	Category id
name	string	Genre name
generic	bool	Is generic

TagsRequest

Field	Type	Label	Description
ids	string	repeated	Genre id

Top

venues.proto

Map

Field	Type	Label	Description
id	string		Map id
name	string		Map name
description	string		[O] Description
venue	string		Venue id
sectors	Map.Sector	repeated	Sectors list
seats	Map.Seat	repeated	Seats list
svg	Map.SvgEntry	repeated	svg maps

Map.Seat

Field	Type	Description
sector	string
row	string	Row number
number	string	Seat number
point	Map.Seat.Point

Map.Seat.Point

Seat coordinates on the map

Field	Type	Description
x	int32
y	int32
r	int32	radius

Map.Sector

Field	Type	Description
id	string	Sector id
name	string	Sector name
description	string	[O] description
with_seats	bool	Whether sector has seats

Map.SvgEntry

Field	Type	Label	Description
key	string
value	string

MapsRequest

Request for maps.

Field	Type	Label	Description
ids	string	repeated	Filtering by map id
venue	string		Filtering by venue id to get all auditoria maps

Venue

Field	Type	Description
id	string	Venue id
name	string	Name
description	string	[O] Description
city	int32	City id
address	string	[O] Address
coordinates	Coordinates	[O] Geo coordinates

VenuesRequest

Request for venues.

Field	Type	Label	Description
ids	string	repeated	Filtering by venue id

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)

Files

docs.md

Latest commit

History