API Репутация

Appearance

Документы арбитражного дела ​

Для чего это нужно и как это работает ​

Данный раздел описывает методы скачивания файла документа арбитражного дела и получения его текста.

Список документов дела отдельным запросом не запрашивается: он приходит вместе с делом, в поле Documents — и в выдаче поиска, и в карточке дела GET /api/v2/arbitr/case. Оттуда же берётся Id документа, которым он адресуется при скачивании.

Основная информация ​

  • эндпоинт получения файла документа — /api/v2/arbitr/documents/file swagger
  • эндпоинт получения текста документа — /api/v2/arbitr/documents/text swagger
  • метод запроса — GET
  • параметры передаются в строке запроса

Список документов дела ​

Документы дела лежат в поле Documents самого дела, плоским списком. Доступны следующие свойства документа:

  • Id — идентификатор документа, им же документ адресуется при скачивании
  • Date — дата документа
  • Type — тип документа
  • InstanceId — идентификатор инстанции, к которой относится документ
  • IsFinalDocument — признак итогового документа инстанции
  • LegalNorms — нормы права, упомянутые в документе, { Id, Name }
  • WebsiteUrl — ссылка на документ на сайте

Документ отдаётся в ответе один раз. Чтобы разложить документы по инстанциям, сопоставьте Documents[].InstanceId с Instances[].Id того же дела.

Скачивание файла документа ​

Для скачивания файла документа необходимо передать его идентификатор в параметре id.

пример запроса:

http
GET /api/v2/arbitr/documents/file?id=d712a1fd-4cc7-4cc7-a19f-733d17f8b670

В ответе будет файл документа (PDF). Если файл недоступен, возвращается 204 No Content.

Получение текста документа ​

Чтобы получить текст документа (а не PDF-файл), передайте тот же идентификатор в параметре id:

http
GET /api/v2/arbitr/documents/text?id=d712a1fd-4cc7-4cc7-a19f-733d17f8b670

В ответе — текстовый файл (text/plain) с содержимым документа. Если текст документа недоступен, возвращается 204 No Content.

Отличия от v1 ​

В v1 документ адресовался числовым DocId, а список документов дела запрашивался отдельным методом GET /api/v1/arbitr/documents?caseId=... по числовому CaseId. Эти методы продолжают работать, но помечены устаревшими; числовые идентификаторы v1 в v2 не отдаются и в его методы не подходят.

Результаты ИИ-поиска остаются на идентификаторах v1: Items[].Documents[].DocId — числовой, и текст по нему получается запросом GET /api/v1/arbitr/document/text?docId={DocId}.