Запрос:
URL:
POST https://api.url/v2.1/user/<user_id>/drivers/<driver_id>/phones
Доп. Заголовки:
Accept - для указания формата ответа. Должен быть "application/vnd.api+json"
Content-Type - "application/vnd.api+json".
Authorization - для передачи токена. Передается в формате: Bearer <access_token>.
Запрос присылается в формате JSON API.
Данные запроса:
Запрос отсылается в формате JSON API.
| Поле | Описание | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| data | Содержит объект в формате JSON API. Каждый объект содержит
|
Описание атрибутов телефонов водителей.
| Поле | Тип | Nullable | Описание |
|---|---|---|---|
| Type | int | нет | тип телефона |
| Phone | string | нет | номер телефона (только цифры) |
| IsPrimary | bool | нет | Основной телефон |
| Spammable | bool | нет | Можно ли делать рассылки на данный телефон |
| DateOfCreation | datetime | нет | Дата создания (игнорируется при создании) |
| UpdateDate | datetime | нет | Дата удаления (игнорируется при создании) |
Типы телефонов:
| Тип | Описание |
|---|---|
| 0 | домашний |
| 1 | рабочий |
| 2 | мобильный |
Коды ответов:
201 Created - Сервер обработал запрос. В теле ответа содержатся данные созданного объекта.
403 Forbidden - нет прав на создание.
404 Not Found - Водитель не найден.
400 Bad Request - Переданы неподдерживаемые параметры, либо сервер не понял запрос (описание ошибки в теле ответа).
Пример
POST https://api.url/v2.1/user/1/drivers/1/phones HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
{
"data": {
"type": "phone",
"attributes":{
"Type": 2,
"Phone": "12025550168",
"IsPrimary": true,
"Spamable": true
}
}
}
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
Location: https://api.url/v2.1/user/1/drivers/1/phones/1
{
"links":{
"self": "https://api.url/v2.1/user/1/drivers/1/phones/1",
},
"data": {
"id": "1",
"type": "phone",
"attributes":{
"Type": 2,
"Phone": "12025550168",
"IsPrimary": true,
"Spamable": true,
"DateOfCreation": "2022-03-10T10:23:45Z",
"UpdateDate": "2022-03-10T10:23:45Z"
}
}
}