---
# System prepended metadata

title: Получение списка регионов
tags: [first_contract, arithmetic-integration]

---

---
tags: arithmetic-integration,first_contract
title: Получение списка регионов
---

# Получение списка регионов

Получение регионов для отображения выбора на сайте.
При успешном запросе возвращает иерархический список json. При отсутствии регионов вернёт [ошибочный результат](/NIkubqRkR5STebBQd8690g#Формат-ошибочных-результатов).

## 1. Запрос выполнения операции

### Request --->

#### URL:
Стандартный, [см. шаблон обращения](/NIkubqRkR5STebBQd8690g#URL)

#### Headers:
* **apikey**: ==[apikey](/NIkubqRkR5STebBQd8690g?both#URL)==
* **Content-type**: application/json; charset=utf-8
* **Mq-Jrb-Exchange**: PersonalAccount
* **Mq-Jrb-Routing-key**: service
* **Mq-Jrb-Operation**: GetRegions
* **Mq-Jrb-Object**: get-regions

#### Body:
```json
{}
```

---
### Response <---

Стандартный, [см. шаблон обращения](/NIkubqRkR5STebBQd8690g?view#Response-lt—)

---

## 2. Получение результата

### Request --->
Стандартный, [см. шаблон обращения](/NIkubqRkR5STebBQd8690g?view#URL1)

### Response <---

#### Headers:
* **Content-type**: application/json; charset=utf-8
* **Mq-Jrb-Id**: ==[id](/NIkubqRkR5STebBQd8690g?view#Headers3)==
* **Mq-Jrb-Id-Result**: ==[id-result](/NIkubqRkR5STebBQd8690g?view#Headers3)==

#### Body:
```json
[
    {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "name": "Наименование населенного пункта",
        "base_source": "xxxxxxxxxxxx",
        "code": "999",
        "satellites": [
            {
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "name": "Наименование населенного пункта",
                "base_source": "xxxxxxxxxxxx"
            },
            ...
        ]
    },
    ...
]
```

:::info
:::spoiler Описание полей
- **id**: идентификатор населенного пункта, строка формата UUID
- **name**: наименование населенного пункта, строка длиной не более 150
- **base_source**: база данных, к которой привязан населенный пункт, строка до 20 символов (будет необходима при оформлении договоров)
- **code**: код региона субъекта РФ, строка, 2-3 цифры, указан только на верхнем уровне иерархии
- **satellites**: список подчиненных населенных пунктов, состоит из населенных пунктов и **id** и **name**

:warning:
Получаемый список будет иерархическим с 2-мя (!!!) уровнями иерархии. На верхнем - административный центр, например, Новосибирск, с `"code": 54`, ему будут подчинены через список `satellites` населенные-пункты-спутники, например, Бердск

:::

:::success
:::spoiler Пример, если доступен список регионов
```json
[
    {
        "id": "1964cd6f-4dbe-4208-8412-7b4bf89bd19e",
        "name": "Новосибирск",
        "code": "54",
        "satellites": [
            {
                "id": "f1b4f6d0-726d-4c25-8d8a-1e46fd5f0a55",
                "name": "Бердск"
            },
            {
                "id": "e6e583fa-e16c-404d-9349-e7fdbe305351",
                "name": "Карасук"
            }
        ]
    },
    {
        "id": "8fe7bcca-846e-429e-99cb-73aacb5429eb",
        "name": "Москва",
        "code": "77",
        "satellites": [
            {
                "id": "2636a473-91be-4fd5-86af-b468c0db6475",
                "name": "Балашиха"
            }
        ]
    }
]
```
:::

:::danger
:::spoiler Примеры [ошибочных результатов](/NIkubqRkR5STebBQd8690g#Формат-ошибочных-результатов)
##### 1. В базе Рассрочки не найдено ни одного магазина с населённым пунктом с заданным субъектом РФ
```json
{ 
    "description": "No regions found",
    "error": "GetRegions.NoRegions"
}
```
:::

---
