Описание: Получение списка всех улиц с привязкой к городам. По умолчанию возвращает улицы для Самары.

Теги: КЛАДР

Параметры:

cityIikoId (query, optional): string - UUID города в iiko. Если не указан, то возвращает улицы для Самары.

Ответ:

200 OK:

[
    {
        "iikoId": "some-street-iiko-id-1",
        "id": "some-street-iiko-id-1",
        "name": "Улица 1",
        "nameWithCity": "Самара, Улица 1",
        "classifierId": "some-classifier-id",
        "cityName": "Самара"
    },
    {
        "iikoId": "some-street-iiko-id-2",
        "id": "some-street-iiko-id-2",
        "name": "Улица 2",
         "nameWithCity": "Самара, Улица 2",
        "classifierId": "some-classifier-id",
        "cityName": "Самара"
    },
       {
        "iikoId": "some-street-iiko-id-3",
        "id": "some-street-iiko-id-3",
        "name": "Улица 3",
         "nameWithCity": "Новокуйбышевск, Улица 3",
         "classifierId": "some-classifier-id",
        "cityName": "Новокуйбышевск"
    },
       {
        "iikoId": "some-street-iiko-id-4",
        "id": "some-street-iiko-id-4",
        "name": "Улица 4",
         "nameWithCity": "Тольятти, Улица 4",
         "classifierId": "some-classifier-id",
        "cityName": "Тольятти"
    }
]

iikoId: (string) - ID улицы в iiko.
id: (string) - ID улицы (дублирует iikoId).
name: (string) - Название улицы.
nameWithCity: (string) - Название улицы вместе с названием города.
classifierId: (string) - ID классификатора.
cityName: (string) - Название города.

4xx или 5xx: Возможные ошибки, связанные с обработкой запроса, например, ошибки базы данных.
```
    {
        "statusCode": 400,
        "error": "Bad Request",
        "message": "Some error message"
    }
```

`GET /city/:cityIikoId`

Описание: Получение списка улиц для конкретного города.

Теги: КЛАДР

Параметры:

cityIikoId (path, required): string - UUID города в iiko.

Ответ:

200 OK:

[
    {
       "iikoId": "some-street-iiko-id-1",
        "id": "some-street-iiko-id-1",
        "name": "Улица 1",
        "nameWithCity": "Самара, Улица 1",
        "classifierId": "some-classifier-id",
        "cityName": "Самара"
    },
    {
        "iikoId": "some-street-iiko-id-2",
        "id": "some-street-iiko-id-2",
        "name": "Улица 2",
         "nameWithCity": "Самара, Улица 2",
        "classifierId": "some-classifier-id",
        "cityName": "Самара"
    }
]

iikoId: (string) - ID улицы в iiko.
id: (string) - ID улицы (дублирует iikoId).
name: (string) - Название улицы.
nameWithCity: (string) - Название улицы вместе с названием города.
classifierId: (string) - ID классификатора.
cityName: (string) - Название города.

4xx или 5xx: Возможные ошибки, связанные с обработкой запроса, например, ошибки базы данных.
```
    {
        "statusCode": 400,
        "error": "Bad Request",
        "message": "Some error message"
    }
```

Примечания:

Поддерживаемые cityIikoId:
- Самара: a85360f2-55a8-47cc-8a79-1eb88a40c4f0
- Тольятти: 3f02eb06-e771-434c-ab73-2ec5bbde1265
- Новокуйбышевск: e27dec5a-4447-4bcb-a124-0c1795618998
Если указан некорректный cityIikoId, вернётся массив с одним объектом:

[
    {
        "iikoId": -1,
        "id": -1,
        "name": "- не найдено"
     }
]

Для Тольятти и Новокуйбышевска также возвращаются улицы, привязанные к поселкам в их составе.
Тольятти: podstepki, primorskij-posyolok, timofeevka
Новокуйбышевск: mayak, voskresenka

Apicity

Apiform

API Documentation

КЛАДР (Классификатор адресов России)

`GET /`

`GET /city/:cityIikoId`