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

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

From version < 109.2 >

edited by Илья Крайнов
on 2023/10/18 15:33

To version < 98.1 >

edited by Илья Крайнов
on 2023/06/30 15:51

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -682,225 +682,6 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% lang="en-US" %)**GET /api/v3/models/{Id}**
--)))
--
--Метод возвращает полную информацию о модели объекта.
--
--(% style="color:#000000" %)Метод запроса: **GET**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
--
--(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Ответ:
--
--(% style="color:#000000" %){
--  "parentName": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "fueloutlay": 0,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
--|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
--|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
--|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
--|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
--|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
--|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
--|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
--|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
--|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
--
--== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
--
--(% class="box successmessage" %)
--(((
--(% lang="en-US" %)**POST /api/v3/models/find**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Параметры в теле запроса (JSON):{
--
--(% style="color:#000000" %)  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--}
--
--(% style="color:#000000" %)Ответ:
--
--(% style="color:#000000" %)[
--  {
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "parentName": "string",
--    "name": "string",
--    "modelType": 0
--  }
--]
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
--|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
--
--== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
--
--(% class="box successmessage" %)
--(((
--(% lang="en-US" %)**POST /api/v3/models**
--)))
--
--(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
--  "extId": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "fueloutlay": 0,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0
--}
--
--Ответ:
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
--  "extId": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "fueloutlay": 0,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0
--}
--
--
--== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
--)))
--
--(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
--
--(% style="color:#000000" %)Метод запроса: **PUT**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
--  "extId": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "fueloutlay": 0,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0
--}
--
--Ответ:
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
--  "extId": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "fueloutlay": 0,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0
--}
--
--== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
--
--(% class="box errormessage" %)
--(((
--(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
--)))
--
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
--
--(% style="color:#000000" %)Метод запроса: **DELETE**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
--
--(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ: В случае успеха **Success 200**
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
@@ -1474,7 +1474,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
  (% style="color:#000000" %){
--    "vehicleId": , ~/~/ ID объекта
++
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1841,322 +1841,6 @@
    }
  ]
--== (% style="color:#000000; 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" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -2362,10 +2362,7 @@
  == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
--(% class="box infomessage" %)
--(((
--**POST /api/v3/Drivers/find**
--)))
++POST /api/v3/Drivers/find
  Передается параметр: parentId - ID клиента-родителя
@@ -2373,23 +2373,20 @@
  [
    {
--    "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 ~/~/ Признак удаления
++    "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}**
--)))
++GET /api/v3/Drivers/{driverGuid}
  Передается параметр: ID водителя
@@ -2396,22 +2396,19 @@
  Ответ:
  {
--  "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 ~/~/ Признак удаления
++  "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**
--)))
++POST /api/v3/Drivers
  Запрос:
@@ -2442,10 +2442,7 @@
  == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Drivers**
--)))
++PUT /api/v3/Drivers
  Запрос:
@@ -2476,10 +2476,7 @@
  == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/Drivers/{driverGuid}**
--)))
++DELETE /api/v3/Drivers/{driverGuid}
  Передается параметр: ID водителя
@@ -2494,10 +2494,7 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
--)))
++POST /api/v3/DriversVehiclesAssignments/GetByDrivers
  Запрос:
@@ -2525,10 +2525,7 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
--)))
++POST /api/v3/DriversVehiclesAssignments/GetByVehicles
  Запрос:
@@ -2556,10 +2556,7 @@
  === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments**
--)))
++POST /api/v3/DriversVehiclesAssignments
  Передается массив назначений
@@ -2567,11 +2567,11 @@
  [
    {
--    "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.902Z", // Момент времени создания назначения
++    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
++    "BeginTime": "2023-06-30T11:04:46.902Z", // Момент времени начала назначения
++    "EndTime": "2023-06-30T11:04:46.902Z" // Момент времени окончания назначения. Необязательно.
    }
  ]
@@ -2591,10 +2591,7 @@
  === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversVehiclesAssignments**
--)))
++PUT /api/v3/DriversVehiclesAssignments
  Запрос:
