DocumentRoutingRules API

Группа методов для работы с маршрутизацией

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

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

[GET]/api/v3/documentRoutingRules

Получение списка правил маршрутизации

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

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

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

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

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

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

[POST]/api/v3/documentRoutingRules

Добавление правила маршрутизации

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

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

Тело запроса

Тип запроса: application/json

Модель для создания правила маршрутизации

Название	Обязат.	Тип	Описание
name	Да	string	Название правила
documentTypes	Нет	string[array]	Типы документов для маршрутизации
counterpartiesIds	Нет	string(uuid)[array]	Список идентификаторов контрагентов для маршрутизации
departmentId	Да	string(uuid)	Идентификатор подразделения

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

{
  "name": "Строка",
  "documentTypes": [
    "Строка"
  ],
  "counterpartiesIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

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

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

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

{
  "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "sequenceNumber": 1
}

[GET]/api/v3/documentRoutingRules/{routingRuleId}

Получение детальной информации о правиле маршрутизации

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

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

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

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

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

{
  "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "sequenceNumber": 1,
  "documentTypes": [
    "Строка"
  ],
  "counterpartiesIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "departmentName": "Строка"
}

[PUT]/api/v3/documentRoutingRules/{routingRuleId}

Редактирование правила маршрутизации

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

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

Тело запроса

Тип запроса: application/json

Модель для редактирования правила маршрутизации

Название	Обязат.	Тип	Описание
name	Да	string	Название правила
documentTypes	Нет	string[array]	Типы документов для маршрутизации
counterpartiesIds	Нет	string(uuid)[array]	Список идентификаторов контрагентов для маршрутизации
departmentId	Да	string(uuid)	Идентификатор подразделения

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

{
  "name": "Строка",
  "documentTypes": [
    "Строка"
  ],
  "counterpartiesIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

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

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

[DELETE]/api/v3/documentRoutingRules/{routingRuleId}

Удаление правила маршрутизации

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

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

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

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

[PUT]/api/v3/documentRoutingRules/updateSequence

Редактирование порядка правил маршрутизации

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

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

Тело запроса

Тип запроса: application/json

Запрос с новым порядком правил Тип контента: SequenceRoutingRules[array]

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

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

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

{
  "count": 1,
  "data": [
    {
      "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "sequenceNumber": 1
    }
  ]
}

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

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

CreateRoutingRuleRequest

Модель создания правила маршрутизации

Название	Обязат.	Тип	Описание
name	Да	string	Название правила
documentTypes	Нет	string[array]	Типы документов для маршрутизации
counterpartiesIds	Нет	string(uuid)[array]	Список идентификаторов контрагентов для маршрутизации
departmentId	Да	string(uuid)	Идентификатор подразделения

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

{
  "name": "Строка",
  "documentTypes": [
    "Строка"
  ],
  "counterpartiesIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

RoutingRuleInfo

Детальная информация о правиле маршрута

Название	Обязат.	Тип	Описание
routingRuleId	Нет	string(uuid)	Идентификатор правила маршрутизации
name	Нет	string	Название правила маршрутизации
sequenceNumber	Нет	integer(int32)	Номер правила маршрутизации
documentTypes	Нет	string[array]	Типы документов в правиле маршрутизации
counterpartiesIds	Нет	string(uuid)[array]	Список контрагентов привязанных к правилу маршрутизации
departmentId	Нет	string(uuid)	Идентификатор подразделения
departmentName	Нет	string	Название подразделения

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

{
  "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "sequenceNumber": 1,
  "documentTypes": [
    "Строка"
  ],
  "counterpartiesIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "departmentName": "Строка"
}

RoutingRuleInfoShort

Краткая информация о правиле маршрута

Название	Обязат.	Тип	Описание
routingRuleId	Нет	string(uuid)	Идентификатор правила маршрутизации
name	Нет	string	Название правила маршрутизации
sequenceNumber	Нет	integer(int32)	Порядковый номер правила маршрутизации

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

{
  "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "sequenceNumber": 1
}

RoutingRuleInfoShortResultList

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

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

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

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

RoutingRuleResult

Результат создания правила маршрутизации

Название	Обязат.	Тип	Описание
routingRuleId	Нет	string(uuid)	Идентификатор правила маршрутизации
sequenceNumber	Нет	integer(int32)	Номер правила

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

{
  "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "sequenceNumber": 1
}

SequenceRoutingRuleResponse

Результат редактирования порядка правил маршрутизации

Название	Обязат.	Тип	Описание
routingRuleId	Нет	string(uuid)	Ид правила маршрутизации
sequenceNumber	Нет	integer(int32)	Порядковый номер правила

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

{
  "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "sequenceNumber": 1
}

SequenceRoutingRuleResponseResultList

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

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

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

{
  "count": 1,
  "data": [
    {
      "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
      "sequenceNumber": 1
    }
  ]
}

SequenceRoutingRules

Новый порядок правила маршрутизации

Название	Обязат.	Тип	Описание
routingRuleId	Да	string(uuid)	Идентификатор правила маршрутизации
sequenceNumber	Да	integer(int32)	Порядковый номер

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

{
  "routingRuleId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "sequenceNumber": 1
}

UpdateRoutingRuleRequest

Модель обновления правила маршрутизации

Название	Обязат.	Тип	Описание
name	Да	string	Название правила
documentTypes	Нет	string[array]	Типы документов для маршрутизации
counterpartiesIds	Нет	string(uuid)[array]	Список идентификаторов контрагентов для маршрутизации
departmentId	Да	string(uuid)	Идентификатор подразделения

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

{
  "name": "Строка",
  "documentTypes": [
    "Строка"
  ],
  "counterpartiesIds": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ],
  "departmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0"
}

DocumentRoutingRules API

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

[GET]/api/v3/documentRoutingRules​

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

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

[POST]/api/v3/documentRoutingRules​

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

Тело запроса​

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

[GET]/api/v3/documentRoutingRules/{routingRuleId}​

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

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

[PUT]/api/v3/documentRoutingRules/{routingRuleId}​

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

Тело запроса​

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

[DELETE]/api/v3/documentRoutingRules/{routingRuleId}​

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

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

[PUT]/api/v3/documentRoutingRules/updateSequence​

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

Тело запроса​

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

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

CreateRoutingRuleRequest​

RoutingRuleInfo​

RoutingRuleInfoShort​

RoutingRuleInfoShortResultList​

RoutingRuleResult​

SequenceRoutingRuleResponse​

SequenceRoutingRuleResponseResultList​

SequenceRoutingRules​

UpdateRoutingRuleRequest​

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

[GET]/api/v3/documentRoutingRules

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

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

[POST]/api/v3/documentRoutingRules

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

Тело запроса

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

[GET]/api/v3/documentRoutingRules/{routingRuleId}

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

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

[PUT]/api/v3/documentRoutingRules/{routingRuleId}

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

Тело запроса

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

[DELETE]/api/v3/documentRoutingRules/{routingRuleId}

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

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

[PUT]/api/v3/documentRoutingRules/updateSequence

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

Тело запроса

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

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

CreateRoutingRuleRequest

RoutingRuleInfo

RoutingRuleInfoShort

RoutingRuleInfoShortResultList

RoutingRuleResult

SequenceRoutingRuleResponse

SequenceRoutingRuleResponseResultList

SequenceRoutingRules

UpdateRoutingRuleRequest