1.19 Отримати список статусів документів (метод «getDocumentStatuses»)

Метод «getDocumentStatuses», працює в моделі "Common", цей метод дозволяє завантажити список статусів документів. Необхідно зберігати копію довідників на стороні клієнта та підтримувати її в актуальному стані. Рекомендується проводити оновлення довідників раз на місяць.
Доступність: Потребує використання API-ключа.

XML

<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>Ваш ключ АРІ 2.0</apiKey>
<calledMethod>getDocumentStatuses</calledMethod>
<modelName>Common</modelName>
</file>

JSON

{
"modelName": "Common",
"calledMethod": "getDocumentStatuses",
"apiKey": "Ваш ключ АРІ 2.0"
}

Опис відповіді на запити

Параметри Тип Опис
StateId int[36] Ідентифікатор статусу
StateName string[36] Назва статусу
GroupId int[36] Груповий ідентифікатор статусу

Запит на забір одного статусу (у властивостях методу можна передавати фільтр по GroupId, StateId, StateName)

{
"modelName": "Common",
"calledMethod": "getDocumentStatuses",
"apiKey": "Ваш ключ АРІ 2.0",
"methodProperties": {
"StateId": "1"
}
}