PowerOfAttorneyValidationStatus

На этой странице, помимо PowerOfAttorneyValidationStatus, описаны следующие структуры:

Статус проверки машиночитаемой доверенности (МЧД).

О том, какие проверки МЧД выполняет Диадок, написано в разделе Предварительная проверка МЧД.

Проверки МЧД выполняются:

  • асинхронно — при отправке документа, подписанного с МЧД; результат проверки будет доступен в полях структуры после ее завершения;

  • синхронно — при вызове метода PrevalidatePowerOfAttorney (V2).

message PowerOfAttorneyValidationStatus {
    required Severity Severity = 1;
    required PowerOfAttorneyValidationStatusNamedId StatusNamedId = 2;
    optional string StatusText = 3;
    repeated PowerOfAttorneyValidationError Errors = 4 [deprecated = true];
    optional ValidationProtocol ValidationProtocol = 5;
    optional PowerOfAttorneyValidationError OperationError = 6;
}

enum PowerOfAttorneyValidationStatusNamedId {
    UnknownStatus = 0;
    CanNotBeValidated = 1;
    IsValid = 2;
    IsNotValid = 3;
    ValidationError = 4;
    IsNotAttached = 5;
    HasWarnings = 6;
}

  • Severity — критичность статуса, принимает значение из перечисления Severity.

  • StatusNamedId — текстовый идентификатор статуса, принимает значение из перечисления PowerOfAttorneyValidationStatusNamedId:

    • UnknownStatus — зарезервированное значение.

    • CanNotBeValidated — не удалось передать МЧД на валидацию. Ошибка может возникнуть в случае, когда файл МЧД некорректный или из него не удалось получить необходимые данные для проверки — данные доверенности, доверителя, представителя из подписи и т.п.

    • IsValid — все проверки выполнены без ошибок, протокол валидации доступен в поле ValidationProtocol.

    • IsNotValid — среди МЧД есть хотя бы одна невалидная, протокол валидации доступен в поле ValidationProtocol.

    • ValidationError — МЧД была передана на валидацию, но во время выполнения проверок произошла внутренняя ошибка.

    • IsNotAttached — МЧД не приложена к подписи, возвращается только для общего (сводного) статуса МЧД.

    • HasWarnings — часть проверок не может быть выполнена или была выполнена с предупреждениями, протокол валидации доступен в поле ValidationProtocol.

  • StatusText — удобочитаемый текст статуса.

  • Errors — поле устарело, используйте значения полей ValidationProtocol и OperationError.

  • ValidationProtocol — протокол валидации с результатами выполнения проверок, представленный структурой ValidationProtocol. Возвращается в случае, когда StatusNamedId принимает значение:

    • IsValid,

    • IsNotValid,

    • HasWarnings.

  • OperationError — описание ошибки, произошедшей в процессе выполнения операции, представленное структурой PowerOfAttorneyValidationError. Возвращается в случае, если StatusNamedId принимает значение ValidationError или CanNotBeValidated.

ValidationProtocol

Данные протокола валидации с результатами выполнения проверок машиночитаемой доверенности (МЧД).

message ValidationProtocol {
    repeated ValidationCheckResult CheckResults = 1;
}

message ValidationCheckResult {
    optional PowerOfAttorneyValidationCheckStatus Status = 1;
    required string Name = 2;
    optional PowerOfAttorneyValidationError Error = 3;
}

enum PowerOfAttorneyValidationCheckStatus {
    UnknownCheckStatus = 0;
    Ok = 1;
    Warning = 2;
    Error = 3;
}

  • CheckResults — результат проверки МЧД, представленный структурой ValidationCheckResult с полями:

    • Status — результат выполнения проверки, принимает значение из перечисления PowerOfAttorneyValidationCheckStatus:

      • UnknownCheckStatus — значение по умолчанию;

      • Ok — проверка успешно пройдена;

      • Warning — есть предупреждение;

      • Error — есть ошибка.

    • Name — текстовый идентификатор проверки.

    • Error — информация об ошибке или предупреждении, представленная структурой PowerOfAttorneyValidationError.

PowerOfAttorneyValidationError

Информация об ошибке, произошедшей при выполнении проверки машиночитаемой доверенности (МЧД).

message PowerOfAttorneyValidationError {
    required string Code = 1;
    required string Text = 2;
}

  • Code — код ошибки.

  • Text — текст ошибки.

См. также

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