API docs by Redocly

API Booking service (v0.1.5)

Download OpenAPI specification:

Bookings

API броней

Создать бронь

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

Id единицы недвижимости (stock-service)

crm_deal_id
string <= 255 characters

Id сделки BX24

expiration_date
string <date-time>

Дата окончания бронирования

comment
string <= 255 characters

Комментарии к броне

responsible
string <uuid>

Id ответственного менеджера

Responses

Request samples

Content type
application/json
{
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "crm_deal_id": "string",
  • "expiration_date": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "responsible": "9511879b-6438-4cb0-a6f1-dcd32ddcb43a"
}

Response samples

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

Получить список броней

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterBookingsDto)
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

Активность

crm_deal_id
string <= 255 characters

Id сделки BX24

expiration_date
string <date-time>

Дата окончания бронирования

comment
string <= 255 characters

Комментарии к броне

responsible
string <uuid>

Id ответственного менеджера

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "crm_deal_id": "string",
  • "expiration_date": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "responsible": "9511879b-6438-4cb0-a6f1-dcd32ddcb43a"
}

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": "Запись удалена"
}

Поиск по броням

Authorizations:
Bearer
Request Body schema: application/json
required
query
required
string

Поиск по номеру сделки, номеру бронирования или строительному коду

include_expired
boolean
Default: false

Включать истекшие (удаленные) брони

required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "include_expired": false,
  • "pagination": {
    }
}

Response samples

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

Booking Groups

API групп броней

Создать группы броней

Authorizations:
Bearer
Request Body schema: application/json
required
name
required
string <= 255 characters

Название группы броней

bookings
required
Array of strings <uuid> [ items <uuid > ]

Массив идентификаторов броней группы

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "bookings": [
    ]
}

Response samples

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

Получить список групп броней

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterBookingGroupsDto)
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

Активность

name
string <= 255 characters

Название группы броней

bookings
Array of strings <uuid> [ items <uuid > ]

Массив идентификаторов броней группы

Responses

Request samples

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

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": "Запись удалена"
}

Booking History

API истории изменений бронирований

Получить список броней

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

Responses

Request samples

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

Response samples

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