Changes for page Методы API для работы с ГЛОНАССSoft

Last modified by Андрей Калиновский on 2025/01/28 12:59

From version < 108.1 >

edited by Илья Крайнов
on 2023/09/27 15:57

To version < 93.1 >

edited by Илья Крайнов
on 2023/05/22 16:01

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -981,70 +981,45 @@
        "retries": 0
      }
    ],
--
-- "sensors": [ ~/~/ Датчики
++  "sensors": [ ~/~/ Датчики
      {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
--      "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
--      "type": 0, ~/~/ Тип датчика
--      "name": "string", ~/~/ Имя датчика
--      "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
--      "inputNumber": 0, ~/~/ Номер входа
--      "pseudonym": "string", ~/~/ Псевдоним
--      "medianDegree": 0, ~/~/ Медианная фильтрация
--      "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
--      "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
--      "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
--      "gradesTables": [ ~/~/ Массив таблиц тарировки
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "kind": 0,
++      "type": 0,
++      "name": "string",
++      "inputType": 0,
++      "inputNumber": 0,
++      "pseudonym": "string",
++      "medianDegree": 0,
++      "isInverted": true,
++      "disabled": true,
++      "gradeType": 0,
++      "gradesTables": [
          {
--          "grades": [ ~/~/ Таблица тарировки 1
++          "grades": [
              {
--              "input": 0, ~/~/ Входящее значение
--              "output": 0 ~/~/ Выходящее значение
++              "input": 0,
++              "output": 0
              }
            ],
--          "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
++          "relevanceTime": "2023-05-22T12:19:59.728Z"
          }
        ],
--      "showInTooltip": true, ~/~/ Отображать в подсказке
--      "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
--      "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
--      "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
--      "expr": "string", ~/~/ Формула
--      "children": [ ~/~/ массив дочерних датчиков
++      "showInTooltip": true,
++      "showLastValid": true,
++      "showAsDutOnGraph": true,
++      "showWithoutIgn": true,
++      "agrFunction": 0,
++      "expr": "string",
++      "children": [
          "string"
        ],
--      "customParams": { ~/~/ прочие произвольные параметры
++      "customParams": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
--
--~/~/ Характерные для произвольного:
--
--~/~/                "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
--
--~/~/                "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
--
--~/~/                "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
--
--~/~/                "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
--
--~/~/               "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
--
--~/~/                "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
--
--~/~/               "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
--
--~/~/                "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
--
--~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
--
--~/~/ "ValueOn": "Вкл.",
--
--~/~/ "ValueOff": "Выкл."
--      "summaryMaxValue": 0 ~/~/ Макс. значение
++      "summaryMaxValue": 0
      }
    ],
    "customFields": [ ~/~/ Произвольные поля
@@ -1255,7 +1255,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
  (% style="color:#000000" %){
--    "vehicleId": , ~/~/ ID объекта
++
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1324,70 +1324,45 @@
        "retries": 0
      }
    ],
--
-- "sensors": [ ~/~/ Датчики
++  "sensors": [ ~/~/ Датчики
      {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
--      "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
--      "type": 0, ~/~/ Тип датчика
--      "name": "string", ~/~/ Имя датчика
--      "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
--      "inputNumber": 0, ~/~/ Номер входа
--      "pseudonym": "string", ~/~/ Псевдоним
--      "medianDegree": 0, ~/~/ Медианная фильтрация
--      "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
--      "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
--      "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
--      "gradesTables": [ ~/~/ Массив таблиц тарировки
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "kind": 0,
++      "type": 0,
++      "name": "string",
++      "inputType": 0,
++      "inputNumber": 0,
++      "pseudonym": "string",
++      "medianDegree": 0,
++      "isInverted": true,
++      "disabled": true,
++      "gradeType": 0,
++      "gradesTables": [
          {
--          "grades": [ ~/~/ Таблица тарировки 1
++          "grades": [
              {
--              "input": 0, ~/~/ Входящее значение
--              "output": 0 ~/~/ Выходящее значение
++              "input": 0,
++              "output": 0
              }
            ],
--          "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
++          "relevanceTime": "2023-05-22T12:19:59.728Z"
          }
        ],
--      "showInTooltip": true, ~/~/ Отображать в подсказке
--      "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
--      "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
--      "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
--      "expr": "string", ~/~/ Формула
--      "children": [ ~/~/ массив дочерних датчиков
++      "showInTooltip": true,
++      "showLastValid": true,
++      "showAsDutOnGraph": true,
++      "showWithoutIgn": true,
++      "agrFunction": 0,
++      "expr": "string",
++      "children": [
          "string"
        ],
--      "customParams": { ~/~/ прочие произвольные параметры
++      "customParams": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
--
--~/~/ Характерные для произвольного:
--
--~/~/                "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
--
--~/~/                "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
--
--~/~/                "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
--
--~/~/                "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
--
--~/~/               "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
--
--~/~/                "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
--
--~/~/               "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
--
--~/~/                "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
--
--~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
--
--~/~/ "ValueOn": "Вкл.",
--
--~/~/ "ValueOff": "Выкл."
--      "summaryMaxValue": 0 ~/~/ Макс. значение
++      "summaryMaxValue": 0
      }
    ],
    "customFields": [ ~/~/ Произвольные поля
@@ -1622,322 +1622,6 @@
    }
  ]
--== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/vehicles/export/history**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **POST**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--{
--  "vehicleId": 0, ~/~/ ID объекта
--  "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
--  "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
--  "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
--}
--
--Ответ:
--
--Получаете файл. Сообщение: Code 200/Success
--
--== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/vehicles/export/history/status**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **GET**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ:
--
--{
--  "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
--  "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
--  "message": "string" ~/~/ текст описывающий статус.
--}
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
--)))
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
--  "vehicleIds": [0], ~/~/ Список ID объектов
--  "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
--  "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
--  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--}
--
--Ответ:
--
--[
--  {
--    "vehicleId": 0, ~/~/ ID объекта
--    "name": "string", ~/~/ Имя ТС
--    "periods": [ ~/~/ Периоды
--      {
--        "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
--        "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
--        "mileageBegin": 0, ~/~/ Пробег на начало периода
--        "mileageEnd": 0, ~/~/ Пробег на окончание периода
--        "motohoursBegin": 0, ~/~/ Моточасы на начало периода
--        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
--      }
--    ]
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
--)))
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
--  "vehicleIds": [0], ~/~/ Список ID объектов
--  "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
--  "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
--  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--}
--
--Ответ:
--
--[
--  {
--    "vehicleId": 0, ~/~/ ID объекта
--    "name": "string", ~/~/ Имя ТС
--    "periods": [ ~/~/ Периоды
--      {
--        "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
--        "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
--        "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
--        "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
--        "fuelConsumption": 0, ~/~/ Расход топлива
--        "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
--      }
--    ]
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
--)))
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "vehicleIds": [0], ~/~/ Список ID объектов
--  "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
--  "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
--  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--}
--
--Ответ:
--
--[
--  {
--    "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
--    "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
--    "vehicleId": 0, ~/~/ ID объекта
--    "name": "string", ~/~/ Имя объекта
--    "model": "string", ~/~/ Модель объекта
--    "fuels": [ ~/~/ Массив данным по заправкам и сливам
--      {
--        "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
--        "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
--        "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
--        "valueFuel": 0, ~/~/ Количество
--        "fuelStart": 0, ~/~/ Уровень топлива на начало события
--        "fuelEnd": 0 ~/~/ Уровень топливо на конец события
--      }
--    ]
--  }
--]
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--(% style="text-align:left" %)
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--}
--
--(% style="text-align:left" %)
--Ответ:
--
--[
--  {
--    "id": 0, ~/~/ Идентификатор объекта геозоны
--    "name": "string", ~/~/ Название объекта геозоны
--    "type": 0, ~/~/ Тип объекта геозоны
--    "fname": "string", ~/~/ Имя файла
--    "parentId": "string", ~/~/ Идентификатор клиента
--    "radius": 0, ~/~/ Радиус геообъекта
--    "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
--    "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
--    "description": "string", ~/~/ Описание
--    "area": 0, ~/~/ Площадь, м^^2^^
--    "perimetr": 0, ~/~/ Периметр, м
--    "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
--  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
--  "ids": [ ], ~/~/ Массив id объектов
--  "byTime": 0, ~/~/ Объединение событий по времени
--  "byDist": 0, ~/~/ Объединение событий по расстоянию
--  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
--  "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
--}
--
--Ответ:
--[
--  {
--    "geozoneId": 0, ~/~/ ID геообъекта
--    "geozoneName": "string", ~/~/ Название геообъекта
--    "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
--    "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
--    "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
--    "vehicleId": 0, ~/~/ ID объекта
--    "vehicleName": "string" ~/~/ Имя объекта
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
--  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
--  "ids": [ ], ~/~/ Массив id геообъектов
--  "byTime": 0, ~/~/ Объединение событий по времени
--  "byDist": 0, ~/~/ Объединение событий по расстоянию
--  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
--  "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
--}
--
--Ответ:
--
--[
--  {
--    "geozoneId": 0, ~/~/ ID геообъекта
--    "geozoneName": "string", ~/~/ Название геообъекта
--    "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
--    "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
--    "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
--    "vehicleId": 0, ~/~/ ID объекта
--    "vehicleName": "string" ~/~/ Имя объекта
--  }
--]
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -2138,701 +2138,6 @@
  Success
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/Drivers/find**
--)))
--
--Передается параметр: parentId - ID клиента-родителя
--
--Ответ:
--
--[
--  {
--    "name": "string", ~/~/ Определяет наименование
--    "description": "string", ~/~/ Определяет описание
--    "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
--    "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
--    "exclusive": true, ~/~/ Определяет признак "Исключительный"
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
--    "deleted": true ~/~/ Признак удаления
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Drivers/{driverGuid}**
--)))
--
--Передается параметр: ID водителя
--
--Ответ:
--
--{
--  "name": "string", ~/~/ Определяет наименование
--  "description": "string", ~/~/ Определяет описание
--  "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
--  "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
--  "exclusive": true, ~/~/ Определяет признак "Исключительный"
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
--  "deleted": true ~/~/ Признак удаления
--}
--
--== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Drivers**
--)))
--
--Запрос:
--
--{
--  "name": "string",
--  "description": "string",
--  "hiredate": "2023-06-30T12:50:54.020Z",
--  "chopdate": "2023-06-30T12:50:54.020Z",
--  "exclusive": true,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--Ответ:
--
--{
--  "name": "string",
--  "description": "string",
--  "hiredate": "2023-06-30T12:50:54.051Z",
--  "chopdate": "2023-06-30T12:50:54.051Z",
--  "exclusive": true,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--
--== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Drivers**
--)))
--
--Запрос:
--
--{
--  "name": "string",
--  "description": "string",
--  "hiredate": "2023-06-30T12:50:27.910Z",
--  "chopdate": "2023-06-30T12:50:27.910Z",
--  "exclusive": true,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--Ответ:
--
--{
--  "name": "string",
--  "description": "string",
--  "hiredate": "2023-06-30T12:50:27.929Z",
--  "chopdate": "2023-06-30T12:50:27.929Z",
--  "exclusive": true,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--
--== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/Drivers/{driverGuid}**
--)))
--
--Передается параметр: ID водителя
--
--Ответ:
--
--Success
--
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
--
--== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:49:04.365Z",
--  "EndTime": "2023-06-30T12:49:04.365Z"
--}
--
--Ответ:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T09:52:31.240Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T09:52:31.240Z",
--    "EndTime": "2023-06-30T09:52:31.240Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    0
--  ],
--  "BeginTime": "2023-06-30T12:48:39.419Z",
--  "EndTime": "2023-06-30T12:48:39.419Z"
--}
--
--Ответ:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T09:54:01.631Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T09:54:01.631Z",
--    "EndTime": "2023-06-30T09:54:01.631Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments**
--)))
--
--Передается массив назначений
--
--Запрос:
--
--[
--  {
--    "VehicleId": 0, ~/~/ Идентификатор объекта
--    "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
--    "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
--    "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
--  }
--]
--
--Ответ:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T11:04:46.903Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:04:46.903Z",
--    "EndTime": "2023-06-30T11:04:46.903Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversVehiclesAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T11:14:08.117Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:14:08.117Z",
--    "EndTime": "2023-06-30T11:14:08.117Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T11:14:53.349Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:14:53.349Z",
--    "EndTime": "2023-06-30T11:14:53.349Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversVehiclesAssignments**
--)))
--
--Запрос:
--
--[
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--]
--
--Ответ:
--
--Success
--
--
--== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:47:12.162Z",
--  "EndTime": "2023-06-30T12:47:12.162Z"
--}
--
--Ответ:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
--    "BeginTime": "2023-06-30T11:19:40.703Z",
--    "EndTime": "2023-06-30T11:19:40.703Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments/GetByRfids**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:47:12.162Z",
--  "EndTime": "2023-06-30T12:47:12.162Z"
--}
--
--Ответ:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
--    "BeginTime": "2023-06-30T11:19:40.703Z",
--    "EndTime": "2023-06-30T11:19:40.703Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:27:08.635Z",
--    "EndTime": "2023-06-30T11:27:08.635Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:27:08.677Z",
--    "EndTime": "2023-06-30T11:27:08.677Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversRfidsAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:28:43.330Z",
--    "EndTime": "2023-06-30T11:28:43.330Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:28:43.331Z",
--    "EndTime": "2023-06-30T11:28:43.331Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversRfidsAssignments**
--)))
--
--Запрос:
--
--[
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--]
--
--Ответ:
--
--Success
--
--
--== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:45:10.852Z",
--  "EndTime": "2023-06-30T12:45:10.852Z"
--}
--
--Ответ:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:58:04.695Z",
--    "EndTime": "2023-06-30T11:58:04.695Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:45:10.852Z",
--  "EndTime": "2023-06-30T12:45:10.852Z"
--}
--
--Ответ:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:58:04.695Z",
--    "EndTime": "2023-06-30T11:58:04.695Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T12:09:53.175Z",
--    "EndTime": "2023-06-30T12:09:53.175Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T12:09:53.201Z",
--    "EndTime": "2023-06-30T12:09:53.201Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversFuelCardsAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T12:09:53.201Z",
--    "EndTime": "2023-06-30T12:09:53.201Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T12:09:53.201Z",
--    "EndTime": "2023-06-30T12:09:53.201Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversFuelCardsAssignments**
--)))
--
--Запрос:
--
--[
--  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--]
--
--Ответ:
--
--Success
--
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/Rfids/find**
--)))
--
--Запрос:
--
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--}
--
--Ответ:
--
--[
--  {
--    "name": "string",
--    "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "deleted": true
--  }
--]
--
--
--== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Rfids/{rfidGuid}**
--)))
--
--Передаем параметр rfidGuid - идентификатор карты-метки
--
--Ответ:
--
--[
--  {
--    "name": "string",
--    "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "deleted": true
--  }
--]
--
--
--== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Rfids**
--)))
--
--Запрос:
--
--{
--  "name": "string",
--  "number": 0,
--  "period": 0,
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--Ответ:
--
--{
--  "name": "string",
--  "number": 0,
--  "period": 0,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--
--== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Rfids**
--)))
--
--Запрос:
--
--{
--  "name": "string",
--  "number": 0,
--  "period": 0,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--Ответ:
--
--{
--  "name": "string",
--  "number": 0,
--  "period": 0,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--
--== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/Rfids/{rfidGuid}**
--)))
--
--Передаем параметр rfidGuid - идентификатор карты-метки
--
--Ответ:
--
--Success
--
--
  (% class="box" lang="en-US" style="text-align: center;" %)
  (((
  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Changes for page Методы API для работы с ГЛОНАССSoft

Summary

Details

Меню