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

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

From version < 98.1 >

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

To version < 103.2 >

edited by Илья Крайнов
on 2023/08/02 09:50

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1255,7 +1255,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
  (% style="color:#000000" %){
--
++    "vehicleId": , ~/~/ ID объекта
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1504,6 +1504,95 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
++
++(% style="text-align:left" %)
++(% 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/users/api/v3/gis/find>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
++
++(% 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: rgb(0, 0, 0); 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>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
++
++(% 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,
++    "geozoneName": "string",
++    "startDate": "2023-08-02T06:13:18.554Z",
++    "endDate": "2023-08-02T06:13:18.554Z",
++    "duration": 0,
++    "vehicleId": 0,
++    "vehicleName": "string"
++  }
++]
++
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
@@ -1827,7 +1827,10 @@
  == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
--POST /api/v3/Drivers/find
++(% class="box infomessage" %)
++(((
++**POST /api/v3/Drivers/find**
++)))
  Передается параметр: parentId - ID клиента-родителя
@@ -1835,20 +1835,23 @@
  [
    {
--    "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" %)**Получить данные о водителе**(%%) ==
--GET /api/v3/Drivers/{driverGuid}
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Drivers/{driverGuid}**
++)))
  Передается параметр: ID водителя
@@ -1855,19 +1855,22 @@
  Ответ:
  {
--  "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" %)**Добавить водителя**(%%) ==
--POST /api/v3/Drivers
++(% class="box successmessage" %)
++(((
++**POST /api/v3/Drivers**
++)))
  Запрос:
@@ -1898,7 +1898,10 @@
  == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
--PUT /api/v3/Drivers
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/Drivers**
++)))
  Запрос:
@@ -1929,7 +1929,10 @@
  == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
--DELETE /api/v3/Drivers/{driverGuid}
++(% class="box errormessage" %)
++(((
++**DELETE /api/v3/Drivers/{driverGuid}**
++)))
  Передается параметр: ID водителя
@@ -1944,7 +1944,10 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
--POST /api/v3/DriversVehiclesAssignments/GetByDrivers
++(% class="box infomessage" %)
++(((
++**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
++)))
  Запрос:
@@ -1972,7 +1972,10 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
--POST /api/v3/DriversVehiclesAssignments/GetByVehicles
++(% class="box infomessage" %)
++(((
++**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
++)))
  Запрос:
@@ -2000,7 +2000,10 @@
  === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
--POST /api/v3/DriversVehiclesAssignments
++(% class="box successmessage" %)
++(((
++**POST /api/v3/DriversVehiclesAssignments**
++)))
  Передается массив назначений
@@ -2008,11 +2008,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" ~/~/ Момент времени окончания назначения. Необязательно.
    }
  ]
@@ -2032,7 +2032,10 @@
  === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
--PUT /api/v3/DriversVehiclesAssignments
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/DriversVehiclesAssignments**
++)))
  Запрос:
@@ -2040,7 +2040,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"
@@ -2063,33 +2063,20 @@
  === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
--DELETE /api/v3/DriversVehiclesAssignments
++(% class="box errormessage" %)
++(((
++**DELETE /api/v3/DriversVehiclesAssignments**
++)))
  Запрос:
  [
--  {
--    "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"
--  }
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  ]
  Ответ:
--[
--  {
--    "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"
--  }
--]
++Success
  == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
@@ -2096,7 +2096,10 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
--POST /api/v3/DriversRfidsAssignments/GetByDrivers
++(% class="box infomessage" %)
++(((
++**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
++)))
  Запрос:
@@ -2112,9 +2112,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"
    }
@@ -2123,7 +2123,10 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
--POST /api/v3/DriversRfidsAssignments/GetByRfids
++(% class="box infomessage" %)
++(((
++**POST /api/v3/DriversRfidsAssignments/GetByRfids**
++)))
  Запрос:
@@ -2139,9 +2139,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"
    }
@@ -2150,7 +2150,10 @@
  === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
--POST /api/v3/DriversRfidsAssignments
++(% class="box successmessage" %)
++(((
++**POST /api/v3/DriversRfidsAssignments**
++)))
  Запрос:
@@ -2178,7 +2178,10 @@
  === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
--PUT /api/v3/DriversRfidsAssignments
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/DriversRfidsAssignments**
++)))
  Запрос:
@@ -2207,31 +2207,20 @@
  === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
--DELETE /api/v3/DriversRfidsAssignments
++(% class="box errormessage" %)
++(((
++**DELETE /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"
--  }
++    "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.331Z",
--    "EndTime": "2023-06-30T11:28:43.331Z"
--  }
--]
++Success
  == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
@@ -2238,7 +2238,10 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
--POST /api/v3/DriversFuelCardsAssignments/GetByDrivers
++(% class="box infomessage" %)
++(((
++**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
++)))
  Запрос:
@@ -2265,7 +2265,10 @@
  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
--POST /api/v3/DriversFuelCardsAssignments/GetByCards
++(% class="box infomessage" %)
++(((
++**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
++)))
  Запрос:
@@ -2292,7 +2292,10 @@
  === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
--POST /api/v3/DriversFuelCardsAssignments
++(% class="box successmessage" %)
++(((
++**POST /api/v3/DriversFuelCardsAssignments**
++)))
  Запрос:
@@ -2320,7 +2320,10 @@
  === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
--PUT /api/v3/DriversFuelCardsAssignments
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/DriversFuelCardsAssignments**
++)))
  Запрос:
@@ -2327,9 +2327,10 @@
  [
    {
      "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "Id": "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"
++    "BeginTime": "2023-06-30T12:09:53.201Z",
++    "EndTime": "2023-06-30T12:09:53.201Z"
    }
  ]
@@ -2348,30 +2348,20 @@
  === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
--DELETE /api/v3/DriversFuelCardsAssignments
++(% class="box errormessage" %)
++(((
++**DELETE /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"
--  }
++  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
  Ответ:
--[
--  {
--    "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"
--  }
--]
++Success
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
@@ -2378,12 +2378,15 @@
  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
--POST /api/v3/Rfids/find
++(% class="box infomessage" %)
++(((
++**POST /api/v3/Rfids/find**
++)))
  Запрос:
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++{
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
  Ответ:
@@ -2392,7 +2392,7 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, // Частота трансляции радиометки
++    "period": 0, ~/~/ Частота трансляции радиометки
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "deleted": true
@@ -2402,7 +2402,10 @@
  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
--GET /api/v3/Rfids/{rfidGuid}
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Rfids/{rfidGuid}**
++)))
  Передаем параметр rfidGuid - идентификатор карты-метки
@@ -2412,7 +2412,7 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, // Частота трансляции радиометки
++    "period": 0, ~/~/ Частота трансляции радиометки
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "deleted": true
@@ -2422,7 +2422,10 @@
  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
--POST /api/v3/Rfids
++(% class="box successmessage" %)
++(((
++**POST /api/v3/Rfids**
++)))
  Запрос:
@@ -2448,7 +2448,10 @@
  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
--PUT /api/v3/Rfids
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/Rfids**
++)))
  Запрос:
@@ -2475,7 +2475,10 @@
  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
++(% class="box errormessage" %)
++(((
  **DELETE /api/v3/Rfids/{rfidGuid}**
++)))
  Передаем параметр rfidGuid - идентификатор карты-метки

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

Summary

Details

Меню