REST API DropCat: получение списка UID
GET /getUuids
Метод предназначен для получения списка UID организаций
Формат запроса
Запрос на получение списка UID организаций следует отправлять методом GET.
/getUuids
? [org_id= <идентификатор>]
& [id_type= <тип идентификатора>]
& [uid_count=<количество>]
Параметры запроса
| Параметр | Пример значения | Описание | Тип параметра | Тип данных |
|---|---|---|---|---|
| id_type* | gln |
Тип идентификатора организации. Принимает значения: gln или fns. |
query | string |
| org_id* | 2000000009994 | Идентификатор организации-инициатора запроса. | query | string |
| uid_count* | Запрашиваемый размер пула. Обязательный для заполнения. Максимальное значение 300. | query | string |
*Обязательный параметр.
Формат ответа
Если запрос был обработан без ошибок, API отвечает кодом 200.
Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.
В заголовке ответа возвращается request_uuid - идентификатор корреляции запроса.
В теле ответа возвращается выделенный пул идентификаторов.
Тело ответа
{
"uids": [
"78f8a3a6-8791-40dc-a288-53ebb8b6c7d9",
"01ccdf15-fcab-44bb-a917-70fd7d03b15a"
],
"error": "здесь будет текст ошибки"
}
HTTP код ответа
200
Заголовки ответа
{
"connection": "keep-alive",
"content-disposition": "attachment; filename=uuids.01092023090949.response.json",
"content-encoding": "gzip",
"content-length": "88",
"content-type": "text/plain; charset=UTF-8",
"date": "Fri, 01 Sep 2023 09:09:49 GMT",
"file_name": "dXVpZHMuMDEwOTIwMjMwOTA5NDkucmVzcG9uc2UuanNvbg==",
"request_uuid": "ae2439e1-2a5e-4231-b2c8-4e5bb54d7a36",
"server": "nginx/1.22.0"
}