Перейти к основному содержимому

Status

Статус обработки документа в рамках внешнего документооборота.

message Status {
required string NamedId = 1;
required string FriendlyName = 2;
required OuterStatusType Type = 3;
optional string Description = 4;
repeated StatusDetail Details = 5;
optional string EntityId = 6;
}

enum OuterStatusType {
UnknownStatus = 0;
Normal = 1;
Success = 2;
Warning = 3;
Error = 4;
}

message StatusDetail {
optional string Code = 1;
optional string Text = 2;
}
  • NamedId — идентификатор статуса.
  • FriendlyName — название статуса, которое используется для отображения в веб-интерфейсе.
  • Type — тип статуса, принимает значения из перечисления OuterStatusType:
    • UnknownStatus — неизвестное значение: клиент использует устаревшую версию SDK и не может интерпретировать ответ;
    • Normal — нормальный: присваивается промежуточным статусам, которые не требуют внимания пользователя, например, «Обрабатывается в ГИС МТ "Честный ЗНАК»;
    • Success — успешный статус: соответствует успешному завершению обработки документа;
    • Warning — предупреждение: присваивается промежуточным статусам, на которые нужно обратить внимание пользователя;
    • Error — ошибка: в процессе внешнего документооборота возникла ошибка.
  • Description — дополнительное описание статуса.
  • Details — детализация по статусу — список ошибок, которые были получены при взаимодействии с внешним сервисом в рамках документооборота. Каждый элемент списка представлен структурой StatusDetail с полями:
    • Code — код ошибки.
    • Text — текст ошибки.
  • EntityId — идентификатор сущности, в которой получен статус. Это та же сущность, что в поле Attachment структуры StatusEntity. С полем LatestStatusEntityId структуры OuterDocflowV5 совпадает только идентификатор последнего статуса.

См. также

Структура используется:

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года