Возвращает список участников события

Request

GET

/persons

Query parameters

Name

Description

limit

Type: string<int64>

Количество элементов в ответе.

offset

Type: string<int64>

Смещение первого элемента списка относительно его начала.
Например, при значении "offset 5" список будет начинаться с шестого элемента.

personId

Type: string[]

Идентификатор персоны в базе данных.

updatedAfter

Type: string<date-time>

События, обновленные после этого времени попадут в ответ.
Заполняется в формате UNIX времени.
Если поле заполнено, пагинация не работает.

Responses

200 OK

OK

Body

application/json
{
    "persons": [
        {
            "id": "string",
            "name": "string",
            "type": "HUMAN",
            "initDate": "2022-12-29T18:02:01Z",
            "endDate": "2022-12-29T18:02:01Z",
            "briefDescription": "string",
            "fullDescription": "string",
            "synonyms": [
                "string"
            ],
            "tags": [
                {
                    "name": "string",
                    "type": "string",
                    "id": "string"
                }
            ],
            "image": {
                "url": "string",
                "type": "string"
            },
            "integrations": [
                {
                    "serviceId": "string",
                    "sourceId": "string"
                }
            ],
            "additional": {}
        }
    ],
    "paging": {
        "limit": "string",
        "offset": "string",
        "total": "string"
    }
}

Name

Description

paging

Type: ListInfo

Информация о пагинации ответа.

persons

Type: Person[]

Список людей, учавствующих в событии.

ListInfo

Name

Description

limit*

Type: string<int64>

Максимальное число элементов на странице.

offset*

Type: string<int64>

Смещение первого элемента списка относительно его начала.
Например, при значении "offset 5" список будет начинаться с шестого элемента.

total*

Type: string<int64>

Общее количество элементов в списке.

Person

Name

Description

additional

Type: object

Служебное поле.

briefDescription

Type: string

Краткое описание.

endDate

Type: string<date-time>

Для групп — дата окончания деятельности.
Для людей — дата смерти.

fullDescription

Type: string

Полное описание.

id

Type: string

Идентификатор персоны в базе данных.

image

Type: Image

Связанные с персоной изображения.

initDate

Type: string<date-time>

Для групп — дата основания.
Для людей — дата рождения.

integrations

Type: SourceRef[]

Служебное поле.

name

Type: string

Имя персоны.

synonyms

Type: string[]

Синонимы для поисковых систем.

tags

Type: Tag[]

Список произвольных тегов.

type

Type: PersonType

Тип персоны.

Default: HUMAN

Enum: HUMAN, BAND

Image

Name

Description

type*

Type: string

Тип изображения. Например, "Постер", "Главная картинка", "Скриншот".

url*

Type: string

Ссылка на изображение.

SourceRef

Name

Description

serviceId

Type: string

Идентификатор сервиса, полученный от менеджера.

sourceId

Type: string

Идентификатор источника в базе данных.

Tag

Name

Description

name*

Type: string

Имя тега.

type*

Type: string

Тип тега.

id

Type: string

Уникальный идентификатор тега.

PersonType

  • HUMAN: Человек. Значение по умолчанию.
  • BAND: Группа.

Type

Description

PersonType

Default: HUMAN

Enum: HUMAN, BAND

No longer supported, please use an alternative and newer version.