@@ -2602,7 +2602,7 @@
    {
      "VehicleId": 0,
      "CreateTime": "2023-06-30T11:14:08.117Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
++    "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"
@@ -2625,20 +2625,33 @@
  === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversVehiclesAssignments**
--)))
++DELETE /api/v3/DriversVehiclesAssignments
  Запрос:
  [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  {
++    "VehicleId": 0,
++    "CreateTime": "2023-06-30T11:16:08.341Z",
++    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "BeginTime": "2023-06-30T11:16:08.342Z",
++    "EndTime": "2023-06-30T11:16:08.342Z"
++  }
  ]
  Ответ:
--Success
++[
++  {
++    "VehicleId": 0,
++    "CreateTime": "2023-06-30T11:16:08.344Z",
++    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "BeginTime": "2023-06-30T11:16:08.344Z",
++    "EndTime": "2023-06-30T11:16:08.344Z"
++  }
++]
  == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
@@ -2645,10 +2645,7 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
--)))
++POST /api/v3/DriversRfidsAssignments/GetByDrivers
  Запрос:
@@ -2664,9 +2664,9 @@
  [
    {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
++    "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"
    }
@@ -2675,10 +2675,7 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments/GetByRfids**
--)))
++POST /api/v3/DriversRfidsAssignments/GetByRfids
  Запрос:
@@ -2694,9 +2694,9 @@
  [
    {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
++    "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"
    }
@@ -2705,10 +2705,7 @@
  === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments**
--)))
++POST /api/v3/DriversRfidsAssignments
  Запрос:
@@ -2736,10 +2736,7 @@
  === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversRfidsAssignments**
--)))
++PUT /api/v3/DriversRfidsAssignments
  Запрос:
@@ -2768,20 +2768,31 @@
  === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversRfidsAssignments**
--)))
++DELETE /api/v3/DriversRfidsAssignments
  Запрос:
  [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++  {
++    "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"
++  }
  ]
  Ответ:
--Success
++[
++  {
++    "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:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
@@ -2788,10 +2788,7 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
--)))
++POST /api/v3/DriversFuelCardsAssignments/GetByDrivers
  Запрос:
@@ -2818,10 +2818,7 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
--)))
++POST /api/v3/DriversFuelCardsAssignments/GetByCards
  Запрос:
@@ -2848,10 +2848,7 @@
  === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments**
--)))
++POST /api/v3/DriversFuelCardsAssignments
  Запрос:
@@ -2879,10 +2879,7 @@
  === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversFuelCardsAssignments**
--)))
++PUT /api/v3/DriversFuelCardsAssignments
  Запрос:
@@ -2889,10 +2889,9 @@
  [
    {
      "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"
++    "BeginTime": "2023-06-30T12:09:53.175Z",
++    "EndTime": "2023-06-30T12:09:53.175Z"
    }
  ]
@@ -2911,20 +2911,30 @@
  === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversFuelCardsAssignments**
--)))
++DELETE /api/v3/DriversFuelCardsAssignments
  Запрос:
  [
--  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++  {
++    "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"
++  }
  ]
  Ответ:
--Success
++[
++  {
++    "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:18.6667px" %)Раздел: **Карты-метки**(%%) =
@@ -2931,15 +2931,12 @@
  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
--(% class="box infomessage" %)
--(((
--**POST /api/v3/Rfids/find**
--)))
++POST /api/v3/Rfids/find
  Запрос:
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++{
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
  Ответ:
@@ -2948,7 +2948,7 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
++    "period": 0, // Частота трансляции радиометки
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "deleted": true
@@ -2958,10 +2958,7 @@
  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Rfids/{rfidGuid}**
--)))
++GET /api/v3/Rfids/{rfidGuid}
  Передаем параметр rfidGuid - идентификатор карты-метки
@@ -2971,7 +2971,7 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
++    "period": 0, // Частота трансляции радиометки
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "deleted": true
@@ -2981,10 +2981,7 @@
  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Rfids**
--)))
++POST /api/v3/Rfids
  Запрос:
@@ -3010,10 +3010,7 @@
  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Rfids**
--)))
++PUT /api/v3/Rfids
  Запрос:
@@ -3040,10 +3040,7 @@
  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
--(% class="box errormessage" %)
--(((
  **DELETE /api/v3/Rfids/{rfidGuid}**
--)))
  Передаем параметр rfidGuid - идентификатор карты-метки

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

Summary

Details

Меню