DocflowStatus

Совет

Эта структура относится к устаревшей версии Docflow API. Мы рекомендуем использовать последнюю версию Docflow API — V3. В нее включена аналогичная структура DocflowStatusV3.

message DocflowStatus
{
    optional DocflowStatusModel PrimaryStatus = 1;
    optional DocflowStatusModel SecondaryStatus = 2;
}

Структура содержит информацию о статусе документооборота. В нее входит человекочитаемый текст статуса, предназначенный для вывода пользователю.

Статус формируется с точки зрения пользователя, от имени которого был сделан запрос на получение этой информации.

Примечание

Не используйте эту структуру для построения логики обработки документов в своих интеграционных решениях. Тексты статусов пополняются новыми значениями и могут меняться. Для оценки состояния документооборота используйте поля структуры Docflow.

  • PrimaryStatus — основная часть статуса.

    Примеры текстов основной части статуса: «Документооборот завершен», «Ожидается основная подпись. Ожидается извещение о получении», «Подписан. Требуется подписать извещение о получении».

  • SecondaryStatus — второстепенная часть статуса, предназначенная для дополнительной информации.

    Примеры текстов второстепенной части статусов: «Аннулирование одобрено», «На согласовании», «Отказано в запросе подписи».

Использование

Эта структура используется в структуре Docflow.