API Reference service (v0.2.1)

Download OpenAPI specification:

Regions

API регионов

Получить регионы

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

Responses

Request samples

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

Response samples

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

Organizations

API застройщиков

Создать организацию

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

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

title
required
string <= 255 characters

Название региона

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "Застройщик"
}

Response samples

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

Получить организации

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

Название организации

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "title": "Застройщик"
}

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