REST API DropCat: получение списка доступных шаблонов
GET /getReports
Метод позволяет получить список всех доступных организации-инициатору запроса шаблонов.
Формат запроса
Запрос на получение списка доступных шаблонов следует отправлять с помощью метода GET.
/edi/api/v1.1/getReports/{docId}/{PDF|XLS}
? [id_type= <тип идентификатора>]
& [org_id= <идентификатор>]
& [doc_id= <идентификатор>]
& [reportFormat= <формат>]
Параметры запроса
| Параметр | Пример значения | Описание | Тип параметра | Тип данных |
|---|---|---|---|---|
| id_type* | gln |
Тип идентификатора организации. Принимает значения: gln или fns. |
query | string |
| org_id* | 2000000009994 | Идентификатор запроса организации-инициатора запроса (gln). | query | string |
| doc_id* | 126194502 | Идентификатор документа в системе. | path | string |
| reportFormat* |
|
Формат отчета. Может принимать значения: — XLS |
path | string |
* Обязательный параметр.
Формат ответа
Если запрос был обработан без ошибок, API отвечает кодом 200. Тело ответа содержит информацию в виде JSON-структуры. Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.
Curl
curl -X GET --header "Accept: application/json" "https://dapi-preprod.ediweb.ru/edi/api/v1.1/getReports/126194502/PDF?id_type=gln&org_id=2000000009994"
URL запроса
https://dapi-preprod.ediweb.ru/edi/api/v1.1/getReports/126194502/PDF?id_type=gln&org_id=2000000009994
Тело ответа
[
{
"templateName": "УПД",
"format": "PDF",
"templateLanguage": "RUSSIAN",
"templateId": 126396756
}
]
HTTP код ответа
200
Заголовки ответа
{
"connection": "keep-alive",
"content-length": "94",
"content-type": "text/plain; charset=UTF-8",
"date": "Tue, 01 Dec 2020 13:14:39 GMT",
"request_uuid": "364ec376-49c4-4106-b1e5-efaab0381d81",
"server": "nginx"
}