POST /plans

Метод создает планировку, позволяет связать её с помещениями.

Заголовки

Название Описание
Content-Type application/json
Authorization Заголовок авторизации

Тело запроса

Название Тип Формат Обязательность Описание
roomIds array Guid true Идентификаторы помещений, входящих в планировку
description string ^\w{1,256}$ false Описание планировки
name string ^\w{1,50}$ true Наименование планировки

Пример

Создание планировки

  POST /realty/web/inspection-api/v1/plans
  Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c
  Content-Type: application/json
{
  "name": "1-комнатная",
  "roomIds": [
    "ccad42c0-5380-11ee-9cf7-fd8814f00a4f",
    "37339792-e4ab-11ed-babf-d39a91301767"
  ],
  "description": "Угловая в секции Б"
}

Ответы

201

Тело ответа

Планировка успешно создана. В теле ответа содержится описание планировки Plan.

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

  HTTP 201
  Content-Type: Application/json
{
  "id": "f0abc2e0-53cc-11ee-8098-01c2d3665ed7",
  "name": "1-комнатная",
  "roomIds": [
    "ccad42c0-5380-11ee-9cf7-fd8814f00a4f",
    "37339792-e4ab-11ed-babf-d39a91301767"
  ],
  "description": "Угловая в секции Б"
}

400

Ошибки валидации запроса.

401

Ошибка авторизации: пользователь не авторизован.

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации.

415

В заголовке Content-Type указан тип контента, который не поддерживается для данного метода.