API docs by Redocly

API Stock service (v0.3.4)

Download OpenAPI specification:

Projects

API проектов

Создать новый проект

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Идентификатор 1С

title
required
string <= 255 characters

Название проекта

region
required
string <uuid>

Идентификатор региона (reference-service)

developer
string <uuid>

Идентификатор застройщика (reference-service)

site_url
string <uri> <= 255 characters

Ссылка на сайт проекта

geolocation
Array of numbers <float> = 2 items [ items <float > ]

Геолокация проекта [широта, долгота]

description
string

Описание проекта

Array of objects (FileDto)
sort
integer >= 0
Default: 500

Сортировка

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "ЖК Солнечный",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "developer": "df9ac066-2abd-4ef2-83a4-e431f1dffbad",
  • "site_url": "https://example.com/project",
  • "geolocation": [
    ],
  • "description": "Проект жилого комплекса с развитой инфраструктурой...",
  • "files": [
    ],
  • "sort": 500
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить список проектов

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterProjectsDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить проект

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Идентификатор проекта

active
boolean

Активность

title
string <= 255 characters

Название проекта

developer
string <uuid>

Идентификатор застройщика (reference-service)

site_url
string <uri> <= 255 characters

Ссылка на сайт проекта

geolocation
Array of numbers <float> = 2 items [ items <float > ]

Геолокация проекта [широта, долгота]

description
string

Описание проекта

Array of objects (FileDto)
sort
integer >= 0
Default: 500

Сортировка

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "title": "ЖК Солнечный",
  • "developer": "df9ac066-2abd-4ef2-83a4-e431f1dffbad",
  • "site_url": "https://example.com/project",
  • "geolocation": [
    ],
  • "description": "Проект жилого комплекса с развитой инфраструктурой...",
  • "files": [
    ],
  • "sort": 500
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить проект (soft delete)

Authorizations:
Bearer
path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}

Houses

API домов

Создать новый дом

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Идентификатор 1С

project
required
string <uuid>

Идентификатор проекта

title
required
string <= 255 characters

Название дома/литера

short_title
string <= 50 characters

Короткое название дома/литера

object (AddressDto)
Array of objects (FileDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "title": "Литер 1",
  • "short_title": "Литер 1",
  • "address": {
    },
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить список домов

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterHousesDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить дом

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

active
boolean

Активность

title
string <= 255 characters

Название дома/литера

short_title
string <= 50 characters

Короткое название дома/литера

object (AddressDto)
Array of objects (FileDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "title": "Литер 1",
  • "short_title": "Литер 1",
  • "address": {
    },
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить дом (soft delete)

Authorizations:
Bearer
path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}

Construction Objects

API объектов строительства

Создать новый объект строительства

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Идентификатор 1С

title
required
string <= 255 characters
house
required
string <uuid>

Идентификатор дома

object (ObjectDevelopmentDateDto)
object (ObjectDevelopmentDateDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "Жилой комплекс Солнечный",
  • "house": "9db7b961-0525-428d-a3d3-65ea4393c911",
  • "development_start": {
    },
  • "development_end": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить список объектов строительства

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterConstructionObjectsDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить объект

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

active
boolean

Активность

title
string <= 255 characters

Название

object (ObjectDevelopmentDateDto)
object (ObjectDevelopmentDateDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "title": "Жилой комплекс Солнечный",
  • "development_start": {
    },
  • "development_end": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить объект (soft delete)

Authorizations:
Bearer
path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}

Units

API единиц недвижимости

Создать единицу недвижиости

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор

construction_object
required
string <uuid>

Идентификатор объекта строительства

type
required
string
Enum: "UNIT_TYPE_APARTMENT" "UNIT_TYPE_OFFICE" "UNIT_TYPE_PARKING" "UNIT_TYPE_PANTRY" "UNIT_TYPE_ROOM"

Тип единицы строительства

required
object (UnitPositionVo)
object (UnitRoomOptionsVo)
required
object (UnitAreaDto)
bti_area
number <double>

Площадь БТИ

object (UnitAttributesDto)
layout
string <uuid>

Первичный ключ, идентификатор

Array of objects (FileDto)
dynamic_attributes
object

Ключ - значение

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "construction_object": "f9f7639b-3ecf-4ab3-ab3a-59f57ed2aede",
  • "type": "UNIT_TYPE_APARTMENT",
  • "position": {
    },
  • "room": {
    },
  • "area": {
    },
  • "bti_area": 75.5,
  • "attributes": {
    },
  • "layout": "be13f3ef-2122-4325-a977-7865d1b44432",
  • "files": [
    ],
  • "dynamic_attributes": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить список единиц недвижимости

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterUnitsDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить единицу недвижимости

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор

active
boolean

Активность

type
string
Enum: "UNIT_TYPE_APARTMENT" "UNIT_TYPE_OFFICE" "UNIT_TYPE_PARKING" "UNIT_TYPE_PANTRY" "UNIT_TYPE_ROOM"

Тип единицы строительства

object (UnitPositionVo)
object (UnitRoomOptionsVo)
object (UnitAreaDto)
bti_area
number <double>

Площадь БТИ

object (UnitAttributesDto)
layout
string <uuid>

Первичный ключ, идентификатор

Array of objects (FileDto)
dynamic_attributes
object

Ключ - значение

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "type": "UNIT_TYPE_APARTMENT",
  • "position": {
    },
  • "room": {
    },
  • "area": {
    },
  • "bti_area": 75.5,
  • "attributes": {
    },
  • "layout": "be13f3ef-2122-4325-a977-7865d1b44432",
  • "files": [
    ],
  • "dynamic_attributes": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить единицу недвижимости (soft delete)

Authorizations:
Bearer
path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}

Layouts

API планировок домов/единиц

Создать планировку дома/единицы недвижимости

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Идентификатор

required
Array of objects (FileDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить планировки

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterLayoutsDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить планировки

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Идентификатор

active
boolean
Default: true

Активность

Array of objects (FileDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить планировку (soft delete)

Authorizations:
Bearer
path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}