GET /plans

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

Переменные

Название Тип Формат Обязательность Описание
ids array Guid false Идентификаторы планировок
token string string false Токен, после которого необходимо получить список
count integer ^\d{1,50}$ true Количество планировок

В переменных запроса могут быть указаны либо идентификаторы планировок ids, либо токен и количество планировок. Если будет указан count >50, то он будет уменьшен системой до 50 в целях надежности.

Заголовки

Название Описание
Authorization Заголовок авторизации

Пример

Получение информации о планировках

  GET /realty/web/inspection-api/v1/plans?token=62482f53331faf529648b388&count=2' 
  Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c

Ответы

200

Тело ответа

{
    "items": [
        {
            "id": "f0abc2e0-53cc-11ee-8098-01c2d3665ed7",
            "name": "2-комнатная",
            "description": null,
            "roomIds": [
                "37339792-e4ab-11ed-babf-d39a91301767",
                "011e5e6c-d52e-11ed-8818-b5068d25e3c2",
                "bc8deb70-d931-11ed-98af-0fac920f4a53"
            ]
        },
        {
            "id": "ecc42c20-52fb-11ee-8538-df7813c9548b",
            "name": "Студия",
            "description": "1",
            "roomIds": [
                "279c90ec-52f9-11ee-9cf7-fd8814f00a4f",
                "0f013994-52e9-11ee-9cf7-fd8814f00a4f"
            ]
        }
    ],
    "nextToken": "ecc42c20-52fb-11ee-8538-df7813c9548b"
}

401

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

403

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