Документация API JCat.Недвижимость

Справочники ЖК

Справочник жилых комплексов используется для обогащения объявлений в тематиках "Продажа квартиры в новостройке", "Продажа квартиры", "Продажа комнаты или доли", "Аренда квартиры", "Аренда комнаты", "Аренда квартиры посуточно", "Аренда комнаты посуточно".

Вывод данных по одному элементу справочника

GET /v1/catalogues/item/{id}

Принимаемые параметры:

Имя параметра	Тип	Описание	Пример значения	Обязательное
id	integer	Идентификатор элемента справочника	123	Да

Результат запроса:

200 OK - успешное выполнение
403 Forbidden - доступ для данного пользователя запрещен

Пример ответа:

{
    "data": {
        "id": 1234,
        "title": "ЖК Ромашка",
        "children_count": 32,
        "photos": [
            {
                "id": 1243,
                "prop_id": null,
                "ext": "jpeg",
                "filename": "0.jpg",
                "filetype": "image\/jpeg",
                "filesize": 312115,
                "pathname": "\/images\/catalogues\/2019-04\/24\/580e88876d697a0a07a53cd700667eee.jpeg",
                "main": false,
                "download_date": "2019-04-24T12:48:24+03:00",
                "width": 1300,
                "height": 573,
                "sort": 0,
                "hash": "3dbe8018500a6dc345427aa30915f531",
                "uiz": null,
                "preview": "\/images\/catalogues\/2019-04\/24\/580e88876d697a0a07a53cd7006675e6.jpeg",
                "isImage": true
            }
        ],
        "address": "Московская область, Королев, Болшево гаражно-строительный кооп.",
        "parent": null
    }
}

Описание возвращаемых полей для элемента справочника:

Имя	Тип	Описание
id	integer	Идентификатор элемента
title	string	Название ЖК
children_count	integer	Количество дочерних элементов
address	string	Адрес ЖК
parent	array	Родительский элемент (структура схожа с основным элементом)

Описание возвращаемых полей для файла:

Имя	Тип	Описание
id	integer	Идентификатор файла
prop_id	integer	Идентификатор поля
ext	string	Расширение
filename	string	Имя файла
filetype	string	Тип файла
filesize	integer	Размер в байтах
pathname	string	Путь до файла
main	boolean	Является ли фото главным
download_date	date	Время загрузки файла
width	integer	Ширина
height	integer	Высота
sort	integer	Индекс сортировки
hash	string	Хеш файла
uiz	integer	Номер объявления
preview	string	Превью фото
isImage	boolean	Является ли файл изображением

Вывод списка из элементов справочника

GET /v1/catalogues/items/{page}/{limit}

Параметры пагинации:

Имя параметра	Тип	Описание	Пример значения	Обязательное
page	integer	Номер страницы	1	Нет
limit	integer	Кол-во записей на страницу	10	Нет

Принимаемые GET параметры:

Имя параметра	Тип	Описание	Возможные значения	Обязательное
status	string	Статусы объектов	all (Все) / not_finished (Строятся) / finished (Сданы)	Нет
parent_id	integer	Идентификатор родительского объекта	123	Нет
level	integer	Уровень справочника	1 (название ЖК) / 2 (корпус ЖК)	Нет

Результат запроса:

200 OK - успешное выполнение
403 Forbidden - доступ для данного пользователя запрещен

{
    "data": {
        "items": [
            {
                "id": 1234,
                "title": "ЖК Ромашка",
                "children_count": 32,
                "photos": [
                    {
                        "id": 1243,
                        "prop_id": null,
                        "ext": "jpeg",
                        "filename": "0.jpg",
                        "filetype": "image\/jpeg",
                        "filesize": 312115,
                        "pathname": "\/images\/catalogues\/2019-04\/24\/580e88876d697a0a07a53cd7006675e6.jpeg",
                        "main": false,
                        "download_date": "2019-04-24T12:48:24+03:00",
                        "width": 1300,
                        "height": 573,
                        "sort": 0,
                        "hash": "3dbe8018500a6dc345427aa30915f531",
                        "uiz": null,
                        "preview": "\/images\/catalogues\/2019-04\/24\/580e88876d697a0a07a53cd7006675e6.jpeg",
                        "isImage": true
                    }
                ],
                "address": "Московская область, Королев, Болшево гаражно-строительный кооп."
            },
            {
                "id": 5678,
                "title": "ЖК Примус",
                "children_count": 3,
                "photos": [],
                "address": "Москва, Филевская 2-я улица"
            }
        ],
        "total": 2,
        "pages": {
            "page": 1,
            "total": 1,
            "limit": 10
        }
    }
}

Cчетчики по объектам ЖК (все, строятся, сданы)

GET /v1/catalogues/items/numbers

Результат запроса:

200 OK - успешное выполнение

Пример ответа:

{
    "data": [
        {
            "id": "all",
            "title": "Все",
            "value": 5
        },
        {
            "id": "not_finished",
            "title": "Строятся",
            "value": 3
        },
        {
            "id": "finished",
            "title": "Сданы",
            "value": 2
        }
    ]
}