Дополнительная фильтрация по идентификаторам

Описание

При получении справочников можно использовать дополнительный параметр 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": "Япония"
    }
]