Документация

v.1.2 от 15.06.2020

Сайт проекта: jsproject.webcademy.ru

Содержание:

Получение значений для фильтра

Получение минимальных и максимальных значений для цены и площади. А также получение всех возможных названий ЖК и вариантов количества комнат в квартирах.

Адрес для запроса:

https://jsproject.webcademy.ru/itemsinfo

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

{
    "priceMin": "1872000",
    "priceMax": "8610000",
    "squareMin": "38",
    "squareMax": "120",
    "complexNames":
        [
            "Генеральский",
            "Квантум",
            "Лесной",
            "Речной"
        ],
    "roomValues":
        [
            "1",
            "2",
            "3",
            "4",
            "5"
        ]
}

Просмотр объектов

Все объекты

https://jsproject.webcademy.ru/items

Объект с конкретным ID

https://jsproject.webcademy.ru/items/5

Несколько объектов по конкретным ID
(для отображения объектов из Избранного) 

https://jsproject.webcademy.ru/items?ids=1,3,5
Если объекты не найдены

Будет возвращен пустой массив:

[]

Если был запрос на конкретный объект по id и такого объекта не существует, тогда будет возвращен пустой объект:

{}

Фильтрация

Пример запроса:

https://jsproject.webcademy.ru/items?complex=Речной&rooms=2,3&sqmin=40&sqmax=90&pricemin=2325000&pricemax=4525000

Параметры по очереди:

complex=Речной // Название комплекса
rooms=2,3 // Перечисление комнат
sqmin=40 // Минимальная площадь
sqmax=90 // Максимальная площадь
pricemin=2325000 // Минимальная цена
pricemax=4525000 // Максимальная цена
ids=1,3,5 // Показать только объекты с указанными ID
Значения параметров:

complex:

Генеральский
Речной
Лесной
Квантум
Если объекты не существуют или не найдены

Будет возвращен пустой массив:

[]

Заявки. Смотреть все заявки

https://jsproject.webcademy.ru/bids
Если заявки отсутствуют

Будет возвращен пустой массив.

[]

Заявки. Добавить заявку

Отправить POST запрос с JSON данными. Поля name и phone являются обязательными для заполнения.

{
    "name": "Client Name",
    "phone": "+7951236547"
}

на адрес:

https://jsproject.webcademy.ru/bidnew
Если заявка добавлена успешно

В ответ придет объект с следующим сообщением:

{
    "message": "Bid Created"
}
Если заявка не добавлена

Если в заявке отсутствовали необходимые поля, то будет получено сообщение с текстом ошибки:

{
    "message": "Bid Not Created",
    "errors": [
        "Поле \"Имя\" обязательно для заполнения!",
        "Поле \"Телефон\" обязательно для заполнения!"
    ]
}

Если поля заполнены, но добавление не произошло по иным причинам связанным с работой сервера:

{
    "message": "Bid Not Created"
}