Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

Запрос:

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.

Каждый объект содержит

ПолеТипОписание
typestringтип ресурса (всегда "phone")
attributesobjectДанные водителя (описание атрибутов ниже)
relationshipsobjectСвязанные объекты

Описание атрибутов телефонов водителей.

ПолеТипNullableОписание
Typeintнет

тип телефона

Phonestringнетномер телефона (только цифры)
IsPrimaryboolнетОсновной телефон
SpammableboolнетМожно ли делать рассылки на данный телефон
DateOfCreationdatetimeнетДата создания (игнорируется при создании)
UpdateDatedatetimeнетДата удаления (игнорируется при создании)
Типы телефонов:
ТипОписание
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"
        }
    }
}
  • No labels