Оформление
Передача и редактирование данных туриста
Заявки созданные по API в CRM будут помечены “Заявка создана по API”
Методы для работы с туристами в заявке
- POST запрос добавления туриста в заявку
https://toursystema.com/org-api/request/create-tourist?request_id=1 GET параметр ID заявки (request_id)
- POST запрос редактирования туриста в заявке
https://toursystema.com/org-api/request/update-tourist?request_id=1&id=134 GET параметры ID заявки (request_id) и ID турист (id)
- POST запрос удаления туриста из заявки
https://toursystema.com/org-api/request/delete-tourist?request_id=1&id=134 GET параметры ID заявки (request_id) и ID туриста (id)
Пример тела запроса для создания и редактирования туриста
json
{
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"phone": "+79990000000",
"email": "test@test.com",
"food_restriction": "Вегетарианец",
"birthday": "1999-09-09",
"passport": "1234 567890"
}
Параметры для создания и редактирования туриста.
Параметр | Описание | Тип данных | Обязательность |
---|---|---|---|
id | ID заявки | string | Нет |
first_name | Фамилия | string | Да |
last_name | Имя | string | Нет |
middle_name | Отчество | string | Нет |
phone | Номер телефона | string | Нет |
Дата рождения | date (YYYY-MM-DD) | Нет | |
birthday | Серия и номер паспорта/номер свидетельства о рождении | string | Нет |
passport | Валюта | string | Нет |
food_restriction | Ограничения по питанию | string | Нет |
Успешный ответ (HTTP 200)
json
{
"success": true,
"request_id": 234238,
"tourist_id": 455
}
Нет прав на создание и редактирование заявки (HTTP 403)
json
{
"name": "Not Found",
"message": "У вас нет права на совершение этого действия",
"code": 0,
"status": 403
}
Заявка не найдена (HTTP 404)
json
{
"name": "Not Found",
"message": "Заявка не найдена",
"code": 0,
"status": 404
}
Турист не найден (HTTP 404)
json
{
"name": "Not Found",
"message": "Турист не найден",
"code": 0,
"status": 404
}
Описание ошибок для валидации каждого параметра
Параметр | Возможные ошибки |
---|---|
first_name | - Слишком длинная строка. (>255) |
last_name | - Необходимо заполнить. - Слишком длинная строка. (>255) |
middle_name | - Слишком длинная строка. (>255) |
phone | - Неверный формат номера телефона. |
- Слишком длинная строка. (>255) - Не является правильным email адресом. | |
birthday | - Неверная дата рождения |
passport | - Слишком длинная строка. (>255) |
food_restriction | - Слишком длинная строка. (>255) |