REST API DropCat: запрос списка партнёров организации
GET /getPartners
Метод позволяет получить список партнеров организации-инициатора запроса и их основные реквизиты.
Формат запроса
Запрос на получения списка партнеров следует отправлять с помощью метода GET.
/getPartners
? [id_type= <тип идентификатора>]
& [org_id= <идентификатор>]
& [name=<название организации>]
& [iln=<ГЛН организации>]
& [inn=<ИНН организации>]
Параметры запроса
| Параметр | Пример значения | Описание | Тип параметра | Тип данных |
|---|---|---|---|---|
| id_type* | gln |
Тип идентификатора организации. Принимает значения: gln или fns. |
query | string |
| org_id* | 2000000009994 | Идентификатор организации-инициатора запроса. | query | string |
| name | VEVTVF9DVVNUT01FUg== | Наименование организации-партнера. Параметр передается в кодировке base64. | query | string |
| iln | 2000000007705 | Идентификатор (GLN) организации-партнера. | query | string |
| inn | 9999999999 | Идентификатор (ИНН) организации-партнера. | query | string |
* Обязательный параметр.
Формат ответа
Если запрос был обработан без ошибок, API отвечает кодом 200.
Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.
Curl
curl -X GET --header "Accept: application/json" "https://dapi-preprod.ediweb.ru/edi/api/v1.1/getPartners?id_type=gln&org_id=2000000009994&name=TEST_CUSTOMER&gln=2000000007705&inn=9999999999"
URL запроса
https://dapi-preprod.ediweb.ru/edi/api/v1.1/getPartners?id_type=gln&org_id=2000000009994&name=TEST_CUSTOMER&gln=2000000007705&inn=9999999999
Тело ответа
В теле ответа содержатся данные о партнерах организации в виде JSON-структуры.
[
{
"name": "TEST_CUSTOMER",
"iln": "2000000007705",
"inn": "9999999999",
"kpp": "999999999",
"fnsId": "2IJ5390D2B5A1E842FE9244528576B450AD",
"addresses": [
{
"countryCode": "BT",
"zip": "",
"regionCode": "",
"regionType": "",
"district": "",
"city": "",
"area": "",
"localityType": "",
"locality": "",
"street": "dcfv",
"streetType": "",
"building": "dfv",
"addInf": "",
"flat": "",
"block": "",
"type": "LEGAL"
}
]
}
]
HTTP код ответа
200
Заголовки ответа
{
"connection": "keep-alive",
"content-length": "370",
"content-type": "text/plain; charset=UTF-8",
"date": "Tue, 01 Dec 2020 11:38:38 GMT",
"request_uuid": "8ec66b39-463a-4466-9c10-5e015a2ef549",
"server": "nginx"
}