GetDocumentTypes (V2)

Возвращает список типов документов, доступных в ящике.

GET /V2/GetDocumentTypes

Query Parameters:

boxId – идентификатор ящика организации.

Request Headers:

Authorization – данные, необходимые для авторизации.

Status Codes:

200 OK – операция успешно завершена.
401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит структуру 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
Content-Type: application/json charset=utf-8

Пример тела ответа:

Так как количество типов документов в Диадоке большое, ниже приведена только часть ответа, описывающая УПД формата приказа №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
                                }
                            ]
                        }
                    ]
                }
            ],
            "Name": "UniversalTransferDocument",
            "RequiresFnsRegistration": true,
            "SupportedDocflows": [
                0
            ],
            "Title": "УПД"
        }
    ]
}

См. также

Инструкции:

Получение информации о типе документа

Методы для работы с документами:

Delete — отмечает указанный документ как удаленный
GetContent — возвращает XSD-схему документа
GetDocument (V3) — возвращает данные документа по указанному идентификатору
GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
GetDocumentsByMessageId — возвращает список документов из указанного сообщения
GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
MoveDocuments — перемещает документы в указанное подразделение организации
Restore — восстанавливает документ из удаленных