GetDocumentTypes (V2)
Для этого метода существует новая версия — GetDocumentTypes (V3). В интеграционных решениях рекомендуем использовать именно ее.
Различия версий метода GetDocumentTypes
| Версия | Особенности |
|---|---|
| V3 | Возвращает структуру DocumentTypeDescriptionV3 с датой перехода на универсальные сообщения |
| V2 | Возвращает структуру DocumentTypeDescriptionV2 |
Возвращает список типов документов, доступных в ящике.
GET /V2/GetDocumentTypes
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит структуру GetDocumentTypesResponseV2 с описанием типов документов:
message GetDocumentTypesResponseV2 {
repeated DocumentTypeDescriptionV2 DocumentTypes = 1;
}
DocumentTypes— список типов документов, представленных структурой DocumentTypeDescriptionV2.
Инструкция о получении данных из метода GetDocumentTypes приведена на странице Получение информации о типе документа.
Примеры использования
Пример HTTP-запроса:
GET /V2/GetDocumentTypes?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
Так как количество типов документов в Диадоке большое, ниже приведена только часть ответа, описывающая УПД формата приказа №970 с функцией СЧФ.
{
"DocumentTypes": [
{
"Functions": [
{
"Name": "СЧФ",
"Versions": [
{
"IsActual": true,
"SupportsAmendmentRequest": true,
"SupportsContentPatching": true,
"SupportsEncrypting": true,
"SupportsPredefinedRecipientTitle": false,
"Titles": [
{
"EncryptedMetadataItems": [],
"Index": 0,
"IsFormal": true,
"MetadataItems": [],
"SignerInfo": {
"ExtendedDocumentTitleType": 12,
"SignerType": 3,
"SignerUserDataXsdUrl": "/GetContent?typeNamedId=UniversalTransferDocument&function=СЧФ&version=utd970_05_03_01&titleIndex=0&contentType=SignerUserContractXsd"
},
"UserDataXsdUrl": "/GetContent?typeNamedId=UniversalTransferDocument&function=СЧФ&version=utd970_05_03_01&titleIndex=0&contentType=UserContractXsd",
"XsdUrl": "/GetContent?typeNamedId=UniversalTransferDocument&function=СЧФ&version=utd970_05_03_01&titleIndex=0&contentType=TitleXsd"
}
],
"Version": "utd970_05_03_01",
"workflows": [
{
"Id": 17,
"IsDefault": true
},
{
"Id": 10,
"IsDefault": false
}
]
}
]
}
],
"UniversalMessagesStartDate": "04/01/2026 00:00:00"
},
{
"Name": "UniversalTransferDocument",
"RequiresFnsRegistration": true,
"SupportedDocflows": [
0
],
"Title": "УПД"
}
]
}
См. также
Инструкции:
Методы для работы с документами:
- Delete — отмечает указанный документ как удаленный
- GetContent — возвращает XSD-схему документа
- GetDocument (V3) — возвращает данные документа по указанному идентификатору
- GetDocumentActions — возвращает список действий, доступных текущему пользователю для указанного документа, шаблона или черновика
- GetDocumentHistory — возвращает историю событий по указанному документу, шаблону или черновику
- GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
- GetDocuments (V4) — возвращает список документов, соответствующих заданным параметрам
- GetDocumentsByMessageId — возвращает список документов из указанного сообщения
- GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
- GetDocumentTypes (V3) — возвращает список типов документов, доступных в ящике, и дату перехода на универсальные сообщения
- MoveDocuments — перемещает документы в указанное подразделение организации
- Restore — восстанавливает документ из удаленных