Доступ к справочнику городов



Структура моделей, назначение полей

Модель City — города

разрешены запросы просмотр данных записи, просмотр списка записей, добавление/редактирование/удаление записей

Модель City — представляет справочник городов.

* @property integer $id // ИД
* @property string $title // Название
@property $type_id // тип населенного пункта

Пример City

curl --location --request GET 'http://{DOMAIN NAME}/rest/api/City' \
--header 'Content-Type: application/json' \
--header 'X-REST-API-KEY: {REST API KEY}'

▶ Ответ сервера
{
    "success": true,
    "message": "Records Retrieved Successfully",
    "data": {
        "totalCount": "239",
        "city": [
            {
                "id": "13",
                "title": "Абинск",
                "type_id": "1"
            },
            {
                "id": "226",
                "title": "Абинский р-он",
                "type_id": "1"
            },
            ***************************
            {
                "id": "254",
                "title": "город Счастья",
                "type_id": "1"
            }

        ]
    }
}

City — Пример добавления записи

curl --location --request POST 'http://{DOMAIN NAME}/rest/api/CityType' \
--header 'Content-Type: application/json' \
--header 'X-REST-API-KEY: {REST API KEY}'
--data-raw '{
    "title": "город Мой родной"
}'

Модель CityType — типы населенных пунктов

разрешены запросы просмотр данных записи, просмотр списка записей, добавление/редактирование/удаление записей

id - ID записи
title - название типа населенного пункта
curl --location --request GET 'http://{DOMAIN NAME}/rest/api/CityType' \
--header 'Content-Type: application/json' \
--header 'X-REST-API-KEY: {REST API KEY}'

▶ Ответ сервера
{
    "success": true,
    "message": "Records Retrieved Successfully",
    "data": {
        "totalCount": "9",
        "cityType": [
            {
                "id": "1",
                "title": "Город"
            },
            {
                "id": "2",
                "title": "Деревня"
            },
            {
                "id": "3",
                "title": "Поселок"
            },
            {
                "id": "4",
                "title": "ПГТ"
            },
            {
                "id": "5",
                "title": "Село"
            },
            {
                "id": "7",
                "title": "Станица"
            },
            {
                "id": "8",
                "title": "Станция"
            },
            {
                "id": "9",
                "title": "Хутор"
            },
            {
                "id": "12",
                "title": "Агрогородок"
            }
        ]
    }
}