Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 156.1 >
edited by Андрей Калиновский
on 2024/07/19 14:24
To version < 112.1 >
edited by Илья Крайнов
on 2023/10/18 17:20
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,6 +40,7 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -54,15 +54,6 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 -
63 -(% class="wikigeneratedid" %)
64 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
65 -
66 66  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
67 67  
68 68  (% class="box infomessage" %)
... ... @@ -101,51 +101,30 @@
101 101  Запрос должен содержать данные параметра "**agentId**"
102 102  
103 103  (% style="color:#000000" %)Ответ:
96 +А
104 104  {
105 - "agentId": "",  (%%)
106 - "parentId": "",
107 - "parentName": "string",
108 - "name": "string",
109 - "fullName": "string",
110 - "agentInfoType": 0,
111 - "isForeign": true/false,
112 - "district": "string", 
113 - "region": "string",
114 - "city": "string",
115 - "inn": "string",
116 - "kpp": "string",
117 - "address": "string",
118 - "addressFact": "string",
119 - "email": "string",
120 - "director": "string",
121 - "bankName": "string",
122 - "bankBIK": "string",
123 - "bankRS": "string",
124 - "bankKS": "string"
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
125 125   }
126 126  
127 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
128 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
129 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
130 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
131 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
132 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
133 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
134 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
135 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
136 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
137 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
138 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
139 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
140 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
141 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
142 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
143 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
144 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
145 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
146 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
147 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
148 -
149 149  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
150 150  
151 151  (% class="box infomessage" %)
... ... @@ -159,7 +159,7 @@
159 159  
160 160  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
161 161  
162 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
163 163  
164 164  (% style="color:#000000" %)Метод запроса: **POST**
165 165  
... ... @@ -174,23 +174,15 @@
174 174  (% style="color:#000000" %)Ответ:
175 175  
176 176  {
177 - "agentId": "",(% style="color:#000000" %)   (%%)
178 - "parentId": "",
179 - "name": "string",
180 - "fullName": "string",
181 - "agentInfoType": 0,
182 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
183 183  }
184 184  
185 -
186 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
187 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
188 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
189 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
190 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
191 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
192 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
193 -
194 194  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
195 195  
196 196  (% class="box successmessage" %)
... ... @@ -209,7 +209,7 @@
209 209  Параметры в теле запроса (JSON):
210 210  
211 211  {
212 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
213 213   "name": "string", ~/~/ имя
214 214   "fullName": "string", ~/~/ полное наименование
215 215   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -254,28 +254,6 @@
254 254   "bankKS": "string" ~/~/ корр. счёт
255 255  }
256 256  
257 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
258 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
259 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
260 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
261 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
262 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
263 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
264 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
265 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
266 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
267 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
268 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
269 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
270 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
271 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
272 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
273 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
274 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
275 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
276 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
277 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
278 -
279 279  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
280 280  
281 281  (% class="box warningmessage" %)
... ... @@ -291,6 +291,7 @@
291 291  
292 292  В заголовках запроса: X-Auth: Токен авторизации
293 293  
235 +
294 294  Параметры в теле запроса (JSON):
295 295  
296 296  {
... ... @@ -315,6 +315,7 @@
315 315   "bankKS": "string" ~/~/ корр. счёт
316 316  }
317 317  
260 +
318 318  Ответ:
319 319  
320 320  {
... ... @@ -357,21 +357,6 @@
357 357  
358 358  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
359 359  
360 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
361 -
362 -(% class="box warningmessage" %)
363 -(((
364 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 -)))
366 -
367 -Метод позволяет изменить статус клиента, указанного в запросе.
368 -
369 -В пути указывается GUID клиента и статус клиента.
370 -
371 -**status **- значение 0 - заблокирован, 1 - активен.
372 -
373 -Ответ: Code 204
374 -
375 375  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
376 376  
377 377  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -435,6 +435,7 @@
435 435   "password": "string",
436 436   "email": "string",
437 437  
366 +
438 438  (% style="text-align:left" %)
439 439  (% style="color:#000000; font-weight:normal" %)Ответ:
440 440  
... ... @@ -463,7 +463,6 @@
463 463  (% style="text-align:left" %)
464 464  (% style="color:#000000; font-weight:normal" %)}
465 465  
466 -
467 467  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
468 468  
469 469  (% class="box infomessage" %)
... ... @@ -783,6 +783,7 @@
783 783   "maxspeed": 0,
784 784   "width": 0,
785 785   "imbeddedtrailer": true,
714 + "fueloutlay": 0,
786 786   "hoppercapacity": 0,
787 787   "hopperdischargespeed": 0,
788 788   "modelType": 0,
... ... @@ -799,8 +799,9 @@
799 799  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
800 800  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
801 801  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
802 802  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
803 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
804 804  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
805 805  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
806 806  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -892,24 +892,12 @@
892 892   "maxspeed": 0,
893 893   "width": 0,
894 894   "imbeddedtrailer": true,
825 + "fueloutlay": 0,
895 895   "hoppercapacity": 0,
896 896   "hopperdischargespeed": 0,
897 897   "modelType": 0
898 898  }
899 899  
900 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
901 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
902 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
903 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
904 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
905 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
906 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
907 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
908 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
909 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
910 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
911 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
912 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
913 913  
914 914  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
915 915  
... ... @@ -964,20 +964,6 @@
964 964   "modelType": 0
965 965  }
966 966  
967 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
968 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
969 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
970 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
971 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
972 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
973 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
974 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
975 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
976 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
977 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
978 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
979 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
980 -
981 981  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
982 982  
983 983  (% class="box errormessage" %)
... ... @@ -1209,84 +1209,6 @@
1209 1209  (% style="text-align:left" %)
1210 1210  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1211 1211  
1212 -===== =====
1213 -
1214 -== **Получить ответ на отправленную на ТС команду** ==
1215 -
1216 -(% class="box infomessage" %)
1217 -(((
1218 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1219 -)))
1220 -
1221 -Идентификатор команды: cmdid
1222 -
1223 -
1224 -Запрос от терминала на ответ команды
1225 -
1226 -
1227 -Пример ответ от терминала:
1228 -
1229 -
1230 -ID= "" ~/~/ идентификатор произвольного поля
1231 -
1232 -Soft="" ~/~/ версия софта
1233 -
1234 -GPS=4 ~/~/ тип трекера
1235 -
1236 -Time=11:05:43 28.06.24 ~/~/ время запроса
1237 -
1238 -Lat=45.056221 ~/~/ широта
1239 -
1240 -Lon=39.035938 ~/~/ долгота
1241 -
1242 -Speed=0.0 ~/~/ скорость
1243 -
1244 -Course=181.4 ~/~/направление
1245 -
1246 -
1247 -
1248 -(((
1249 -== **Список отправленных объекту команд с ответами** ==
1250 -
1251 -(% class="box infomessage" %)
1252 -(((
1253 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1254 -)))
1255 -
1256 -Идентификатор ТС: vehicleId
1257 -
1258 -
1259 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1260 -
1261 -
1262 -Пример ответа терминала
1263 -
1264 -
1265 -[ 
1266 -
1267 -{   
1268 -
1269 -"id": "", ~/~/ идентификатор пользователя
1270 -
1271 -"commandText": "", ~/~/Текст команды.
1272 -
1273 -"templateId": "", ~/~/Идентификатор шаблона
1274 -
1275 -"updated": "", ~/~/ Время отправки 
1276 -
1277 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1278 -
1279 -"answer": "", ~/~/ Ответ терминала.
1280 -
1281 -"status": "" ~/~/ Статус отправки
1282 -
1283 -}
1284 -
1285 -]
1286 -
1287 -
1288 -)))
1289 -
1290 1290  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1291 1291  
1292 1292  (% class="box successmessage" %)
... ... @@ -1509,7 +1509,7 @@
1509 1509  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1510 1510  )))
1511 1511  
1512 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1338 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1513 1513  
1514 1514  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1515 1515  
... ... @@ -1630,30 +1630,6 @@
1630 1630  (% style="text-align:left" %)
1631 1631  (% style="color:#000000" %) }
1632 1632  
1633 -(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
1634 -**Отправить команду на терминал**
1635 -
1636 -(% class="box successmessage" %)
1637 -(((
1638 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1639 -)))
1640 -
1641 -Команда для отправки на тс.
1642 -
1643 -
1644 -{ 
1645 -
1646 -"id": "", ~/~/идентификатор произвольного поля
1647 -
1648 -"command": "", ~/~/ Текст команды
1649 -
1650 -"retries": "", ~/~/ Количество попыток
1651 -
1652 -"idTemplate": "" ~/~/ ID шаблона команды
1653 -
1654 -}
1655 -
1656 -
1657 1657  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1658 1658  
1659 1659  (% class="box warningmessage" %)
... ... @@ -1907,7 +1907,7 @@
1907 1907  
1908 1908  (% style="color:#000000" %)Метод запроса: **GET**
1909 1909  
1910 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1712 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1911 1911  
1912 1912  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1913 1913  
... ... @@ -1990,56 +1990,6 @@
1990 1990   }
1991 1991  ]
1992 1992  
1993 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1994 -
1995 -(% class="box infomessage" style="text-align: left;" %)
1996 -(((
1997 -**POST /api/v3/terminalMessages/mapping**
1998 -)))
1999 -
2000 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2001 -
2002 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2003 -
2004 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2005 -
2006 -{
2007 - "protocolType": 0,
2008 - "params": ["string"]
2009 -}
2010 -
2011 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2012 -|protocolType|ID типа протокола
2013 -|params|(((
2014 -Массив наименований параметров в сообщении
2015 -)))
2016 -
2017 -Ответ:
2018 -
2019 -{
2020 - "protocolType": 0,
2021 - "mapping": {
2022 - "additionalProp1": {
2023 - "inputType": 0,
2024 - "inputNumber": 0
2025 - },
2026 - "additionalProp2": {
2027 - "inputType": 0,
2028 - "inputNumber": 0
2029 - }
2030 - }
2031 -}
2032 -
2033 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2034 -|protocolType|Тип протокола
2035 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2036 -|inputNumber|(((
2037 -Номер входа
2038 -)))
2039 -
2040 -(% class="wikigeneratedid" %)
2041 -Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2042 -
2043 2043  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2044 2044  
2045 2045  (% class="box infomessage" %)
... ... @@ -2064,11 +2064,6 @@
2064 2064   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2065 2065  }
2066 2066  
2067 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2068 -|vehicleId|ID объекта
2069 -|from|Дата и время начала периода запроса
2070 -|to|Дата и время окончания периода запроса
2071 -
2072 2072  Ответ:
2073 2073  
2074 2074  [
... ... @@ -2075,43 +2075,80 @@
2075 2075   {
2076 2076   "messages": [
2077 2077   {
2078 - "deviceTime": "2023-11-29T07:40:44.052Z",
2079 - "serverTime": "2023-11-29T07:40:44.052Z",
2080 - "speed": 0,
2081 - "altitude": 0,
2082 - "latitude": 0,
2083 - "longitude": 0,
2084 - "satellites": 0,
2085 - "course": 0,
2086 - "voltage": 0,
2087 - "parameters": {
1825 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1826 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1827 + "speed": 0, ~/~/ Скорость, км/ч
1828 + "altitude": 0, ~/~/ Высота, м
1829 + "latitude": 0, ~/~/ Широта [-90°;90°]
1830 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1831 + "satellites": 0, ~/~/ Кол-во спутников
1832 + "voltage": 0, ~/~/ Напряжение
1833 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
2088 2088   "additionalProp1": "string",
2089 2089   "additionalProp2": "string",
2090 2090   "additionalProp3": "string"
2091 2091   },
2092 - "photoCount": 0,
2093 - "lbsCorrectedCoords": true,
2094 - "protocolType": 0
1838 + "photoCount": 0 ~/~/ Кол-во фото
2095 2095   }
2096 2096   ]
2097 2097   }
2098 2098  ]
2099 2099  
2100 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2101 -|deviceTime|Время сообщения терминала
2102 -|serverTime|Время когда сообщение поступило на сервер
2103 -|speed|Скорость
2104 -|altitude|Высота над уровнем моря
2105 -|latitude|Широта
2106 -|longitude|Долгота
2107 -|satellites|Кол-во спутников
2108 -|course|Курс
2109 -|voltage|Бортовое напряжение
2110 -|parameters|Список параметров и их значений
2111 -|photoCount|Количество фото
2112 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2113 -|protocolType|ID типа протокола
1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
2114 2114  
1846 +(% class="box infomessage" %)
1847 +(((
1848 +**POST /api/v3/vehicles/export/history**
1849 +)))
1850 +
1851 +Метод возвращает список сообщений терминала объекта за выбранный период.
1852 +
1853 +(% style="text-align: left;" %)
1854 +Метод запроса **POST**
1855 +
1856 +(% style="text-align: left;" %)
1857 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1858 +
1859 +(% style="text-align: left;" %)
1860 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1861 +
1862 +{
1863 + "vehicleId": 0, ~/~/ ID объекта
1864 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1865 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1866 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1867 +}
1868 +
1869 +Ответ:
1870 +
1871 +Получаете файл. Сообщение: Code 200/Success
1872 +
1873 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1874 +
1875 +(% class="box infomessage" %)
1876 +(((
1877 +**GET /api/v3/vehicles/export/history/status**
1878 +)))
1879 +
1880 +Метод возвращает список сообщений терминала объекта за выбранный период.
1881 +
1882 +(% style="text-align: left;" %)
1883 +Метод запроса **GET**
1884 +
1885 +(% style="text-align: left;" %)
1886 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1887 +
1888 +(% style="text-align: left;" %)
1889 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1890 +
1891 +Ответ:
1892 +
1893 +{
1894 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1895 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1896 + "message": "string" ~/~/ текст описывающий статус.
1897 +}
1898 +
2115 2115  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2116 2116  
2117 2117  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2245,129 +2245,6 @@
2245 2245   }
2246 2246  ]
2247 2247  
2248 -
2249 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2250 -
2251 -(% class="box infomessage" %)
2252 -(((
2253 -**POST /api/v3/vehicles/moveStop**
2254 -)))
2255 -
2256 -Метод запроса: **POST**
2257 -
2258 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2259 -
2260 -В заголовках запроса: X-Auth: Токен авторизации
2261 -
2262 -
2263 -Тело запроса:
2264 -
2265 -{
2266 -
2267 - "vehicleIds": [ ], ~/~/ Список ID объектов
2268 -
2269 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2270 -
2271 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2272 -
2273 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2274 -
2275 -}
2276 -
2277 -Ответ:
2278 -
2279 -[
2280 -
2281 - {
2282 -
2283 - "vehicleId": 0, ~/~/ ID объекта
2284 -
2285 - "vehicleName": "string", ~/~/ Имя объекта
2286 -
2287 - "moves": [ ~/~/ Событие движения
2288 -
2289 - {
2290 -
2291 - "mileage": 0, ~/~/ Пробег, км
2292 -
2293 - "eventId": 0, ~/~/ Идентификатор события
2294 -
2295 - "eventName": "string", ~/~/ Название события
2296 -
2297 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2298 -
2299 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2300 -
2301 - "duration": 0 ~/~/ Продолжительность события, секунд
2302 -
2303 - }
2304 -
2305 - ],
2306 -
2307 - "stops": [ ~/~/ События стоянок
2308 -
2309 - {
2310 -
2311 - "address": "string", ~/~/ Адрес события
2312 -
2313 - "eventId": 0, ~/~/ Идентификатор события
2314 -
2315 - "eventName": "string", ~/~/ Название события
2316 -
2317 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2318 -
2319 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2320 -
2321 - "duration": 0 ~/~/ Продолжительность события, секунд
2322 -
2323 -
2324 - }
2325 -
2326 - ]
2327 -
2328 - }
2329 -
2330 -]
2331 -
2332 -
2333 -
2334 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2335 -
2336 -(% class="box infomessage" %)
2337 -(((
2338 -**POST /api/v3/vehicles/getlastdata**
2339 -)))
2340 -
2341 -Метод запроса: **POST**
2342 -
2343 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2344 -
2345 -В заголовках запроса: X-Auth: Токен авторизации
2346 -
2347 -
2348 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2349 -
2350 -Ответ:
2351 - {
2352 - "vehicleId": 0, ~/~/Идентификатор объекта.
2353 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2354 - "vehicleNumber": "string",~/~/Номер объекта.
2355 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2356 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2357 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2358 - "speed": 0,~/~/Скорость объекта.
2359 - "course": 0,~/~/Курс движения [0;360]
2360 - "latitude": 0,~/~/Широта [-90°;90°].
2361 - "longitude": 0,~/~/Долгота [-180°;180°].
2362 - "address": "string",~/~/Адрес.
2363 - "geozones": [ ~/~/Сведения по геозонам.
2364 - {
2365 - "id": 0,
2366 - "name": "string"
2367 - }
2368 -
2369 -
2370 -
2371 2371  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2372 2372  
2373 2373  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3266,83 +3266,6 @@
3266 3266  Success
3267 3267  
3268 3268  
3269 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3270 -
3271 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3272 -
3273 -(% class="box infomessage" %)
3274 -(((
3275 -**POST /api/v3/Trailers**
3276 -)))
3277 -
3278 -Пример запроса:
3279 -
3280 -{
3281 - "startDate": "2023-11-14T10:48:03.671Z",
3282 - "endDate": "2023-11-14T10:48:03.671Z",
3283 - "ids": [ 0 ],
3284 - "timezone": 0
3285 -}
3286 -
3287 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3288 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3289 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3290 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3291 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3292 -
3293 -Пример ответа:
3294 -
3295 -[
3296 - {
3297 - "SD": "2023-11-14T10:48:03.717Z",
3298 - "ED": "2023-11-14T10:48:03.717Z", 
3299 - "id": 0,
3300 - "SLat": 0,
3301 - "SLon": 0,
3302 - "ELat": 0,
3303 - "ELon": 0,
3304 - "mileage": 0
3305 - "Duration": 0
3306 - "Address": "string",
3307 - "Address2": "string",
3308 - "name": "string",
3309 - "rid": "string",
3310 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3311 - "trailer": {
3312 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3313 - "Number": "string",
3314 - "Description": "string",
3315 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3316 - "ExternalID": "string",
3317 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3318 - "CreateTime": "2023-11-14T10:48:03.717Z",
3319 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3320 - "IsDeleted": true
3321 - },
3322 - "filesCount": 0,
3323 - }
3324 -]
3325 -
3326 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3327 -|SD|Дата и время начала события
3328 -|ED|Дата и время окончания события
3329 -|id|ID объекта
3330 -|SLat|Широта начальной координаты
3331 -|SLon|Долгота начальной координаты
3332 -|ELat|Широта конечной координаты
3333 -|ELon|Долгота конечной координаты
3334 -|mileage|Пробег
3335 -|Duration|Продолжительность
3336 -|Address|Адрес начального местоположения
3337 -|Address2|Адрес конечного местоположения
3338 -|name|Имя радиометки
3339 -|rid|Номер радиометки
3340 -|rguid|ID радиометки
3341 -|trailer|Информация об агрегате
3342 -|ModelGuid|ID агрегата
3343 -|Number|Название/номер агрегата
3344 -|Description|Текст примечания агрегата
3345 -
3346 3346  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3347 3347  
3348 3348  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3364,19 +3364,13 @@
3364 3364   {
3365 3365   "name": "string",
3366 3366   "number": 0,
3367 - "period": 0,
2951 + "period": 0, ~/~/ Частота трансляции радиометки
3368 3368   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3369 3369   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "deleted": true
3370 3370   }
3371 3371  ]
3372 3372  
3373 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3374 -|parentId|ID клиента
3375 -|name|Название карты-метки
3376 -|number|Номер
3377 -|period|Период запросов в секундах (работает только для агрегатов)
3378 -|id|ID карты-метки
3379 -
3380 3380  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3381 3381  
3382 3382  (% class="box infomessage" %)
... ... @@ -3392,18 +3392,13 @@
3392 3392   {
3393 3393   "name": "string",
3394 3394   "number": 0,
3395 - "period": 0,
2973 + "period": 0, ~/~/ Частота трансляции радиометки
3396 3396   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3397 3397   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "deleted": true
3398 3398   }
3399 3399  ]
3400 3400  
3401 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3402 -|name|Название карты-метки
3403 -|number|Номер
3404 -|period|Период запросов в секундах (работает только для агрегатов)
3405 -|id|ID карты-метки
3406 -|parentId|ID клиента
3407 3407  
3408 3408  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3409 3409  
... ... @@ -3419,6 +3419,7 @@
3419 3419   "number": 0,
3420 3420   "period": 0,
3421 3421   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 + "deleted": true
3422 3422  }
3423 3423  
3424 3424  Ответ:
... ... @@ -3429,15 +3429,9 @@
3429 3429   "period": 0,
3430 3430   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3431 3431   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3006 + "deleted": true
3432 3432  }
3433 3433  
3434 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3435 -|name|Название карты-метки
3436 -|number|Номер
3437 -|period|Период запросов в секундах (работает только для агрегатов)
3438 -|id|ID карты-метки
3439 -|parentId|ID клиента
3440 -
3441 3441  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3442 3442  
3443 3443  (% class="box warningmessage" %)
... ... @@ -3453,6 +3453,7 @@
3453 3453   "period": 0,
3454 3454   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3455 3455   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3024 + "deleted": true
3456 3456  }
3457 3457  
3458 3458  Ответ:
... ... @@ -3463,15 +3463,9 @@
3463 3463   "period": 0,
3464 3464   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 3465   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 + "deleted": true
3466 3466  }
3467 3467  
3468 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3469 -|name|Название карты-метки
3470 -|number|Номер
3471 -|period|Период запросов в секундах (работает только для агрегатов)
3472 -|id|ID карты-метки
3473 -|parentId|ID клиента
3474 -
3475 3475  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3476 3476  
3477 3477  (% class="box errormessage" %)
... ... @@ -3479,7 +3479,7 @@
3479 3479  **DELETE /api/v3/Rfids/{rfidGuid}**
3480 3480  )))
3481 3481  
3482 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3045 +Передаем параметр rfidGuid - идентификатор карты-метки
3483 3483  
3484 3484  Ответ:
3485 3485  
... ... @@ -3720,8 +3720,6 @@
3720 3720  **PUT /api/v3/Billing/client/balance**
3721 3721  )))
3722 3722  
3723 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3724 -
3725 3725  Тело запроса:
3726 3726  
3727 3727  {
... ... @@ -3735,50 +3735,6 @@
3735 3735  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3736 3736  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3737 3737  
3738 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3739 -
3740 -(% class="box warningmessage" %)
3741 -(((
3742 -**PUT /api/v3/billing/client/balance/deposit**
3743 -)))
3744 -
3745 -Создает операцию **Пополнение **с указанной суммой
3746 -
3747 -Тело запроса:
3748 -
3749 -{
3750 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3751 - "Balance": 0
3752 -}
3753 -
3754 -Ответ: Success
3755 -
3756 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3757 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3758 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3759 -
3760 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3761 -
3762 -Создает операцию **Списание **с указанной суммой
3763 -
3764 -(% class="box warningmessage" %)
3765 -(((
3766 -**PUT /api/v3/billing/client/balance/withdraw**
3767 -)))
3768 -
3769 -Тело запроса:
3770 -
3771 -{
3772 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3773 - "Balance": 0
3774 -}
3775 -
3776 -Ответ: Success
3777 -
3778 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3779 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3780 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3781 -
3782 3782  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3783 3783  
3784 3784  (% class="box warningmessage" %)
... ... @@ -3851,990 +3851,6 @@
3851 3851  |PeriodValue|Значение периода.
3852 3852  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3853 3853  
3854 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3855 -
3856 -(% class="box warningmessage" %)
3857 -(((
3858 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3859 -)))
3860 -
3861 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3862 -
3863 -(% class="box infomessage" %)
3864 -(((
3865 -**POST /api/v3/vehicles/import/{agentId}**
3866 -)))
3867 -
3868 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3869 -
3870 -В пути указывается **agentId** - id клиента.
3871 -
3872 -**Заголовок**
3873 -
3874 -**X-Auth: [токен авторизации]**
3875 -
3876 -**Параметры**
3877 -
3878 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3879 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3880 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3881 -
3882 -В теле использовать тип **form-data,** тип значения** file**
3883 -
3884 -**Ключи**
3885 -
3886 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3887 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3888 -|csv|В значении передаем файл датчиков, формат **csv**
3889 -
3890 -Ответ:
3891 -
3892 -{
3893 - "vehicleId": 0,
3894 - "name": "string",
3895 - "errors": ["string"]
3896 -}
3897 -
3898 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3899 -|vehicleId|ID созданного объекта
3900 -|name|Имя созданного объекта
3901 -|errors|Ошибки и их описание
3902 -
3903 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3904 -
3905 -(% class="box infomessage" %)
3906 -(((
3907 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3908 -)))
3909 -
3910 -(% class="wikigeneratedid" %)
3911 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3912 -
3913 -(% class="wikigeneratedid" %)
3914 -В пути указывается **vehicleId **- id объекта.
3915 -
3916 -**Заголовок**
3917 -
3918 -**X-Auth: [токен авторизации]**
3919 -
3920 -В теле использовать тип **form-data.**
3921 -
3922 -Ключи:
3923 -
3924 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3925 -|**history**|В значении передавать файл с историей
3926 -
3927 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3928 -
3929 -Ответ:
3930 -
3931 -{
3932 - "results": [
3933 - {
3934 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3935 - "vehicleId": 0,
3936 - "errors": [
3937 - "string"
3938 - ],
3939 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3940 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3941 - "producedCount": 0,
3942 - "msgCount": 0
3943 - }
3944 - ]
3945 -}
3946 -
3947 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3948 -|results|Результаты импорта в разрезе ТС
3949 -|vehicleGuid|Guid ТС
3950 -|vehicleId|ID ТС
3951 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3952 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3953 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3954 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3955 -|msgCount|Кол-во обработанных сообщений всего
3956 -
3957 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3958 -
3959 -(% class="box infomessage" %)
3960 -(((
3961 -**GET /api/v3/vehicles/import/history/status**
3962 -)))
3963 -
3964 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3965 -
3966 -Ответ:
3967 -
3968 -{
3969 - "activity": true,
3970 - "progress": 0,
3971 - "message": "string"
3972 -}
3973 -
3974 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3975 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3976 -|progress|Guid ТС
3977 -
3978 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3979 -
3980 -(% class="box infomessage" %)
3981 -(((
3982 -**POST /api/v3/vehicles/export**
3983 -)))
3984 -
3985 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3986 -
3987 -Тело запроса:
3988 -
3989 -[
3990 - id
3991 -]
3992 -
3993 -Ответ: Success 200, получаете файлы с настройками.
3994 -
3995 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3996 -
3997 -(% class="box infomessage" %)
3998 -(((
3999 -**POST /api/v3/vehicles/export/history**
4000 -)))
4001 -
4002 -Метод возвращает список сообщений терминала объекта за выбранный период.
4003 -
4004 -Тело запроса:
4005 -
4006 -{
4007 - "vehicleId": 0,
4008 - "asArchive": true,
4009 - "from": "2023-09-27T12:17:45.973Z",
4010 - "to": "2023-09-27T12:17:45.973Z"
4011 -}
4012 -
4013 -Ответ:
4014 -
4015 -Получаете файл. Сообщение: Code 200/Success
4016 -
4017 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4018 -|vehicleId|ID объекта
4019 -|asArchive|true - Архивировать файл, False - не архивировать
4020 -|from|Дата и время начала запроса
4021 -|to|Дата и время окончания запроса
4022 -
4023 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4024 -
4025 -(% class="box infomessage" %)
4026 -(((
4027 -**GET /api/v3/vehicles/export/history/status**
4028 -)))
4029 -
4030 -Метод возвращает список сообщений терминала объекта за выбранный период.
4031 -
4032 -Ответ:
4033 -
4034 -{
4035 - "activity": true,
4036 - "progress": 0,
4037 - "message": "string"
4038 -}
4039 -
4040 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4041 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4042 -|progress|Прогресс экспорта, от 0 до 100%
4043 -|message|Текст описывающий статус
4044 -
4045 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4046 -
4047 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4048 -
4049 -(% class="box infomessage" %)
4050 -(((
4051 -**POST /api/v3/EcoDriving/rating**
4052 -)))
4053 -
4054 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4055 -
4056 -Тело запроса:
4057 -
4058 -{
4059 - "vehicleIds": [vehicleId],
4060 - "from": "2023-11-22T09:29:48.051Z",
4061 - "to": "2023-11-22T09:29:48.051Z"
4062 -}
4063 -
4064 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4065 -|vehicleIds|Массив ID объектов
4066 -|from|Дата начала запроса
4067 -|to|Дата окончания запроса
4068 -
4069 -Ответ:
4070 -
4071 -{
4072 - "items": [
4073 - {
4074 - "from": "2023-11-22T09:29:48.052Z",
4075 - "to": "2023-11-22T09:29:48.052Z",
4076 - "vehicleId": 0,
4077 - "vehicleName": "string",
4078 - "vehicleModel": "string",
4079 - "penalty": 0,
4080 - "score": 0,
4081 - "totalViolations": 0,
4082 - "violationsByType": {
4083 - "overspeedingViolations": 0,
4084 - "accelerationViolations": 0,
4085 - "brakingViolations": 0,
4086 - "turningViolations": 0,
4087 - "dangerousDrivingViolations": 0,
4088 - "sensorViolations": 0
4089 - },
4090 - "moveTime": 0,
4091 - "mileage": 0,
4092 - "tripsCount": 0,
4093 - "trips": [
4094 - {
4095 - "penalty": 0,
4096 - "score": 0,
4097 - "violationsCount": 0,
4098 - "violationsByType": {
4099 - "overspeedingViolations": 0,
4100 - "accelerationViolations": 0,
4101 - "brakingViolations": 0,
4102 - "turningViolations": 0,
4103 - "dangerousDrivingViolations": 0,
4104 - "sensorViolations": 0
4105 - },
4106 - "moveTime": 0,
4107 - "mileage": 0,
4108 - "motohours": 0,
4109 - "maxSpeed": 0,
4110 - "startAddress": "string",
4111 - "endAddress": "string",
4112 - "drivers": [
4113 - {
4114 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4115 - "driverName": "string",
4116 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4117 - }
4118 - ]
4119 - }
4120 - ]
4121 - }
4122 - ]
4123 -}
4124 -
4125 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4126 -|from|Дата начала запроса
4127 -|to|Дата  окончания
4128 -|vehicleId|ID объекта
4129 -|vehicleName|Имя объекта
4130 -|vehicleModel|Модель объекта
4131 -|penalty|Сумма штрафных баллов
4132 -|score|Оценка
4133 -|totalViolations|Суммарное количество нарушений
4134 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4135 -|overspeedingViolations|Превышение скорости
4136 -|accelerationViolations|Ускорение
4137 -|brakingViolations|Торможение
4138 -|turningViolations|Резкий поворот
4139 -|dangerousDrivingViolations|Резкое вождение
4140 -|sensorViolations|Нарушение по датчику
4141 -|moveTime|Время в движении
4142 -|mileage|Пробег
4143 -|tripsCount|Количество рейсов
4144 -|motohours|Моточасы
4145 -|maxSpeed|Максимальная скорость
4146 -|startAddress|Адрес начала рейса
4147 -|endAddress|Адрес окончания рейса
4148 -|drivers|Список водителей, которые были на объекте в течениии рейса
4149 -|driverGuid|Guid водителя
4150 -|driverName|Имя водителя
4151 -|driverRfid|Номер Карты-метки
4152 -
4153 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4154 -
4155 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4156 -
4157 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4158 -
4159 -(% class="box infomessage" %)
4160 -(((
4161 -POST /api/v3/fuelcards/transactions
4162 -)))
4163 -
4164 -Метод запроса: POST
4165 -
4166 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4167 -\\В заголовках запроса: X-Auth: Токен авторизации
4168 -
4169 -Параметры в теле запроса (JSON):
4170 -
4171 -{
4172 -
4173 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4174 -
4175 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4176 -
4177 - "ids": [
4178 -
4179 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4180 -
4181 - ],
4182 -
4183 - "timezone": 0 ~/~/Таймзона
4184 -
4185 -}
4186 -
4187 -Ответ:
4188 -
4189 - {
4190 -
4191 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4192 -
4193 - "driver": "string", ~/~/Водители, привязанные к ТК
4194 -
4195 - "object": "string", ~/~/Наименование ТС
4196 -
4197 - "amount": 0, ~/~/Количество топлива
4198 -
4199 - "amountDut": 0, ~/~/Количество по ДУТ
4200 -
4201 - "amountDiff": 0, ~/~/Разница, л
4202 -
4203 - "amountDiffPerc": 0, ~/~/Разница, %
4204 -
4205 - "summa": 0, ~/~/Стоимость, руб
4206 -
4207 - "serviceName": "string", ~/~/Тип топлива
4208 -
4209 - "price": 0, ~/~/Цена за литр, руб
4210 -
4211 - "cardName": "string", ~/~/Наименование ТК
4212 -
4213 - "cardNum": "string", ~/~/Номер ТК
4214 -
4215 - "operator": "string", ~/~/Оператор ТК
4216 -
4217 - "address": "string" ~/~/Адрес АЗС
4218 -
4219 - }
4220 -
4221 -
4222 -==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ====
4223 -
4224 -
4225 -==== **Получение полных данных о ретрансляторе** ====
4226 -
4227 -(% class="box infomessage" %)
4228 -(((
4229 -**GET ** **/api/v3/retranslations/{id}**
4230 -)))
4231 -
4232 -Идентификатор запроса: ID
4233 -
4234 -
4235 -Пример ответа:
4236 -
4237 -{ 
4238 -
4239 -"description": "", ~/~/ Определяет описание
4240 -
4241 -"subscriberId": "", ~/~/ Подписчик
4242 -
4243 -"protocolType": 0, ~/~/ Тип протокола
4244 -
4245 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4246 -
4247 -"address": "string", ~/~/ Адрес события
4248 -
4249 -"objects": [ ~/~/Объекты для ретрансляции
4250 -
4251 -{     
4252 -
4253 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4254 -
4255 -"name": "", ~/~/ Наименование объекта ретрансляции
4256 -
4257 -"imei": "", ~/~/ IMEI объекта 
4258 -
4259 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4260 -
4261 -}
4262 -
4263 - ], 
4264 -
4265 -"id": "", ~/~/ идентификатор пользователя  
4266 -
4267 -"parentId": "", ~/~/Guid родителя
4268 -
4269 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4270 -
4271 -}
4272 -
4273 -
4274 -==== **Удаление данных ретранслятора** ====
4275 -
4276 -(% class="box infomessage" %)
4277 -(((
4278 -**DELETE** **/api/v3/retranslations/{id}**
4279 -)))
4280 -
4281 -Параметр запроса: ID
4282 -
4283 -
4284 -==== **Создание ретранслятора** ====
4285 -
4286 -(% class="box infomessage" %)
4287 -(((
4288 -**POST ** **/api/v3/retranslations/{id}**
4289 -)))
4290 -
4291 -Запрос:
4292 -
4293 -
4294 -{ 
4295 -
4296 -"description": "", ~/~/ Описание
4297 -
4298 -"subscriberId": "", ~/~/ Подписчик
4299 -
4300 -"protocolType": 0, ~/~/ Тип протокола
4301 -
4302 -"address": "", ~/~/ Адрес ретрансляции
4303 -
4304 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4305 -
4306 -"objects": [ ~/~/Объекты для ретрансляции
4307 -
4308 -{     
4309 -
4310 -"id": "", ~/~/ идентификатор пользователя    
4311 -
4312 -"imei": "", ~/~/IMEI объекта
4313 -
4314 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен 
4315 -
4316 -}
4317 -
4318 - ]
4319 -
4320 -}
4321 -
4322 -
4323 -
4324 -Ответ
4325 -
4326 -{ 
4327 -
4328 -"description": "string", ~/~/ Определяет описание
4329 -
4330 -"subscriberId": "", ~/~/ идентификатор запроса
4331 -
4332 -"protocolType": 0, ~/~/ Тип протокола
4333 -
4334 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4335 -
4336 -"address": "", ~/~/ Адрес события
4337 -
4338 -"objects": [ ~/~/Объекты для ретрансляции
4339 -
4340 -{     
4341 -
4342 -"id": "", ~/~/ идентификатор пользователя   
4343 -
4344 -"name": "string", ~/~/ Название уведомления
4345 -
4346 -"imei": "string", ~/~/IMEI объекта 
4347 -
4348 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 
4349 -
4350 -}
4351 -
4352 - ], 
4353 -
4354 -"id": "", ~/~/ идентификатор пользователя 
4355 -
4356 -"parentId": "", ~/~/ Guid идентификатор родителя
4357 -
4358 -"deleted": true ~/~/ Признак удаления
4359 -
4360 -}
4361 -
4362 -
4363 -==== **Редактирование ретранслятора** ====
4364 -
4365 -(% class="box infomessage" %)
4366 -(((
4367 -**PUT** **/api/v3/retranslations**
4368 -)))
4369 -
4370 -Пример запроса:
4371 -
4372 -{ 
4373 -
4374 -"id": "", ~/~/ идентификатор пользователя  
4375 -
4376 -"description": "string", ~/~/ Определяет описание
4377 -
4378 -"subscriberId": "", ~/~/ идентификатор запроса
4379 -
4380 -"protocolType": 0, ~/~/ Тип протокола
4381 -
4382 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 
4383 -
4384 -"address": "string", ~/~/ Адрес события
4385 -
4386 -"objects": ~/~/Объекты для ретрансляции
4387 -
4388 -[   
4389 -
4390 -{     
4391 -
4392 -"id": "",  ~/~/ идентификатор пользователя        
4393 -
4394 -"imei": "", ~/~/IMEI объекта
4395 -
4396 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 
4397 -
4398 -}
4399 -
4400 - ]
4401 -
4402 -}
4403 -
4404 -
4405 -Пример ответа:
4406 -
4407 -{ 
4408 -
4409 -"description": "", ~/~/ Определяет описание
4410 -
4411 -"subscriberId": "", ~/~/ идентификатор запроса
4412 -
4413 -"protocolType": 0, ~/~/ Тип протокола
4414 -
4415 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 
4416 -
4417 -"address": "string", ~/~/ Адрес события
4418 -
4419 -"objects": [ ~/~/Объекты для ретрансляции
4420 -
4421 -{     
4422 -
4423 -"id": "", ~/~/ идентификатор пользователя    
4424 -
4425 -"name": "string", ~/~/ Название уведомления   
4426 -
4427 -"imei": "", ~/~/IMEI объекта
4428 -
4429 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 
4430 -
4431 -}
4432 -
4433 - ],
4434 -
4435 -"id": "", ~/~/ идентификатор пользователя  
4436 -
4437 -"parentId": "", ~/~/ Guid идентификатор родителя
4438 -
4439 -"deleted": true ~/~/ Признак удаления
4440 -
4441 -}
4442 -
4443 -
4444 -
4445 -==== **Получение списка ретранслятора клиента** ====
4446 -
4447 -(% class="box infomessage" %)
4448 -(((
4449 -**POST /api/v3/retranslations/find**
4450 -)))
4451 -
4452 -Пример запроса:
4453 -
4454 -
4455 -{ 
4456 -
4457 -"id": "", ~/~/ идентификатор пользователя  
4458 -
4459 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4460 -
4461 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4462 -
4463 -}
4464 -
4465 -
4466 -
4467 -Ответ
4468 -
4469 -
4470 -[ 
4471 -
4472 -{   
4473 -
4474 -"description": "", ~/~/ Определяет описание
4475 -
4476 -"subscriberId": "", ~/~/ идентификатор запроса
4477 -
4478 -"protocolType": 0, ~/~/ Тип протокола
4479 -
4480 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 
4481 -
4482 -"address": "string", ~/~/ Адрес события
4483 -
4484 -"id": "", ~/~/ идентификатор пользователя  
4485 -
4486 -"parentId": "", ~/~/ Guid идентификатор родителя
4487 -
4488 -"deleted": true ~/~/ Признак удаления
4489 -
4490 -}
4491 -
4492 -]
4493 -
4494 -
4495 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
4496 -
4497 -
4498 -==== **API для отчета по выгрузке комбайнов** ====
4499 -
4500 -
4501 -(% class="box infomessage" %)
4502 -(((
4503 -POST **/api/v3/Reports/harvesterUnloading**
4504 -)))
4505 -
4506 -Пример запроса:
4507 -
4508 -
4509 -{
4510 -
4511 - "byTime": 0, ~/~/ Объединение событий по времени
4512 -
4513 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4514 -
4515 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4516 -
4517 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4518 -
4519 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4520 -
4521 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4522 -
4523 - 0
4524 -
4525 - ],
4526 -
4527 - "from": "", ~/~/ Дата и время начало запроса
4528 -
4529 - "to": "", ~/~/ Дата и время окончания запроса
4530 -
4531 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4532 -
4533 -}
4534 -
4535 -
4536 -
4537 -Пример ответа:
4538 -
4539 -
4540 -[
4541 -
4542 - {
4543 -
4544 - "harvesterName": "", ~/~/Комбайн, номер
4545 -
4546 - "harvesterId": 0, ~/~/Комбайн, id
4547 -
4548 -"harvesterModel": "", ~/~/ Модель комбайна
4549 -
4550 - "hopperCapacity": 0, ~/~/ Объем бункера м3
4551 -
4552 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4553 -
4554 - "events": [ ~/~/Список событий в разрезе комбайна
4555 -
4556 - {
4557 -
4558 - "driverId": "", ~/~/Идентификатор водителя
4559 -
4560 - "driverName": "", ~/~/Водитель комбайна, ФИО
4561 -
4562 - "RFID": "", ~/~/ идентификатор карты-метки
4563 -
4564 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4565 -
4566 - "vehicleId": 0, ~/~/идентификатор объекта
4567 -
4568 - "vehicleName": "string", ~/~/ Имя объекта
4569 -
4570 - "modelName": "string", ~/~/ Имя модели объекта
4571 -
4572 - "nearestVehicles": [ ~/~/Объекты рядом
4573 -
4574 - {
4575 -
4576 - "vehicleId": 0, ~/~/идентификатор объекта
4577 -
4578 - "vehicleName": "string" ~/~/ Имя объекта
4579 -
4580 - }
4581 -
4582 - ],
4583 -
4584 - "fields": [ ~/~/Поля, где происходила выгрузка
4585 -
4586 - {
4587 -
4588 - "id": 0, ~/~/ идентификатор пользователя
4589 -
4590 - "name": "string" ~/~/ имя пользователя
4591 -
4592 - }
4593 -
4594 - ],
4595 -
4596 - "event": "string", ~/~/Событие
4597 -
4598 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4599 -
4600 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4601 -
4602 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4603 -
4604 - "cultureName": "string", ~/~/ название культуры
4605 -
4606 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4607 -
4608 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4609 -
4610 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4611 -
4612 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4613 -
4614 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4615 -
4616 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4617 -
4618 - "issued": 0, ~/~/Выдано, бункеров
4619 -
4620 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4621 -
4622 - "latitude": 0, ~/~/Широта
4623 -
4624 - "longitude": 0, ~/~/ Долгота
4625 -
4626 - "litresAway": 0, ~/~/Отдано, л
4627 -
4628 - "m3Away": 0 ~/~/Отдано, м3
4629 -
4630 - }
4631 -
4632 - ]
4633 -
4634 - }
4635 -
4636 -]
4637 -
4638 -
4639 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4640 -
4641 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4642 -
4643 -
4644 -(% class="box infomessage" %)
4645 -(((
4646 -GET api/v3/Vehicles/recyclebin/all
4647 -)))
4648 -
4649 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4650 -
4651 -Параметр запроса: {parentId} - идентификатор агента
4652 -
4653 -В заголовках запроса: X-Auth: Токен авторизации
4654 -
4655 -Ответ:
4656 -
4657 -[
4658 -
4659 - {
4660 -
4661 - "recordTime": "", ~/~/Время записи
4662 -
4663 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4664 -
4665 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4666 -
4667 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4668 -
4669 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4670 -
4671 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4672 -
4673 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4674 -
4675 - "items": [ ~/~/ [
4676 -
4677 -nullable: true ~/~/Детали
4678 -
4679 - {
4680 -
4681 - "name": "string", ~/~/наименование столбца
4682 -
4683 - "value": "string" ~/~/содержание столбца
4684 -
4685 - }
4686 -
4687 - ]
4688 -
4689 - },
4690 -
4691 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4692 -
4693 - "string"
4694 -
4695 - ]
4696 -
4697 - }
4698 -
4699 -]
4700 -
4701 -
4702 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4703 -
4704 -(% class="box infomessage" %)
4705 -(((
4706 -POST/api/v3/Vehicles/recyclebin/erase
4707 -)))
4708 -
4709 -В заголовках запроса: X-Auth: Токен авторизации
4710 -
4711 -Пример запроса:
4712 -
4713 -
4714 -[
4715 -
4716 - 0
4717 -
4718 -]
4719 -
4720 -
4721 -Пример ответа:
4722 -
4723 -[
4724 -
4725 - {
4726 -
4727 - "recordTime": "", ~/~/Время записи
4728 -
4729 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4730 -
4731 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4732 -
4733 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
4734 -
4735 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4736 -
4737 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4738 -
4739 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4740 -
4741 - "items": [ ~/~/Детали
4742 -
4743 - {
4744 -
4745 - "name": "", ~/~/Имя свойства
4746 -
4747 - "value": "" ~/~/Значение свойства
4748 -
4749 - }
4750 -
4751 - ]
4752 -
4753 - },
4754 -
4755 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4756 -
4757 - ""
4758 -
4759 - ]
4760 -
4761 - }
4762 -
4763 -]
4764 -
4765 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4766 -
4767 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4768 -
4769 -(% class="box infomessage" %)
4770 -(((
4771 -POST/api/v3/Vehicles/recyclebin/restore
4772 -)))
4773 -
4774 -В заголовках запроса: X-Auth: Токен авторизации
4775 -
4776 -Параметры в теле запроса (JSON):
4777 -
4778 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4779 -
4780 -В заголовках запроса: X-Auth: Токен авторизации
4781 -
4782 -
4783 -Пример запроса:
4784 -
4785 -[
4786 -
4787 - 0
4788 -
4789 -]
4790 -
4791 -
4792 -Пример ответа:
4793 -
4794 -[
4795 -
4796 - {
4797 -
4798 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4799 -
4800 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4801 -
4802 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4803 -
4804 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4805 -
4806 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4807 -
4808 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4809 -
4810 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4811 -
4812 - "items": [ ~/~/Детали
4813 -
4814 - {
4815 -
4816 - "name": "string", ~/~/Имя свойства
4817 -
4818 - "value": "string" ~/~/Значение свойства
4819 -
4820 - }
4821 -
4822 - ]
4823 -
4824 - },
4825 -
4826 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4827 -
4828 - "string"
4829 -
4830 - ]
4831 -
4832 - }
4833 -
4834 -]
4835 -
4836 -
4837 -
4838 4838  (% class="box" lang="en-US" style="text-align: center;" %)
4839 4839  (((
4840 4840  (% 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]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

ГЛОНАССSoft wiki - 2024 г.