Для отправки заявки на подключение делаем POST-запрос с обязательным заголовком
Content-Type: application/json; charset=utf-8

Тело запроса имеет вид JSON-объекта:
{
"city": "Киев",
"street": "Лесі Українки бул",
"house": "12",
......
}

Все поля имеют строковый тип данных, если в описании не указано другое.

Обязательные поля:
city — название города на русском
street — название улицы
house — номер дома
firstname — имя
phone — телефон
apartment — номер квартиры, произвольная строка

Необязательные поля:
email — адрес электронной почты
comment — комментарий, произвольная строка
lastname — фамилия

Проверить результат выполнения запроса можно по HTTP-статусу ответа:
200 OK — заявка успешно отправлена
405 Method Not Allowed — неправильный HTTP-метод запроса (допускается
только POST)
415 Unsupported Media Type — не указан или указан неправильный
заголовок Content-Type запроса (допускается только application/json;
charset=utf-8)
400 Bad Request — ошибка парсинга JSON-данных
403 Data Validation Failed — ошибка проверки данных (например, не
указано обязательное поле или улица не найдена в базе)
500 Internal Server Error — внутренняя ошибка (например, не удалось
отправить письмо)

При получении ошибки в диапазоне от 500 до 599 необходимо по
возможности повторить запрос (или попросить об этом пользователя),
такой код говорит о том, что данные не были обработаны сервером в
полном объеме.

При получении ошибки в диапазоне от 400 до 499 запрос повторять нет
смысла, поскольку он приведет к такой же ошибке — необходимо
соответствующим образом исправить исходные данные.

Все ответы в теле будут также содержать JSON-объект с единственным
полем success, равным true, для успешного результата и единственным
полем error, содержащим описание ошибки, для ошибочного результата. Не
смотря на то, что тело ответа является корректным JSONом, оно не
предназначено для какой-либо машинной обработки, т.е. не нужно по
наличию или отсутствию полей или их значению принимать какие-либо
решения в коде вашего API-клиента — для этого есть HTTP-статус. В
ошибочном результате поле error будет содержать довольно подробное
описание ошибки, которое лучше залогировать для дальнейшего изучения.

Is this article helpful for you?