Додаткова фільтрація за ідентифікаторами
Опис
При отриманні довідників можна використовувати додатковий параметр ids
,
щоб в масиві відповіді залишилися тільки елементи довідника, чиї
ідентифікатори були згадані в рядку запиту.
Примітки:
- ця опція недоступна в довіднику "Мови локалізації"
- в довіднику "Країни" для фільтрації використовується параметр
signs
. Як аргументи використовуються 2-буквені коди країн у верхньому регістрі, в іншому правила такі самі.
Структура URL
GET /v2/path/to/some/reference?ids=1&ids=2&ids=5
# або
GET /v2/path/to/some/reference?ids=1,2,5
# для довідника країн
GET /v2/references/countries?signs=TZ&signs=JP
# або
GET /v2/references/countries?signs=TZ,JP
Зразки запиту і відповіді.
Для довідника "Області"
Запит
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/areas?ids=16,17,19"
Відповідь
[
{
"id": 16,
"name": "Волынская обл.",
"countrySign": "UA",
"regionId": 4
},
{
"id": 17,
"name": "Днепропетровская обл.",
"countrySign": "UA",
"regionId": 2
},
{
"id": 19,
"name": "Житомирская обл.",
"countrySign": "UA",
"regionId": 6
}
]
Для довідника "Країни"
Запит
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/countries?signs=JP,TZ"
Відповідь
[
{
"sign": "TZ",
"name": "Танзания"
},
{
"sign": "JP",
"name": "Япония"
}
]