Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на изменение смены водителя.

Новая смена не должна пересекаться по времени с уже существующими сменами водителя.

Смена пересекающая 24:00 или 00:00 считается ночной.

Примеры валидных смен:

1) с 00:00 до 24:00 - весь день.

2) с 10:00 до 10:00 - весь десь

3) с 07:00 до 18:00 - дневная

    с 18:00 до 07:00 - ночная

4) с 06:00 до 14:00 - дневная

    с 14:00 до 20:00 - дневная

    с 20:00 до 06:00 - ночная  

Не корректная смена:

c 08:00 до 20:00

c 22:00 до 09:00  - есть пересечение по времени с 08:00 до 09:00

Запрос:

URL:

      PATCH https://api.url/v2.1/user/<user_id>/drivers/workShifts

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

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

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

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


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

 Список атрибутов заметки:

ПолеТипNullableОписание
TimeFromtime_hmнетвремя начала смены hh:mm
TimeTotime_hmнетвремя окончания смены hh:mm

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

ПолеТипNullableОписание
Driverobject<Driver>да

ссылка на водителя, для смены по умолчанию нужно указывать null.

Accountobject<user>дапроставляется сервером автоматически.

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

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

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

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

Также возможны другие ошибки.

Пример

POST https://api.url/v2.1/user/1/drivers/workShifts/1 HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>

{
    "data": {
         "id": 1
         "type": "driverShift",
         "attributes": {
             "TimeFrom": "06:00"
         }
    }
}


HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
Location: https://api.url/v2.1/user/1/drivers/workShifts/1

{
    "links": {
        "self": "https://api-test05.citypoint.ru/v2.1/user/1/drivers/workShifts/1"
    },
    "data": {
        "id": "1",
        "type": "driverShift",
        "attributes": {
            "TimeFrom": "06:00",
            "TimeTo": "07:00"
        },
        "relationships": {
            "Driver": {
                "data": {
                    "id": "1",
                    "type": "driver"
                }
            },
            "Account": {
                "data": {
                    "id": "1",
                    "type": "user"
                }
            }
        }
    }
}
  • No labels