Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос:

URL:

PATCH https://api.url/v2.1/user/<user_id>/drivers/<driver_id>/emails/<email_id>

Доп. Заголовки:

Accept - для указания формата ответа. Должен быть "application/vnd.api+json"

Content-Type - "application/vnd.api+json".

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Запрос присылается в формате JSON API.

Данные запроса:

       Запрос отсылается в формате  JSON API.

ПолеОписание
data

Содержит объект с описанием водителя в формате JSON API.

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

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

Описание атрибутов.

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

тип email

0 - домашний (личный)

1 - рабочий

EmailstringнетEmail
IsPrimaryboolнетОсновной email - на него будут уходить письма о смене / восстановлении пароля.
SpamableboolнетМожно ли отсылать на него письма. Разрешены или заблокированы уведомления.

Описание связанных объектов:

ПолеТипNullableОписание
Driverobject<driver>нет

Водитель к которому привязан email

Коды ответов:

201 Created - Сервер обработал запрос. В теле ответа  содержатся данные созданного объекта.

403 Forbidden - нет прав на создание.

404 Not Found - Водитель не найден.

400 Bad Request - Переданы не поддерживаемые параметры либо сервер не понял запрос (описание ошибки в теле ответа).

Пример

POST https://api.url/v2.1/user/1/drivers/1/emails/1 HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
 
{
    "data": {
        "type": "email",
        "attributes": {
            "Type": 0,
            "Spamable": false
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://api-test01.citypoint.ru/v2.1/user/1/drivers/1/emails/1"
    },
    "data": {
        "id": "1",
        "type": "email",
        "attributes": {
            "Type": 0,
            "Email": "test@example.com",
            "IsPrimary": false,
            "Spamable": false,
            "DateOfCreation": "2021-12-10T09:51:46Z",
            "UpdateDate": "2021-12-10T09:51:46Z"
        },
        "relationships": {
            "Driver": {
                "data": {
                    "id": "1",
                    "type": "driver"
                }
            }
        }
    }
}
  • No labels