Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 108.1 >
edited by Илья Крайнов
on 2023/09/27 15:57
To version < 176.1 >
edited by Михаил Жучков
on 2024/10/24 11:15
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.SupportZhuchkov
Content
... ... @@ -14,13 +14,22 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 +
20 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
21 +
22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
23 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
26 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
27 +(((
28 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
29 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
30 +)))
22 22  
23 -(% class="box infomessage" %)
32 +(% class="box successmessage" %)
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**__».
43 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,21 +40,25 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
47 47  (% style="color:#000000" %){
48 -
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
52 -
53 -(% lang="en-US" %)
56 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
57 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
62 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
63 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
64 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
65 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
66 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
67 +
68 +(% class="wikigeneratedid" %)
69 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
70 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,51 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -А
97 97  {
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" ~/~/ Корр. счет
110 + "agentId": "",  (%%)
111 + "parentId": "",
112 + "parentName": "string",
113 + "name": "string",
114 + "fullName": "string",
115 + "agentInfoType": 0,
116 + "isForeign": true/false,
117 + "district": "string", 
118 + "region": "string",
119 + "city": "string",
120 + "inn": "string",
121 + "kpp": "string",
122 + "address": "string",
123 + "addressFact": "string",
124 + "email": "string",
125 + "director": "string",
126 + "bankName": "string",
127 + "bankBIK": "string",
128 + "bankRS": "string",
129 + "bankKS": "string"
118 118   }
119 119  
132 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
133 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
134 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
135 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
136 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
137 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
138 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
139 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
140 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
141 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
142 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
143 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
144 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
145 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
146 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
147 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
148 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
149 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
150 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
151 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
152 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
153 +
120 120  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
122 122  (% class="box infomessage" %)
... ... @@ -130,7 +130,7 @@
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
167 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,23 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
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 - Отказ)
182 + "agentId": "",(% style="color:#000000" %)   (%%)
183 + "parentId": "",
184 + "name": "string",
185 + "fullName": "string",
186 + "agentInfoType": 0,
187 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
190 +
191 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
192 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
193 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
194 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
195 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
196 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
197 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
198 +
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
... ... @@ -172,7 +172,7 @@
172 172  Параметры в теле запроса (JSON):
173 173  
174 174  {
175 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
217 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 178   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -192,7 +192,6 @@
192 192   "bankKS": "string" ~/~/ корр. счёт
193 193  }
194 194  
195 -
196 196  Ответ:
197 197  
198 198  {
... ... @@ -217,6 +217,28 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
261 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
262 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
263 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
264 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
265 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
266 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
267 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
268 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
269 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
270 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
271 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
272 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
273 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
274 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
275 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
276 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
277 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
278 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
279 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
280 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
281 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
282 +
220 220  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 221  
222 222  (% class="box warningmessage" %)
... ... @@ -232,7 +232,6 @@
232 232  
233 233  В заголовках запроса: X-Auth: Токен авторизации
234 234  
235 -
236 236  Параметры в теле запроса (JSON):
237 237  
238 238  {
... ... @@ -257,7 +257,6 @@
257 257   "bankKS": "string" ~/~/ корр. счёт
258 258  }
259 259  
260 -
261 261  Ответ:
262 262  
263 263  {
... ... @@ -300,6 +300,21 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
364 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
365 +
366 +(% class="box warningmessage" %)
367 +(((
368 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
369 +)))
370 +
371 +Метод позволяет изменить статус клиента, указанного в запросе.
372 +
373 +В пути указывается GUID клиента и статус клиента.
374 +
375 +**status **- значение 0 - заблокирован, 1 - активен.
376 +
377 +Ответ: Code 204
378 +
303 303  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 305  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -351,7 +351,6 @@
351 351   ],
352 352   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
353 353  }
354 -
355 355  {
356 356   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 357   "lastName": "string",
... ... @@ -363,15 +363,10 @@
363 363   "password": "string",
364 364   "email": "string",
365 365  
366 -
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)Ответ:
369 -
370 -(% style="text-align:left" %)
371 -(% style="color:#000000; font-weight:normal" %){    
372 -
373 -(% style="text-align:left" %)
374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
443 +{     
444 + "id": "" , ~/~/ ID пользователя
375 375   "lastName": "" , ~/~/ Фамилия ,
376 376   "firstName": "" , ~/~/ Имя
377 377   "position": "" , ~/~/ Должность
... ... @@ -388,9 +388,8 @@
388 388   "kind": "" , ~/~/ тип аутентификации
389 389   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
390 390   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
461 +}
391 391  
392 -(% style="text-align:left" %)
393 -(% style="color:#000000; font-weight:normal" %)}
394 394  
395 395  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 396  
... ... @@ -411,19 +411,16 @@
411 411  
412 412  (% style="color:#000000" %)Параметры в теле запроса (JSON):
413 413  
414 -(% style="color:#000000" %){
415 -
483 +(% style="color:#000000" %){(%%)
416 416   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
417 417   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
418 418   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
419 419   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 -
421 421  (% style="color:#000000" %)}
422 422  
423 423  (% style="color:#000000" %)Ответ:
424 424  
425 425  (% style="color:#000000" %){         (%%)
426 -
427 427   "id": "" , ~/~/ идентификатор пользователя
428 428   "lastName": "" , ~/~/ фамилия
429 429   "firstName": "" , ~/~/ имя
... ... @@ -437,7 +437,6 @@
437 437   "sessionDuration":"", ~/~/ длительность сессии в минутах
438 438   "status": "1",  ~/~/ статус пользователя
439 439   "lastLogged": "", ~/~/ дата/время последней авторизации
440 -
441 441  (% style="color:#000000" %)}
442 442  
443 443  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -511,10 +511,8 @@
511 511  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
512 512  
513 513  (% lang="en-US" style="text-align:left" %)
514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 -
516 -(% lang="en-US" style="text-align:left" %)
517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
579 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
580 + "id": "" , ~/~/ ID пользователя 
518 518   "lastName": "" , ~/~/ фамилия
519 519   "firstName": "" , ~/~/ имя
520 520   "position": "" , ~/~/ должность
... ... @@ -536,9 +536,7 @@
536 536   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 537   },
538 538   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 -
541 -(% lang="en-US" style="text-align:left" %)
602 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
542 542  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
543 543  
544 544  (% lang="en-US" style="text-align:left" %)
... ... @@ -545,10 +545,8 @@
545 545  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
546 546  
547 547  (% lang="en-US" style="text-align:left" %)
548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
549 -
550 -(% lang="en-US" style="text-align:left" %)
551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
609 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
610 + "id": "" , ~/~/ идентификатор пользователя
552 552   "lastName": "" , ~/~/ фамилия
553 553   "firstName": "" , ~/~/ имя
554 554   "position": "" , ~/~/ должность
... ... @@ -569,10 +569,8 @@
569 569   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
570 570   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
571 571   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
631 +}
572 572  
573 -(% lang="en-US" style="text-align:left" %)
574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 -
576 576  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
577 577  
578 578  (% class="box warningmessage" %)
... ... @@ -592,12 +592,10 @@
592 592  
593 593  (% style="color:#000000" %)Параметры в теле запроса (JSON):
594 594  
595 -(% style="color:#000000" %){
596 -
652 +(% style="color:#000000" %){(%%)
597 597   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
598 598   "description": "" , ~/~/ описание
599 599   "data": "" , ~/~/ данные, связанные со сменой статуса
600 -
601 601  (% style="color:#000000" %)}
602 602  
603 603  (% style="text-align:left" %)
... ... @@ -619,7 +619,7 @@
619 619  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
620 620  
621 621   [ 
622 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
677 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
623 623   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
624 624   ]
625 625  
... ... @@ -682,8 +682,251 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
740 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
686 686  
742 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
743 +
744 +(% class="box infomessage" %)
745 +(((
746 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
747 +)))
748 +
749 +Метод возвращает полную информацию о модели объекта.
750 +
751 +(% style="color:#000000" %)Метод запроса: **GET**
752 +
753 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
754 +
755 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
756 +
757 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
758 +
759 +(% style="color:#000000" %)Ответ:
760 +
761 +(% style="color:#000000" %){
762 + "parentName": "string",
763 + "name": "string",
764 + "picture": "string",
765 + "minspeed": 0,
766 + "maxspeed": 0,
767 + "width": 0,
768 + "imbeddedtrailer": true,
769 + "hoppercapacity": 0,
770 + "hopperdischargespeed": 0,
771 + "modelType": 0,
772 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
773 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
774 + "deleted": true
775 +}
776 +
777 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
778 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
779 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
780 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
781 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
782 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
783 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
784 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
785 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
786 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
787 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
788 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
789 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
790 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
791 +
792 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
793 +
794 +(% class="box successmessage" %)
795 +(((
796 +(% lang="en-US" %)**POST /api/v3/models/find**
797 +)))
798 +
799 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
800 +
801 +(% style="color:#000000" %)Метод запроса: **POST**
802 +
803 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
804 +
805 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
806 +
807 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
808 +
809 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
810 +}
811 +
812 +(% style="color:#000000" %)Ответ:
813 +
814 +(% style="color:#000000" %)[
815 + {
816 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
817 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
818 + "parentName": "string",
819 + "name": "string",
820 + "modelType": 0
821 + }
822 +]
823 +
824 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
825 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
826 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
827 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
828 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
829 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
830 +
831 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
832 +
833 +(% class="box successmessage" %)
834 +(((
835 +(% lang="en-US" %)**POST /api/v3/models**
836 +)))
837 +
838 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
839 +
840 +(% style="color:#000000" %)Метод запроса: **POST**
841 +
842 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
843 +
844 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
845 +
846 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
847 +
848 +{
849 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
850 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
851 + "deleted": true,
852 + "extId": "string",
853 + "name": "string",
854 + "picture": "string",
855 + "minspeed": 0,
856 + "maxspeed": 0,
857 + "width": 0,
858 + "imbeddedtrailer": true,
859 + "fueloutlay": 0,
860 + "hoppercapacity": 0,
861 + "hopperdischargespeed": 0,
862 + "modelType": 0
863 +}
864 +
865 +Ответ:
866 +
867 +{
868 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
869 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
870 + "deleted": true,
871 + "extId": "string",
872 + "name": "string",
873 + "picture": "string",
874 + "minspeed": 0,
875 + "maxspeed": 0,
876 + "width": 0,
877 + "imbeddedtrailer": true,
878 + "hoppercapacity": 0,
879 + "hopperdischargespeed": 0,
880 + "modelType": 0
881 +}
882 +
883 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
884 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
885 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
886 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
887 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
888 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
889 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
890 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
891 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
892 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
893 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
894 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
895 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
896 +
897 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
898 +
899 +(% class="box warningmessage" %)
900 +(((
901 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
902 +)))
903 +
904 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
905 +
906 +(% style="color:#000000" %)Метод запроса: **PUT**
907 +
908 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
909 +
910 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911 +
912 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
913 +
914 +{
915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
916 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
917 + "deleted": true,
918 + "extId": "string",
919 + "name": "string",
920 + "picture": "string",
921 + "minspeed": 0,
922 + "maxspeed": 0,
923 + "width": 0,
924 + "imbeddedtrailer": true,
925 + "fueloutlay": 0,
926 + "hoppercapacity": 0,
927 + "hopperdischargespeed": 0,
928 + "modelType": 0
929 +}
930 +
931 +Ответ:
932 +
933 +{
934 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
935 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
936 + "deleted": true,
937 + "extId": "string",
938 + "name": "string",
939 + "picture": "string",
940 + "minspeed": 0,
941 + "maxspeed": 0,
942 + "width": 0,
943 + "imbeddedtrailer": true,
944 + "fueloutlay": 0,
945 + "hoppercapacity": 0,
946 + "hopperdischargespeed": 0,
947 + "modelType": 0
948 +}
949 +
950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
951 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
952 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
953 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
954 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
955 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
956 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
957 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
958 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
959 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
960 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
961 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
962 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
963 +
964 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
965 +
966 +(% class="box errormessage" %)
967 +(((
968 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
969 +)))
970 +
971 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
972 +
973 +(% style="color:#000000" %)Метод запроса: **DELETE**
974 +
975 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
976 +
977 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
978 +
979 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
980 +
981 +Ответ: В случае успеха **Success 200**
982 +
983 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
984 +
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
688 688  
689 689  (% class="box infomessage" %)
... ... @@ -718,19 +718,15 @@
718 718   "deviceTypeName": "", ~/~/ Название типа устройства
719 719   "sim1": "", ~/~/ Номер SIM1
720 720   "sim2": "", ~/~/ Номер SIM2
721 -
722 722   "parentId": "", ~/~/ ID клиента-родителя
723 723   "parentName": "", ~/~/ Наименование клиента-родителя
724 724   "modelId": "", ~/~/ ID модели объекта
725 725   "modelName": "", ~/~/ Имя модели объекта
726 -
727 727   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 728   "unitName": "string", ~/~/ Наименование подразделения
729 729   "status": 0, ~/~/ Статус объекта
730 -
731 731   "createdAt": "", ~/~/ Дата создания объекта
732 732   },
733 -
734 734  "customFields": [ ~/~/ Произвольные поля
735 735   {
736 736   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -753,8 +753,7 @@
753 753   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 754   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 755   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 -
1050 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
758 758   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 759   "mileageCoeff": 0, ~/~/ коэффициент пробега
760 760   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -784,7 +784,6 @@
784 784   "retries": 0 ~/~/ Количество попыток
785 785   }
786 786   ],
787 -
788 788   "sensors": [ ~/~/ Датчики
789 789   {
790 790   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -825,31 +825,19 @@
825 825   },
826 826  
827 827  ~/~/ Характерные для произвольного:
828 -
829 829  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 -
831 831  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 -
833 833  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 -
835 835  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 -
837 837  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 -
839 839  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 -
841 841  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 -
843 843  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 -
845 845  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 -
847 847  ~/~/ "ValueOn": "Вкл.",
848 -
849 849  ~/~/ "ValueOff": "Выкл."
850 850   "summaryMaxValue": 0 ~/~/ Макс. значение
851 851   }
852 -
853 853   "drivers": [ ~/~/ Водители
854 854   {
855 855   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -858,7 +858,6 @@
858 858   "isDefault": true ~/~/ По умолчанию
859 859   }
860 860   ],
861 -
862 862   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
863 863   {
864 864   "id": "", ~/~/ ID  задания
... ... @@ -875,8 +875,7 @@
875 875   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
876 876   }
877 877   ],
878 -
879 - "statusHistory": [ ~/~/ История статусов
1157 +"statusHistory": [ ~/~/ История статусов
880 880   {
881 881   "status": 0,
882 882   "date": "2023-05-22T09:57:39.562Z",
... ... @@ -884,7 +884,6 @@
884 884   "additionalInfo": "string"
885 885   }
886 886   ]
887 -
888 888  }
889 889  )))
890 890  
... ... @@ -894,6 +894,73 @@
894 894  (% style="text-align:left" %)
895 895  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
896 896  
1174 +
1175 +== **Отправить команду на терминал** ==
1176 +
1177 +(% class="box successmessage" %)
1178 +(((
1179 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1180 +)))
1181 +
1182 +Команда для отправки на тс.
1183 +
1184 +{  
1185 +"id": "", ~/~/идентификатор произвольного поля
1186 +"command": "", ~/~/ Текст команды
1187 +"retries": "", ~/~/ Количество попыток
1188 +"idTemplate": "" ~/~/ ID шаблона команды
1189 +}
1190 +
1191 +
1192 +== **Получить ответ на отправленную на ТС команду** ==
1193 +
1194 +(% class="box infomessage" %)
1195 +(((
1196 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1197 +)))
1198 +
1199 +Идентификатор команды: cmdid
1200 +
1201 +Запрос от терминала на ответ команды
1202 +
1203 +Пример ответ от терминала:
1204 +
1205 +ID= "" ~/~/ идентификатор произвольного поля
1206 +Soft="" ~/~/ версия софта
1207 +GPS=4 ~/~/ тип трекера
1208 +Time=11:05:43 28.06.24 ~/~/ время запроса
1209 +Lat=45.056221 ~/~/ широта
1210 +Lon=39.035938 ~/~/ долгота
1211 +Speed=0.0 ~/~/ скорость
1212 +Course=181.4 ~/~/направление
1213 +
1214 +(((
1215 +== **Список отправленных объекту команд с ответами** ==
1216 +
1217 +(% class="box infomessage" %)
1218 +(((
1219 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1220 +)))
1221 +
1222 +Идентификатор ТС: vehicleId
1223 +
1224 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1225 +
1226 +Пример ответа терминала
1227 +
1228 +[ 
1229 +{    
1230 +"id": "", ~/~/ идентификатор пользователя
1231 +"commandText": "", ~/~/Текст команды.
1232 +"templateId": "", ~/~/Идентификатор шаблона
1233 +"updated": "", ~/~/ Время отправки  
1234 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1235 +"answer": "", ~/~/ Ответ терминала.
1236 +"status": "" ~/~/ Статус отправки
1237 +}
1238 +]
1239 +)))
1240 +
897 897  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
898 898  
899 899  (% class="box successmessage" %)
... ... @@ -911,8 +911,7 @@
911 911  
912 912  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
913 913  
914 -(% style="color:#000000" %){
915 -
1258 +(% style="color:#000000" %){(%%)
916 916   "parentId": "" , ~/~/ ID клиента
917 917   "name": "" , ~/~/ имя ТС
918 918   "imei": "" , ~/~/ IMEI
... ... @@ -933,7 +933,6 @@
933 933   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
934 934   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
935 935   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
936 -
937 937   "mileageCalcMethod": 0,
938 938   "mileageCoeff": 0,
939 939   "locationByCellId": true,
... ... @@ -966,7 +966,6 @@
966 966   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
967 967   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
968 968   }
969 -
970 970  "drivers": [ ~/~/ Водители
971 971   {
972 972   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -981,8 +981,7 @@
981 981   "retries": 0
982 982   }
983 983   ],
984 -
985 - "sensors": [ ~/~/ Датчики
1325 +"sensors": [ ~/~/ Датчики
986 986   {
987 987   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
988 988   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1020,29 +1020,17 @@
1020 1020   "additionalProp2": "string",
1021 1021   "additionalProp3": "string"
1022 1022   },
1023 -
1024 1024  ~/~/ Характерные для произвольного:
1025 -
1026 1026  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1027 -
1028 1028  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1029 -
1030 1030  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1031 -
1032 1032  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1033 -
1034 1034  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1035 -
1036 1036  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1037 -
1038 1038  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1039 -
1040 1040  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1041 -
1042 1042  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1043 -
1044 1044  ~/~/ "ValueOn": "Вкл.",
1045 -
1046 1046  ~/~/ "ValueOff": "Выкл."
1047 1047   "summaryMaxValue": 0 ~/~/ Макс. значение
1048 1048   }
... ... @@ -1061,8 +1061,7 @@
1061 1061  
1062 1062  (% style="color:#000000" %)Ответ:
1063 1063  
1064 -(% style="color:#000000" %){
1065 -
1392 +(% style="color:#000000" %){(%%)
1066 1066   "vehicleId": "", ~/~/ID ТС 
1067 1067   "parentId": "", ~/~/Guid владельца ТС
1068 1068   "name": "", ~/~/Имя объекта
... ... @@ -1100,8 +1100,6 @@
1100 1100   "kind": "", ~/~/ Вид периодичности по времени 
1101 1101   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1102 1102   }
1103 -
1104 -(% style="text-align:left" %)
1105 1105  (% style="color:#000000" %)}
1106 1106  
1107 1107  **Валидация:**
... ... @@ -1109,7 +1109,7 @@
1109 1109  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1110 1110  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1111 1111  
1112 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1437 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1113 1113  
1114 1114  (% class="box infomessage" %)
1115 1115  (((
... ... @@ -1116,7 +1116,7 @@
1116 1116  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1117 1117  )))
1118 1118  
1119 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1444 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1120 1120  
1121 1121  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1122 1122  
... ... @@ -1160,8 +1160,7 @@
1160 1160  (% style="color:#000000" %)Ответ:
1161 1161  
1162 1162  (% style="color:#000000" %){
1163 -
1164 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1488 + "vehicleId": "" ~/~/ идентификатор объекта
1165 1165   "name": "" ~/~/ наименование объекта
1166 1166   "imei": "" ~/~/ IMEI объекта
1167 1167   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1220,13 +1220,11 @@
1220 1220   "data": "", ~/~/ Данные
1221 1221   "overwrite": false, ~/~/ Флаг перезаписи
1222 1222   "stage": "", ~/~/ Состояние, может быть null
1223 -
1224 1224  (% style="color:#000000" %)}
1225 1225  
1226 1226  (% style="color:#000000" %)Ответ:
1227 1227  
1228 -(% style="color:#000000" %){
1229 -
1551 +(% style="color:#000000" %){(%%)
1230 1230   "status": "", ~/~/ значение статуса
1231 1231   "date": "", ~/~/ Дата смены статуса 
1232 1232   "description": "", ~/~/ Описание
... ... @@ -1233,10 +1233,10 @@
1233 1233   "data": "", ~/~/ Данные
1234 1234   "overwrite": false, ~/~/ Флаг перезаписи
1235 1235   "stage": "", ~/~/ Состояние
1236 -
1237 -(% style="text-align:left" %)
1238 1238  (% style="color:#000000" %) }
1239 1239  
1560 +== ==
1561 +
1240 1240  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1241 1241  
1242 1242  (% class="box warningmessage" %)
... ... @@ -1324,8 +1324,7 @@
1324 1324   "retries": 0
1325 1325   }
1326 1326   ],
1327 -
1328 - "sensors": [ ~/~/ Датчики
1649 +"sensors": [ ~/~/ Датчики
1329 1329   {
1330 1330   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1331 1331   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1363,29 +1363,17 @@
1363 1363   "additionalProp2": "string",
1364 1364   "additionalProp3": "string"
1365 1365   },
1366 -
1367 1367  ~/~/ Характерные для произвольного:
1368 -
1369 1369  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1370 -
1371 1371  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1372 -
1373 1373  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1374 -
1375 1375  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1376 -
1377 1377  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1378 -
1379 1379  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1380 -
1381 1381  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1382 -
1383 1383  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1384 -
1385 1385  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1386 -
1387 1387  ~/~/ "ValueOn": "Вкл.",
1388 -
1389 1389  ~/~/ "ValueOff": "Выкл."
1390 1390   "summaryMaxValue": 0 ~/~/ Макс. значение
1391 1391   }
... ... @@ -1405,9 +1405,7 @@
1405 1405  (% style="color:#000000" %)Ответ:
1406 1406  
1407 1407  (% lang="en-US" style="text-align:left" %)
1408 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1409 -
1410 -(% lang="en-US" style="text-align:left" %)
1717 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1411 1411   "vehicleId": "", ~/~/ ID ТС
1412 1412   "parentId": "", ~/~/ ID клиента
1413 1413   "name": "", ~/~/ имя ТС
... ... @@ -1448,8 +1448,6 @@
1448 1448   "kind": "", ~/~/ Вид периодичности по времени
1449 1449   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1450 1450   }
1451 -
1452 -(% lang="en-US" style="text-align:left" %)
1453 1453  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1454 1454  
1455 1455  **Валидация:**
... ... @@ -1490,18 +1490,15 @@
1490 1490  
1491 1491  (% style="color:#000000" %)Метод запроса: **GET**
1492 1492  
1493 -(% 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]]
1798 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1494 1494  
1495 1495  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1496 1496  
1497 1497  (% style="color:#000000" %)Ответ:
1498 1498  
1499 -(% style="color:#000000" %){
1500 -
1804 +(% style="color:#000000" %){(%%)
1501 1501   "deviceTypeId" : "", ~/~/ ID типа устройства
1502 1502   "deviceTypeName" : "" ~/~/ Название типа устройства
1503 -
1504 -(% style="text-align:left" %)
1505 1505  (% style="color:#000000" %)}
1506 1506  
1507 1507  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1523,13 +1523,10 @@
1523 1523  
1524 1524  (% style="color:#000000" %)Ответ:
1525 1525  
1526 -(% style="color:#000000" %){
1527 -
1828 +(% style="color:#000000" %){(%%)
1528 1528   "id": "", ~/~/ ID типа датчика 
1529 1529   "name": "", ~/~/ Название
1530 1530   "description": "", ~/~/ Описание
1531 -
1532 -(% style="text-align:left" %)
1533 1533  (% style="color:#000000" %)}
1534 1534  
1535 1535  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1573,6 +1573,56 @@
1573 1573   }
1574 1574  ]
1575 1575  
1875 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1876 +
1877 +(% class="box infomessage" style="text-align: left;" %)
1878 +(((
1879 +**POST /api/v3/terminalMessages/mapping**
1880 +)))
1881 +
1882 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1883 +
1884 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1885 +
1886 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1887 +
1888 +{
1889 + "protocolType": 0,
1890 + "params": ["string"]
1891 +}
1892 +
1893 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1894 +|protocolType|ID типа протокола
1895 +|params|(((
1896 +Массив наименований параметров в сообщении
1897 +)))
1898 +
1899 +Ответ:
1900 +
1901 +{
1902 + "protocolType": 0,
1903 + "mapping": {
1904 + "additionalProp1": {
1905 + "inputType": 0,
1906 + "inputNumber": 0
1907 + },
1908 + "additionalProp2": {
1909 + "inputType": 0,
1910 + "inputNumber": 0
1911 + }
1912 + }
1913 +}
1914 +
1915 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1916 +|protocolType|Тип протокола
1917 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1918 +|inputNumber|(((
1919 +Номер входа
1920 +)))
1921 +
1922 +(% class="wikigeneratedid" %)
1923 +Перечень 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/]]
1924 +
1576 1576  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 1577  
1578 1578  (% class="box infomessage" %)
... ... @@ -1597,6 +1597,11 @@
1597 1597   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 1598  }
1599 1599  
1949 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1950 +|vehicleId|ID объекта
1951 +|from|Дата и время начала периода запроса
1952 +|to|Дата и время окончания периода запроса
1953 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,80 +1603,43 @@
1603 1603   {
1604 1604   "messages": [
1605 1605   {
1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 - "speed": 0, ~/~/ Скорость, км/ч
1609 - "altitude": 0, ~/~/ Высота, м
1610 - "latitude": 0, ~/~/ Широта [-90°;90°]
1611 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 - "satellites": 0, ~/~/ Кол-во спутников
1613 - "voltage": 0, ~/~/ Напряжение
1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1960 + "deviceTime": "2023-11-29T07:40:44.052Z",
1961 + "serverTime": "2023-11-29T07:40:44.052Z",
1962 + "speed": 0,
1963 + "altitude": 0,
1964 + "latitude": 0,
1965 + "longitude": 0,
1966 + "satellites": 0,
1967 + "course": 0,
1968 + "voltage": 0,
1969 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
1974 + "photoCount": 0,
1975 + "lbsCorrectedCoords": true,
1976 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1625 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) ==
1982 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1983 +|deviceTime|Время сообщения терминала
1984 +|serverTime|Время когда сообщение поступило на сервер
1985 +|speed|Скорость
1986 +|altitude|Высота над уровнем моря
1987 +|latitude|Широта
1988 +|longitude|Долгота
1989 +|satellites|Кол-во спутников
1990 +|course|Курс
1991 +|voltage|Бортовое напряжение
1992 +|parameters|Список параметров и их значений
1993 +|photoCount|Количество фото
1994 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1995 +|protocolType|ID типа протокола
1626 1626  
1627 -(% class="box infomessage" %)
1628 -(((
1629 -**POST /api/v3/vehicles/export/history**
1630 -)))
1631 -
1632 -Метод возвращает список сообщений терминала объекта за выбранный период.
1633 -
1634 -(% style="text-align: left;" %)
1635 -Метод запроса **POST**
1636 -
1637 -(% style="text-align: left;" %)
1638 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1639 -
1640 -(% style="text-align: left;" %)
1641 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1642 -
1643 -{
1644 - "vehicleId": 0, ~/~/ ID объекта
1645 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1646 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1647 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1648 -}
1649 -
1650 -Ответ:
1651 -
1652 -Получаете файл. Сообщение: Code 200/Success
1653 -
1654 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1655 -
1656 -(% class="box infomessage" %)
1657 -(((
1658 -**GET /api/v3/vehicles/export/history/status**
1659 -)))
1660 -
1661 -Метод возвращает список сообщений терминала объекта за выбранный период.
1662 -
1663 -(% style="text-align: left;" %)
1664 -Метод запроса **GET**
1665 -
1666 -(% style="text-align: left;" %)
1667 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1668 -
1669 -(% style="text-align: left;" %)
1670 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1671 -
1672 -Ответ:
1673 -
1674 -{
1675 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1676 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1677 - "message": "string" ~/~/ текст описывающий статус.
1678 -}
1679 -
1680 1680  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1681 1681  
1682 1682  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1713,10 +1713,12 @@
1713 1713   {
1714 1714   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1715 1715   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1716 - "mileageBegin": 0, ~/~/ Пробег на начало периода
1717 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
1718 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1719 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2033 + "mileage": 0, ~/~/ Пробег за период, километры
2034 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2035 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2036 + "motohours": 0, ~/~/ Моточасы за период, секунды
2037 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2038 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
1720 1720   }
1721 1721   ]
1722 1722   }
... ... @@ -1765,6 +1765,12 @@
1765 1765   }
1766 1766  ]
1767 1767  
2087 +(% class="box warningmessage" %)
2088 +(((
2089 +Максимальное кол-во периодов - 1440 (maxPeriodsCount = 1440)
2090 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2091 +)))
2092 +
1768 1768  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
1769 1769  
1770 1770  (% class="box infomessage" %)
... ... @@ -1810,6 +1810,96 @@
1810 1810   }
1811 1811  ]
1812 1812  
2138 +
2139 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2140 +
2141 +(% class="box infomessage" %)
2142 +(((
2143 +**POST /api/v3/vehicles/moveStop**
2144 +)))
2145 +
2146 +Метод запроса: **POST**
2147 +
2148 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2149 +
2150 +В заголовках запроса: X-Auth: Токен авторизации
2151 +
2152 +
2153 +Тело запроса:
2154 +
2155 +{
2156 + "vehicleIds": [ ], ~/~/ Список ID объектов
2157 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2158 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2159 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2160 +}
2161 +
2162 +Ответ:
2163 +
2164 +[ 
2165 + {
2166 + "vehicleId": 0, ~/~/ ID объекта
2167 + "vehicleName": "string", ~/~/ Имя объекта
2168 + "moves": [ ~/~/ Событие движения
2169 + {
2170 + "mileage": 0, ~/~/ Пробег, км
2171 + "eventId": 0, ~/~/ Идентификатор события
2172 + "eventName": "string", ~/~/ Название события
2173 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2174 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2175 + "duration": 0 ~/~/ Продолжительность события, секунд
2176 + }
2177 + ],
2178 + "stops": [ ~/~/ События стоянок
2179 + {
2180 + "address": "string", ~/~/ Адрес события
2181 + "eventId": 0, ~/~/ Идентификатор события
2182 + "eventName": "string", ~/~/ Название события
2183 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2184 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2185 + "duration": 0 ~/~/ Продолжительность события, секунд
2186 + }
2187 + ]
2188 + }
2189 +]
2190 +
2191 +
2192 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2193 +
2194 +(% class="box infomessage" %)
2195 +(((
2196 +**POST /api/v3/vehicles/getlastdata**
2197 +)))
2198 +
2199 +Метод запроса: **POST**
2200 +
2201 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2202 +
2203 +В заголовках запроса: X-Auth: Токен авторизации
2204 +
2205 +
2206 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2207 +
2208 +Ответ:
2209 + {
2210 + "vehicleId": 0, ~/~/Идентификатор объекта.
2211 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2212 + "vehicleNumber": "string",~/~/Номер объекта.
2213 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2214 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2215 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2216 + "speed": 0,~/~/Скорость объекта.
2217 + "course": 0,~/~/Курс движения [0;360]
2218 + "latitude": 0,~/~/Широта [-90°;90°].
2219 + "longitude": 0,~/~/Долгота [-180°;180°].
2220 + "address": "string",~/~/Адрес.
2221 + "geozones": [ ~/~/Сведения по геозонам.
2222 + {
2223 + "id": 0,
2224 + "name": "string"
2225 + }
2226 +
2227 +
1813 1813  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1814 1814  
1815 1815  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2117,6 +2117,32 @@
2117 2117  
2118 2118  Success
2119 2119  
2535 +
2536 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2537 +
2538 +(% class="box warningmessage" %)
2539 +(((
2540 +**PUT** /api/v3/notifications/prolongation
2541 +)))
2542 +
2543 +Метод позволяет продлить уведомления.
2544 +
2545 +Метод запроса **PUT**
2546 +
2547 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2548 +
2549 +В заголовках запроса: X-Auth: Токен авторизации.
2550 +
2551 +Тело запроса:
2552 +
2553 +[
2554 +
2555 +0
2556 +
2557 +]
2558 +
2559 +где 0 идентификатор ids.
2560 +
2120 2120  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2121 2121  
2122 2122  (% class="box errormessage" %)
... ... @@ -2708,6 +2708,83 @@
2708 2708  Success
2709 2709  
2710 2710  
3152 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3153 +
3154 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3155 +
3156 +(% class="box infomessage" %)
3157 +(((
3158 +**POST /api/v3/Trailers**
3159 +)))
3160 +
3161 +Пример запроса:
3162 +
3163 +{
3164 + "startDate": "2023-11-14T10:48:03.671Z",
3165 + "endDate": "2023-11-14T10:48:03.671Z",
3166 + "ids": [ 0 ],
3167 + "timezone": 0
3168 +}
3169 +
3170 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3171 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3172 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3173 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3174 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3175 +
3176 +Пример ответа:
3177 +
3178 +[
3179 + {
3180 + "SD": "2023-11-14T10:48:03.717Z",
3181 + "ED": "2023-11-14T10:48:03.717Z", 
3182 + "id": 0,
3183 + "SLat": 0,
3184 + "SLon": 0,
3185 + "ELat": 0,
3186 + "ELon": 0,
3187 + "mileage": 0
3188 + "Duration": 0
3189 + "Address": "string",
3190 + "Address2": "string",
3191 + "name": "string",
3192 + "rid": "string",
3193 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3194 + "trailer": {
3195 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3196 + "Number": "string",
3197 + "Description": "string",
3198 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3199 + "ExternalID": "string",
3200 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3201 + "CreateTime": "2023-11-14T10:48:03.717Z",
3202 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3203 + "IsDeleted": true
3204 + },
3205 + "filesCount": 0,
3206 + }
3207 +]
3208 +
3209 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3210 +|SD|Дата и время начала события
3211 +|ED|Дата и время окончания события
3212 +|id|ID объекта
3213 +|SLat|Широта начальной координаты
3214 +|SLon|Долгота начальной координаты
3215 +|ELat|Широта конечной координаты
3216 +|ELon|Долгота конечной координаты
3217 +|mileage|Пробег
3218 +|Duration|Продолжительность
3219 +|Address|Адрес начального местоположения
3220 +|Address2|Адрес конечного местоположения
3221 +|name|Имя радиометки
3222 +|rid|Номер радиометки
3223 +|rguid|ID радиометки
3224 +|trailer|Информация об агрегате
3225 +|ModelGuid|ID агрегата
3226 +|Number|Название/номер агрегата
3227 +|Description|Текст примечания агрегата
3228 +
2711 2711  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2712 2712  
2713 2713  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2729,13 +2729,18 @@
2729 2729   {
2730 2730   "name": "string",
2731 2731   "number": 0,
2732 - "period": 0, ~/~/ Частота трансляции радиометки
3250 + "period": 0,
2733 2733   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2734 2734   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2735 - "deleted": true
2736 2736   }
2737 2737  ]
2738 2738  
3256 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3257 +|parentId|ID клиента
3258 +|name|Название карты-метки
3259 +|number|Номер
3260 +|period|Период запросов в секундах (работает только для агрегатов)
3261 +|id|ID карты-метки
2739 2739  
2740 2740  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2741 2741  
... ... @@ -2752,13 +2752,18 @@
2752 2752   {
2753 2753   "name": "string",
2754 2754   "number": 0,
2755 - "period": 0, ~/~/ Частота трансляции радиометки
3278 + "period": 0,
2756 2756   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2757 2757   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2758 - "deleted": true
2759 2759   }
2760 2760  ]
2761 2761  
3284 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3285 +|name|Название карты-метки
3286 +|number|Номер
3287 +|period|Период запросов в секундах (работает только для агрегатов)
3288 +|id|ID карты-метки
3289 +|parentId|ID клиента
2762 2762  
2763 2763  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2764 2764  
... ... @@ -2774,7 +2774,6 @@
2774 2774   "number": 0,
2775 2775   "period": 0,
2776 2776   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2777 - "deleted": true
2778 2778  }
2779 2779  
2780 2780  Ответ:
... ... @@ -2785,9 +2785,14 @@
2785 2785   "period": 0,
2786 2786   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2787 2787   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2788 - "deleted": true
2789 2789  }
2790 2790  
3317 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3318 +|name|Название карты-метки
3319 +|number|Номер
3320 +|period|Период запросов в секундах (работает только для агрегатов)
3321 +|id|ID карты-метки
3322 +|parentId|ID клиента
2791 2791  
2792 2792  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2793 2793  
... ... @@ -2804,7 +2804,6 @@
2804 2804   "period": 0,
2805 2805   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2806 2806   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2807 - "deleted": true
2808 2808  }
2809 2809  
2810 2810  Ответ:
... ... @@ -2815,9 +2815,14 @@
2815 2815   "period": 0,
2816 2816   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2817 2817   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2818 - "deleted": true
2819 2819  }
2820 2820  
3351 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3352 +|name|Название карты-метки
3353 +|number|Номер
3354 +|period|Период запросов в секундах (работает только для агрегатов)
3355 +|id|ID карты-метки
3356 +|parentId|ID клиента
2821 2821  
2822 2822  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2823 2823  
... ... @@ -2826,7 +2826,7 @@
2826 2826  **DELETE /api/v3/Rfids/{rfidGuid}**
2827 2827  )))
2828 2828  
2829 -Передаем параметр rfidGuid - идентификатор карты-метки
3365 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2830 2830  
2831 2831  Ответ:
2832 2832  
... ... @@ -2833,6 +2833,1108 @@
2833 2833  Success
2834 2834  
2835 2835  
3372 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3373 +
3374 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3375 +
3376 +(% class="box infomessage" %)
3377 +(((
3378 +**GET /api/v3/Billing/client/balance/{clientId}**
3379 +)))
3380 +
3381 +Параметр запроса: **clientId **- идентификатор клиента.
3382 +
3383 +Ответ:
3384 +
3385 +{
3386 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3387 + "Balance": 0
3388 +}
3389 +
3390 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3391 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3392 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3393 +
3394 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3395 +
3396 +(% class="box infomessage" %)
3397 +(((
3398 +**GET /api/v3/Billing/client/constraint/{clientId}**
3399 +)))
3400 +
3401 +Параметр запроса: **clientId **- идентификатор клиента.
3402 +
3403 +Ответ:
3404 +
3405 +{
3406 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3407 + "CalculationType": 0,
3408 + "PermissibleBalance": 0,
3409 + "DefermentDays": 0,
3410 + "SendUiNotifications": true,
3411 + "SendEmailNotifications": true,
3412 + "IsPrivate": true,
3413 +}
3414 +
3415 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3416 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3417 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3418 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3419 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3420 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3421 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3422 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3423 +
3424 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3425 +
3426 +(% class="box infomessage" %)
3427 +(((
3428 +**GET /api/v3/Billing/client/plan/{clientId}**
3429 +)))
3430 +
3431 +Параметры запроса:
3432 +
3433 +**clientId **- идентификатор клиента.
3434 +
3435 +**planId **- идентификатор тарифного плана.
3436 +
3437 +Ответ:
3438 +
3439 +{
3440 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3441 + "Plan": { **~/~/ Описание тарифного плана**
3442 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3443 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3444 + "Name": "string",
3445 + "IsArchived": true,
3446 + "Constraint": {
3447 + "CalculationType": 0,
3448 + "PermissibleBalance": 0,
3449 + "DefermentDays": 0
3450 + },
3451 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3452 + {
3453 + "Feature": "string",
3454 + "IsFactual": true,
3455 + "Limit": 0,
3456 + "Price": 0,
3457 + "PeriodValue": 0,
3458 + "PeriodType": 0
3459 + }
3460 + ]
3461 + },
3462 + "DebitDate": "2023-10-18T12:46:24.213Z",
3463 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3464 + {
3465 + "Feature": "string",
3466 + "IsEnabled": true,
3467 + "IsPrivate": true,
3468 + "IsFactual": true,
3469 + "Limit": 0,
3470 + "Price": 0,
3471 + "DebitDate": "2023-10-18T12:46:24.213Z",
3472 + "PeriodValue": 0,
3473 + "PeriodType": 0
3474 + }
3475 + ]
3476 +}
3477 +
3478 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3479 +|ClientId|Идентификатор клиента
3480 +|Id|Идентификатор тарифного плана
3481 +|OwnerId|Идентификатор клиента-владельца
3482 +|Name|Наименование тарифного плана
3483 +|IsArchived|Признак, определяющий архивный тарифный план
3484 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3485 +|PermissibleBalance|Допустимый баланс
3486 +|DefermentDays|Отсрочка, количество дней
3487 +|Feature|Код услуги
3488 +|IsEnabled|Признак, определяющий активирована ли услуга
3489 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3490 +|IsFactual|Признак, определяющий расчёт по факту
3491 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3492 +|Price|Цена за единицу.
3493 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3494 +|PeriodValue|Значение периода.
3495 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3496 +
3497 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3498 +
3499 +(% class="box infomessage" %)
3500 +(((
3501 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3502 +)))
3503 +
3504 +Параметр запроса: **clientId **- идентификатор клиента.
3505 +
3506 +Ответ:
3507 +
3508 +[
3509 + {
3510 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3511 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3512 + "Name": "string",
3513 + "IsArchived": true,
3514 + "Constraint": {
3515 + "CalculationType": 0,
3516 + "PermissibleBalance": 0,
3517 + "DefermentDays": 0
3518 + },
3519 + "Features": [
3520 + {
3521 + "Feature": "string",
3522 + "IsFactual": true,
3523 + "Limit": 0,
3524 + "Price": 0,
3525 + "PeriodValue": 0,
3526 + "PeriodType": 0
3527 + }
3528 + ]
3529 + }
3530 +]
3531 +
3532 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3533 +|ClientId|Идентификатор клиента
3534 +|Id|Идентификатор тарифного плана
3535 +|OwnerId|Идентификатор клиента-владельца
3536 +|Name|Наименование тарифного плана
3537 +|IsArchived|Признак, определяющий архивный тарифный план
3538 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3539 +|PermissibleBalance|Допустимый баланс
3540 +|DefermentDays|Отсрочка, количество дней
3541 +|Feature|Код услуги
3542 +|IsFactual|Признак, определяющий расчёт по факту
3543 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3544 +|Price|Цена за единицу.
3545 +|PeriodValue|Значение периода.
3546 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3547 +
3548 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3549 +
3550 +(% class="box infomessage" %)
3551 +(((
3552 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3553 +)))
3554 +
3555 +Параметр запроса: **clientId **- идентификатор клиента.
3556 +
3557 +Ответ:
3558 +
3559 +[
3560 + {
3561 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3562 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3563 + "Name": "string",
3564 + "IsArchived": true,
3565 + "Constraint": {
3566 + "CalculationType": 0,
3567 + "PermissibleBalance": 0,
3568 + "DefermentDays": 0
3569 + },
3570 + "Features": [
3571 + {
3572 + "Feature": "string",
3573 + "IsFactual": true,
3574 + "Limit": 0,
3575 + "Price": 0,
3576 + "PeriodValue": 0,
3577 + "PeriodType": 0
3578 + }
3579 + ]
3580 + }
3581 +]
3582 +
3583 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3584 +|ClientId|Идентификатор клиента
3585 +|Id|Идентификатор тарифного плана
3586 +|OwnerId|Идентификатор клиента-владельца
3587 +|Name|Наименование тарифного плана
3588 +|IsArchived|Признак, определяющий архивный тарифный план
3589 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3590 +|PermissibleBalance|Допустимый баланс
3591 +|DefermentDays|Отсрочка, количество дней
3592 +|Feature|Код услуги
3593 +|IsFactual|Признак, определяющий расчёт по факту
3594 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3595 +|Price|Цена за единицу.
3596 +|PeriodValue|Значение периода.
3597 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3598 +
3599 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3600 +
3601 +(% class="box warningmessage" %)
3602 +(((
3603 +**PUT /api/v3/Billing/client/balance**
3604 +)))
3605 +
3606 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3607 +
3608 +Тело запроса:
3609 +
3610 +{
3611 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3612 + "Balance": 0
3613 +}
3614 +
3615 +Ответ: Success
3616 +
3617 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3618 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3619 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3620 +
3621 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3622 +
3623 +(% class="box warningmessage" %)
3624 +(((
3625 +**PUT /api/v3/billing/client/balance/deposit**
3626 +)))
3627 +
3628 +Создает операцию **Пополнение **с указанной суммой
3629 +
3630 +Тело запроса:
3631 +
3632 +{
3633 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3634 + "Balance": 0
3635 +}
3636 +
3637 +Ответ: Success
3638 +
3639 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3640 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3641 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3642 +
3643 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3644 +
3645 +Создает операцию **Списание **с указанной суммой
3646 +
3647 +(% class="box warningmessage" %)
3648 +(((
3649 +**PUT /api/v3/billing/client/balance/withdraw**
3650 +)))
3651 +
3652 +Тело запроса:
3653 +
3654 +{
3655 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3656 + "Balance": 0
3657 +}
3658 +
3659 +Ответ: Success
3660 +
3661 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3662 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3663 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3664 +
3665 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3666 +
3667 +(% class="box warningmessage" %)
3668 +(((
3669 +**PUT /api/v3/Billing/client/constraint**
3670 +)))
3671 +
3672 +Тело запроса:
3673 +
3674 +{
3675 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3676 + "CalculationType": 0,
3677 + "PermissibleBalance": 0,
3678 + "DefermentDays": 0,
3679 + "SendUiNotifications": true,
3680 + "SendEmailNotifications": true,
3681 + "IsPrivate": true,
3682 +}
3683 +
3684 +Ответ: Success
3685 +
3686 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3687 +|ClientId|Идентификатор клиента
3688 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3689 +|PermissibleBalance|Допустимый баланс
3690 +|DefermentDays|(((
3691 +Отсрочка, количество дней
3692 +)))
3693 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3694 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3695 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3696 +
3697 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3698 +
3699 +(% class="box warningmessage" %)
3700 +(((
3701 +**PUT /api/v3/Billing/client/plan**
3702 +)))
3703 +
3704 +Тело запроса:
3705 +
3706 +{
3707 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3708 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3709 + "Features": [
3710 + {
3711 + "Feature": "string",
3712 + "IsEnabled": true,
3713 + "IsFactual": true,
3714 + "Limit": 0,
3715 + "Price": 0,
3716 + "DebitDate": "2023-10-18T13:26:58.987Z",
3717 + "PeriodValue": 0,
3718 + "PeriodType": 0
3719 + }
3720 + ]
3721 +}
3722 +
3723 +Ответ: Success
3724 +
3725 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3726 +|ClientId|Идентификатор клиента
3727 +|PlanId|Идентификатор тарифного плана
3728 +|Feature|Код услуги
3729 +|IsEnabled|Признак, определяющий активирована ли услуга
3730 +|IsFactual|Признак, определяющий расчёт по факту
3731 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3732 +|Price|Цена за единицу.
3733 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3734 +|PeriodValue|Значение периода.
3735 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3736 +
3737 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3738 +
3739 +(% class="box warningmessage" %)
3740 +(((
3741 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3742 +)))
3743 +
3744 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3745 +
3746 +(% class="box infomessage" %)
3747 +(((
3748 +**POST /api/v3/vehicles/import/{agentId}**
3749 +)))
3750 +
3751 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3752 +
3753 +В пути указывается **agentId** - id клиента.
3754 +
3755 +**Заголовок**
3756 +
3757 +**X-Auth: [токен авторизации]**
3758 +
3759 +**Параметры**
3760 +
3761 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3762 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3763 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3764 +
3765 +В теле использовать тип **form-data,** тип значения** file**
3766 +
3767 +**Ключи**
3768 +
3769 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3770 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3771 +|csv|В значении передаем файл датчиков, формат **csv**
3772 +
3773 +Ответ:
3774 +
3775 +{
3776 + "vehicleId": 0,
3777 + "name": "string",
3778 + "errors": ["string"]
3779 +}
3780 +
3781 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3782 +|vehicleId|ID созданного объекта
3783 +|name|Имя созданного объекта
3784 +|errors|Ошибки и их описание
3785 +
3786 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3787 +
3788 +(% class="box infomessage" %)
3789 +(((
3790 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3791 +)))
3792 +
3793 +(% class="wikigeneratedid" %)
3794 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3795 +
3796 +(% class="wikigeneratedid" %)
3797 +В пути указывается **vehicleId **- id объекта.
3798 +
3799 +**Заголовок**
3800 +
3801 +**X-Auth: [токен авторизации]**
3802 +
3803 +В теле использовать тип **form-data.**
3804 +
3805 +Ключи:
3806 +
3807 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3808 +|**history**|В значении передавать файл с историей
3809 +
3810 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3811 +
3812 +Ответ:
3813 +
3814 +{
3815 + "results": [
3816 + {
3817 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3818 + "vehicleId": 0,
3819 + "errors": [
3820 + "string"
3821 + ],
3822 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3823 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3824 + "producedCount": 0,
3825 + "msgCount": 0
3826 + }
3827 + ]
3828 +}
3829 +
3830 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3831 +|results|Результаты импорта в разрезе ТС
3832 +|vehicleGuid|Guid ТС
3833 +|vehicleId|ID ТС
3834 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3835 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3836 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3837 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3838 +|msgCount|Кол-во обработанных сообщений всего
3839 +
3840 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3841 +
3842 +(% class="box infomessage" %)
3843 +(((
3844 +**GET /api/v3/vehicles/import/history/status**
3845 +)))
3846 +
3847 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3848 +
3849 +Ответ:
3850 +
3851 +{
3852 + "activity": true,
3853 + "progress": 0,
3854 + "message": "string"
3855 +}
3856 +
3857 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3858 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3859 +|progress|Guid ТС
3860 +
3861 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3862 +
3863 +(% class="box infomessage" %)
3864 +(((
3865 +**POST /api/v3/vehicles/export**
3866 +)))
3867 +
3868 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3869 +
3870 +Тело запроса:
3871 +
3872 +[
3873 + id
3874 +]
3875 +
3876 +Ответ: Success 200, получаете файлы с настройками.
3877 +
3878 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3879 +
3880 +(% class="box infomessage" %)
3881 +(((
3882 +**POST /api/v3/vehicles/export/history**
3883 +)))
3884 +
3885 +Метод возвращает список сообщений терминала объекта за выбранный период.
3886 +
3887 +Тело запроса:
3888 +
3889 +{
3890 + "vehicleId": 0,
3891 + "asArchive": true,
3892 + "from": "2023-09-27T12:17:45.973Z",
3893 + "to": "2023-09-27T12:17:45.973Z"
3894 +}
3895 +
3896 +Ответ:
3897 +
3898 +Получаете файл. Сообщение: Code 200/Success
3899 +
3900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3901 +|vehicleId|ID объекта
3902 +|asArchive|true - Архивировать файл, False - не архивировать
3903 +|from|Дата и время начала запроса
3904 +|to|Дата и время окончания запроса
3905 +
3906 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3907 +
3908 +(% class="box infomessage" %)
3909 +(((
3910 +**GET /api/v3/vehicles/export/history/status**
3911 +)))
3912 +
3913 +Метод возвращает список сообщений терминала объекта за выбранный период.
3914 +
3915 +Ответ:
3916 +
3917 +{
3918 + "activity": true,
3919 + "progress": 0,
3920 + "message": "string"
3921 +}
3922 +
3923 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3924 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3925 +|progress|Прогресс экспорта, от 0 до 100%
3926 +|message|Текст описывающий статус
3927 +
3928 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3929 +
3930 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3931 +
3932 +(% class="box infomessage" %)
3933 +(((
3934 +**POST /api/v3/EcoDriving/rating**
3935 +)))
3936 +
3937 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3938 +
3939 +Тело запроса:
3940 +
3941 +{
3942 + "vehicleIds": [vehicleId],
3943 + "from": "2023-11-22T09:29:48.051Z",
3944 + "to": "2023-11-22T09:29:48.051Z"
3945 +}
3946 +
3947 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3948 +|vehicleIds|Массив ID объектов
3949 +|from|Дата начала запроса
3950 +|to|Дата окончания запроса
3951 +
3952 +Ответ:
3953 +
3954 +{
3955 + "items": [
3956 + {
3957 + "from": "2023-11-22T09:29:48.052Z",
3958 + "to": "2023-11-22T09:29:48.052Z",
3959 + "vehicleId": 0,
3960 + "vehicleName": "string",
3961 + "vehicleModel": "string",
3962 + "penalty": 0,
3963 + "score": 0,
3964 + "totalViolations": 0,
3965 + "violationsByType": {
3966 + "overspeedingViolations": 0,
3967 + "accelerationViolations": 0,
3968 + "brakingViolations": 0,
3969 + "turningViolations": 0,
3970 + "dangerousDrivingViolations": 0,
3971 + "sensorViolations": 0
3972 + },
3973 + "moveTime": 0,
3974 + "mileage": 0,
3975 + "tripsCount": 0,
3976 + "trips": [
3977 + {
3978 + "penalty": 0,
3979 + "score": 0,
3980 + "violationsCount": 0,
3981 + "violationsByType": {
3982 + "overspeedingViolations": 0,
3983 + "accelerationViolations": 0,
3984 + "brakingViolations": 0,
3985 + "turningViolations": 0,
3986 + "dangerousDrivingViolations": 0,
3987 + "sensorViolations": 0
3988 + },
3989 + "moveTime": 0,
3990 + "mileage": 0,
3991 + "motohours": 0,
3992 + "maxSpeed": 0,
3993 + "startAddress": "string",
3994 + "endAddress": "string",
3995 + "drivers": [
3996 + {
3997 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3998 + "driverName": "string",
3999 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4000 + }
4001 + ]
4002 + }
4003 + ]
4004 + }
4005 + ]
4006 +}
4007 +
4008 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4009 +|from|Дата начала запроса
4010 +|to|Дата  окончания
4011 +|vehicleId|ID объекта
4012 +|vehicleName|Имя объекта
4013 +|vehicleModel|Модель объекта
4014 +|penalty|Сумма штрафных баллов
4015 +|score|Оценка
4016 +|totalViolations|Суммарное количество нарушений
4017 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4018 +|overspeedingViolations|Превышение скорости
4019 +|accelerationViolations|Ускорение
4020 +|brakingViolations|Торможение
4021 +|turningViolations|Резкий поворот
4022 +|dangerousDrivingViolations|Резкое вождение
4023 +|sensorViolations|Нарушение по датчику
4024 +|moveTime|Время в движении
4025 +|mileage|Пробег (км)
4026 +|tripsCount|Количество рейсов
4027 +|motohours|Моточасы
4028 +|maxSpeed|Максимальная скорость
4029 +|startAddress|Адрес начала рейса
4030 +|endAddress|Адрес окончания рейса
4031 +|drivers|Список водителей, которые были на объекте в течениии рейса
4032 +|driverGuid|Guid водителя
4033 +|driverName|Имя водителя
4034 +|driverRfid|Номер Карты-метки
4035 +
4036 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4037 +
4038 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4039 +
4040 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4041 +
4042 +(% class="box infomessage" %)
4043 +(((
4044 +POST /api/v3/fuelcards/transactions
4045 +)))
4046 +
4047 +Метод запроса: POST
4048 +
4049 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4050 +\\В заголовках запроса: X-Auth: Токен авторизации
4051 +
4052 +Параметры в теле запроса (JSON):
4053 +
4054 +{
4055 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4056 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4057 + "ids": [ 
4058 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4059 + ],
4060 + "timezone": 0 ~/~/Таймзона
4061 +}
4062 +
4063 +
4064 +Ответ:
4065 + {
4066 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4067 + "driver": "string", ~/~/Водители, привязанные к ТК
4068 + "object": "string", ~/~/Наименование ТС
4069 + "amount": 0, ~/~/Количество топлива
4070 + "amountDut": 0, ~/~/Количество по ДУТ
4071 + "amountDiff": 0, ~/~/Разница, л
4072 + "amountDiffPerc": 0, ~/~/Разница, %
4073 + "summa": 0, ~/~/Стоимость, руб
4074 + "serviceName": "string", ~/~/Тип топлива
4075 + "price": 0, ~/~/Цена за литр, руб
4076 + "cardName": "string", ~/~/Наименование ТК
4077 + "cardNum": "string", ~/~/Номер ТК
4078 + "operator": "string", ~/~/Оператор ТК
4079 + "address": "string" ~/~/Адрес АЗС
4080 + }
4081 +
4082 +
4083 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4084 +
4085 +
4086 +== **Получение полных данных о ретрансляторе** ==
4087 +
4088 +(% class="box infomessage" %)
4089 +(((
4090 +**GET ** **/api/v3/retranslations/{id}**
4091 +)))
4092 +
4093 +Идентификатор запроса: ID
4094 +
4095 +
4096 +Пример ответа:
4097 +
4098 +{  
4099 +"description": "", ~/~/ Определяет описание
4100 +"subscriberId": "", ~/~/ Подписчик
4101 +"protocolType": 0, ~/~/ Тип протокола
4102 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4103 +"address": "string", ~/~/ Адрес события
4104 +"objects": [ ~/~/Объекты для ретрансляции
4105 +{      
4106 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4107 +"name": "", ~/~/ Наименование объекта ретрансляции
4108 +"imei": "", ~/~/ IMEI объекта  
4109 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4110 +}
4111 + ],  
4112 +"id": "", ~/~/ идентификатор пользователя   
4113 +"parentId": "", ~/~/Guid родителя
4114 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4115 +}
4116 +
4117 +
4118 +== **Удаление данных ретранслятора** ==
4119 +
4120 +(% class="box infomessage" %)
4121 +(((
4122 +**DELETE** **/api/v3/retranslations/{id}**
4123 +)))
4124 +
4125 +Параметр запроса: ID
4126 +
4127 +
4128 +== **Создание ретранслятора** ==
4129 +
4130 +(% class="box infomessage" %)
4131 +(((
4132 +**POST ** **/api/v3/retranslations/{id}**
4133 +)))
4134 +
4135 +Запрос:
4136 +
4137 +{  
4138 +"description": "", ~/~/ Описание
4139 +"subscriberId": "", ~/~/ Подписчик
4140 +"protocolType": 0, ~/~/ Тип протокола
4141 +"address": "", ~/~/ Адрес ретрансляции
4142 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4143 +"objects": [ ~/~/Объекты для ретрансляции
4144 +{      
4145 +"id": "", ~/~/ идентификатор пользователя     
4146 +"imei": "", ~/~/IMEI объекта
4147 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4148 +}
4149 + ]
4150 +}
4151 +
4152 +
4153 +Ответ:
4154 +
4155 +{  
4156 +"description": "string", ~/~/ Определяет описание
4157 +"subscriberId": "", ~/~/ идентификатор запроса
4158 +"protocolType": 0, ~/~/ Тип протокола
4159 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4160 +"address": "", ~/~/ Адрес события
4161 +"objects": [ ~/~/Объекты для ретрансляции
4162 +{      
4163 +"id": "", ~/~/ идентификатор пользователя    
4164 +"name": "string", ~/~/ Название уведомления
4165 +"imei": "string", ~/~/IMEI объекта  
4166 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4167 +}
4168 + ],  
4169 +"id": "", ~/~/ идентификатор пользователя  
4170 +"parentId": "", ~/~/ Guid идентификатор родителя
4171 +"deleted": true ~/~/ Признак удаления
4172 +}
4173 +
4174 +
4175 +== **Редактирование ретранслятора** ==
4176 +
4177 +(% class="box infomessage" %)
4178 +(((
4179 +**PUT** **/api/v3/retranslations**
4180 +)))
4181 +
4182 +Пример запроса:
4183 +
4184 +{  
4185 +"id": "", ~/~/ идентификатор пользователя   
4186 +"description": "string", ~/~/ Определяет описание
4187 +"subscriberId": "", ~/~/ идентификатор запроса
4188 +"protocolType": 0, ~/~/ Тип протокола
4189 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4190 +"address": "string", ~/~/ Адрес события
4191 +"objects": ~/~/Объекты для ретрансляции
4192 +[    
4193 +{      
4194 +"id": "",  ~/~/ идентификатор пользователя         
4195 +"imei": "", ~/~/IMEI объекта
4196 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4197 +}
4198 + ]
4199 +}
4200 +
4201 +
4202 +Пример ответа:
4203 +
4204 +{  
4205 +"description": "", ~/~/ Определяет описание
4206 +"subscriberId": "", ~/~/ идентификатор запроса
4207 +"protocolType": 0, ~/~/ Тип протокола
4208 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4209 +"address": "string", ~/~/ Адрес события
4210 +"objects": [ ~/~/Объекты для ретрансляции
4211 +{      
4212 +"id": "", ~/~/ идентификатор пользователя     
4213 +"name": "string", ~/~/ Название уведомления    
4214 +"imei": "", ~/~/IMEI объекта
4215 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4216 +}
4217 + ],
4218 +"id": "", ~/~/ идентификатор пользователя   
4219 +"parentId": "", ~/~/ Guid идентификатор родителя
4220 +"deleted": true ~/~/ Признак удаления
4221 +}
4222 +
4223 +
4224 +== **Получение списка ретранслятора клиента** ==
4225 +
4226 +(% class="box infomessage" %)
4227 +(((
4228 +**POST /api/v3/retranslations/find**
4229 +)))
4230 +
4231 +Пример запроса:
4232 +
4233 +{  
4234 +"id": "", ~/~/ идентификатор пользователя   
4235 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4236 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4237 +}
4238 +
4239 +Ответ:
4240 +
4241 +[ 
4242 +{    
4243 +"description": "", ~/~/ Определяет описание
4244 +"subscriberId": "", ~/~/ идентификатор запроса
4245 +"protocolType": 0, ~/~/ Тип протокола
4246 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4247 +"address": "string", ~/~/ Адрес события
4248 +"id": "", ~/~/ идентификатор пользователя   
4249 +"parentId": "", ~/~/ Guid идентификатор родителя
4250 +"deleted": true ~/~/ Признак удаления
4251 +}
4252 +]
4253 +
4254 +
4255 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4256 +
4257 +== **API для отчета по выгрузке комбайнов** ==
4258 +
4259 +(% class="box infomessage" %)
4260 +(((
4261 +POST **/api/v3/Reports/harvesterUnloading**
4262 +)))
4263 +
4264 +Пример запроса:
4265 +
4266 +{
4267 + "byTime": 0, ~/~/ Объединение событий по времени
4268 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4269 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4270 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4271 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4272 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4273 + 0
4274 + ],
4275 + "from": "", ~/~/ Дата и время начало запроса
4276 + "to": "", ~/~/ Дата и время окончания запроса
4277 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4278 +}
4279 +
4280 +Пример ответа:
4281 +
4282 +[ 
4283 + {
4284 + "harvesterName": "", ~/~/Комбайн, номер
4285 + "harvesterId": 0, ~/~/Комбайн, id
4286 +"harvesterModel": "", ~/~/ Модель комбайна
4287 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4288 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4289 + "events": [ ~/~/Список событий в разрезе комбайна
4290 + {
4291 + "driverId": "", ~/~/Идентификатор водителя
4292 + "driverName": "", ~/~/Водитель комбайна, ФИО
4293 + "RFID": "", ~/~/ идентификатор карты-метки
4294 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4295 + "vehicleId": 0, ~/~/идентификатор объекта
4296 + "vehicleName": "string", ~/~/ Имя объекта
4297 + "modelName": "string", ~/~/ Имя модели объекта
4298 + "nearestVehicles": [ ~/~/Объекты рядом
4299 + {
4300 + "vehicleId": 0, ~/~/идентификатор объекта
4301 + "vehicleName": "string" ~/~/ Имя объекта
4302 + }
4303 + ],
4304 + "fields": [ ~/~/Поля, где происходила выгрузка
4305 + {
4306 + "id": 0, ~/~/ идентификатор пользователя 
4307 + "name": "string" ~/~/ имя пользователя 
4308 + }
4309 + ],
4310 + "event": "string", ~/~/Событие
4311 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4312 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4313 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4314 + "cultureName": "string", ~/~/ название культуры
4315 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4316 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4317 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4318 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4319 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4320 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4321 + "issued": 0, ~/~/Выдано, бункеров
4322 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4323 + "latitude": 0, ~/~/Широта
4324 + "longitude": 0, ~/~/ Долгота
4325 + "litresAway": 0, ~/~/Отдано, л
4326 + "m3Away": 0 ~/~/Отдано, м3
4327 + }
4328 + ]
4329 + }
4330 +]
4331 +
4332 +
4333 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4334 +
4335 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4336 +
4337 +
4338 +(% class="box infomessage" %)
4339 +(((
4340 +GET api/v3/Vehicles/recyclebin/all
4341 +)))
4342 +
4343 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4344 +
4345 +Параметр запроса: {parentId} - идентификатор агента
4346 +
4347 +В заголовках запроса: X-Auth: Токен авторизации
4348 +
4349 +Ответ:
4350 +
4351 +[ 
4352 + {
4353 + "recordTime": "", ~/~/Время записи
4354 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4355 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4356 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4357 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4358 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4359 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4360 + "items": [ ~/~/ 
4361 +nullable: true ~/~/Детали
4362 + {
4363 + "name": "string", ~/~/наименование столбца
4364 + "value": "string" ~/~/содержание столбца
4365 + }
4366 + ]
4367 + },
4368 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4369 + "string"
4370 + ]
4371 + }
4372 +]
4373 +
4374 +
4375 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4376 +
4377 +(% class="box infomessage" %)
4378 +(((
4379 +POST/api/v3/Vehicles/recyclebin/erase
4380 +)))
4381 +
4382 +В заголовках запроса: X-Auth: Токен авторизации
4383 +
4384 +Пример запроса:
4385 +
4386 +[
4387 +0
4388 +]
4389 +
4390 +
4391 +Пример ответа:
4392 +
4393 +[ 
4394 +{
4395 + "recordTime": "", ~/~/Время записи
4396 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4397 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4398 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4399 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4400 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4401 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4402 + "items": [ ~/~/Детали
4403 + {
4404 + "name": "", ~/~/Имя свойства
4405 + "value": "" ~/~/Значение свойства
4406 + }
4407 + ]
4408 + },
4409 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4410 + ""
4411 + ]
4412 + }
4413 +]
4414 +
4415 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4416 +
4417 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4418 +
4419 +(% class="box infomessage" %)
4420 +(((
4421 +POST/api/v3/Vehicles/recyclebin/restore
4422 +)))
4423 +
4424 +В заголовках запроса: X-Auth: Токен авторизации
4425 +
4426 +Параметры в теле запроса (JSON):
4427 +
4428 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4429 +
4430 +В заголовках запроса: X-Auth: Токен авторизации
4431 +
4432 +
4433 +Пример запроса:
4434 +
4435 +(((
4436 +[
4437 +)))
4438 +
4439 +(((
4440 + 0
4441 +)))
4442 +
4443 +(((
4444 +]
4445 +)))
4446 +
4447 +
4448 +Пример ответа:
4449 +
4450 +[
4451 +{
4452 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4453 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4454 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4455 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4456 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4457 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4458 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4459 + "items": [ ~/~/Детали
4460 + {
4461 + "name": "string", ~/~/Имя свойства
4462 + "value": "string" ~/~/Значение свойства
4463 + }
4464 + ]
4465 + },
4466 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4467 + "string"
4468 + ]
4469 + }
4470 +]
4471 +
4472 +
4473 +
2836 2836  (% class="box" lang="en-US" style="text-align: center;" %)
2837 2837  (((
2838 2838  (% 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,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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