Profitbase API API Reference
Документация
Расширяйте возможности Profitbase с помощью API.
Мы стараемся предоставить максимальные возможности для пользователей Profitbase покрывая большинство бизнес-процессов по автоматизации продаж. Использование специфических бизнес-процессов или CRM систем не ограничивает вас в подключении к Profitbase. Используйте API Profitbase для получения, добавления и обновления помещений в вашем аккаунте Profitbase.
С помощью API вы сможете интегрировать Profitbase:
- с сайтом
- с 1С и любыми другими CRM
- с своими виджетами и приложениям amoCRM и Битрикс24
- с сквозными системами аналитики и BI
Основные возможности API v4:
- Работа с каталогом объектов (чтение, обновление ЖК/домов/помещений)
- Работа со сделками (при интеграции с amoCRM и Б24)
- Получение планировок, фасадов
- Получение акций
v4. Для некоторых методов, предназначенных для работы с приложениями "Profitbase для amoCRM" или "Profitbase для Битрикс24" требуется разрешение подключения к CRM. Включить разрешение можно в настройках приложения API в личном кабинете Profitbase.
Ограничения по работе с API:
- Запросы необходимо отправлять только с протоколом https
- Запросы необходимо отправлять в формате JSON (в заголовках указать Content-Type: application/json)
- Не более одного запроса в секунду
API Endpoint
https://pbXXX.profitbase.ru/api/v4/jsonContact: support@profitbase.ru
Schemes: https
Version: 4.0
Authentication
AppId
Для авторизации в сервисе необходимо передавать в запросе GET-параметр access_token
auth
Авторизация
Авторизация
Метод для аутентификации. Возвращает access_token необходимый для доступа к API. После аутентификации для работы с API необходимо передавать полученный access_token в качестве GET параметра для всех методов. Время жизни токена 24h.
- type: string
- credentials: object
-
- pb_api_key: string
Request Content-Type: application/json
Request Example
{
"type": "api-app",
"credentials": {
"pb_api_key": "app-5c6a7fa3b55aa"
}
}
Успешная авторизация
Access token для дальнейшего использования в запросах
Время жизни токена в секундах
Язык
403 Forbidden
(no description)
Язык
Response Content-Type: application/json
Response Example (200 OK)
{
"access_token": "db0f7ffcdb3ff2101b6602cf746a9e4cb1f31a09c903385e391535dfd6e91448",
"remaining_time": 3454,
"lang": "ru"
}
Response Example (403 Forbidden)
{
"error": "Not allowed.",
"lang": "ru"
}
houses
Управление домами
Метод получения списка домов с возможностью фильтрации
Метод получения списка домов с возможностью фильтрации
Идентификатор дома
Идентификатор ЖК
Идентификаторы ЖК
(no description)
Возврат только заданного числа комнат
Выбирает кол-во комнат равно или более чем заданное значение. Имеет приоритет над фильтром rooms
При значении false исключит из ответа помещения без планировки
При значении false исключит студии из ответа
При значении false исключит свободные планировки из ответа
При значении false исключит европланировки из ответа. При значении true и наличии параметра rooms или roomMoreThan фильтрует европланировки по комнатности.
Отделка
Минимальная цена
Максимальная цена
Минимальная цена за квадратный метр
Максимальная цена за квадратный метр
Минимальная площадь
Максимальная площадь
Минимальная жилая площадь
Максимальная жилая площадь
Дом сдан
Срок сдачи дома (четверть)
Срок сдачи дома (год)
Специальные предложения
Статусы
ID статусов
Характеристики
смещение для паджинации
кол-во домов в ответе
Игнорировать помещения в статусе не для продажи
Показывать пустые дома
Список доступных домов
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"projectId": 1,
"projectName": "Новомосковский",
"title": "Корпус 1",
"street": "Краснолесья",
"number": "71А",
"facing": "Чистовая",
"material": "Монолит",
"buildingState": "BUILT",
"developmentStartQuarter": {
"year": 2015,
"quarter": 1
},
"developmentEndQuarter": {
"year": 2015,
"quarter": 1
},
"salesStart": {
"month": "02",
"year": "2018"
},
"salesEnd": {
"month": "02",
"year": "2018"
},
"id": 10,
"type": "APARTMENT"
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод получения количества этажей в конкретном доме
Метод получения количества этажей в конкретном доме
Идентификатор дома
Количество этажей в каждом подъезде
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true,
"data": [
{
"section_id": 52,
"title": "Подъезд 1",
"count": 59,
"above-ground": 56,
"underground": 3
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод получения количества помещений в конкретном доме на конкретном этаже
Метод получения количества помещений в конкретном доме на конкретном этаже
Идентификатор дома
Номер этажа
Количество помещений на этаже в каждом подъезде
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true,
"data": [
{
"section_id": 52,
"title": "Подъезд 1",
"floor": 59,
"floor_id": 56,
"count": 3
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Устаревший метод v3 получения списка домов
Устаревший метод v3 получения списка домов
Идентификатор ЖК
Список доступных домов
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"projectId": 1,
"projectName": "Новомосковский",
"title": "Корпус 1",
"street": "Краснолесья",
"number": "71А",
"facing": "Чистовая",
"material": "Монолит",
"buildingState": "BUILT",
"developmentStartQuarter": {
"year": 2015,
"quarter": 1
},
"developmentEndQuarter": {
"year": 2015,
"quarter": 1
},
"salesStart": {
"month": "02",
"year": "2018"
},
"salesEnd": {
"month": "02",
"year": "2018"
},
"id": 10,
"type": "APARTMENT"
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод создание дома в существующий ЖК
Метод создание дома в существующий ЖК
(no description)
Request Content-Type: application/json
Request Example
{
"project_id": 1,
"title": "Корпус 1",
"street": "Краснолесья",
"number": "71А",
"facing": "Чистовая",
"material": "Монолит",
"building_state": "BUILT",
"developmentStartQuarter": {
"year": 2015,
"quarter": 1
},
"developmentEndQuarter": {
"year": 2015,
"quarter": 1
},
"image": {
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
}
}
Создан дом
Идентификатор дома
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": 1
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод обновления данных в конкретном доме
Метод обновления данных в конкретном доме
Идентификатор дома
Request Content-Type: application/json
Request Example
{
"project_id": 1,
"title": "Корпус 1",
"street": "Краснолесья",
"number": "71А",
"facing": "Чистовая",
"material": "Монолит",
"building_state": "BUILT",
"developmentStartQuarter": {
"year": 2015,
"quarter": 1
},
"developmentEndQuarter": {
"year": 2015,
"quarter": 1
},
"image": {
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
}
}
Дом обнавлен
Идентификатор дома
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": 1
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод для поиска домов по названию, адресу и названию ЖК
Метод для поиска домов по названию, адресу и названию ЖК
Поисковый запрос
Список домов, подходящих по условию
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"id": 1,
"name": "Корпус 1",
"address": "Екатеринбург, Свердловская область, Краснолесья, 71А",
"developer": "Солнечный ключ"
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
projects
Управление жилыми комплексами
Метод получения списка ЖК
Метод получения списка ЖК
Список доступных ЖК
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"title": "Новомосковский",
"type": "complex",
"region": "Свердловская область",
"district": "Ленинский район",
"currency": "RUB",
"locality": "Екатеринбург",
"developer": "СтройСуперЗастрой",
"developer_brand": "СтройСуперЗастрой",
"banks": "Ребсбанк",
"image": {
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
},
"id": 10
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод обновления ЖК
Метод обновления ЖК
(no description)
Request Content-Type: application/json
Request Example
{
"title": "Новомосковский",
"type": "complex",
"region": "Свердловская область",
"district": "Ленинский район",
"currency": "RUB",
"locality": "Екатеринбург",
"developer": "СтройСуперЗастрой",
"developer_brand": "СтройСуперЗастрой",
"banks": "Ребсбанк",
"image": {
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
}
}
Обновлен проект
Идентификатор проекта
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": 1
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод создания ЖК
Метод создания ЖК
(no description)
Request Content-Type: application/json
Request Example
{
"title": "Новомосковский",
"type": "complex",
"region": "Свердловская область",
"district": "Ленинский район",
"currency": "RUB",
"locality": "Екатеринбург",
"developer": "СтройСуперЗастрой",
"developer_brand": "СтройСуперЗастрой",
"banks": "Ребсбанк",
"image": {
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
}
}
Создан проект
Идентификатор проекта
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": 1
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод для поиска ЖК по названию, адресу и названию дома, названию застройщика
Метод для поиска ЖК по названию, адресу и названию дома, названию застройщика
Поисковый запрос
Список ЖК, подходящих по условию
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"id": 1,
"name": "ЖК Солнечный",
"location": "Екатеринбург",
"district": "Ленинский район",
"developer": "Солнечный ключ"
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
properties
Управление помещениями
Метод получения списка помещений с возможностью фильтрации
Метод получения списка помещений с возможностью фильтрации. При отправке запроса с параметром full=true лимит отдаваемых помещений будет ограничен до 100. При отправке запроса с параметром full=false, лимит отдаваемых помещений будет ограничен до 1000.
Идентификатор помещения
Идентификатор дома. Может быть числом или массивом чисел
Номер помещения
Номера подъездов
Идентификатор ЖК
Идентификаторы ЖК
Типы помещений
Возврат только заданного числа комнат
Выбирает кол-во комнат равно или более чем заданное значение. Имеет приоритет над фильтром rooms
При значении false исключит из ответа помещения без планировки
При значении false исключит студии из ответа
При значении false исключит свободные планировки из ответа
При значении false исключит европланировки из ответа. При значении true и наличии параметра rooms или roomMoreThan фильтрует европланировки по комнатности.
Отделка
Минимальная цена
Максимальная цена
Минимальная цена за квадратный метр
Максимальная цена за квадратный метр
Минимальная площадь
Максимальная площадь
Минимальная жилая площадь
Максимальная жилая площадь
Дом сдан
Срок сдачи дома (четверть)
Срок сдачи дома (год)
Специальные предложения
Статусы
ID статусов
Характеристики
ID кастомных полей (параметр учитывается только при full=true)
Расширенный набор данных. Если передано значение true, то будет возвращено подробное описание связанных сущностей. Иначе возвращаются только идентификаторы.
Количество выбираемых строк
Сдвиг выборки (с какой строки выбирать)
Если в настройках ключа включена опция "Получать данные из CRM" и в запросе передан параметр full=true в ответе будут возвращены данные из crm
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"status": "success",
"data": [
{
"id": 248408,
"house_id": 873,
"number": "1",
"rooms_amount": 200,
"floor": 2,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"propertyType": "property",
"typePurpose": "residential",
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"houseName": "Дом 1",
"sectionName": "Подъезд 14",
"projectName": "Новомосковский",
"specialOffers": [
{
"id": 2170,
"name": "Акция 1",
"archive": false,
"color": "#fa8174",
"description": "Описсание",
"descriptionActive": false,
"startDate": {
"date": "2019-02-01 00:00:00.000000",
"timezone_type": "3",
"timezone": "Asia/Yekaterinburg"
},
"finishDate": {
"date": "2019-02-25 00:00:00.000000",
"timezone_type": "3",
"timezone": "Asia/Yekaterinburg"
},
"badge": {
"icon": "percent",
"label": "Акция"
},
"banner": {
"active": true,
"text": "Текст баннера",
"buttonText": "Забронировать"
},
"discount": {
"active": true,
"type": "FULL_PRICE",
"unit": "PERCENT",
"value": 10,
"description": "Установлена скидка -10% от полной стоимости",
"humanizedType": "от полной стоимости",
"humanizedUnit": "%"
},
"propertyIds": [
3244361,
3244364
]
}
],
"address": "Екатеринбург, Ленинский район, Свердловская область - эт. 2 № 1",
"section": "Подъезд 14",
"preset": "https://pbXXX.profitbase.ru/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jpg",
"externalId": "dp-1488",
"attachments": [
{
"id": "number",
"type": "panorama - 3d тур",
"code": "string",
"parameters": {
"url": "string",
"isEnabled": "boolean",
"uid": "string",
"type": "string"
}
}
],
"planImages": [
{
"image_name": "Вид второго этажа",
"source": "https://pbXXX.profitbase.ru/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg"
}
],
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
},
"custom_fields": [
{
"id": "pbcf_5c5bfff299292",
"name": "Номер помещения для БТИ",
"value": "4353435"
}
],
"price": {
"value": 3200000
},
"status": "BOOKED",
"responsibleName": "Test",
"responsibleId": "2",
"crmContactName": "contact@amo.ru"
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод получения списка типов помещений и их дополнительных полей
Метод получения списка типов помещений и их дополнительных полей
Описание Типов
(no description)
(no description)
(no description)
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": 1,
"alias": "property",
"name": "Квартира",
"customFields": [
{
"id": 1,
"key": "pbcf_5c5bfff299292",
"name": "Номер помещения для БТИ",
"rank": "1",
"type": "text",
"specificationName": "kitchen-living-room"
}
],
"systemFields": [
{
"id": 146248,
"key": "id",
"name": "ID помещения",
"rank": "2",
"type": "text",
"specificationName": "null"
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод получения списка помещений привязанных к конкретной сделке
Метод получения списка помещений привязанных к конкретной сделке Требуется разрешение подключения к CRM.
Ид сделки
Список помещений
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"status": "success",
"data": [
{
"id": 10,
"house_id": 10,
"number": 606,
"rooms_amount": 3,
"floor": 11,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"propertyType": "property",
"typePurpose": "residential",
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"houseName": "1",
"sectionName": "1",
"projectName": "1",
"specialOffers": [
23,
45
],
"address": "1",
"section": "1",
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
},
"custom_fields": [
{
"id": 1,
"key": "pbcf_5c5bfff299292",
"name": "Номер помещения для БТИ",
"type": "text"
}
],
"status": "AVAILABLE",
"price": {
"value": 3200000
}
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод получения истории изменения статусов по конкретному помещению
Метод получения истории изменения статусов по конкретному помещению
Ид помещения
История помещения
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"response": [
{
"action": "Adding an object to a deal",
"actionKey": "ADD_PROPERTY",
"date": "1562766475",
"propertyStatus": "Free",
"propertyStatusKey": "AVAILABLE",
"dealStatus": "Первичный контакт",
"dealId": "6928063",
"dealName": "Deal 1",
"responsibleName": "Ivanov Ivan",
"responsibleId": "3634981",
"contactName": "Petr Petrov",
"contactPhone": "+79221111111",
"contactId": "17675313",
"propertyId": "248301"
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Устаревший метод v3 получения списка помещений в конкретном доме
Устаревший метод v3 получения списка помещений в конкретном доме
Идентификатор ЖК
Идентификатор дома
Список помещений в доме
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"id": 10,
"house_id": 10,
"number": 606,
"rooms_amount": 3,
"section": "1",
"floor": 11,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"status": "AVAILABLE",
"price": {
"value": 3200000
},
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
},
"status_change_set": [
{
"id": "integer",
"property_id": "integer",
"previus_value": "AVAILABLE",
"current_value": "BOOKED",
"user_id": "integer",
"changed_at": {
"date": "string",
"timezone_type": "integer",
"timezone": "string"
}
}
],
"preset_id": "string",
"custom_fields": [
{
"id": "pbcf_5bdae1ed43d69",
"name": "Номер помещения для БТИ",
"value": 84
}
]
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод обновления данных в конкретном помещении
Метод обновления данных в конкретном помещении
- number: string
-
Номер
- property_type: string property, apartment, parking, office, pantry, storage, commercial_premises, free_destination
-
Тип помещения
- rooms_amount: number
-
Количество комнат
- without_layout: boolean
-
Без планировки
- studio: boolean
-
Студия
- free_layout: boolean
-
Свободная планировка
- euro_layout: boolean
-
Европланировка
- facing: string
-
Отделка
- area: Area
- price: Price
- attributes: Attributes
- custom_fields: object
- preset: PresetImage
- payment_types: string[]
-
Доступные типы оплаты (FULL - 100%, INSTALLMENT - рассрочка, MORTGAGE - ипотека)
-
string
Идентификатор помещения
Request Content-Type: application/json
Request Example
{
"number": "606",
"property_type": "property",
"rooms_amount": 3,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"facing": "Евроремонт",
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"price": {
"value": 3200000
},
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
},
"custom_fields": {
"pbcf_5d1080c8830d7": 85,
"pbcf_5d107d35cc63d": 12
},
"preset": {
"name": "№606",
"type": "url",
"data": "string"
},
"payment_types": [
"string"
]
}
Помещение с обновленными данными
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": 10,
"house_id": 10,
"number": 606,
"rooms_amount": 3,
"section": "1",
"floor": 11,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"status": "AVAILABLE",
"price": {
"value": 3200000
},
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
},
"status_change_set": [
{
"id": "integer",
"property_id": "integer",
"previus_value": "AVAILABLE",
"current_value": "BOOKED",
"user_id": "integer",
"changed_at": {
"date": "string",
"timezone_type": "integer",
"timezone": "string"
}
}
],
"preset_id": "string",
"custom_fields": [
{
"id": "pbcf_5bdae1ed43d69",
"name": "Номер помещения для БТИ",
"value": 84
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод получения списка сделок привязанных к конкретным помещениям
Метод получения списка сделок привязанных к конкретным помещениям. Требуется разрешение подключения к CRM.
Массив идентификаторов помещений
Список сделок
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"property_id": 3225935,
"deals": [
{
"crm": "bitrix",
"deal_id": 1
}
]
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод создания помещения в конкретный дом
Метод создания помещения в конкретный дом
(no description)
Request Content-Type: application/json
Request Example
{
"house_id": 1,
"number": "606",
"property_type": "property",
"rooms_amount": "3",
"section": "1",
"floor": 11,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"status": "AVAILABLE",
"price": {
"value": 3200000
},
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"layout_code": "1K42"
},
"preset": {
"name": "№606",
"type": "url",
"data": "string"
}
}
Создано помещение
Идентификатор помещения
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": 1
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод изменения статуса помещения
Метод изменения статуса помещения.
Идентификатор нового статуса (id) или текстовый идентификатор (alias)
Идентификатор помещения
Request Content-Type: application/json
Request Example
{
"status": "AVAILABLE"
}
Новый статус
Идентификатор помещения
Идентификатор нового статуса (id) или текстовой идентификатор (alias)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": 1,
"status": "AVAILABLE"
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод продления брони в конкретном помещении
Метод продления брони в конкретном помещении. Работает только при включенной опции "Получать данные из CRM".
- propertyId: integer
-
Идентификатор помещения
- date: string
-
Дата в формате Y-m-d H:i
Request Content-Type: application/json
Request Example
{
"propertyId": "777",
"date": "2021-07-21 12:00"
}
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
board
Шахматка
Метод получения шахматки дома
Метод получения шахматки дома
Идентификатор дома
Список этажей
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"floors": [
{
"number": 25,
"sections": [
{
"number": 1,
"name": "Подъезд 1",
"cells": [
{
"propertyId": 3238749
}
]
}
]
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
presets
Управление планировками
Метод получения планировок помещений с возможностью фильтрации
Метод получения планировок помещений с возможностью фильтрации
Идентификатор ЖК
Идентификаторы ЖК
Идентификаторы домов
(no description)
Возврат только заданного числа комнат
Выбирает кол-во комнат равно или более чем заданное значение. Имеет приоритет над фильтром rooms
При значении false исключит из ответа помещения без планировки
При значении false исключит студии из ответа
При значении false исключит свободные планировки из ответа
При значении false исключит европланировки из ответа. При значении true и наличии параметра rooms или roomMoreThan фильтрует европланировки по комнатности.
Отделка
Минимальная цена
Максимальная цена
Минимальная цена за квадратный метр
Максимальная цена за квадратный метр
Минимальная площадь
Максимальная площадь
Минимальная жилая площадь
Максимальная жилая площадь
Дом сдан
Срок сдачи дома (четверть)
Срок сдачи дома (год)
Специальные предложения
Статусы
ID статусов
Характеристики
Сортировка по Id проекта
смещение для паджинации
кол-во домов в ответе
Список планировок
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true,
"data": [
{
"id": "1",
"code": "193164-1",
"projectName": "Новомосковский",
"houseName": "Объект",
"houseId": 870,
"isWithoutLayout": true,
"isStudio": false,
"isEuroLayout": false,
"isFreeLayout": false,
"roomsAmount": 20,
"hidePrice": false,
"priceRange": {
"min": "860000",
"max": "860000"
},
"areaRange": {
"min": "200",
"max": "200"
},
"attachments": [
{
"id": "number",
"type": "panorama - 3d тур",
"code": "string",
"parameters": {
"url": "string",
"isEnabled": "boolean",
"uid": "string",
"type": "string"
}
}
],
"properties": [
[
"248408",
"248422"
]
],
"address": {
"full": "Екатеринбург, Ленинский район, Свердловская область",
"locality": "Екатеринбург",
"district": "Ленинский район",
"region": "Свердловская область",
"street": "Ленина",
"number": "48"
},
"image": {
"source": "https://pbXXX.profitbase.ru/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jpg",
"big": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_1200_700/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jp",
"preview": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_x_240/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jpg",
"small": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_x_240/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jpg",
"imageName": "Вид сверху"
},
"planImages": [
{
"source": "https://pbXXX.profitbase.ru/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg",
"big": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_1200_700/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg",
"preview": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_x_240/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg",
"small": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_x_240/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg",
"imageName": "Вид сверху"
}
],
"countFilteredProperty": 2
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Устаревший метод получения планировок помещений в доме
Идентификатор ЖК
Идентификатор дома
Список планировок в доме
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"id": "number",
"url": "https://pbXXX.profitbase.ru/uploads/preset/image.jpg",
"code": "string",
"attachments": [
{
"id": "number",
"type": "panorama - 3d тур",
"code": "string",
"parameters": {
"url": "string",
"isEnabled": "boolean",
"uid": "string",
"type": "string"
}
}
]
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
facade
Фасады
Метод получения списка фасадов дома
Метод получения списка фасадов дома
Ид дома
Список фасадов дома
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"id": 156,
"image": "https://pbXXX.profitbase.ru/media/cache/resolve/blurred_facade/uploads/facade/3/5c8f9023d0875.jpg",
"name": "01012002_03-1",
"areaColor": "#fa8174",
"areaOpacity": "10",
"areas": [
{
"id": 101348,
"floorNumber": 6,
"coordinates": [
[
644.42114257812,
299.79376060313
]
]
}
]
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
floor
Этажи
Метод получения планировок этажей дома
Метод получения планировок этажей дома
Ид дома
Планировки
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"id": 2170,
"number": 2,
"images": {
"source": "https://pbXXX.profitbase.ru/uploads/layout/3/5c5d4e8a70c90.jpg",
"large": "https://pbXXX.profitbase.ru/media/cache/resolve/floor_10000_10000/uploads/layout/3/5c5d4e8a70c90.jpg",
"big": "https://pbXXX.profitbase.ru/media/cache/resolve/floor_2000_2000/uploads/layout/3/5c5d4e8a70c90.jpg",
"preview": "https://pbXXX.profitbase.ru/media/cache/resolve/floor_200_w/uploads/layout/3/5c5d4e8a70c90.jpg"
},
"originalLayoutHeight": 1920,
"originalLayoutWidth": 1080,
"areas": [
{
"propertyId": 2,
"coordinates": [
{
"x": 608,
"y": 61
}
]
}
]
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
actions
Акции
crm
CRM
Метод получения списка сделок или конкретной сделки
Метод получения списка сделок или конкретной сделки. Требуется разрешение подключения к CRM. Требуется подключенное приложение "Profitbase для amoCRM" или "Profitbase для Битрикс24".
Идентификатор сделки
Сделка
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"deal": {
"id": 448303,
"name": "Сделка 1",
"status": {
"color": "#98cbff",
"name": "Уточнение потребности",
"id": "456",
"isBindedToPropertyStatus": true
},
"pipelineId": "2210374",
"manager": {
"id": 3010726,
"fullName": "manager@profitbase.ru"
},
"client": {
"id": 1343551,
"fullName": "ООО МояКомпания",
"phone": "+79111111111"
}
},
"property": {
"id": 260016,
"houseId": 1034,
"apartment_status_key": "AVAILABLE",
"fullAddress": "Екатеринбург, Свердловская область, Малышева, 71 - эт. 25 № 98"
},
"queueReserve": {
"id": 225,
"propertyId": 260016,
"rank": 1
}
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод получения списка сделок в которые добавлено конкретное помещение
Метод получения списка сделок в которые добавлено конкретное помещение. Требуется разрешение подключения к CRM. Требуется подключенное приложение "Profitbase для amoCRM" или "Profitbase для Битрикс24"
Идентификатор помещения
Сделки
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"deals": [
{
"id": 132,
"name": "Сделка ЖК",
"status": {
"color": "#99ccff",
"name": "Первичный контакт",
"id": "30953311",
"isBindedToPropertyStatus": true
},
"manager": {
"id": 53463,
"fullName": "Кирилл Александрович Гануленко"
},
"client": {
"id": 242,
"fullName": "Наталья Сергеевна",
"phone": "=70136667755"
}
}
],
"leads": [
{
"id": 132,
"name": "Сделка ЖК",
"status": {
"color": "#99ccff",
"name": "Первичный контакт",
"id": "30953311",
"isBindedToPropertyStatus": true
},
"manager": {
"id": 53463,
"fullName": "Кирилл Александрович Гануленко"
},
"client": {
"id": 242,
"fullName": "Наталья Сергеевна",
"phone": "=70136667755"
}
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод добавления помещения в сделку
Метод добавления помещения в сделку. Требуется разрешение подключения к CRM. Требуется подключенное приложение "Profitbase для amoCRM" или "Profitbase для Битрикс24".
- propertyId: integer
- dealId: integer
Request Content-Type: application/json
Request Example
{
"propertyId": 248408,
"dealId": 448303
}
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод удаления помещений из сделки
Метод удаления помещений из сделки. Требуется разрешение подключения к CRM. Требуется подключенное приложение "Profitbase для amoCRM" или "Profitbase для Битрикс24".
- dealId: integer
Request Content-Type: application/json
Request Example
{
"dealId": 448303
}
Создан дом
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод обновления полей Proftibase в сделке по помещению
Метод обновления полей Proftibase в сделке по помещению. Требуется разрешение подключения к CRM. Требуется подключенное приложение "Profitbase для amoCRM" или "Profitbase для Битрикс24".
Идентификатор сделки
Идентификатор помещения
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Метод синхронизации статуса помещения с этапом сделки CRM согласно разметке статусов приложения CRM для Profitbase
Метод синхронизации статуса помещения с этапом сделки CRM согласно разметке статусов приложения CRM для Profitbase. Требуется разрешение подключения к CRM. Требуется подключенное приложение "Profitbase для amoCRM" или "Profitbase для Битрикс24".
Идентификатор сделки
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
order
Заявки
Метод создания заявки на помещение
Метод создания заявки на помещение. Требуется разрешение подключения к CRM. Требуется подключенное приложение Смарт-каталог
- order: object
-
- name: string
- phone: string
- email: string
- apartment_id: integer
- calc_credit: integer
-
Покупка в ипотеку
- comment: string
- site_widget: integer
Request Content-Type: application/json
Request Example
{
"order": {
"name": "TEST",
"phone": "+79111111111",
"email": "test@profitbase.ru",
"apartment_id": 248408,
"calc_credit": 1,
"comment": "тестовая заявка",
"site_widget": 1
}
}
Идентификатор заявки
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"response": {
"order": 17
}
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
history
История изменения статусов
Метод получения истории изменения статусов помещений с возможностью фильтрации
Метод получения истории изменения статусов помещений с возможностью фильтрации.
У парметра property_ids приоретет выше т.е при одновременной передаче пареметров фильтрации property_ids и house_ids, пареметр house_ids учитываться не будет
- property_ids: object[]
-
Массив идентификаторов помещений
-
object - house_ids: object[]
-
Массив идентификаторов домов.
-
object
Request Content-Type: application/json
Request Example
{
"property_ids": [
3225787,
3225788
],
"house_ids": [
3225787,
3225786,
3225785
]
}
История помещения
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"response": [
{
"action": "Adding an object to a deal",
"actionKey": "ADD_PROPERTY",
"date": "1562766475",
"propertyStatus": "Free",
"propertyStatusKey": "AVAILABLE",
"dealStatus": "Первичный контакт",
"dealId": "6928063",
"dealName": "Deal 1",
"responsibleName": "Ivanov Ivan",
"responsibleId": "3634981",
"contactName": "Petr Petrov",
"contactPhone": "+79221111111",
"contactId": "17675313",
"propertyId": "248301"
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
statuses
Метод получения списка статусов для crm, или конкретного статуса по id
Метод получения списка статусов для crm, или конкретного статуса по id
Идентификатор crm (amo, bitrix)
Идентификатор кастомного статуса
Идентификатор статуса
Текстовое название статуса
Цвет в формате HEX
Базовый статус: AVAILABLE, BOOKED, UNAVAILABLE, SOLD
Базовый статус или нет
Текстовой идентификатор статуса
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"id": "12",
"name": "Временная бронь",
"color": "#63cba5",
"baseStatus": "BOOKED",
"isProtected": false,
"alias": "BOOKED_amo_5de231eb3d9fd"
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
filter
Метод для получения списка отображаемых в виджете фильтров
Метод для получения списка отображаемых в виджете фильтров
Список фильтров для виджета
Требуется авторизация
(no description)
Не найден виджет
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"name": "facing",
"view": "standard"
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Response Example (404 Not Found)
{
"error": {
"code": 404,
"message": "Not Found"
}
}
Метод для получения списка доступных отделок для отображения в фильтре по отделке
Метод для получения списка доступных отделок для отображения в фильтре по отделке
Идентификаторы домов
Cписок доступных отделок для отображения в фильтре по отделке
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true,
"data": [
"Чистовая",
"Без отделки"
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Получить характеристики для фильтра
Получить список выбираемых характеристик для фильтра виджета
Список характеристик по фильтрам виджета
Требуется авторизация
(no description)
Виджет не найден
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"filterName": "propertyNumber",
"filterSpecifications": [
"terrace",
"wardrobe"
]
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Response Example (404 Not Found)
{
"error": {
"code": 404,
"message": "Not Found"
}
}
property-specification
Метод получения списка характеристик для помещений с количеством аналогичных помещений в доме
Метод получения списка характеристик для помещений с количеством аналогичных помещений в доме
Идентификаторы помещений
Список характеристик для каждого помещения
(no description)
(no description)
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
{
"success": true,
"data": [
{
"propertyId": 3536848,
"specs": [
{
"label": "Большая прихожая",
"image": "string",
"description": "string",
"countAtHome": "integer"
}
]
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Получить список всех характеристик
Получить список характеристик для помещений на аккаунте
Список характеристик
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"alias": "sunny-side",
"label": "Солнечная сторона",
"image": "string",
"description": "string"
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Получить характеристики по дому
Получить список характеристик помещений по дому
Идентификатор дома
Список характеристик по дому
Требуется авторизация
(no description)
Дом не найден
(no description)
Переданы некорректные данные
Response Content-Type: application/json
Response Example (200 OK)
[
{
"propertyIds": [
1,
2,
3
],
"alias": "sunny-side",
"label": "Солнечная сторона",
"image": "string",
"description": "string"
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Response Example (404 Not Found)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Response Example (422 Unprocessable Entity)
[
"string"
]
render
Метод получения списка генпланов
Метод получения списка генпланов
Ид ЖК
Список генпланов
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"id": 156,
"image": "https://pbXXX.profitbase.ru/media/cache/resolve/blurred_render/uploads/render/3/5c8f9023d0875.jpg",
"name": "01012002_03-1",
"projectId": 14543,
"index": 3,
"areaColor": "#fa8174",
"areaOpacity": 10,
"areas": [
{
"id": 101348,
"coordinates": [
[
644.42114257812,
299.79376060313
]
]
}
]
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
special-offer
Метод получения списка активных акции со списком помещений по каждой акции
Метод получения списка активных акции со списком помещений по каждой акции
Список акций
Требуется авторизация
(no description)
Response Content-Type: application/json
Response Example (200 OK)
[
{
"id": 2170,
"name": "Акция 1",
"archive": false,
"color": "#fa8174",
"description": "Описсание",
"descriptionActive": false,
"startDate": {
"date": "2019-02-01 00:00:00.000000",
"timezone_type": "3",
"timezone": "Asia/Yekaterinburg"
},
"finishDate": {
"date": "2019-02-25 00:00:00.000000",
"timezone_type": "3",
"timezone": "Asia/Yekaterinburg"
},
"badge": {
"icon": "percent",
"label": "Акция"
},
"banner": {
"active": true,
"text": "Текст баннера",
"buttonText": "Забронировать"
},
"discount": {
"active": true,
"type": "FULL_PRICE",
"unit": "PERCENT",
"value": 10,
"description": "Установлена скидка -10% от полной стоимости",
"humanizedType": "от полной стоимости",
"humanizedUnit": "%"
},
"propertyIds": [
3244361,
3244364
]
}
]
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
stock-version
Получить изменения по версиям
Получить список изменений в параметрах помещений по версиям
(no description)
Request Content-Type: application/json
Request Example
{
"ids": [
12345,
12346
],
"fields": [
"price",
"status"
]
}
Список изменений
Требуется авторизация
(no description)
Доступ запрещен
Ошибка валидации данных
Response Content-Type: application/json
Response Example (200 OK)
{
"versions": [
{
"id": 12345,
"diffs": [
{
"propertyId": 12345,
"field": "price",
"prevValue": "2000000",
"value": "2500000"
}
]
}
]
}
Response Example (401 Unauthorized)
{
"error": {
"code": 401,
"message": "Unauthorized"
}
}
Response Example (403 Forbidden)
{
"message": "Something failed."
}
Response Example (422 Unprocessable Entity)
{
"errors": [
{
"property": "ids",
"message": "You must specify at least one version ID."
}
],
"message": "Something failed."
}
Schema Definitions
Error:
- code: integer (int32)
-
Class APIBundle
- message: string
-
Class APIBundle
Example
{
"code": 401,
"message": "Unauthorized"
}
CrmDeal: object
- id: integer
- name: string
- status: object
-
- color: string
- name: string
- id: string
- isBindedToPropertyStatus: boolean
-
Сопоставлен ли статус CRM со статусом помещения
- manager: object
-
- id: integer
- fullName: string
- client: object
-
- id: integer
- fullName: string
- phone: string
Example
{
"id": 132,
"name": "Сделка ЖК",
"status": {
"color": "#99ccff",
"name": "Первичный контакт",
"id": "30953311",
"isBindedToPropertyStatus": true
},
"manager": {
"id": 53463,
"fullName": "Кирилл Александрович Гануленко"
},
"client": {
"id": 242,
"fullName": "Наталья Сергеевна",
"phone": "=70136667755"
}
}
CustomStatus: object
- id: integer
-
Идентификатор статуса
- name: string
-
Текстовое название статуса
- color: string
-
Цвет в формате HEX
- baseStatus: string AVAILABLE, BOOKED, UNAVAILABLE, SOLD
-
Базовый статус: AVAILABLE, BOOKED, UNAVAILABLE, SOLD
- isProtected: boolean
-
Базовый статус или нет
- alias: string
-
Текстовой идентификатор статуса
Example
{
"id": 1,
"name": "Свободно",
"color": "#63cba5",
"baseStatus": "AVAILABLE",
"isProtected": "true",
"alias": "BOOKED_amo_5de231eb3d9fd"
}
FilterResponse: object
- name: string
-
Название
- view: string
-
Вид
Example
{
"name": "facing",
"view": "standard"
}
FilterPropertySpecificationResponse: object
- filterName: string
-
Название фильтра
- filterSpecifications: string[]
-
Характеристики фильтра
-
string
Example
{
"filterName": "propertyNumber",
"filterSpecifications": [
"terrace",
"wardrobe"
]
}
NotFoundError:
- code: integer (int32)
- message: string
Example
{
"code": 404,
"message": "Not Found"
}
HouseResponse:
- id: integer
- type: string APARTMENT, OFFICE, PARKING, RESIDENTIAL
-
Тип строения
Example
{
"projectId": 1,
"projectName": "Новомосковский",
"title": "Корпус 1",
"street": "Краснолесья",
"number": "71А",
"facing": "Чистовая",
"material": "Монолит",
"buildingState": "BUILT",
"developmentStartQuarter": {
"year": 2015,
"quarter": 1
},
"developmentEndQuarter": {
"year": 2015,
"quarter": 1
},
"salesStart": {
"month": "02",
"year": "2018"
},
"salesEnd": {
"month": "02",
"year": "2018"
},
"id": 10,
"type": "APARTMENT"
}
GetHouse: object
- projectId: integer
-
Идентификатор ЖК
- projectName: string
-
Название ЖК
- title: string
-
Название
- street: string
-
Улица
- number: string
-
Номер
- facing: string
-
Отделка
- material: string
-
Материал
- buildingState: string UNFINISHED, BUILT, HAND-OVER
-
Стадия строительства
- developmentStartQuarter: developmentQuarter
- developmentEndQuarter: developmentQuarter
- salesStart: salesPeriod
- salesEnd: salesPeriod
Example
{
"projectId": 1,
"projectName": "Новомосковский",
"title": "Корпус 1",
"street": "Краснолесья",
"number": "71А",
"facing": "Чистовая",
"material": "Монолит",
"buildingState": "BUILT",
"developmentStartQuarter": {
"year": 2015,
"quarter": 1
},
"developmentEndQuarter": {
"year": 2015,
"quarter": 1
},
"salesStart": {
"month": "02",
"year": "2018"
},
"salesEnd": {
"month": "02",
"year": "2018"
}
}
HouseImage: object
- name: string
- type: string base64, url
-
Тип вложения
- data: string
Example
{
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
}
House: object
- project_id: integer
-
Идентификатор ЖК
- title: string
-
Название
- street: string
-
Улица
- number: string
-
Номер
- facing: string
-
Отделка
- material: string
-
Материал
- building_state: string UNFINISHED, BUILT, HAND-OVER
-
Стадия строительства
- developmentStartQuarter: developmentQuarter
- developmentEndQuarter: developmentQuarter
- image: HouseImage
Example
{
"project_id": 1,
"title": "Корпус 1",
"street": "Краснолесья",
"number": "71А",
"facing": "Чистовая",
"material": "Монолит",
"building_state": "BUILT",
"developmentStartQuarter": {
"year": 2015,
"quarter": 1
},
"developmentEndQuarter": {
"year": 2015,
"quarter": 1
},
"image": {
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
}
}
HouseSearchResponse: object
- id: integer
-
Идентификатор дома
- name: string
-
Название
- address: string
-
Полный адрес
- developer: string
-
Название застройщика
Example
{
"id": 1,
"name": "Корпус 1",
"address": "Екатеринбург, Свердловская область, Краснолесья, 71А",
"developer": "Солнечный ключ"
}
Preset: object
- id: number
-
Class PresetController
- url: string
-
Class PresetController
- code: string
-
Код планировки
- attachments: PresetAttachments
-
Class PresetController
-
PresetAttachments
Example
{
"id": "number",
"url": "https://pbXXX.profitbase.ru/uploads/preset/image.jpg",
"code": "string",
"attachments": [
{
"id": "number",
"type": "panorama - 3d тур",
"code": "string",
"parameters": {
"url": "string",
"isEnabled": "boolean",
"uid": "string",
"type": "string"
}
}
]
}
PresetAttachments: object
Дополнительное отображение планировки
- id: number
-
Class PresetController
- type: string
-
Способ отображения
- code: string
-
Код планировки
- parameters: object
-
Набор параметров отображения
-
- url: string
-
Url адрес 3d тура
- isEnabled: boolean
-
Признак активности представления в Profitbase
- uid: string
-
Class PresetController
- type: string
-
Название сервиса-конструктора 3D тура
Example
{
"id": "number",
"type": "panorama - 3d тур",
"code": "string",
"parameters": {
"url": "string",
"isEnabled": "boolean",
"uid": "string",
"type": "string"
}
}
PresetResponse: object
- id: integer
-
Class PresetController
- code: string
-
Class PresetController
- projectName: string
-
Class PresetController
- houseName: string
-
Class PresetController
- houseId: integer
-
Class PresetController
- isWithoutLayout: boolean
-
Class PresetController
- isStudio: boolean
-
Class PresetController
- isEuroLayout: boolean
-
Class PresetController
- isFreeLayout: boolean
-
Class PresetController
- roomsAmount: integer
-
Class PresetController
- hidePrice: boolean
-
Class PresetController
- priceRange: object
-
Class PresetController
-
- min: number
-
Class PresetController
- max: number
-
Class PresetController
- areaRange: object
-
Class PresetController
-
- min: number
-
Class PresetController
- max: number
-
Class PresetController
- attachments: PresetAttachments
-
Class PresetController
-
PresetAttachments - properties: integer[]
-
Class PresetController
-
integer - address: object
-
Class PresetController
-
- full: string
-
Class PresetController
- locality: string
-
Class PresetController
- district: string
-
Class PresetController
- region: string
-
Class PresetController
- street: string
-
Class PresetController
- number: string
-
Class PresetController
- image: object
-
Содержит основное изображение планировки
-
- source: string
-
Class PresetController
- big: string
-
Class PresetController
- preview: string
-
Class PresetController
- small: string
-
Class PresetController
- imageName: string
-
Class PresetController
- planImages: object[]
-
Содержит все изображения планировки, включая основное
-
object - source: string
-
Class PresetController
- big: string
-
Class PresetController
- preview: string
-
Class PresetController
- small: string
-
Class PresetController
- imageName: string
-
Class PresetController
- countFilteredProperty: integer
-
Class PresetController
Example
{
"id": "1",
"code": "193164-1",
"projectName": "Новомосковский",
"houseName": "Объект",
"houseId": 870,
"isWithoutLayout": true,
"isStudio": false,
"isEuroLayout": false,
"isFreeLayout": false,
"roomsAmount": 20,
"hidePrice": false,
"priceRange": {
"min": "860000",
"max": "860000"
},
"areaRange": {
"min": "200",
"max": "200"
},
"attachments": [
{
"id": "number",
"type": "panorama - 3d тур",
"code": "string",
"parameters": {
"url": "string",
"isEnabled": "boolean",
"uid": "string",
"type": "string"
}
}
],
"properties": [
[
"248408",
"248422"
]
],
"address": {
"full": "Екатеринбург, Ленинский район, Свердловская область",
"locality": "Екатеринбург",
"district": "Ленинский район",
"region": "Свердловская область",
"street": "Ленина",
"number": "48"
},
"image": {
"source": "https://pbXXX.profitbase.ru/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jpg",
"big": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_1200_700/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jp",
"preview": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_x_240/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jpg",
"small": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_x_240/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jpg",
"imageName": "Вид сверху"
},
"planImages": [
{
"source": "https://pbXXX.profitbase.ru/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg",
"big": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_1200_700/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg",
"preview": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_x_240/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg",
"small": "https://pbXXX.profitbase.ru/media/cache/resolve/apartment_x_240/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg",
"imageName": "Вид сверху"
}
],
"countFilteredProperty": 2
}
ProjectResponse:
- id: integer
-
Class ProjectController
Example
{
"title": "Новомосковский",
"type": "complex",
"region": "Свердловская область",
"district": "Ленинский район",
"currency": "RUB",
"locality": "Екатеринбург",
"developer": "СтройСуперЗастрой",
"developer_brand": "СтройСуперЗастрой",
"banks": "Ребсбанк",
"image": {
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
},
"id": 10
}
Project: object
- title: string
-
Название
- type: string complex, district, quarter
-
Тип комплекса: ЖК, Район, Квартал
- region: string
-
Регион
- district: string
-
Район
- currency: string RUB, UAH, EUR, KZT, USD
-
Валюта
- locality: string
-
Населенный пункт
- developer: string
-
Застройщик (Поле устаревшее)
- developer_brand: string
-
Бренд застройщика
- banks: string
-
Аккредитованные банки
- image: ProjectImage
-
Class ProjectController
Example
{
"title": "Новомосковский",
"type": "complex",
"region": "Свердловская область",
"district": "Ленинский район",
"currency": "RUB",
"locality": "Екатеринбург",
"developer": "СтройСуперЗастрой",
"developer_brand": "СтройСуперЗастрой",
"banks": "Ребсбанк",
"image": {
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
}
}
ProjectImage: object
- name: string
-
Class ProjectController
- type: string base64, url
-
Тип вложения
- data: string
-
Class ProjectController
Example
{
"name": "Дом.jpg",
"type": "url",
"data": "https://m-files-new.cdnvideo.ru/lpfile/2/e/2/2e2d974a3a129c42761d7ec906be1a72.png"
}
ProjectsSearchResponse: object
- id: integer
-
Идентификатор ЖК
- name: string
-
Название ЖК
- location: string
-
Город
- district: string
-
Район
- developer: string
-
Название застройщика
Example
{
"id": 1,
"name": "ЖК Солнечный",
"location": "Екатеринбург",
"district": "Ленинский район",
"developer": "Солнечный ключ"
}
Property: object
- house_id: integer
-
Идентификатор дома
- number: string
-
Номер
- property_type: string property, apartment, parking, office, pantry, storage, commercial_premises, free_destination
-
Тип помещения (по умолчанию property)
- rooms_amount: integer
-
Количество комнат
- section: string
-
Подъезд
- floor: integer
-
Этаж
- without_layout: boolean
-
Без планировки
- studio: boolean
-
Студия
- free_layout: boolean
-
Свободная планировка
- euro_layout: boolean
-
Европланировка
- area: Area
-
Class PropertyController
- status: string AVAILABLE, BOOKED, EXECUTION, SOLD
-
Статус, AVAILABLE, BOOKED, EXECUTION, SOLD
- development_start_quarter: developmentQuarter
-
Class PropertyController
- price: Price
-
Class PropertyController
- sales_start: salesPeriod
-
Class PropertyController
- attributes: Attributes
-
Class PropertyController
Example
{
"house_id": 1,
"number": "606",
"property_type": "property",
"rooms_amount": "3",
"section": "1",
"floor": 11,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"status": "AVAILABLE",
"development_start_quarter": {
"year": 2015,
"quarter": 1
},
"price": {
"value": 3200000
},
"sales_start": {
"month": "02",
"year": "2018"
},
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
}
}
PropertyBodyParameter: object
- house_id: integer
-
Идентификатор дома
- number: string
-
Номер
- property_type: string property, apartment, parking, office, pantry, storage, commercial_premises, free_destination
-
Тип помещения (по умолчанию property)
- rooms_amount: integer
-
Количество комнат
- section: string
-
Подъезд
- floor: integer
-
Этаж
- without_layout: boolean
-
Без планировки
- studio: boolean
-
Студия
- free_layout: boolean
-
Свободная планировка
- euro_layout: boolean
-
Европланировка
- area: Area
-
Class PropertyController
- status: string AVAILABLE, BOOKED, EXECUTION, UNAVAILABLE, SOLD
-
Статус, AVAILABLE, BOOKED, EXECUTION, UNAVAILABLE, SOLD
- price: Price
-
Class PropertyController
- attributes: object
-
Class PropertyController
-
- loggia_count: integer
-
Количество лоджий
- balcony_count: integer
-
Количество балконов
- combined_bathroom_count: integer
-
Количество совмещенных санузлов
- separated_bathroom_count: integer
-
Количество раздельных санузлов
- position_on_floor: integer
-
Окна выходят
- description: string
-
Описание помещения
- layout_code: string
-
Код планировки
- preset: PresetImage
-
Class PropertyController
Example
{
"house_id": 1,
"number": "606",
"property_type": "property",
"rooms_amount": "3",
"section": "1",
"floor": 11,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"status": "AVAILABLE",
"price": {
"value": 3200000
},
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"layout_code": "1K42"
},
"preset": {
"name": "№606",
"type": "url",
"data": "string"
}
}
Area: object
- area_total: number
-
Общая площадь
- area_estimated: number
-
Площадь расчетная
- area_living: number
-
Площадь жилая
- area_kitchen: number
-
Площадь кухни
Example
{
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
}
Attributes: object
- loggia_count: integer
-
Количество лоджий
- balcony_count: integer
-
Количество балконов
- combined_bathroom_count: integer
-
Количество совмещенных санузлов
- separated_bathroom_count: integer
-
Количество раздельных санузлов
- bti_number: string
-
Номер по БТИ
- window_view: string
-
Номер по БТИ
- position_on_floor: integer
-
Окна выходят
- description: string
-
Описание помещения
- code: string
-
Код планировки
Example
{
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
}
PropertyResponse:
- id: integer
-
Class PropertyController
- house_id: integer
-
Идентификатор дома
- number: string
-
Номер
- rooms_amount: number
-
Количество комнат
- section: string
-
Подъезд
- floor: number
-
Этаж
- without_layout: boolean
-
Без плаинровки
- studio: boolean
-
Студия
- free_layout: boolean
-
Свободная планировка
- euro_layout: boolean
-
Европланировка
- area: Area
-
Class PropertyController
- status: string AVAILABLE, BOOKED, EXECUTION, UNAVAILABLE, SOLD
-
Class PropertyController
- price: Price
-
Class PropertyController
- attributes: Attributes
-
Class PropertyController
- status_change_set: StatusChangeLogRecord
-
Статус, AVAILABLE, BOOKED, EXECUTION, UNAVAILABLE, SOLD
-
StatusChangeLogRecord - preset_id: string
-
url адрес планировки
- custom_fields: object[]
-
Class PropertyController
-
object Запись о смене статуса помещения
- id: string
-
Class PropertyController
- name: string
-
Class PropertyController
- value: number
-
Class PropertyController
Example
{
"id": 10,
"house_id": 10,
"number": 606,
"rooms_amount": 3,
"section": "1",
"floor": 11,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"status": "AVAILABLE",
"price": {
"value": 3200000
},
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
},
"status_change_set": [
{
"id": "integer",
"property_id": "integer",
"previus_value": "AVAILABLE",
"current_value": "BOOKED",
"user_id": "integer",
"changed_at": {
"date": "string",
"timezone_type": "integer",
"timezone": "string"
}
}
],
"preset_id": "string",
"custom_fields": [
{
"id": "pbcf_5bdae1ed43d69",
"name": "Номер помещения для БТИ",
"value": 84
}
]
}
PropertyFullResponse:
- id: integer
-
Class PropertyController
- house_id: integer
-
Идентификатор дома
- number: string
-
Номер
- rooms_amount: number
-
Количество комнат
- floor: number
-
Этаж
- without_layout: boolean
-
Без планировки
- studio: boolean
-
Студия
- free_layout: boolean
-
Свободная планировка
- euro_layout: boolean
-
Европланировка
- propertyType: string
-
Тип помещения
- typePurpose: string
-
Тип недвижимости
- area: Area
-
Class PropertyController
- houseName: string
-
Дом 1
- sectionName: string
-
2й подъезд
- projectName: string
-
ЖК Сверистелькино
- specialOffers: integer[]
-
Class PropertyController
-
integer - address: string
-
эт. 1 № 18
- section: string
-
2й подъезд
- attributes: Attributes
-
Class PropertyController
- custom_fields: Field
-
Class PropertyController
-
Field - status: string AVAILABLE, BOOKED, EXECUTION, UNAVAILABLE, SOLD
-
Class PropertyController
- price: Price
-
Class PropertyController
Example
{
"id": 10,
"house_id": 10,
"number": 606,
"rooms_amount": 3,
"floor": 11,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"propertyType": "property",
"typePurpose": "residential",
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"houseName": "1",
"sectionName": "1",
"projectName": "1",
"specialOffers": [
23,
45
],
"address": "1",
"section": "1",
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
},
"custom_fields": [
{
"id": 1,
"key": "pbcf_5c5bfff299292",
"name": "Номер помещения для БТИ",
"type": "text"
}
],
"status": "AVAILABLE",
"price": {
"value": 3200000
}
}
StatusChangeLogRecord: object
Запись о смене статуса помещения
- id: integer
-
Class PropertyController
- property_id: integer
-
Идентификатор помещения
- previus_value: string
-
Предыдущее значение
- current_value: string
-
Новое значение
- user_id: integer
-
Идентификатор пользователя сменивший статус
- changed_at: object
-
Дата изменения статуса
-
- date: string
-
Дата и время
- timezone_type: integer
-
Class PropertyController
- timezone: string
-
Часовой пояс
Example
{
"id": "integer",
"property_id": "integer",
"previus_value": "AVAILABLE",
"current_value": "BOOKED",
"user_id": "integer",
"changed_at": {
"date": "string",
"timezone_type": "integer",
"timezone": "string"
}
}
Status: object
- status: string AVAILABLE, BOOKED, EXECUTION, UNAVAILABLE, SOLD
-
Class PropertyController
Example
{
"status": "AVAILABLE"
}
Field: object
- id: integer
-
Class PropertyController
- key: string
-
Class PropertyController
- name: string
-
Class PropertyController
- type: string
-
Class PropertyController
Example
{
"id": 1,
"key": "pbcf_5c5bfff299292",
"name": "Номер помещения для БТИ",
"type": "text"
}
CustomField: object
- id: integer
-
Class PropertyController
- key: string
-
Class PropertyController
- name: string
-
Class PropertyController
- rank: integer
-
Class PropertyController
- type: string
-
Class PropertyController
- specificationName: string
-
Class PropertyController
Example
{
"id": 1,
"key": "pbcf_5c5bfff299292",
"name": "Номер помещения для БТИ",
"rank": "1",
"type": "text",
"specificationName": "kitchen-living-room"
}
SystemField: object
- id: integer
-
Class PropertyController
- key: string
-
Class PropertyController
- name: string
-
Class PropertyController
- rank: integer
-
Class PropertyController
- type: string
-
Class PropertyController
- specificationName: string
-
Class PropertyController
Example
{
"id": 146248,
"key": "id",
"name": "ID помещения",
"rank": "2",
"type": "text",
"specificationName": "null"
}
Property_new: object
- id: integer
-
Class PropertyController
- house_id: integer
-
Class PropertyController
- number: string
-
Class PropertyController
- rooms_amount: integer
-
Class PropertyController
- floor: integer
-
Class PropertyController
- without_layout: boolean
-
Class PropertyController
- studio: boolean
-
Class PropertyController
- free_layout: boolean
-
Class PropertyController
- euro_layout: boolean
-
Class PropertyController
- propertyType: string
-
Class PropertyController
- typePurpose: string
-
Class PropertyController
- area: Area
-
Class PropertyController
- houseName: string
-
Class PropertyController
- sectionName: string
-
Class PropertyController
- projectName: string
-
Class PropertyController
- specialOffers: SpecialOffers
-
Class PropertyController
-
SpecialOffers - address: string
-
Class PropertyController
- section: string
-
Class PropertyController
- preset: string
-
Содержит основное изображение планировки
- externalId: string
-
Class PropertyController
- attachments: PresetAttachments
-
Class PropertyController
-
PresetAttachments - planImages: object[]
-
Содержит все изображения планировки, включая основное
-
object - image_name: string
-
Class PropertyController
- source: string
-
Class PropertyController
- attributes: Attributes
-
Class PropertyController
- custom_fields: object[]
-
Class PropertyController
-
object - id: string
-
Class PropertyController
- name: string
-
Class PropertyController
- value: string
-
Class PropertyController
- price: Price
-
Class PropertyController
- status: string
-
Class PropertyController
- responsibleName: string
-
Class PropertyController
- responsibleId: string
-
Class PropertyController
- crmContactName: string
-
Class PropertyController
- crmContactId: string
-
Class PropertyController
- countHistoryRecord: string
-
Class PropertyController
- countDeals: integer
-
Class PropertyController
- bookedUntilDate: string
-
Class PropertyController
Example
{
"id": 248408,
"house_id": 873,
"number": "1",
"rooms_amount": 200,
"floor": 2,
"without_layout": false,
"studio": false,
"free_layout": false,
"euro_layout": false,
"propertyType": "property",
"typePurpose": "residential",
"area": {
"area_total": 60.2,
"area_estimated": 60.2,
"area_living": 60.2,
"area_kitchen": 60.2
},
"houseName": "Дом 1",
"sectionName": "Подъезд 14",
"projectName": "Новомосковский",
"specialOffers": [
{
"id": 2170,
"name": "Акция 1",
"archive": false,
"color": "#fa8174",
"description": "Описсание",
"descriptionActive": false,
"startDate": {
"date": "2019-02-01 00:00:00.000000",
"timezone_type": "3",
"timezone": "Asia/Yekaterinburg"
},
"finishDate": {
"date": "2019-02-25 00:00:00.000000",
"timezone_type": "3",
"timezone": "Asia/Yekaterinburg"
},
"badge": {
"icon": "percent",
"label": "Акция"
},
"banner": {
"active": true,
"text": "Текст баннера",
"buttonText": "Забронировать"
},
"discount": {
"active": true,
"type": "FULL_PRICE",
"unit": "PERCENT",
"value": 10,
"description": "Установлена скидка -10% от полной стоимости",
"humanizedType": "от полной стоимости",
"humanizedUnit": "%"
},
"propertyIds": [
3244361,
3244364
]
}
],
"address": "Екатеринбург, Ленинский район, Свердловская область - эт. 2 № 1",
"section": "Подъезд 14",
"preset": "https://pbXXX.profitbase.ru/uploads/preset/3/07cfa5704b48d25e0ba50a52d4c1a414.jpg",
"externalId": "dp-1488",
"attachments": [
{
"id": "number",
"type": "panorama - 3d тур",
"code": "string",
"parameters": {
"url": "string",
"isEnabled": "boolean",
"uid": "string",
"type": "string"
}
}
],
"planImages": [
{
"image_name": "Вид второго этажа",
"source": "https://pbXXX.profitbase.ru/uploads/preset/3/77b904fc0df6b19ca00372c4298103c1.jpg"
}
],
"attributes": {
"loggia_count": 1,
"balcony_count": 1,
"combined_bathroom_count": 1,
"separated_bathroom_count": 0,
"bti_number": "1",
"window_view": "1",
"position_on_floor": 1,
"description": "Самая лучшая квартира на этаже",
"code": "1K42"
},
"custom_fields": [
{
"id": "pbcf_5c5bfff299292",
"name": "Номер помещения для БТИ",
"value": "4353435"
}
],
"price": {
"value": 3200000
},
"status": "BOOKED",
"responsibleName": "Test",
"responsibleId": "2",
"crmContactName": "contact@amo.ru",
"crmContactId": "1",
"countHistoryRecord": "0",
"countDeals": 0,
"bookedUntilDate": "string"
}
PresetImage: object
Изображение планировки
- name: string
-
Название планировки, поле обязательное для типов base64 и url
- type: string base64, url, preset
-
Тип изображения
- data: string
-
Данные в зависимости от типа
Example
{
"name": "№606",
"type": "url",
"data": "string"
}
PropertySpecificationsResponse: object
- propertyId: integer
- specs: object[]
-
object - label: string
-
Название характеристики
- image: string
-
Ссылка на изображение
- description: string
-
Описание характеристики
- countAtHome: integer
-
Количество помещений в доме с такой же характеристикой
Example
{
"propertyId": 3536848,
"specs": [
{
"label": "Большая прихожая",
"image": "string",
"description": "string",
"countAtHome": "integer"
}
]
}
PropertySpecificationsListResponse: object
- alias: string
-
Псевдоним характеристики
- label: string
-
Название характеристики
- image: string
-
Ссылка на изображение характеримтики
- description: string
-
Описание характеристики
Example
{
"alias": "sunny-side",
"label": "Солнечная сторона",
"image": "string",
"description": "string"
}
PropertySpecificationHouseListResponse:
- propertyIds: integer[]
-
Идентификаторы помещений
-
integer
Example
{
"propertyIds": [
1,
2,
3
],
"alias": "sunny-side",
"label": "Солнечная сторона",
"image": "string",
"description": "string"
}
SpecialOffers: object
- id: integer
-
Class SpecialOfferController
- name: string
-
Class SpecialOfferController
- archive: boolean
-
Class SpecialOfferController
- color: string
-
Class SpecialOfferController
- description: string
-
Class SpecialOfferController
- descriptionActive: boolean
-
Class SpecialOfferController
- startDate: object
-
Class SpecialOfferController
-
- date: string
-
Class SpecialOfferController
- timezone_type: integer
-
Class SpecialOfferController
- timezone: string
-
Class SpecialOfferController
- finishDate: object
-
Class SpecialOfferController
-
- date: string
-
Class SpecialOfferController
- timezone_type: integer
-
Class SpecialOfferController
- timezone: string
-
Class SpecialOfferController
- badge: object
-
Class SpecialOfferController
-
- icon: string
-
Class SpecialOfferController
- label: string
-
Class SpecialOfferController
- banner: object
-
Class SpecialOfferController
-
- active: boolean
-
Class SpecialOfferController
- text: string
-
Class SpecialOfferController
- buttonText: string
-
Class SpecialOfferController
- discount: object
-
Class SpecialOfferController
-
- active: boolean
-
Class SpecialOfferController
- type: string
-
Class SpecialOfferController
- unit: string
-
Class SpecialOfferController
- value: integer
-
Class SpecialOfferController
- description: string
-
Class SpecialOfferController
- humanizedType: string
-
Class SpecialOfferController
- humanizedUnit: string
-
Class SpecialOfferController
- propertyIds: integer[]
-
Class SpecialOfferController
-
integer
Example
{
"id": 2170,
"name": "Акция 1",
"archive": false,
"color": "#fa8174",
"description": "Описсание",
"descriptionActive": false,
"startDate": {
"date": "2019-02-01 00:00:00.000000",
"timezone_type": "3",
"timezone": "Asia/Yekaterinburg"
},
"finishDate": {
"date": "2019-02-25 00:00:00.000000",
"timezone_type": "3",
"timezone": "Asia/Yekaterinburg"
},
"badge": {
"icon": "percent",
"label": "Акция"
},
"banner": {
"active": true,
"text": "Текст баннера",
"buttonText": "Забронировать"
},
"discount": {
"active": true,
"type": "FULL_PRICE",
"unit": "PERCENT",
"value": 10,
"description": "Установлена скидка -10% от полной стоимости",
"humanizedType": "от полной стоимости",
"humanizedUnit": "%"
},
"propertyIds": [
3244361,
3244364
]
}
GetDiffsByVersionsParameter: object
- ids: integer[]
-
Список ID версий
-
integer - fields: string[]
-
Список полей изменений
-
string
Example
{
"ids": [
12345,
12346
],
"fields": [
"price",
"status"
]
}
GetDiffsByVersionsVersion: object
Example
{
"versions": [
{
"id": 12345,
"diffs": [
{
"propertyId": 12345,
"field": "price",
"prevValue": "2000000",
"value": "2500000"
}
]
}
]
}
GetDiffsByVersionsVersions: object
- id: integer
-
ID версии
- diffs: GetDiffsByVersionsDiff
-
GetDiffsByVersionsDiff
Example
{
"id": 12345,
"diffs": [
{
"propertyId": 12345,
"field": "price",
"prevValue": "2000000",
"value": "2500000"
}
]
}
GetDiffsByVersionsDiff: object
- propertyId: integer
-
ID помещения
- field: string
-
Изменившееся поле
- prevValue: string
-
Предыдущее значене поля. Может быть null.
- value: string
-
Новое значение поля. Может быть null.
Example
{
"propertyId": 12345,
"field": "price",
"prevValue": "2000000",
"value": "2500000"
}
StockVersionsError: object
- message: string
-
Сообщение ошибки
Example
{
"message": "Something failed."
}
StockVersionsValidationErrors:
- errors: StockVersionsValidationErrorsError
-
Список ошибок
-
StockVersionsValidationErrorsError
Example
{
"errors": [
{
"property": "ids",
"message": "You must specify at least one version ID."
}
],
"message": "Something failed."
}