ExtendedSignerDetails (V2)
Заполняет или возвращает дополнительные данные подписанта.
Метод ExtendedSignerDetails
можно использовать двумя способами:
POST-запрос — для ручного заполнения дополнительных данных о подписанте,
GET-запрос — для получения дополнительных данных о подписанте.
Заполнение данных
Дополнительные данные подписанта могут быть заполнены:
Автоматически — для документов, перечисленных в поле
ExtendedDocumentTitleType
структуры SignerInfoV2, Диадок заполнит данные подписанта на основе информации из сертификата и реквизитов организации, если были указаныBoxId
иCertificate/CertificateThumbprint
. Если в Диадоке нет дополнительных данных, необходимых для подписания, то возникнет ошибка.Вручную — с помощью метода
ExtendedSignerDetails
.
- POST /V2/ExtendedSignerDetails
- Query Parameters:
boxId – идентификатор ящика организации, для которого нужно заполнить дополнительные данные подписанта.
thumbprint – отпечаток сертификата, для которого нужно заполнить дополнительные данные подписанта.
documentTitleType – тип титула, для которого нужно заполнить дополнительные данные подписанта. Принимает значения из перечисления DocumentTitleType.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Request Body:
Тело запроса должно содержать информацию для заполнения дополнительных данных подписанта, представленную структурой ExtendedSignerDetailsToPost.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorization
или в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит данные подписанта, представленные структурой ExtendedSignerDetails.
Получение данных
- GET /V2/ExtendedSignerDetails
- Query Parameters:
boxId – идентификатор ящика организации, для которого нужно заполнить дополнительные данные подписанта.
thumbprint – отпечаток сертификата, для которого нужно заполнить дополнительные данные подписанта.
documentTitleType – тип титула, для которого нужно заполнить дополнительные данные подписанта. Принимает значения из перечисления DocumentTitleType.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorization
или в этом заголовке содержатся некорректные авторизационные данные.403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
404 Not Found – не найдены данные подписанта по указанным параметрам.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит данные подписанта, представленные структурой ExtendedSignerDetails.
Примеры использования
POST-запрос
Пример HTTP-запроса:
POST /V2/ExtendedSignerDetails?boxId={{boxId}}&thumbprint=ee67...fa1e1&documentTitleType=UtdSeller HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела запроса:
{
"JobTitle": "Сотрудник",
"SignerType": "PhysicalPerson",
"SignerInfo": "Additional",
"SignerPowers": "PersonMadeOperation",
"SignerStatus": "SellerEmployee"
}
Пример тела ответа:
{
"Surname": "Иванов",
"FirstName": "Иван",
"Patronymic": "Иванович",
"JobTitle": "Сотрудник",
"Inn": "930745467108",
"SignerType": "PhysicalPerson",
"SignerInfo": "Additional",
"SignerPowers": "PersonMadeOperation",
"SignerStatus": "SellerEmployee"
}
GET-запрос
Пример HTTP-запроса:
GET /V2/ExtendedSignerDetails?boxId={{boxId}}&thumbprint=ee67...fa1e1&documentTitleType=UtdSeller HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"Surname": "Иванов",
"FirstName": "Иван",
"Patronymic": "Иванович",
"JobTitle": "Сотрудник",
"Inn": "930745467108",
"SignerType": "PhysicalPerson",
"SignerInfo": "Additional",
"SignerPowers": "PersonMadeOperation",
"SignerStatus": "SellerEmployee"
}
См. также
- Инструкции:
- Устаревшие версии метода: