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

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

From version < 149.1 >

edited by Андрей Калиновский
on 2024/03/18 11:34

To version < 154.2 >

edited by Андрей Калиновский
on 2024/07/19 13:24

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -60,6 +60,9 @@
  |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
  |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
++(% class="wikigeneratedid" %)
++Также  имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] /  [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации -  {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
++
  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
  (% class="box infomessage" %)
@@ -1428,7 +1428,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
++(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
@@ -4049,31 +4049,34 @@
  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
--Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
++Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
  (% class="box infomessage" %)
  (((
--**POST**/api/v3/fuelcards/transactions
++POST /api/v3/fuelcards/transactions
  )))
--Запрос должен содержать параметры:
++Метод запроса: POST
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
++\\В заголовках запроса: X-Auth: Токен авторизации
++
++Параметры в теле запроса (JSON):
++
  {
--  "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
++  "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
--  "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
++  "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
    "ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
    ],
--  "timezone": 0, ~/~/ Часовой пояс
++  "timezone": 0 ~/~/Таймзона
--  "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
--
  }
  Ответ:
@@ -4080,35 +4080,36 @@
    {
--    "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
++    "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
--    " driver ": "string", ~/~/ Имя водителя
++    "driver": "string", ~/~/Водители, привязанные к ТК
--    "amount": 0, ~/~/ Количество топлива
++    "object": "string", ~/~/Наименование ТС
--    "amountDut": 0, ~/~/ Количество топлива по ДУТ
++    "amount": 0, ~/~/Количество топлива
--    "amountDiff": 0, ~/~/ Разница в литрах
++    "amountDut": 0, ~/~/Количество по ДУТ
--    "amountDiffPerc": 0, ~/~/ Разница в %
++    "amountDiff": 0, ~/~/Разница, л
--    "summa": 0, ~/~/  Стоимость в руб.
++    "amountDiffPerc": 0, ~/~/Разница, %
--    "serviceName": "string", ~/~/ Тип топлива
++    "summa": 0, ~/~/Стоимость, руб
--    "price": 0, ~/~/ Цена за литр в руб.
++    "serviceName": "string", ~/~/Тип топлива
--    "cardName": "string", ~/~/ Наименование ТК
++    "price": 0, ~/~/Цена за литр, руб
--    "cardNum": "string", ~/~/ Номер ТК
++    "cardName": "string", ~/~/Наименование ТК
--    "operator": "string", ~/~/ Оператор ТК
++    "cardNum": "string", ~/~/Номер ТК
--    "address": "string", ~/~/ Адрес АЗС
++    "operator": "string", ~/~/Оператор ТК
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
++    "address": "string" ~/~/Адрес АЗС
    }
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
@@ -4127,36 +4127,53 @@
  Ответ:
--"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
--"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
--"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
--"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
--"objectType": "Vehicle", - Тип объекта
--"details": {
--"items": [ {
--"name": "ObjectName", - наименование столбца
--"value": "01" - содержание столбца
--},
++[
--{
--"parentName": "string",
--"name": "string",
--"picture": "string",
--"minspeed": 0,
--"maxspeed": 0,
--"width": 0,
--"imbeddedtrailer": true,
--"hoppercapacity": 0,
--"hopperdischargespeed": 0,
--"modelType": 0,
--"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--"deleted": true
--}
++  {
++    "recordTime": "",  ~/~/Время записи
--== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
++
++    "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
++
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++
++      "items": [ ~/~/ [
++
++nullable: true  ~/~/Детали
++
++        {
++
++          "name": "string", ~/~/наименование столбца
++
++          "value": "string" ~/~/содержание столбца
++
++        }
++
++      ]
++
++    },
++
++    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++
++      "string"
++
++    ]
++
++  }
++
++]
++
++
++(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
++
  (% class="box infomessage" %)
  (((
  POST/api/v3/Vehicles/recyclebin/erase
@@ -4164,12 +4164,60 @@
  В заголовках запроса: X-Auth: Токен авторизации
--Параметры в теле запроса (JSON):
++Пример запроса:
++
++
  [
--"eb737fdf-c422-4df7-8727-bd61439b8460",
--"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
++
++  0
++
  ]
++
++Пример ответа:
++
++[
++
++  {
++
++    "recordTime": "", ~/~/Время записи
++
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++
++    "objectId": 0, ~/~/ID объекта, помещённого в корзин
++
++    "objectGuid": "",  ~/~/Guid объекта, помещённого в корзину
++
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++
++      "items": [ ~/~/Детали
++
++        {
++
++          "name": "", ~/~/Имя свойства
++
++          "value": "" ~/~/Значение свойства
++
++        }
++
++      ]
++
++    },
++
++    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++
++      ""
++
++    ]
++
++  }
++
++]
++
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
  == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
@@ -4182,15 +4182,67 @@
  В заголовках запроса: X-Auth: Токен авторизации
  Параметры в теле запроса (JSON):
++
++Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Пример запроса:
++
  [
--"eb737fdf-c422-4df7-8727-bd61439b8460",
--"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
++
++  0
++
  ]
--Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
++Пример ответа:
++[
++  {
++
++    "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
++
++    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/Guid пользователя, добавившего объект в корзину
++
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
++
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
++
++    "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
++
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++
++      "items": [ ~/~/Детали
++
++        {
++
++          "name": "string",  ~/~/Имя свойства
++
++          "value": "string" ~/~/Значение свойства
++
++        }
++
++      ]
++
++    },
++
++    "errors": [ ~/~/Список ошибок удаления/восстановления объекта
++
++      "string"
++
++    ]
++
++  }
++
++]
++
++
++
  (% 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

Меню