Список событий
Возвращает массив событий.
Формат запроса
POST https://api.tickets.yandex.net/api/agent/\
? action=event.list\
& auth=<string>\
& city_id=<number>\
& [limit=<number>]\
& [offset=<number>]\
& [venue_id=<number>]\
& [genre_id=<number>]\
& [activity_id=<number>]\
& [search=<string>]\
& [start_date=<string>]\
& [end_date=<string>]\
& [updated_after=<string>]
Параметры запроса
Query-параметр | Описание |
---|---|
action | string Идентификатор запроса. |
auth | string Идентификатор внешней системы. |
city_id | number Идентификатор города. |
limit | number Максимальное количество возвращаемых объектов. |
offset | number Количество пропускаемых в ответе объектов, начиная с первого. |
venue_id | number Идентификатор места проведения. |
genre_id | number Идентификатор жанра. |
activity_id | number Идентификатор мероприятия. |
search | string Название события. |
start_date | string Дата в формате yyyy-mm-dd, начиная с которой (включительно) события возвращаются в ответе. |
end_date | string Дата в формате yyyy-mm-dd, до которой (включительно) события возвращаются в ответе. |
updated_after | string Дата обновления в формате YYYY-MM-DDThh:mm:ss±hh. Ответ будет содержать только объекты, измененные после этой даты. |
Формат ответа
JSON
{
"status": string,
"result": [
{
"id": number,
"name": string,
"venue_id": number,
"version_id": number,
"venue": string,
"version": string,
"date": string,
"activity_id": number,
"widget": string,
"min_price": number,
"max_price": number,
"genres_id": array,
"age": string,
"image": string,
"image_list": string,
"image_poster": string,
"city_id": number,
"close_to": number,
"close_to_date": string,
"pro_culture_id": string,
"pro_culture_organization_id": number,
"has_document_verification": integer,
"pro_culture_place_id": number,
"khl_id": number
}
]
}
Параметры ответа
Параметр | Описание |
---|---|
status | string Статус выполнения запроса. Возможные значения:
|
result[] | [object] Результат выполнения запроса. |
result[].id | number Идентификатор события. |
result[].name | string Название события. |
result[].venue_id | number Идентификатор места проведения. |
result[].version_id | number Идентификатор версии зала. |
result[].venue | string Название места проведения. |
result[].version | string Название версии зала. |
result[].date | string Дата события в формате YYYY-MM-DD hh:mm:ss. |
result[].activity_id | number Идентификатор мероприятия. |
result[].widget | string Код виджета. |
result[].min_price | number Минимальная стоимость билета. |
result[].max_price | number Максимальная стоимость билета. |
result[].genres_id[] | array Массив идентификаторов жанров. |
result[].age | string Рекомендованный возраст. |
result[].image | string Ссылка на изображение. |
result[].image_list | string Ссылка на изображение для списков. |
result[].image_poster | string Ссылка на постер. |
result[].city_id | number Идентификатор города. |
result[].close_to | number Количество часов до события, когда прекращается продажа билетов. |
result[].close_to_date | string Дата закрытия события в формате YYYY-MM-DD hh:mm:ss. |
result[].pro_culture_id | string Идентификатор мероприятия из системы «PRO.Культура.РФ». |
result[].pro_culture_organization_id | number Идентификатор организации из системы «PRO.Культура.РФ». |
result[].has_document_verification | integer Если значение равно 1 , то для события нужно передавать документы зрителя. Параметр не может принимать значение null . |
result[].pro_culture_place_id | number Идентификатор площадки из системы «PRO.Культура.РФ». |
result[].khl_id | number Идентификатор мероприятия КХЛ. Может принимать значение null , если поле не было заполнено. |
Пример ответа
{
"status": string,
"result": [
{
"id": 123,
"name": "Название события 1",
"venue_id": 123,
"version_id": 123,
"venue": "Название места проведения",
"version": "Название версии зала",
"date": "2024-02-14 20:32:33",
"activity_id": 123,
"widget": "https://example.com",
"min_price": 123,
"max_price": 321,
"genres_id": [],
"age": "12+",
"image": "https://example.com/image1.jpg",
"image_list": "https://example.com/image_list1.jpg",
"image_poster": "https://example.com/image_poster1.jpg",
"city_id": 123,
"close_to": 1,
"close_to_date": "2024-02-14 21:32:33",
"pro_culture_id": null,
"pro_culture_organization_id": null,
"has_document_verification": 0,
"pro_culture_place_id": null,
"khl_id": 123
},
{
"id": 124,
"name": "Название события 2",
"venue_id": 124,
"version_id": 124,
"venue": "Название места проведения",
"version": "Название версии зала",
"date": "2024-02-15 20:32:33",
"activity_id": 124,
"widget": "https://example.com",
"min_price": 123,
"max_price": 321,
"genres_id": [],
"age": "12+",
"image": "https://example.com/image2.jpg",
"image_list": "https://example.com/image_list2.jpg",
"image_poster": "https://example.com/image_poster2.jpg",
"city_id": 124,
"close_to": 1,
"close_to_date": "2024-02-15 21:32:33",
"pro_culture_id": "123",
"pro_culture_organization_id": 100,
"has_document_verification": 1,
"pro_culture_place_id": 12345,
"khl_id": null
}
]
}
Была ли статья полезна?
Предыдущая
Следующая