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

Данные о незаполненных полях в объявлении

Данный метод возвращает для объявления список полей, которые не были заполнены при создании/редактировании.

Набор передаваемых полей в теле ответа зависит от тематики объявления.

GET /v1/orders/{id}/props/empty

Обязательные параметры:

ИмяТипОписание
 id integerИдентификатор объявления

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

  • 200 OK - успешное выполнение запроса
  • 404 Not Found - объявление не найдено
  • 403 Forbidden - авторизация неудачна

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

HTTP/1.1 200 OK

{
    "data": [
        {
            "id": 12309,
            "code": "auction",
            "type": "checkbox",
            "desc": "Флажок (одиночный)",
            "name": "Аукцион",
            "unit": "",
            "tips": "",
            "required": false
        },
        {
            "id": 12143,
            "code": "cadastral_number",
            "type": "text",
            "desc": "Строка",
            "name": "Кадастровый номер",
            "unit": "",
            "tips": "",
            "required": false
        },
        {
            "id": 12279,
            "code": "company_name",
            "type": "text",
            "desc": "Строка",
            "name": "Компания",
            "unit": "",
            "tips": "",
            "required": false
        },
        {
            "id": 251,
            "code": "heating_available",
            "type": "checkbox",
            "desc": "Флажок (одиночный)",
            "name": "Отопление",
            "unit": "",
            "tips": "",
            "required": false
        },
        {
            "id": 63,
            "code": "house",
            "type": "text",
            "desc": "Строка",
            "name": "Номер дома",
            "unit": "",
            "tips": "7к20В",
            "required": false
        },
        {
            "id": 12202,
            "code": "lease_rights",
            "type": "checkbox",
            "desc": "Флажок (одиночный)",
            "name": "Переуступка права аренды",
            "unit": "",
            "tips": "",
            "required": false
        },
        {
            "id": 1813,
            "code": "link_to_the_video_on_youtube",
            "type": "youtube_video",
            "desc": "Ссылка на видео на YouTube",
            "name": "Ссылка на видео на YouTube",
            "unit": "",
            "tips": "",
            "required": false
        },
        {
            "id": 683,
            "code": "metro",
            "type": "suggest_required",
            "desc": "Текстовое поле с автоподсказкой и обязательным выбором из списка значений",
            "name": "Метро",
            "unit": "",
            "tips": "",
            "required": true
        },
        {
            "id": 495,
            "code": "on_the_territory_of_gsk_or_gk",
            "type": "checkbox",
            "desc": "Флажок (одиночный)",
            "name": "На территории ГСК или ГК",
            "unit": "",
            "tips": "",
            "required": false
        },
        {
            "id": 12255,
            "code": "order_photo",
            "type": "photo",
            "desc": "Фотографии",
            "name": "Фотографии",
            "unit": "",
            "tips": "",
            "required": false
        },
        {
            "id": 12286,
            "code": "phone_additional",
            "type": "text",
            "desc": "Строка",
            "name": "Дополнительный телефон",
            "unit": "",
            "tips": "",
            "required": false
        }
    ]
}

Каждый элемент списка содержит следующие данные:

ИмяТипОписание
 id integerИдентификатор. Уникальное значение
 code stringСимвольное обозначение
 type stringТип. Каждый тип характеризуется своим возможным форматом и набором значений (для типов-списков)
 desc stringОписание
 name stringНаименование. Может иметь разные значения для одного и того же поля в рамках использованиея в разных тематиках
 unit stringЕдиница измерения
 tips stringПример заполнения
 required booleanОбязательность заполнения