Аутентификация токеном TalentOAuth пользователем Таланта.
Передается в заголовке Authorization: Bearer в формате JWT.
При использовании этой аутентификации, авторизация сервисом выполняется в отношении пользователя, авторизовавшего переданный токен.
Для получения токена нужно воспользоваться API OAuth2 провайдера.
Аутентификация учетными данными OAuth2 клиента TalentOAuth.
В качестве username используется client_id, а в password - client_secret.
Пагинация может быть представлена как параметром offset, так и параметром id_offset.
Параметр offset позволяет указать кол-во объектов для пропуска из читаемой выборки.
В id_offset указывается идентификатор, до которого включительно будут пропущены объекты.
Предпочтительно, когда есть возможность, использовать
id_offset. Также надо учитывать, что допустимое значение дляoffsetимеет ограничения.
У
id_offsetтоже имеется ограничение - с ним не доступны варианты сортировки результатов, за исключением вариантовid_ascиid_desc. Для иных значенийorder_byбудет возвращаться ответ400 Bad Request.
| id required | integer <int32> (EventID) ID мероприятия. | ||||||||||
| created_at required | string <date-time> (EventCreatedAt) Дата создания. | ||||||||||
| updated_at required | string <date-time> (EventUpdatedAt) Дата обновления. | ||||||||||
| draft required | boolean (EventDraft) Мероприятие находится в статусе черновика. На такое мероприятие нельзя зарегистрироваться. | ||||||||||
| public required | boolean (EventPublic) Статус публичности мероприятия. | ||||||||||
| hidden required | boolean (EventHidden) Исключение мероприятия из календаря. | ||||||||||
| canceled required | boolean (EventCanceled) Статус отмены мероприятия. | ||||||||||
| title required | string (EventTitle) Название мероприятия. | ||||||||||
| start required | string or null <date-time> (EventStart) Дата начала мероприятия. | ||||||||||
| end required | string or null <date-time> (EventEnd) Дата окончания мероприятия. | ||||||||||
| format required | string (EventFormat)
Формат проведения мероприятия. | ||||||||||
| organization_id required | integer or null <int32> (EventOrganizationID) ID организации мероприятия. | ||||||||||
| meta_event_id required | integer or null <int32> (EventMetaEventID) ID мета-мероприятия. | ||||||||||
| created_by_id required | integer or null <int32> (EventCreatedByID) ID автора мероприятия. | ||||||||||
| venue_id required | integer or null <int32> (EventVenueID) ID площадки на которой проводится мероприятие. | ||||||||||
| simplified_registration required | boolean Доступность упрощенной регистрации на мероприятие. | ||||||||||
| autocreate_member required | boolean (EventAutocreateMember) Автоматическое добавление в участники организации пользователя с подтвержденной заявки. | ||||||||||
| achievements_allowed required | boolean (EventAchievementsAllowed) Допуск на создания достижений на мероприятие. | ||||||||||
| requests_allowed required | boolean (EventRequestsAllowed) Допуск на создания заявок на мероприятие. | ||||||||||
| self_check_in required | boolean (EventSelfCheckIn) Доступность чекина | ||||||||||
| teams_involved required | integer <int32> (EventTeamsInvolved)
Формат участия. | ||||||||||
| owner_can_moderate required | boolean | ||||||||||
| user_in_multiple_teams required | boolean | ||||||||||
| mentors_allowed required | boolean | ||||||||||
| support_i18n required | boolean | ||||||||||
| gir_collection required | boolean | ||||||||||
| time_matters required | boolean (EventTimeMatters) Учитывается ли время или только даты в полях | ||||||||||
| promoted required | boolean | ||||||||||
| max_users required | integer or null (EventMaxUsers) | ||||||||||
| team_create_notification required | boolean | ||||||||||
| team_assignment_method required | string (EventTeamAssignmentMethod)
| ||||||||||
| achievement_roles_count required | integer <int32> | ||||||||||
| achievements_count required | integer <int32> (EventAchievementsCount) | ||||||||||
| requests_count required | integer <int32> (EventRequestsCount) | ||||||||||
| expected_start required | string or null <date-time> (EventExpectedStart) | ||||||||||
| alt_title required | string (EventAltTitle) Альтернативное название мероприятия. | ||||||||||
| cover required | string (EventCover) Ссылка на обложку мероприятия. | ||||||||||
| url required | string <url> (EventURL) <= 200 characters Адрес online мероприятия. | ||||||||||
| type_id required | integer or null <int32> (EventTypeID) Идентификатор типа мероприятия. | ||||||||||
| description required | string (EventDescription) Описание мероприятия. | ||||||||||
| cancellation_reason required | string Причина отмены мероприятия. | ||||||||||
| questionnaire_completed_message required | string (EventQuestionnaireCompletedMessage) Сообщение о заполненной анкете. |
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "public": true,
- "hidden": true,
- "canceled": true,
- "title": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "format": "",
- "organization_id": 0,
- "meta_event_id": 0,
- "created_by_id": 0,
- "venue_id": 0,
- "simplified_registration": true,
- "autocreate_member": true,
- "achievements_allowed": true,
- "requests_allowed": true,
- "self_check_in": true,
- "teams_involved": 0,
- "owner_can_moderate": true,
- "user_in_multiple_teams": true,
- "mentors_allowed": true,
- "support_i18n": true,
- "gir_collection": true,
- "time_matters": true,
- "promoted": true,
- "max_users": 0,
- "team_create_notification": true,
- "team_assignment_method": "completion",
- "achievement_roles_count": 0,
- "achievements_count": 0,
- "requests_count": 0,
- "expected_start": "2019-08-24T14:15:22Z",
- "alt_title": "string",
- "cover": "string",
- "url": "string",
- "type_id": 0,
- "description": "string",
- "cancellation_reason": "string",
- "questionnaire_completed_message": "string"
}| id required | integer <int32> (EventID) ID мероприятия. | ||||||||
| created_at required | string <date-time> (EventCreatedAt) Дата создания. | ||||||||
| updated_at required | string <date-time> (EventUpdatedAt) Дата обновления. | ||||||||
| draft required | boolean (EventDraft) Мероприятие находится в статусе черновика. На такое мероприятие нельзя зарегистрироваться. | ||||||||
| public required | boolean (EventPublic) Статус публичности мероприятия. | ||||||||
| hidden required | boolean (EventHidden) Исключение мероприятия из календаря. | ||||||||
| canceled required | boolean (EventCanceled) Статус отмены мероприятия. | ||||||||
| title required | string (EventTitle) Название мероприятия. | ||||||||
| start required | string or null <date-time> (EventStart) Дата начала мероприятия. | ||||||||
| end required | string or null <date-time> (EventEnd) Дата окончания мероприятия. | ||||||||
| format required | string (EventFormat)
Формат проведения мероприятия. | ||||||||
| organization_id required | integer or null <int32> (EventOrganizationID) ID организации мероприятия. | ||||||||
| meta_event_id required | integer or null <int32> (EventMetaEventID) ID мета-мероприятия. | ||||||||
| created_by_id required | integer or null <int32> (EventCreatedByID) ID автора мероприятия. | ||||||||
| venue_id required | integer or null <int32> (EventVenueID) ID площадки на которой проводится мероприятие. |
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "public": true,
- "hidden": true,
- "canceled": true,
- "title": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "format": "",
- "organization_id": 0,
- "meta_event_id": 0,
- "created_by_id": 0,
- "venue_id": 0
}| event_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов мероприятий. | ||||||||
| organization_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтрация мероприятий по ID организации. | ||||||||
| meta_event_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтрация мероприятий по ID мета-мероприятия. | ||||||||
| venue_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтрация мероприятий по ID площадки их проведения. | ||||||||
| start_before | string <date-time> Мероприятия с датой начала ранее указанной. | ||||||||
| end_after | string <date-time> Мероприятия с датой завершения после указанной. | ||||||||
| search | string [ 3 .. 150 ] characters Поиск по названию, ключевым словам и описанию. | ||||||||
| format | string (EventFormat)
Фильтрация по формату мероприятий. |
{- "error": "string"
}Если не указан критерий сортировки результатов order_by,
то он определяется в зависимости от указания других параметров.
По-умолчанию результаты сортируются по идентификаторам в порядке возрастания (id_asc).
Но если указан поисковый запрос и не используется параметр id_offset,
то результаты сортируются по релевантности к поисковому запросу (relevant).
При явном указании order_by, его значение должно соответствовать требованиям:
id_offset допускается только order_by=id_ascorder_by=relevant доступен только при указании параметра search.| event_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов мероприятий. | ||||||||
| organization_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтрация мероприятий по ID организации. | ||||||||
| meta_event_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтрация мероприятий по ID мета-мероприятия. | ||||||||
| venue_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтрация мероприятий по ID площадки их проведения. | ||||||||
| start_before | string <date-time> Мероприятия с датой начала ранее указанной. | ||||||||
| end_after | string <date-time> Мероприятия с датой завершения после указанной. | ||||||||
| search | string [ 3 .. 150 ] characters Поиск по названию, ключевым словам и описанию. | ||||||||
| format | string (EventFormat)
Фильтрация по формату мероприятий. | ||||||||
| id_offset | integer <int32> Пропуск объектов с идентификатором равном или менее указанного. | ||||||||
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. | ||||||||
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. | ||||||||
| order_by | string Enum: "relevant" "id_asc" "id_desc" |
[- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "public": true,
- "hidden": true,
- "canceled": true,
- "title": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "format": "",
- "organization_id": 0,
- "meta_event_id": 0,
- "created_by_id": 0,
- "venue_id": 0,
- "cover": "string"
}
]Мероприятия, доступные для добавления достижения пользователем.
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. | ||||||||
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. | ||||||||
| search | string [ 3 .. 150 ] characters Поиск по названию, ключевым словам и описанию. | ||||||||
| event_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов мероприятий. | ||||||||
| format | string (EventFormat)
Фильтрация по формату мероприятий. | ||||||||
| start_before | string <date-time> Мероприятия с датой начала ранее указанной. | ||||||||
| end_after | string <date-time> Мероприятия с датой завершения после указанной. | ||||||||
| brand_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов брендов. | ||||||||
| competency_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов компетенций Конкурса Талант. | ||||||||
| region | string Фильтрация по названию региона. |
[- {
- "id": 0,
- "title": "string",
- "alt_title": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "achievement_roles": [
- 0
]
}
]| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. |
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. |
| order_by | string Default: "start_asc" Enum: "start_asc" "start_desc" "title_asc" "title_desc" Критерий сортировки результатов. |
[- {
- "id": 0,
- "canceled": true,
- "title": "string",
- "alt_title": "string",
- "format": "",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "requests_allowed": true,
- "expected_start": "2019-08-24T14:15:22Z",
- "time_matters": true,
- "limits": {
- "date_end_request": "2019-08-24T14:15:22Z"
}, - "cover": "string",
- "city": "string",
- "brands": [
- 0
]
}
]| organization_id required | integer <int32> >= 1 ID организации. |
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. | ||||||||
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. | ||||||||
| event_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов мероприятий. | ||||||||
| search | string [ 3 .. 150 ] characters Поиск по названию, ключевым словам и описанию. | ||||||||
| format | string (EventFormat)
Фильтрация по формату мероприятий. | ||||||||
| start_before | string <date-time> Мероприятия с датой начала ранее указанной. | ||||||||
| end_after | string <date-time> Мероприятия с датой завершения после указанной. | ||||||||
| city | string Фильтрация по названию города. | ||||||||
| order_by | string Default: "start_desc" Enum: "start_asc" "start_desc" "title_asc" "title_desc" Критерий сортировки результатов. При использовании текстового поиска, результаты будут отсортированы сначала в порядке релевантности, а потом в соответствии с указанным этим параметром критерием. |
[- {
- "id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "public": true,
- "hidden": true,
- "canceled": true,
- "title": "string",
- "alt_title": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "format": "",
- "organization_id": 0,
- "meta_event_id": 0,
- "achievements_allowed": true,
- "requests_allowed": true,
- "self_check_in": true,
- "teams_involved": 0,
- "max_users": 0,
- "limits": {
- "date_end_request": "2019-08-24T14:15:22Z"
}, - "achievements_count": 0,
- "requests_count": 0,
- "cover": "string",
- "url": "string",
- "city": "string",
- "address": "string",
- "edges_incoming": [
- {
- "id": 0,
- "type": 1,
- "from_event_id": 0,
- "to_event_id": 0
}
]
}
]По умолчанию возвращаются только метаданные.
Для получения полного набора свойств используйте параметр extend.
| event_id required | integer <int32> >= 1 ID мероприятия |
| extend | boolean Default: false Вернуть в ответе полный набор свойств. |
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "public": true,
- "hidden": true,
- "canceled": true,
- "title": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "format": "",
- "organization_id": 0,
- "meta_event_id": 0,
- "created_by_id": 0,
- "venue_id": 0
}| event_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов мероприятий. |
| brand_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов брендов. |
| id_offset | integer <int32> Пропуск объектов с идентификатором равном или менее указанного. |
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. |
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. |
[- {
- "id": 0,
- "event_id": 0,
- "brand_id": 0
}
]| event_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов мероприятий. |
| route_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов направлений. |
| id_offset | integer <int32> Пропуск объектов с идентификатором равном или менее указанного. |
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. |
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. |
[- {
- "id": 0,
- "event_id": 0,
- "route_id": 0
}
]При полном отсутствии в запросе массива achievement_roles,
мероприятию назначаются роли достижений по-умолчанию.
Пустой же массив приведет к созданию мероприятия без ролей.
| organization_id required | integer <int32> ID организации мероприятия. | ||||||||||
| draft | boolean (EventDraft) Мероприятие находится в статусе черновика. На такое мероприятие нельзя зарегистрироваться. | ||||||||||
| public | boolean (EventPublic) Статус публичности мероприятия. | ||||||||||
| hidden | boolean (EventHidden) Исключение мероприятия из календаря. | ||||||||||
| title required | string (EventTitleInput) non-empty Название мероприятия. | ||||||||||
| start | string or null <date-time> (EventStart) Дата начала мероприятия. | ||||||||||
| end | string or null <date-time> (EventEnd) Дата окончания мероприятия. | ||||||||||
| format | string (EventFormat)
Формат проведения мероприятия. | ||||||||||
| venue_id | integer or null <int32> (EventVenueID) ID площадки на которой проводится мероприятие. | ||||||||||
| autocreate_member | boolean (EventAutocreateMember) Автоматическое добавление в участники организации пользователя с подтвержденной заявки. | ||||||||||
| achievements_allowed | boolean (EventAchievementsAllowed) Допуск на создания достижений на мероприятие. | ||||||||||
| requests_allowed | boolean (EventRequestsAllowed) Допуск на создания заявок на мероприятие. | ||||||||||
| teams_involved | integer <int32> (EventTeamsInvolved)
Формат участия. | ||||||||||
| user_in_multiple_teams | boolean | ||||||||||
| time_matters | boolean (EventTimeMatters) Учитывается ли время или только даты в полях | ||||||||||
| team_assignment_method | string (EventTeamAssignmentMethod)
| ||||||||||
| url | string <url> (EventURL) <= 200 characters Адрес online мероприятия. | ||||||||||
| type_id | integer or null <int32> (EventTypeID) Идентификатор типа мероприятия. | ||||||||||
| description | string (EventDescription) Описание мероприятия. | ||||||||||
| questionnaire_completed_message | string (EventQuestionnaireCompletedMessage) Сообщение о заполненной анкете. | ||||||||||
| notification_email_message | string (EventNotificationEmailMessage) Дополнительный текст для Email уведомления о регистрации на мероприятие.
| ||||||||||
| cover_url | string <uri> (EventCoverURLWrite) Ссылка на обложку мероприятия. | ||||||||||
| achievement_roles | Array of integers <int32> [ items <int32 > ] | ||||||||||
| brands | Array of integers <int32> [ items <int32 > ] |
{- "organization_id": 0,
- "draft": true,
- "public": true,
- "hidden": true,
- "title": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "format": "",
- "venue_id": 0,
- "autocreate_member": true,
- "achievements_allowed": true,
- "requests_allowed": true,
- "teams_involved": 0,
- "user_in_multiple_teams": true,
- "time_matters": true,
- "team_assignment_method": "completion",
- "url": "string",
- "type_id": 0,
- "description": "string",
- "questionnaire_completed_message": "string",
- "notification_email_message": "string",
- "achievement_roles": [
- 0
], - "brands": [
- 0
]
}{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "draft": true,
- "public": true,
- "hidden": true,
- "canceled": true,
- "title": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "format": "",
- "organization_id": 0,
- "meta_event_id": 0,
- "created_by_id": 0,
- "venue_id": 0,
- "simplified_registration": true,
- "autocreate_member": true,
- "achievements_allowed": true,
- "requests_allowed": true,
- "self_check_in": true,
- "teams_involved": 0,
- "owner_can_moderate": true,
- "user_in_multiple_teams": true,
- "mentors_allowed": true,
- "support_i18n": true,
- "gir_collection": true,
- "time_matters": true,
- "promoted": true,
- "max_users": 0,
- "team_create_notification": true,
- "team_assignment_method": "completion",
- "achievement_roles_count": 0,
- "achievements_count": 0,
- "requests_count": 0,
- "expected_start": "2019-08-24T14:15:22Z",
- "alt_title": "string",
- "cover": "string",
- "url": "string",
- "type_id": 0,
- "description": "string",
- "cancellation_reason": "string",
- "questionnaire_completed_message": "string"
}| event_id required | integer <int32> >= 1 ID мероприятия |
{- "id": 0,
- "event_id": 0,
- "auto_approve": true,
- "collect_snils": true,
- "collect_phones": true,
- "participant_limit": 1,
- "date_end_request": "2019-08-24T14:15:22Z",
- "date_end_update": "2019-08-24T14:15:22Z",
- "user_age_start": 0,
- "user_age_end": 0,
- "requires_project": true,
- "requires_stepik": true,
- "requires_github": true,
- "requires_yandex": true,
- "requires_kaggle": true,
- "requires_leader": true,
- "requires_vk": true,
- "requires_telegram": true,
- "countries": [
- "string"
], - "regions": [
- "string"
], - "cities": [
- "string"
], - "description": "string"
}Лимиты могут существовать только в единичном кол-ве на мероприятие.
Попытка создать больше будет возвращать 409 ответ.
| event_id required | integer <int32> >= 1 ID мероприятия |
| auto_approve | boolean (EventLimitAutoApprove) Автосогласование заявок. |
| collect_snils | boolean (EventLimitCollectSNILS) Собирать СНИЛС в заявках. |
| collect_phones | boolean (EventLimitCollectPhones) Собирать номера телефонов в заявках. |
| participant_limit | integer or null (EventLimitParticipantLimit) >= 1 Максимальное количество участников. |
| date_end_request | string or null <date-time> (EventLimitDateEndRequest) Крайний срок подачи заявки. |
| date_end_update | string or null <date-time> (EventLimitDateEndUpdate) Крайний срок обновления заявки. |
| user_age_start | integer or null <int32> (EventLimitUserAgeStart) Минимальный возраст участника. Рассчитывается от даты начала мероприятия. |
| user_age_end | integer or null <int32> (EventLimitUserAgeEnd) Максимальный возраст участника. Рассчитывается от даты начала мероприятия. |
| requires_project | boolean (EventLimitRequiresProject) Требуется проект. |
| requires_stepik | boolean (EventLimitRequiresStepik) Требуется учетная запись Stepik. |
| requires_github | boolean (EventLimitRequiresGitHub) Требуется учетная запись GitHub. |
| requires_yandex | boolean (EventLimitRequiresYandex) Требуется учетная запись Yandex. |
| requires_kaggle | boolean (EventLimitRequiresKaggle) Требуется учетная запись Kaggle. |
| requires_leader | boolean (EventLimitRequiresLeader) Требуется учетная запись Leader. |
| requires_vk | boolean (EventLimitRequiresVK) Требуется учетная запись VK. |
| requires_telegram | boolean (EventLimitRequiresTelegram) Требуется учетная запись Telegram. |
| countries | Array of strings (EventLimitCountries) Допускаемые к регистрации страны. |
| regions | Array of strings (EventLimitRegions) Допускаемые к регистрации регионы. |
| cities | Array of strings (EventLimitCities) Допускаемые к регистрации города. |
| description | string (EventLimitDescription) Текстовое описание ограничений по регистрации. |
{- "auto_approve": true,
- "collect_snils": true,
- "collect_phones": true,
- "participant_limit": 1,
- "date_end_request": "2019-08-24T14:15:22Z",
- "date_end_update": "2019-08-24T14:15:22Z",
- "user_age_start": 0,
- "user_age_end": 0,
- "requires_project": true,
- "requires_stepik": true,
- "requires_github": true,
- "requires_yandex": true,
- "requires_kaggle": true,
- "requires_leader": true,
- "requires_vk": true,
- "requires_telegram": true,
- "countries": [
- "string"
], - "regions": [
- "string"
], - "cities": [
- "string"
], - "description": "string"
}{- "id": 0,
- "event_id": 0,
- "auto_approve": true,
- "collect_snils": true,
- "collect_phones": true,
- "participant_limit": 1,
- "date_end_request": "2019-08-24T14:15:22Z",
- "date_end_update": "2019-08-24T14:15:22Z",
- "user_age_start": 0,
- "user_age_end": 0,
- "requires_project": true,
- "requires_stepik": true,
- "requires_github": true,
- "requires_yandex": true,
- "requires_kaggle": true,
- "requires_leader": true,
- "requires_vk": true,
- "requires_telegram": true,
- "countries": [
- "string"
], - "regions": [
- "string"
], - "cities": [
- "string"
], - "description": "string"
}| event_id required | integer <int32> >= 1 ID мероприятия |
| auto_approve | boolean (EventLimitAutoApprove) Автосогласование заявок. |
| collect_snils | boolean (EventLimitCollectSNILS) Собирать СНИЛС в заявках. |
| collect_phones | boolean (EventLimitCollectPhones) Собирать номера телефонов в заявках. |
| participant_limit | integer or null (EventLimitParticipantLimit) >= 1 Максимальное количество участников. |
| date_end_request | string or null <date-time> (EventLimitDateEndRequest) Крайний срок подачи заявки. |
| date_end_update | string or null <date-time> (EventLimitDateEndUpdate) Крайний срок обновления заявки. |
| user_age_start | integer or null <int32> (EventLimitUserAgeStart) Минимальный возраст участника. Рассчитывается от даты начала мероприятия. |
| user_age_end | integer or null <int32> (EventLimitUserAgeEnd) Максимальный возраст участника. Рассчитывается от даты начала мероприятия. |
| requires_project | boolean (EventLimitRequiresProject) Требуется проект. |
| requires_stepik | boolean (EventLimitRequiresStepik) Требуется учетная запись Stepik. |
| requires_github | boolean (EventLimitRequiresGitHub) Требуется учетная запись GitHub. |
| requires_yandex | boolean (EventLimitRequiresYandex) Требуется учетная запись Yandex. |
| requires_kaggle | boolean (EventLimitRequiresKaggle) Требуется учетная запись Kaggle. |
| requires_leader | boolean (EventLimitRequiresLeader) Требуется учетная запись Leader. |
| requires_vk | boolean (EventLimitRequiresVK) Требуется учетная запись VK. |
| requires_telegram | boolean (EventLimitRequiresTelegram) Требуется учетная запись Telegram. |
| countries | Array of strings (EventLimitCountries) Допускаемые к регистрации страны. |
| regions | Array of strings (EventLimitRegions) Допускаемые к регистрации регионы. |
| cities | Array of strings (EventLimitCities) Допускаемые к регистрации города. |
| description | string (EventLimitDescription) Текстовое описание ограничений по регистрации. |
{- "auto_approve": true,
- "collect_snils": true,
- "collect_phones": true,
- "participant_limit": 1,
- "date_end_request": "2019-08-24T14:15:22Z",
- "date_end_update": "2019-08-24T14:15:22Z",
- "user_age_start": 0,
- "user_age_end": 0,
- "requires_project": true,
- "requires_stepik": true,
- "requires_github": true,
- "requires_yandex": true,
- "requires_kaggle": true,
- "requires_leader": true,
- "requires_vk": true,
- "requires_telegram": true,
- "countries": [
- "string"
], - "regions": [
- "string"
], - "cities": [
- "string"
], - "description": "string"
}{- "id": 0,
- "event_id": 0,
- "auto_approve": true,
- "collect_snils": true,
- "collect_phones": true,
- "participant_limit": 1,
- "date_end_request": "2019-08-24T14:15:22Z",
- "date_end_update": "2019-08-24T14:15:22Z",
- "user_age_start": 0,
- "user_age_end": 0,
- "requires_project": true,
- "requires_stepik": true,
- "requires_github": true,
- "requires_yandex": true,
- "requires_kaggle": true,
- "requires_leader": true,
- "requires_vk": true,
- "requires_telegram": true,
- "countries": [
- "string"
], - "regions": [
- "string"
], - "cities": [
- "string"
], - "description": "string"
}| event_id required | integer <int32> >= 1 ID мероприятия |
{- "qstatus": "pending",
- "event_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "before_start": {
- "microseconds": 0,
- "days": 0,
- "months": 0
}, - "receivers_cnt": 0,
- "started_at": "2019-08-24T14:15:22Z",
- "finished_at": "2019-08-24T14:15:22Z",
- "template": 0,
- "message": "string"
}| event_id required | integer <int32> >= 1 ID мероприятия |
required | object (EventDeferredNotificationBeforeStart) Интервал до начала мероприятия. Вычисляемая дата является границей, до которой не отправляются уведомления. |
| template | integer <int16> (EventDeferredNotificationTemplateID) Идентификатор шаблона отложенного уведомления. |
| message required | string |
{- "before_start": {
- "microseconds": 0,
- "days": 0,
- "months": 0
}, - "template": 0,
- "message": "string"
}{- "qstatus": "pending",
- "event_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "before_start": {
- "microseconds": 0,
- "days": 0,
- "months": 0
}, - "receivers_cnt": 0,
- "started_at": "2019-08-24T14:15:22Z",
- "finished_at": "2019-08-24T14:15:22Z",
- "template": 0,
- "message": "string"
}Если уведомление уже существует и оно находится в статусе canceled,
оно будет переведено в статус pending.
| event_id required | integer <int32> >= 1 ID мероприятия |
object (EventDeferredNotificationBeforeStart) Интервал до начала мероприятия. Вычисляемая дата является границей, до которой не отправляются уведомления. | |
| template | integer <int16> (EventDeferredNotificationTemplateID) Идентификатор шаблона отложенного уведомления. |
| message | string |
{- "before_start": {
- "microseconds": 0,
- "days": 0,
- "months": 0
}, - "template": 0,
- "message": "string"
}{- "qstatus": "pending",
- "event_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "before_start": {
- "microseconds": 0,
- "days": 0,
- "months": 0
}, - "receivers_cnt": 0,
- "started_at": "2019-08-24T14:15:22Z",
- "finished_at": "2019-08-24T14:15:22Z",
- "template": 0,
- "message": "string"
}Перевод уведомления из статуса pending в статус canceled.
Если уведомление в статусе pending не найдено, будет возвращен 404 ответ.
| event_id required | integer <int32> >= 1 ID мероприятия |
{- "qstatus": "pending",
- "event_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "before_start": {
- "microseconds": 0,
- "days": 0,
- "months": 0
}, - "receivers_cnt": 0,
- "started_at": "2019-08-24T14:15:22Z",
- "finished_at": "2019-08-24T14:15:22Z",
- "template": 0,
- "message": "string"
}| id_offset | integer <int32> Пропуск объектов с идентификатором равном или менее указанного. |
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. |
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. |
| event_ids | Array of integers <int32> [ items <int32 > ] ID мероприятий, записывается в формате |
[- {
- "event_diploma_settings": {
- "event_id": 0,
- "diplomas_dark_theme": true,
- "template": "diploma",
- "diploma_issue_mode": "all"
}, - "role_ids": [
- 0
]
}
]| event_id required | integer <int32> >= 1 ID мероприятия |
{- "event_diploma_settings": {
- "event_id": 0,
- "diplomas_dark_theme": true,
- "template": "diploma",
- "diploma_issue_mode": "all"
}, - "role_ids": [
- 0
]
}| event_id required | integer <int32> >= 1 ID мероприятия |
| diplomas_dark_theme | boolean Default: false Включить тёмную тему для дипломов | ||||||||
| background required | string <uri> Фон для дипломов | ||||||||
| template | string (DiplomaTemplate)
| ||||||||
| diploma_issue_mode | string (DiplomaIssueMode)
Для кого предусмотрена выдача дипломов |
{- "diplomas_dark_theme": false,
- "template": "diploma",
- "diploma_issue_mode": "all"
}{- "event_id": 0,
- "diplomas_dark_theme": true,
- "template": "diploma",
- "diploma_issue_mode": "all"
}| event_id required | integer <int32> >= 1 ID мероприятия |
| diplomas_dark_theme | boolean Включить тёмную тему для дипломов | ||||||||
| background | string <uri> Фон для дипломов | ||||||||
| template | string (DiplomaTemplate)
| ||||||||
| diploma_issue_mode | string (DiplomaIssueMode)
Для кого предусмотрена выдача дипломов |
{- "diplomas_dark_theme": true,
- "template": "diploma",
- "diploma_issue_mode": "all"
}{- "event_id": 0,
- "diplomas_dark_theme": true,
- "template": "diploma",
- "diploma_issue_mode": "all"
}| organization_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов организаций. |
| parent_organization_id | integer <int32> >= 1 ID родительской организации. |
| id_offset | integer <int32> Пропуск объектов с идентификатором равном или менее указанного. |
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. |
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. |
| order_by | string Default: "id_asc" Enum: "id_asc" "id_desc" Критерий сортировки результатов. |
[- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_permitted": true,
- "legal_entity_id": 0,
- "parent_organization_id": 0,
- "educational_category": ""
}
]| organization_id required | integer <int32> >= 1 ID организации. |
| is_owner | boolean Требование наличия или отсутствия статуса владельца организации. При указании значения, роль пользователя должна ему соответствовать;
это значит что если указать |
{- "error": "string"
}| id_offset | integer <int32> Пропуск объектов с идентификатором равном или менее указанного. |
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. |
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. |
| organization_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов организаций. |
| subject_id | Array of integers <int32> [ items <int32 > >= 1 ] Фильтр по массиву идентификаторов тематик. |
[- {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "organization_id": 0,
- "subject_id": 0
}
]Запрос необходимо выполнять от ментора или владельца организации, указываемой в свойстве
organization_idтела запроса.
| organization_id required | integer <int32> |
| subject_id required | integer <int32> ID тематики |
{- "organization_id": 0,
- "subject_id": 0
}{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "organization_id": 0,
- "subject_id": 0
}| id_offset | integer <int32> Пропуск объектов с идентификатором равном или менее указанного. |
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. |
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. |
[- {
- "id": 0,
- "title": "string"
}
]| partial_token | string <uuid> |
| utm | string |
| consents | Array of strings (UserConsentKind) Items Enum: "personal_data_processing" "terms_of_service" |
| password | string |
string <email> (Email) | |
| last_name | string (Фамилия) |
| first_name | string (Имя) |
| middle_name | string (Отчество) |
| no_middle_name | boolean (Нет отчества) |
| birthday | string <date> (Дата рождения) |
| address | string (Адрес) |
| sex | string (UserSex) Enum: "m" "w" |
| grade | integer <int8> (Класс) |
| snils | string (СНИЛС) |
| adult_confirm | integer <int32> (Подтверждение родителей) |
| redirect_uri | string (URI перенаправления) <= 1000 characters |
| phone | string (Номер телефона) |
| session_token | string (Токен подтверждения телефона) |
{- "consents": [
- "personal_data_processing"
], - "password": "string",
- "email": "user@example.com",
- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "no_middle_name": true,
- "birthday": "2019-08-24",
- "address": "string",
- "sex": "m",
- "grade": 0,
- "snils": "string",
- "adult_confirm": 0,
- "redirect_uri": "string",
- "phone": "string",
- "session_token": "string"
}{- "id": 0,
- "expires_in": 0,
- "reg_token": "string"
}Операция еще не доступна
| last_name | string (Фамилия) |
| first_name | string (Имя) |
| middle_name | string (Отчество) |
| no_middle_name | boolean (Нет отчества) |
| birthday | string <date> (Дата рождения) |
| address | string (Адрес) |
| sex | string (UserSex) Enum: "m" "w" |
| grade | integer <int8> (Класс) |
| snils | string (СНИЛС) |
| phone | string (Номер телефона) |
| session_token | string (Токен подтверждения телефона) |
| about | string |
| status_text | string |
| public_page_enabled | boolean |
| first_grade_year | integer <int16> |
| current_education | integer <int32> |
{- "last_name": "string",
- "first_name": "string",
- "middle_name": "string",
- "no_middle_name": true,
- "birthday": "2019-08-24",
- "address": "string",
- "sex": "m",
- "grade": 0,
- "snils": "string",
- "phone": "string",
- "session_token": "string",
- "about": "string",
- "status_text": "string",
- "public_page_enabled": true,
- "first_grade_year": 0,
- "current_education": 0
}{- "error": "string"
}Параметр user_id в запросе должен содержать идентификатор аутентифицированного пользователя.
| user_id required | integer <int32> >= 1 ID пользователя |
| kind required | string (UserConsentKind) Enum: "personal_data_processing" "terms_of_service" |
{- "error": "string"
}Часть данных возвращается только при наличии аутентификации и определенных прав у пользователя, от лица которого выполняется запрос.
| team_id required | integer <int32> ID команды. |
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "assignment_participation": true,
- "created_by_assignment": true,
- "event_id": 0,
- "project_id": 0,
- "owner_id": 0,
- "contact_link": "string",
- "invite_code": "string"
}Доступно только для капитана команды и организатора мероприятия.
| team_id required | integer <int32> ID команды. |
| title | string <= 255 characters |
| description | string <= 2000 characters |
| assignment_participation | boolean Команда участвует в автораспределении. |
| project_id | integer <int32> ID проекта команды.
|
| contact_link | string <uri> (TeamContactLink) Контактная ссылка. |
{- "title": "string",
- "description": "string",
- "assignment_participation": true,
- "project_id": 0,
}{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "assignment_participation": true,
- "created_by_assignment": true,
- "event_id": 0,
- "project_id": 0,
- "owner_id": 0,
- "contact_link": "string",
- "invite_code": "string"
}| id required | integer <int32> ID команды. |
| created_at required | string <date-time> Дата создания. |
| updated_at required | string <date-time> Дата обновления. |
| title required | string Название команды. |
| description required | string Описание команды. |
| assignment_participation required | boolean Команда участвует в автораспределении. |
| created_by_assignment required | boolean Команда создана автораспределением. |
| event_id required | integer <int32> ID мероприятия команды. |
| project_id required | integer <int32> ID проекта команды. |
| owner_id | integer <int32> TalentID капитана команды.
|
| contact_link | string Контактная ссылка команды.
|
| invite_code | string Код для вступления в команду.
|
{- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string",
- "description": "string",
- "assignment_participation": true,
- "created_by_assignment": true,
- "event_id": 0,
- "project_id": 0,
- "owner_id": 0,
- "contact_link": "string",
- "invite_code": "string"
}Файлы пользователей могут быть как приватными так и публичными. Публичные файлы доступны всем, в том числе и без аутентификации. Запрос к приватному файлу может осуществляться только от его владельца. Так же как и запросы на какое либо изменение файла.
Файлы могут быть загружены в хранилище и привязаны к объектам любого сервиса. Как загрузить файл:
Допустимый размер одного файла ограничен 10 мегабайтами. При его превышении возвращается 413 ответ.
Помимо этого, 413 ответ будет возвращен и когда достигается лимит суммы размера файлов пользователя.
Допускается запрос без аутентификации при соблюдении условий:
file_idis_public отсутствует либо содержит trueПри несоблюдении какого-либо из условий, возвращается 401 ответ.
| file_id | Array of strings <uuid> <= 30 items [ items <uuid > ] Чтение метаинформации конкретных файлов. Значения указываются через запятую. |
| is_public | boolean Статус публичности файла. |
| namespace | string Пространство имен для объекта, где используется файл, в формате <сервис>/<таблица БД>/<поле со ссылкой на файл> (например, polls/questions/picture, venues/venue/cover, etc.) |
| namespace_startswith | string >= 3 characters Фильтрация по префиксной подстроке в пространстве имен. |
| name_like | string >= 3 characters Фильтрация по подстроке в имени файла. |
| ext | string Фильтрация по точному совпадению расширения. |
| offset | integer <int32> [ 0 .. 200 ] Default: 0 Кол-во объектов выборки для пропуска. |
| limit | integer <int32> [ 1 .. 200 ] Default: 100 Максимум объектов возвращаемых в теле ответа. |
| order_by | string Default: "created_at_desc" Enum: "created_at_asc" "created_at_desc" "uploaded_at_asc" "uploaded_at_desc" "file_id" Поле, по которому будет отсортирован список файлов. |
[- {
- "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
- "name": "string",
- "content_type": "string",
- "content_length": 1,
- "extension": "string",
- "is_public": true,
- "namespace": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "uploaded_at": "2019-08-24T14:15:22Z",
- "version": 0
}
]| namespace required | string Пространство имен для объекта, где используется файл, в формате <сервис>/<таблица БД>/<поле со ссылкой на файл> (например, polls/questions/picture, venues/venue/cover, etc.) |
| is_public | boolean Default: false Статус публичности файла. |
| extension | string [ 2 .. 10 ] characters ^\.[a-zA-Z0-9]+$ Расширение файла (например, .jpg, .png, .pdf, etc.) |
| content_type required | string MIME-тип файла. |
| content_length required | integer <int32> (ContentLength) >= 1 Размер файла в байтах. |
| name | string (FileMetaName) <= 200 characters Опциональное название файла. |
{- "namespace": "string",
- "is_public": false,
- "extension": "string",
- "content_type": "string",
- "content_length": 1,
- "name": "string"
}{- "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
- "name": "string",
- "content_type": "string",
- "content_length": 1,
- "extension": "string",
- "is_public": true,
- "namespace": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "uploaded_at": "2019-08-24T14:15:22Z",
- "version": 0,
- "method": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}
}По-умолчанию возвращается в форме 307 ответа.
С параметром noredir=true возвращается 200.
Чтение приватного файла требует прохождение авторизации. Аутентифицированный пользователь должен быть владельцем файла.
| file_id required | string <uuid> ID файла |
| noredir | boolean |
Позволяет повторно получить ссылку на загрузку того же файла или сформировать ссылку для загрузки новой версии файла (того же типа, но другого размера).
| file_id required | string <uuid> ID файла |
| content_length required | integer <int32> (ContentLength) >= 1 Размер файла в байтах. |
{- "content_length": 1
}{- "method": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}
}Чтение приватного файла требует прохождение авторизации. Аутентифицированный пользователь должен быть владельцем файла.
| file_id required | string <uuid> ID файла. |
{- "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
- "name": "string",
- "content_type": "string",
- "content_length": 1,
- "extension": "string",
- "is_public": true,
- "namespace": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "uploaded_at": "2019-08-24T14:15:22Z",
- "version": 0
}| file_id required | string <uuid> ID файла. |
| name | string (FileMetaName) <= 200 characters Опциональное название файла. |
{- "name": "string"
}{- "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
- "name": "string",
- "content_type": "string",
- "content_length": 1,
- "extension": "string",
- "is_public": true,
- "namespace": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "uploaded_at": "2019-08-24T14:15:22Z",
- "version": 0
}| file_id required | string <uuid> ID файла. |
{- "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
- "name": "string",
- "content_type": "string",
- "content_length": 1,
- "extension": "string",
- "is_public": true,
- "namespace": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "uploaded_at": "2019-08-24T14:15:22Z",
- "version": 0
}| file_id required | string <uuid> ID файла |
| object_id required | string <= 36 characters ID связанного объекта |
{- "object_id": "string",
- "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
- "created_at": "2019-08-24T14:15:22Z"
}После загрузки, файл может быть заблокирован от изменений. Каждая блокировка относится к какому-то объекту в системе, для которого файл становится зависимостью. Таких объектов-блокировок на файл может быть назначено несколько. И пока есть хотя бы одна активная блокировка, файл изменить нельзя.
Блокировка может быть снята только системой, ответственной за объект, на который ссылается блок. Для представления этой ссылки, блок имеет два свойства:
object_key - символьное представление ключа зависимого объекта;object_namespace - пространство имен ключа, определяющее тип сущности, которую ключ идентифицирует.Блокировки создаются только для файлов, принадлежащих пользователю.
Чужие файлы, несуществующие файлы, а так же файлы,
для которых блокировки уже имеются,
будут пропущены и не возвращены в теле 201 ответа.
| object_namespace required | string [ 5 .. 50 ] characters Имя пространства имен, к которому относится зависимый объект |
| object_key required | string [ 1 .. 36 ] characters Ключ объекта зависящего от блокируемых файлов |
Идентификатор файла
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
][- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Изначально блокировка создается в состоянии активной. После создания, состояние можно декактивировать и активировать обратно.
Неактивная блокировка равнозначна ее отсутствию.
| object_namespace required | string [ 5 .. 50 ] characters Имя пространства имен, к которому относится зависимый объект |
| object_key required | string [ 1 .. 36 ] characters Ключ объекта зависящего от блокируемых файлов |
| active required | boolean |
{- "active": true
}{- "active": true
}| object_namespace required | string [ 5 .. 50 ] characters Имя пространства имен, к которому относится зависимый объект |
| object_key required | string [ 1 .. 36 ] characters Ключ объекта зависящего от блокируемых файлов |
{- "error": "string"
}