ApprovalRoutes API

Группа методов для работы с маршрутами согласования.

Описание методов

Данный блок содержит подробное описание по каждому методу API.

---

[GET]/api/v3/approvalRoutes

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

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Идентификатор абонента
offset	Нет	Query	integer(int32)	Количество пропускаемых элементов
count	Нет	Query	integer(int32)	Количество получаемых элементов

Возможные ответы метода

Код	Тип	Описание
200	ApprovalRouteResultList	Список маршрутов согласования.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "name": "Строка",
      "isEnabled": true
    }
  ]
}

---

[GET]/api/v3/approvalRoutes/{approvalRouteId}

Получить подробную информацию о маршруте согласования

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Идентификатор абонента
approvalRouteId	Да	Path	string(uuid)	Идентификатор маршрута согласования

Возможные ответы метода

Код	Тип	Описание
200	ApprovalRouteFull	Информация о маршруте согласования.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "isEnabled": true,
  "steps": [
    {
      "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "stepType": "Signing",
      "executorType": "Department",
      "executorId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "executorName": "Строка"
    }
  ]
}

---

Описание дополнительных моделей

Данный блок содержит описание дополнительных моделей.

---

ApprovalRoute

Информация о маршруте согласования

Название	Обязат.	Тип	Описание
id	Нет	string(uuid)	Идентификатор маршрута согласования
name	Нет	string	Название маршрута согласования
isEnabled	Нет	boolean	Включен ли маршрут согласования

Пример модели

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "isEnabled": true
}

---

ApprovalRouteFull

Информация о маршруте согласования

Название	Обязат.	Тип	Описание
id	Нет	string(uuid)	Идентификатор маршрута согласования
name	Нет	string	Название маршрута согласования
isEnabled	Нет	boolean	Включен ли маршрут согласования
steps	Нет	ApprovalStepFull[array]	Шаги маршрута согласования

Пример модели

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "isEnabled": true,
  "steps": [
    {
      "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "stepType": "Signing",
      "executorType": "Department",
      "executorId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "executorName": "Строка"
    }
  ]
}

---

ApprovalRouteResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	ApprovalRoute[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "name": "Строка",
      "isEnabled": true
    }
  ]
}

---

ApprovalStepExecutorType

Тип исполнителя шага маршрута согласования

Значение	Описание
Department	Подразделение
Employee	Сотрудник

---

ApprovalStepFull

Информация о шаге согласования

Название	Обязат.	Тип	Описание
id	Нет	string(uuid)	Идентификатор шага маршрута согласования
stepType	Нет	Одна из: ApprovalStepType	Тип шага
executorType	Нет	Одна из: ApprovalStepExecutorType	Тип исполнителя
executorId	Нет	string(uuid)	Идентификатор исполнителя
executorName	Нет	string	Имя исполнителя

Пример модели

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "stepType": "Signing",
  "executorType": "Department",
  "executorId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "executorName": "Строка"
}

---

ApprovalStepType

Тип шага маршрута согласования

Значение	Описание
Approving	Согласование
Signing	Подписание