regions
GET /api/regions/tree
Get Regions Tree
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| include_inactive | Include Inactive | False | Включить деактивированные регионы |
Response 200: Successful Response
array[RegionTreeItem]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| phone_code | Phone Code | нет | |
| phone_zone | Phone Zone | нет | |
| children | array[object] | нет | |
| is_active | Is Active | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/regions
List Regions
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| parent_id | Parent Id | Фильтр по parent_id | |
| top_level | Top Level | False | Только области (parent_id IS NULL) |
| include_inactive | Include Inactive | False | Включить деактивированные регионы |
Response 200: Successful Response
array[RegionResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| phone_code | Phone Code | нет | |
| phone_zone | Phone Zone | нет | |
| parent_id | Parent Id | нет | |
| parent_name | Parent Name | нет | |
| full_phone_code | Full Phone Code | нет | |
| sort_order | Sort Order | нет | |
| is_active | Is Active | нет | |
| local_digits | Local Digits | нет | |
| is_regional_center | Is Regional Center | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/regions
Create Region
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | да | |
| phone_code | Phone Code | нет | |
| phone_zone | Phone Zone | нет | |
| parent_id | Parent Id | нет | |
| local_digits | Local Digits | нет | |
| is_regional_center | Is Regional Center | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| phone_code | Phone Code | нет | |
| phone_zone | Phone Zone | нет | |
| parent_id | Parent Id | нет | |
| parent_name | Parent Name | нет | |
| full_phone_code | Full Phone Code | нет | |
| sort_order | Sort Order | нет | |
| is_active | Is Active | нет | |
| local_digits | Local Digits | нет | |
| is_regional_center | Is Regional Center | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/regions/{region_id}
Get Region
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| region_id | Region Id |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| phone_code | Phone Code | нет | |
| phone_zone | Phone Zone | нет | |
| parent_id | Parent Id | нет | |
| parent_name | Parent Name | нет | |
| full_phone_code | Full Phone Code | нет | |
| sort_order | Sort Order | нет | |
| is_active | Is Active | нет | |
| local_digits | Local Digits | нет | |
| is_regional_center | Is Regional Center | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/regions/{region_id}
Update Region
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| region_id | Region Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | да | |
| phone_code | Phone Code | нет | |
| phone_zone | Phone Zone | нет | |
| parent_id | Parent Id | нет | |
| local_digits | Local Digits | нет | |
| is_regional_center | Is Regional Center | нет | |
| sort_order | Sort Order | нет | |
| is_active | Is Active | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| phone_code | Phone Code | нет | |
| phone_zone | Phone Zone | нет | |
| parent_id | Parent Id | нет | |
| parent_name | Parent Name | нет | |
| full_phone_code | Full Phone Code | нет | |
| sort_order | Sort Order | нет | |
| is_active | Is Active | нет | |
| local_digits | Local Digits | нет | |
| is_regional_center | Is Regional Center | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
DELETE /api/regions/{region_id}
Delete Region
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| region_id | Region Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/regions/reorder
Reorder Regions
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| region_ids | array[integer] | да |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |