Получение списка приглашений агента

Метод API предназначен для получения списка приглашений агента.

Для вызова метода передать X-Login и X-Password в Headers запроса.

Для более точного поиска приглашений, можно использовать квери параметры.

GET https://business.selfwork.ru/selfemployed/business/v1/legal/get-invitations

Query Parameters

Name	Type	Description
createdFrom	string	Дата начала выборки по дате создания, в формате: yyyy-MM-dd
createdTo	string	Дата окончания выборки по дате создания, в формате: yyyy-MM-dd
invitationId	integer	Идентификатор приглашения
page	int32	Номер страницы
pageSize	int32	Размер страницы
state	int32	Статус
updatedAtFrom	string	Дата начала выборки по дате последнего обновления, в формате: yyyy-MM-dd
updatedAtTo	string	Дата окончания выборки по дате последнего обновления, в формате: yyyy-MM-dd

Headers

Name	Type	Description
X-Login*	string	Логин пользователя
X-Password*	string	Пароль пользователя

200: OK Запрос выполнен успешно

[
  {
    "invitationId": 10,
    "invitationScenarioId": 10,
    "phone": "[phone]",
    "state": 3,
    "meta": "some text here",
    "created": "2022-01-22 00:00:00+7",
    "updatedAt": "2022-01-22 00:00:00+7",
    "individualId": 15
  }
]

401: Unauthorized Не валидные авторизационные данные

{
  "errorCode": 1,
  "message": "Access denied"
}

500: Internal Server Error Системная ошибка

{
  "errorCode": 100,
  "message": "Internal server error"
}

Справочник параметра status

Статус	Описание
0	Новый
1	Приглашение отправлено
2	Подключение к компании
3	Заполняется анкета
4	Проверка ПД (идетификация)
5	Ошибка проверки ПД
6	Ожидание подписания договора
7	Ожидание подписи компании
8	Готово,
9	Отменено

Ответ - успешное выполнение метода

Ключ	Описание
invitationId	Идентификатор приглашения в базе данных
invitationScenarioId	Идентификатор сценария в базе данных
phone	Номер телефона
state	Статусы приглашения
meta	Мета-информация
created	Дата и время создания
updatedAt	Дата и время обновления
individualId	Идентификатор самозанятого

Ответ - Системная ошибка

Ключ	Описание
errorCode	Код ошибки вернувшаяся с сервера
message	Сообщение сервера описывающая ошибку