<
From version < 174.1 >
edited by Андрей Калиновский
on 2024/10/23 09:09
To version < 110.1 >
edited by Илья Крайнов
on 2023/10/18 16:32
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Content
... ... @@ -14,22 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 -
20 -(% style="color:#000000; font-size:16px" %)**Рекомендации**
21 -
22 -- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
23 -
24 24  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
25 25  
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 -)))
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
31 31  
32 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
33 33  (((
34 34  (% lang="en-US" %)**POST /api/v3/auth/login**
35 35  )))
... ... @@ -40,7 +40,7 @@
40 40  
41 41  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
42 42  
43 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
44 44  
45 45  (% style="color:#000000" %)Параметры в теле запроса (JSON):
46 46  
... ... @@ -49,25 +49,21 @@
49 49   "password": "testuser"
50 50  }
51 51  
43 +
52 52  (% style="color:#000000" %)**Ответ:**
53 53  
54 54  (% lang="en-US" %)
55 55  (% style="color:#000000" %){
56 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
57 - "User": "testuser" , ~/~/ имя пользователя(%%)
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" %)
58 58  }
59 59  
60 60  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
61 61  
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 -
71 71  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
72 72  
73 73  (% class="box infomessage" %)
... ... @@ -106,51 +106,30 @@
106 106  Запрос должен содержать данные параметра "**agentId**"
107 107  
108 108  (% style="color:#000000" %)Ответ:
96
109 109  {
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"
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" ~/~/ Корр. счет
130 130   }
131 131  
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 -
154 154  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
155 155  
156 156  (% class="box infomessage" %)
... ... @@ -164,7 +164,7 @@
164 164  
165 165  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
166 166  
167 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
168 168  
169 169  (% style="color:#000000" %)Метод запроса: **POST**
170 170  
... ... @@ -179,23 +179,15 @@
179 179  (% style="color:#000000" %)Ответ:
180 180  
181 181  {
182 - "agentId": "",(% style="color:#000000" %)   (%%)
183 - "parentId": "",
184 - "name": "string",
185 - "fullName": "string",
186 - "agentInfoType": 0,
187 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
188 188  }
189 189  
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 -
199 199  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
200 200  
201 201  (% class="box successmessage" %)
... ... @@ -214,7 +214,7 @@
214 214  Параметры в теле запроса (JSON):
215 215  
216 216  {
217 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
218 218   "name": "string", ~/~/ имя
219 219   "fullName": "string", ~/~/ полное наименование
220 220   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -234,6 +234,7 @@
234 234   "bankKS": "string" ~/~/ корр. счёт
235 235  }
236 236  
195 +
237 237  Ответ:
238 238  
239 239  {
... ... @@ -258,28 +258,6 @@
258 258   "bankKS": "string" ~/~/ корр. счёт
259 259  }
260 260  
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 -
283 283  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
284 284  
285 285  (% class="box warningmessage" %)
... ... @@ -295,6 +295,7 @@
295 295  
296 296  В заголовках запроса: X-Auth: Токен авторизации
297 297  
235 +
298 298  Параметры в теле запроса (JSON):
299 299  
300 300  {
... ... @@ -319,6 +319,7 @@
319 319   "bankKS": "string" ~/~/ корр. счёт
320 320  }
321 321  
260 +
322 322  Ответ:
323 323  
324 324  {
... ... @@ -361,21 +361,6 @@
361 361  
362 362  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
363 363  
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 -
379 379  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
380 380  
381 381  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -427,6 +427,7 @@
427 427   ],
428 428   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
429 429  }
354 +
430 430  {
431 431   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
432 432   "lastName": "string",
... ... @@ -438,10 +438,15 @@
438 438   "password": "string",
439 439   "email": "string",
440 440  
366 +
441 441  (% style="text-align:left" %)
442 442  (% style="color:#000000; font-weight:normal" %)Ответ:
443 -{     
444 - "id": "" , ~/~/ ID пользователя
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 пользователя
445 445   "lastName": "" , ~/~/ Фамилия ,
446 446   "firstName": "" , ~/~/ Имя
447 447   "position": "" , ~/~/ Должность
... ... @@ -458,8 +458,9 @@
458 458   "kind": "" , ~/~/ тип аутентификации
459 459   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
460 460   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
461 -}
462 462  
392 +(% style="text-align:left" %)
393 +(% style="color:#000000; font-weight:normal" %)}
463 463  
464 464  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465 465  
... ... @@ -480,16 +480,19 @@
480 480  
481 481  (% style="color:#000000" %)Параметры в теле запроса (JSON):
482 482  
483 -(% style="color:#000000" %){(%%)
414 +(% style="color:#000000" %){
415 +
484 484   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
485 485   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
486 486   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
487 487   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 +
488 488  (% style="color:#000000" %)}
489 489  
490 490  (% style="color:#000000" %)Ответ:
491 491  
492 492  (% style="color:#000000" %){         (%%)
426 +
493 493   "id": "" , ~/~/ идентификатор пользователя
494 494   "lastName": "" , ~/~/ фамилия
495 495   "firstName": "" , ~/~/ имя
... ... @@ -503,6 +503,7 @@
503 503   "sessionDuration":"", ~/~/ длительность сессии в минутах
504 504   "status": "1",  ~/~/ статус пользователя
505 505   "lastLogged": "", ~/~/ дата/время последней авторизации
440 +
506 506  (% style="color:#000000" %)}
507 507  
508 508  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -576,8 +576,10 @@
576 576  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
577 577  
578 578  (% lang="en-US" style="text-align:left" %)
579 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
580 - "id": "" , ~/~/ ID пользователя 
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 пользователя 
581 581   "lastName": "" , ~/~/ фамилия
582 582   "firstName": "" , ~/~/ имя
583 583   "position": "" , ~/~/ должность
... ... @@ -599,7 +599,9 @@
599 599   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
600 600   },
601 601   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
602 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 +
541 +(% lang="en-US" style="text-align:left" %)
603 603  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
604 604  
605 605  (% lang="en-US" style="text-align:left" %)
... ... @@ -606,8 +606,10 @@
606 606  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
607 607  
608 608  (% lang="en-US" style="text-align:left" %)
609 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
610 - "id": "" , ~/~/ идентификатор пользователя
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": "" , ~/~/ идентификатор пользователя
611 611   "lastName": "" , ~/~/ фамилия
612 612   "firstName": "" , ~/~/ имя
613 613   "position": "" , ~/~/ должность
... ... @@ -628,8 +628,10 @@
628 628   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
629 629   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
630 630   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
631 -}
632 632  
573 +(% lang="en-US" style="text-align:left" %)
574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 +
633 633  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
634 634  
635 635  (% class="box warningmessage" %)
... ... @@ -649,10 +649,12 @@
649 649  
650 650  (% style="color:#000000" %)Параметры в теле запроса (JSON):
651 651  
652 -(% style="color:#000000" %){(%%)
595 +(% style="color:#000000" %){
596 +
653 653   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
654 654   "description": "" , ~/~/ описание
655 655   "data": "" , ~/~/ данные, связанные со сменой статуса
600 +
656 656  (% style="color:#000000" %)}
657 657  
658 658  (% style="text-align:left" %)
... ... @@ -674,7 +674,7 @@
674 674  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
675 675  
676 676   [ 
677 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
678 678   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
679 679   ]
680 680  
... ... @@ -766,6 +766,7 @@
766 766   "maxspeed": 0,
767 767   "width": 0,
768 768   "imbeddedtrailer": true,
714 + "fueloutlay": 0,
769 769   "hoppercapacity": 0,
770 770   "hopperdischargespeed": 0,
771 771   "modelType": 0,
... ... @@ -782,8 +782,9 @@
782 782  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
783 783  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
784 784  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
785 785  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
786 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
787 787  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
788 788  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
789 789  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -875,24 +875,12 @@
875 875   "maxspeed": 0,
876 876   "width": 0,
877 877   "imbeddedtrailer": true,
825 + "fueloutlay": 0,
878 878   "hoppercapacity": 0,
879 879   "hopperdischargespeed": 0,
880 880   "modelType": 0
881 881  }
882 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 896  
897 897  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
898 898  
... ... @@ -947,20 +947,6 @@
947 947   "modelType": 0
948 948  }
949 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 964  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
965 965  
966 966  (% class="box errormessage" %)
... ... @@ -980,7 +980,7 @@
980 980  
981 981  Ответ: В случае успеха **Success 200**
982 982  
983 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
904 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
984 984  
985 985  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
986 986  
... ... @@ -1016,15 +1016,19 @@
1016 1016   "deviceTypeName": "", ~/~/ Название типа устройства
1017 1017   "sim1": "", ~/~/ Номер SIM1
1018 1018   "sim2": "", ~/~/ Номер SIM2
940 +
1019 1019   "parentId": "", ~/~/ ID клиента-родителя
1020 1020   "parentName": "", ~/~/ Наименование клиента-родителя
1021 1021   "modelId": "", ~/~/ ID модели объекта
1022 1022   "modelName": "", ~/~/ Имя модели объекта
945 +
1023 1023   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1024 1024   "unitName": "string", ~/~/ Наименование подразделения
1025 1025   "status": 0, ~/~/ Статус объекта
949 +
1026 1026   "createdAt": "", ~/~/ Дата создания объекта
1027 1027   },
952 +
1028 1028  "customFields": [ ~/~/ Произвольные поля
1029 1029   {
1030 1030   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -1047,7 +1047,8 @@
1047 1047   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1048 1048   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1049 1049   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1050 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
975 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
976 +
1051 1051   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1052 1052   "mileageCoeff": 0, ~/~/ коэффициент пробега
1053 1053   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -1077,6 +1077,7 @@
1077 1077   "retries": 0 ~/~/ Количество попыток
1078 1078   }
1079 1079   ],
1006 +
1080 1080   "sensors": [ ~/~/ Датчики
1081 1081   {
1082 1082   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -1117,19 +1117,31 @@
1117 1117   },
1118 1118  
1119 1119  ~/~/ Характерные для произвольного:
1047 +
1120 1120  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1049 +
1121 1121  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1051 +
1122 1122  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1053 +
1123 1123  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1055 +
1124 1124  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1057 +
1125 1125  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1059 +
1126 1126  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1061 +
1127 1127  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1063 +
1128 1128  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1065 +
1129 1129  ~/~/ "ValueOn": "Вкл.",
1067 +
1130 1130  ~/~/ "ValueOff": "Выкл."
1131 1131   "summaryMaxValue": 0 ~/~/ Макс. значение
1132 1132   }
1071 +
1133 1133   "drivers": [ ~/~/ Водители
1134 1134   {
1135 1135   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1138,6 +1138,7 @@
1138 1138   "isDefault": true ~/~/ По умолчанию
1139 1139   }
1140 1140   ],
1080 +
1141 1141   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1142 1142   {
1143 1143   "id": "", ~/~/ ID  задания
... ... @@ -1154,7 +1154,8 @@
1154 1154   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1155 1155   }
1156 1156   ],
1157 -"statusHistory": [ ~/~/ История статусов
1097 +
1098 + "statusHistory": [ ~/~/ История статусов
1158 1158   {
1159 1159   "status": 0,
1160 1160   "date": "2023-05-22T09:57:39.562Z",
... ... @@ -1162,6 +1162,7 @@
1162 1162   "additionalInfo": "string"
1163 1163   }
1164 1164   ]
1106 +
1165 1165  }
1166 1166  )))
1167 1167  
... ... @@ -1171,73 +1171,6 @@
1171 1171  (% style="text-align:left" %)
1172 1172  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1173 1173  
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 -
1241 1241  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1242 1242  
1243 1243  (% class="box successmessage" %)
... ... @@ -1255,7 +1255,8 @@
1255 1255  
1256 1256  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1257 1257  
1258 -(% style="color:#000000" %){(%%)
1133 +(% style="color:#000000" %){
1134 +
1259 1259   "parentId": "" , ~/~/ ID клиента
1260 1260   "name": "" , ~/~/ имя ТС
1261 1261   "imei": "" , ~/~/ IMEI
... ... @@ -1276,6 +1276,7 @@
1276 1276   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1277 1277   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1278 1278   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1155 +
1279 1279   "mileageCalcMethod": 0,
1280 1280   "mileageCoeff": 0,
1281 1281   "locationByCellId": true,
... ... @@ -1308,6 +1308,7 @@
1308 1308   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1309 1309   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1310 1310   }
1188 +
1311 1311  "drivers": [ ~/~/ Водители
1312 1312   {
1313 1313   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1322,7 +1322,8 @@
1322 1322   "retries": 0
1323 1323   }
1324 1324   ],
1325 -"sensors": [ ~/~/ Датчики
1203 +
1204 + "sensors": [ ~/~/ Датчики
1326 1326   {
1327 1327   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1328 1328   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1360,17 +1360,29 @@
1360 1360   "additionalProp2": "string",
1361 1361   "additionalProp3": "string"
1362 1362   },
1242 +
1363 1363  ~/~/ Характерные для произвольного:
1244 +
1364 1364  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1246 +
1365 1365  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1248 +
1366 1366  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1250 +
1367 1367  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1252 +
1368 1368  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1254 +
1369 1369  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1256 +
1370 1370  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1258 +
1371 1371  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1260 +
1372 1372  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1262 +
1373 1373  ~/~/ "ValueOn": "Вкл.",
1264 +
1374 1374  ~/~/ "ValueOff": "Выкл."
1375 1375   "summaryMaxValue": 0 ~/~/ Макс. значение
1376 1376   }
... ... @@ -1389,7 +1389,8 @@
1389 1389  
1390 1390  (% style="color:#000000" %)Ответ:
1391 1391  
1392 -(% style="color:#000000" %){(%%)
1283 +(% style="color:#000000" %){
1284 +
1393 1393   "vehicleId": "", ~/~/ID ТС 
1394 1394   "parentId": "", ~/~/Guid владельца ТС
1395 1395   "name": "", ~/~/Имя объекта
... ... @@ -1427,6 +1427,8 @@
1427 1427   "kind": "", ~/~/ Вид периодичности по времени 
1428 1428   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1429 1429   }
1322 +
1323 +(% style="text-align:left" %)
1430 1430  (% style="color:#000000" %)}
1431 1431  
1432 1432  **Валидация:**
... ... @@ -1434,7 +1434,7 @@
1434 1434  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1435 1435  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1436 1436  
1437 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1331 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1438 1438  
1439 1439  (% class="box infomessage" %)
1440 1440  (((
... ... @@ -1441,7 +1441,7 @@
1441 1441  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1442 1442  )))
1443 1443  
1444 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1338 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1445 1445  
1446 1446  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1447 1447  
... ... @@ -1485,7 +1485,8 @@
1485 1485  (% style="color:#000000" %)Ответ:
1486 1486  
1487 1487  (% style="color:#000000" %){
1488 - "vehicleId": "" ~/~/ идентификатор объекта
1382 +
1383 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1489 1489   "name": "" ~/~/ наименование объекта
1490 1490   "imei": "" ~/~/ IMEI объекта
1491 1491   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1544,11 +1544,13 @@
1544 1544   "data": "", ~/~/ Данные
1545 1545   "overwrite": false, ~/~/ Флаг перезаписи
1546 1546   "stage": "", ~/~/ Состояние, может быть null
1442 +
1547 1547  (% style="color:#000000" %)}
1548 1548  
1549 1549  (% style="color:#000000" %)Ответ:
1550 1550  
1551 -(% style="color:#000000" %){(%%)
1447 +(% style="color:#000000" %){
1448 +
1552 1552   "status": "", ~/~/ значение статуса
1553 1553   "date": "", ~/~/ Дата смены статуса 
1554 1554   "description": "", ~/~/ Описание
... ... @@ -1555,10 +1555,10 @@
1555 1555   "data": "", ~/~/ Данные
1556 1556   "overwrite": false, ~/~/ Флаг перезаписи
1557 1557   "stage": "", ~/~/ Состояние
1455 +
1456 +(% style="text-align:left" %)
1558 1558  (% style="color:#000000" %) }
1559 1559  
1560 -== ==
1561 -
1562 1562  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1563 1563  
1564 1564  (% class="box warningmessage" %)
... ... @@ -1646,7 +1646,8 @@
1646 1646   "retries": 0
1647 1647   }
1648 1648   ],
1649 -"sensors": [ ~/~/ Датчики
1546 +
1547 + "sensors": [ ~/~/ Датчики
1650 1650   {
1651 1651   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1652 1652   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1684,17 +1684,29 @@
1684 1684   "additionalProp2": "string",
1685 1685   "additionalProp3": "string"
1686 1686   },
1585 +
1687 1687  ~/~/ Характерные для произвольного:
1587 +
1688 1688  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1589 +
1689 1689  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1591 +
1690 1690  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1593 +
1691 1691  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1595 +
1692 1692  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1597 +
1693 1693  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1599 +
1694 1694  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1601 +
1695 1695  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1603 +
1696 1696  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1605 +
1697 1697  ~/~/ "ValueOn": "Вкл.",
1607 +
1698 1698  ~/~/ "ValueOff": "Выкл."
1699 1699   "summaryMaxValue": 0 ~/~/ Макс. значение
1700 1700   }
... ... @@ -1714,7 +1714,9 @@
1714 1714  (% style="color:#000000" %)Ответ:
1715 1715  
1716 1716  (% lang="en-US" style="text-align:left" %)
1717 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1627 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1628 +
1629 +(% lang="en-US" style="text-align:left" %)
1718 1718   "vehicleId": "", ~/~/ ID ТС
1719 1719   "parentId": "", ~/~/ ID клиента
1720 1720   "name": "", ~/~/ имя ТС
... ... @@ -1755,6 +1755,8 @@
1755 1755   "kind": "", ~/~/ Вид периодичности по времени
1756 1756   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1757 1757   }
1670 +
1671 +(% lang="en-US" style="text-align:left" %)
1758 1758  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1759 1759  
1760 1760  **Валидация:**
... ... @@ -1795,15 +1795,18 @@
1795 1795  
1796 1796  (% style="color:#000000" %)Метод запроса: **GET**
1797 1797  
1798 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1712 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1799 1799  
1800 1800  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1801 1801  
1802 1802  (% style="color:#000000" %)Ответ:
1803 1803  
1804 -(% style="color:#000000" %){(%%)
1718 +(% style="color:#000000" %){
1719 +
1805 1805   "deviceTypeId" : "", ~/~/ ID типа устройства
1806 1806   "deviceTypeName" : "" ~/~/ Название типа устройства
1722 +
1723 +(% style="text-align:left" %)
1807 1807  (% style="color:#000000" %)}
1808 1808  
1809 1809  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1825,10 +1825,13 @@
1825 1825  
1826 1826  (% style="color:#000000" %)Ответ:
1827 1827  
1828 -(% style="color:#000000" %){(%%)
1745 +(% style="color:#000000" %){
1746 +
1829 1829   "id": "", ~/~/ ID типа датчика 
1830 1830   "name": "", ~/~/ Название
1831 1831   "description": "", ~/~/ Описание
1750 +
1751 +(% style="text-align:left" %)
1832 1832  (% style="color:#000000" %)}
1833 1833  
1834 1834  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1872,56 +1872,6 @@
1872 1872   }
1873 1873  ]
1874 1874  
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 -
1925 1925  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1926 1926  
1927 1927  (% class="box infomessage" %)
... ... @@ -1946,11 +1946,6 @@
1946 1946   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1947 1947  }
1948 1948  
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 -
1954 1954  Ответ:
1955 1955  
1956 1956  [
... ... @@ -1957,43 +1957,80 @@
1957 1957   {
1958 1958   "messages": [
1959 1959   {
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": {
1825 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1826 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1827 + "speed": 0, ~/~/ Скорость, км/ч
1828 + "altitude": 0, ~/~/ Высота, м
1829 + "latitude": 0, ~/~/ Широта [-90°;90°]
1830 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1831 + "satellites": 0, ~/~/ Кол-во спутников
1832 + "voltage": 0, ~/~/ Напряжение
1833 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1970 1970   "additionalProp1": "string",
1971 1971   "additionalProp2": "string",
1972 1972   "additionalProp3": "string"
1973 1973   },
1974 - "photoCount": 0,
1975 - "lbsCorrectedCoords": true,
1976 - "protocolType": 0
1838 + "photoCount": 0 ~/~/ Кол-во фото
1977 1977   }
1978 1978   ]
1979 1979   }
1980 1980  ]
1981 1981  
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 типа протокола
1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1996 1996  
1846 +(% class="box infomessage" %)
1847 +(((
1848 +**POST /api/v3/vehicles/export/history**
1849 +)))
1850 +
1851 +Метод возвращает список сообщений терминала объекта за выбранный период.
1852 +
1853 +(% style="text-align: left;" %)
1854 +Метод запроса **POST**
1855 +
1856 +(% style="text-align: left;" %)
1857 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1858 +
1859 +(% style="text-align: left;" %)
1860 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1861 +
1862 +{
1863 + "vehicleId": 0, ~/~/ ID объекта
1864 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1865 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1866 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1867 +}
1868 +
1869 +Ответ:
1870 +
1871 +Получаете файл. Сообщение: Code 200/Success
1872 +
1873 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1874 +
1875 +(% class="box infomessage" %)
1876 +(((
1877 +**GET /api/v3/vehicles/export/history/status**
1878 +)))
1879 +
1880 +Метод возвращает список сообщений терминала объекта за выбранный период.
1881 +
1882 +(% style="text-align: left;" %)
1883 +Метод запроса **GET**
1884 +
1885 +(% style="text-align: left;" %)
1886 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1887 +
1888 +(% style="text-align: left;" %)
1889 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1890 +
1891 +Ответ:
1892 +
1893 +{
1894 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1895 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1896 + "message": "string" ~/~/ текст описывающий статус.
1897 +}
1898 +
1997 1997  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1998 1998  
1999 1999  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2030,12 +2030,10 @@
2030 2030   {
2031 2031   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2032 2032   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2033 - "mileage": 0, ~/~/ Пробег за период, километры
2034 - "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2035 - "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2036 - "motohours": 0, ~/~/ Моточасы за период, секунды
2037 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2038 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
1935 + "mileageBegin": 0, ~/~/ Пробег на начало периода
1936 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
1937 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1938 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2039 2039   }
2040 2040   ]
2041 2041   }
... ... @@ -2129,96 +2129,6 @@
2129 2129   }
2130 2130  ]
2131 2131  
2132 -
2133 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2134 -
2135 -(% class="box infomessage" %)
2136 -(((
2137 -**POST /api/v3/vehicles/moveStop**
2138 -)))
2139 -
2140 -Метод запроса: **POST**
2141 -
2142 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2143 -
2144 -В заголовках запроса: X-Auth: Токен авторизации
2145 -
2146 -
2147 -Тело запроса:
2148 -
2149 -{
2150 - "vehicleIds": [ ], ~/~/ Список ID объектов
2151 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2152 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2153 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2154 -}
2155 -
2156 -Ответ:
2157 -
2158 -[ 
2159 - {
2160 - "vehicleId": 0, ~/~/ ID объекта
2161 - "vehicleName": "string", ~/~/ Имя объекта
2162 - "moves": [ ~/~/ Событие движения
2163 - {
2164 - "mileage": 0, ~/~/ Пробег, км
2165 - "eventId": 0, ~/~/ Идентификатор события
2166 - "eventName": "string", ~/~/ Название события
2167 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2168 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2169 - "duration": 0 ~/~/ Продолжительность события, секунд
2170 - }
2171 - ],
2172 - "stops": [ ~/~/ События стоянок
2173 - {
2174 - "address": "string", ~/~/ Адрес события
2175 - "eventId": 0, ~/~/ Идентификатор события
2176 - "eventName": "string", ~/~/ Название события
2177 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2178 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2179 - "duration": 0 ~/~/ Продолжительность события, секунд
2180 - }
2181 - ]
2182 - }
2183 -]
2184 -
2185 -
2186 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2187 -
2188 -(% class="box infomessage" %)
2189 -(((
2190 -**POST /api/v3/vehicles/getlastdata**
2191 -)))
2192 -
2193 -Метод запроса: **POST**
2194 -
2195 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2196 -
2197 -В заголовках запроса: X-Auth: Токен авторизации
2198 -
2199 -
2200 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2201 -
2202 -Ответ:
2203 - {
2204 - "vehicleId": 0, ~/~/Идентификатор объекта.
2205 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2206 - "vehicleNumber": "string",~/~/Номер объекта.
2207 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2208 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2209 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2210 - "speed": 0,~/~/Скорость объекта.
2211 - "course": 0,~/~/Курс движения [0;360]
2212 - "latitude": 0,~/~/Широта [-90°;90°].
2213 - "longitude": 0,~/~/Долгота [-180°;180°].
2214 - "address": "string",~/~/Адрес.
2215 - "geozones": [ ~/~/Сведения по геозонам.
2216 - {
2217 - "id": 0,
2218 - "name": "string"
2219 - }
2220 -
2221 -
2222 2222  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2223 2223  
2224 2224  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2526,32 +2526,6 @@
2526 2526  
2527 2527  Success
2528 2528  
2529 -
2530 -== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2531 -
2532 -(% class="box warningmessage" %)
2533 -(((
2534 -**PUT** /api/v3/notifications/prolongation
2535 -)))
2536 -
2537 -Метод позволяет продлить уведомления.
2538 -
2539 -Метод запроса **PUT**
2540 -
2541 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2542 -
2543 -В заголовках запроса: X-Auth: Токен авторизации.
2544 -
2545 -Тело запроса:
2546 -
2547 -[
2548 -
2549 -0
2550 -
2551 -]
2552 -
2553 -где 0 идентификатор ids.
2554 -
2555 2555  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2556 2556  
2557 2557  (% class="box errormessage" %)
... ... @@ -3143,83 +3143,6 @@
3143 3143  Success
3144 3144  
3145 3145  
3146 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3147 -
3148 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3149 -
3150 -(% class="box infomessage" %)
3151 -(((
3152 -**POST /api/v3/Trailers**
3153 -)))
3154 -
3155 -Пример запроса:
3156 -
3157 -{
3158 - "startDate": "2023-11-14T10:48:03.671Z",
3159 - "endDate": "2023-11-14T10:48:03.671Z",
3160 - "ids": [ 0 ],
3161 - "timezone": 0
3162 -}
3163 -
3164 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3165 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3166 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3167 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3168 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3169 -
3170 -Пример ответа:
3171 -
3172 -[
3173 - {
3174 - "SD": "2023-11-14T10:48:03.717Z",
3175 - "ED": "2023-11-14T10:48:03.717Z", 
3176 - "id": 0,
3177 - "SLat": 0,
3178 - "SLon": 0,
3179 - "ELat": 0,
3180 - "ELon": 0,
3181 - "mileage": 0
3182 - "Duration": 0
3183 - "Address": "string",
3184 - "Address2": "string",
3185 - "name": "string",
3186 - "rid": "string",
3187 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3188 - "trailer": {
3189 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3190 - "Number": "string",
3191 - "Description": "string",
3192 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3193 - "ExternalID": "string",
3194 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3195 - "CreateTime": "2023-11-14T10:48:03.717Z",
3196 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3197 - "IsDeleted": true
3198 - },
3199 - "filesCount": 0,
3200 - }
3201 -]
3202 -
3203 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3204 -|SD|Дата и время начала события
3205 -|ED|Дата и время окончания события
3206 -|id|ID объекта
3207 -|SLat|Широта начальной координаты
3208 -|SLon|Долгота начальной координаты
3209 -|ELat|Широта конечной координаты
3210 -|ELon|Долгота конечной координаты
3211 -|mileage|Пробег
3212 -|Duration|Продолжительность
3213 -|Address|Адрес начального местоположения
3214 -|Address2|Адрес конечного местоположения
3215 -|name|Имя радиометки
3216 -|rid|Номер радиометки
3217 -|rguid|ID радиометки
3218 -|trailer|Информация об агрегате
3219 -|ModelGuid|ID агрегата
3220 -|Number|Название/номер агрегата
3221 -|Description|Текст примечания агрегата
3222 -
3223 3223  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3224 3224  
3225 3225  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3241,19 +3241,13 @@
3241 3241   {
3242 3242   "name": "string",
3243 3243   "number": 0,
3244 - "period": 0,
2951 + "period": 0, ~/~/ Частота трансляции радиометки
3245 3245   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3246 3246   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "deleted": true
3247 3247   }
3248 3248  ]
3249 3249  
3250 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3251 -|parentId|ID клиента
3252 -|name|Название карты-метки
3253 -|number|Номер
3254 -|period|Период запросов в секундах (работает только для агрегатов)
3255 -|id|ID карты-метки
3256 -
3257 3257  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3258 3258  
3259 3259  (% class="box infomessage" %)
... ... @@ -3269,18 +3269,13 @@
3269 3269   {
3270 3270   "name": "string",
3271 3271   "number": 0,
3272 - "period": 0,
2973 + "period": 0, ~/~/ Частота трансляции радиометки
3273 3273   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3274 3274   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "deleted": true
3275 3275   }
3276 3276  ]
3277 3277  
3278 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3279 -|name|Название карты-метки
3280 -|number|Номер
3281 -|period|Период запросов в секундах (работает только для агрегатов)
3282 -|id|ID карты-метки
3283 -|parentId|ID клиента
3284 3284  
3285 3285  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3286 3286  
... ... @@ -3296,6 +3296,7 @@
3296 3296   "number": 0,
3297 3297   "period": 0,
3298 3298   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 + "deleted": true
3299 3299  }
3300 3300  
3301 3301  Ответ:
... ... @@ -3306,15 +3306,9 @@
3306 3306   "period": 0,
3307 3307   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3308 3308   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3006 + "deleted": true
3309 3309  }
3310 3310  
3311 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3312 -|name|Название карты-метки
3313 -|number|Номер
3314 -|period|Период запросов в секундах (работает только для агрегатов)
3315 -|id|ID карты-метки
3316 -|parentId|ID клиента
3317 -
3318 3318  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3319 3319  
3320 3320  (% class="box warningmessage" %)
... ... @@ -3330,6 +3330,7 @@
3330 3330   "period": 0,
3331 3331   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3332 3332   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3024 + "deleted": true
3333 3333  }
3334 3334  
3335 3335  Ответ:
... ... @@ -3340,15 +3340,9 @@
3340 3340   "period": 0,
3341 3341   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3342 3342   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 + "deleted": true
3343 3343  }
3344 3344  
3345 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3346 -|name|Название карты-метки
3347 -|number|Номер
3348 -|period|Период запросов в секундах (работает только для агрегатов)
3349 -|id|ID карты-метки
3350 -|parentId|ID клиента
3351 -
3352 3352  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3353 3353  
3354 3354  (% class="box errormessage" %)
... ... @@ -3356,7 +3356,7 @@
3356 3356  **DELETE /api/v3/Rfids/{rfidGuid}**
3357 3357  )))
3358 3358  
3359 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3045 +Передаем параметр rfidGuid - идентификатор карты-метки
3360 3360  
3361 3361  Ответ:
3362 3362  
... ... @@ -3365,6 +3365,7 @@
3365 3365  
3366 3366  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3367 3367  
3054 +(% class="wikigeneratedid" %)
3368 3368  == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3369 3369  
3370 3370  (% class="box infomessage" %)
... ... @@ -3385,6 +3385,7 @@
3385 3385  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3386 3386  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3387 3387  
3075 +(% class="wikigeneratedid" %)
3388 3388  == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3389 3389  
3390 3390  (% class="box infomessage" %)
... ... @@ -3415,6 +3415,7 @@
3415 3415  |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3416 3416  |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3417 3417  
3106 +(% class="wikigeneratedid" %)
3418 3418  == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3419 3419  
3420 3420  (% class="box infomessage" %)
... ... @@ -3488,6 +3488,7 @@
3488 3488  |PeriodValue|Значение периода.
3489 3489  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3490 3490  
3180 +(% class="wikigeneratedid" %)
3491 3491  == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3492 3492  
3493 3493  (% class="box infomessage" %)
... ... @@ -3539,6 +3539,7 @@
3539 3539  |PeriodValue|Значение периода.
3540 3540  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3541 3541  
3232 +(% class="wikigeneratedid" %)
3542 3542  == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3543 3543  
3544 3544  (% class="box infomessage" %)
... ... @@ -3590,72 +3590,6 @@
3590 3590  |PeriodValue|Значение периода.
3591 3591  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3592 3592  
3593 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3594 -
3595 -(% class="box warningmessage" %)
3596 -(((
3597 -**PUT /api/v3/Billing/client/balance**
3598 -)))
3599 -
3600 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3601 -
3602 -Тело запроса:
3603 -
3604 -{
3605 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3606 - "Balance": 0
3607 -}
3608 -
3609 -Ответ: Success
3610 -
3611 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3612 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3613 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3614 -
3615 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3616 -
3617 -(% class="box warningmessage" %)
3618 -(((
3619 -**PUT /api/v3/billing/client/balance/deposit**
3620 -)))
3621 -
3622 -Создает операцию **Пополнение **с указанной суммой
3623 -
3624 -Тело запроса:
3625 -
3626 -{
3627 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3628 - "Balance": 0
3629 -}
3630 -
3631 -Ответ: Success
3632 -
3633 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3634 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3635 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3636 -
3637 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3638 -
3639 -Создает операцию **Списание **с указанной суммой
3640 -
3641 -(% class="box warningmessage" %)
3642 -(((
3643 -**PUT /api/v3/billing/client/balance/withdraw**
3644 -)))
3645 -
3646 -Тело запроса:
3647 -
3648 -{
3649 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3650 - "Balance": 0
3651 -}
3652 -
3653 -Ответ: Success
3654 -
3655 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3656 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3657 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3658 -
3659 3659  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3660 3660  
3661 3661  (% class="box warningmessage" %)
... ... @@ -3718,7 +3718,6 @@
3718 3718  
3719 3719  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3720 3720  |ClientId|Идентификатор клиента
3721 -|PlanId|Идентификатор тарифного плана
3722 3722  |Feature|Код услуги
3723 3723  |IsEnabled|Признак, определяющий активирована ли услуга
3724 3724  |IsFactual|Признак, определяющий расчёт по факту
... ... @@ -3728,743 +3728,7 @@
3728 3728  |PeriodValue|Значение периода.
3729 3729  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3730 3730  
3731 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3732 3732  
3733 -(% class="box warningmessage" %)
3734 -(((
3735 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3736 -)))
3737 -
3738 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3739 -
3740 -(% class="box infomessage" %)
3741 -(((
3742 -**POST /api/v3/vehicles/import/{agentId}**
3743 -)))
3744 -
3745 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3746 -
3747 -В пути указывается **agentId** - id клиента.
3748 -
3749 -**Заголовок**
3750 -
3751 -**X-Auth: [токен авторизации]**
3752 -
3753 -**Параметры**
3754 -
3755 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3756 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3757 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3758 -
3759 -В теле использовать тип **form-data,** тип значения** file**
3760 -
3761 -**Ключи**
3762 -
3763 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3764 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3765 -|csv|В значении передаем файл датчиков, формат **csv**
3766 -
3767 -Ответ:
3768 -
3769 -{
3770 - "vehicleId": 0,
3771 - "name": "string",
3772 - "errors": ["string"]
3773 -}
3774 -
3775 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3776 -|vehicleId|ID созданного объекта
3777 -|name|Имя созданного объекта
3778 -|errors|Ошибки и их описание
3779 -
3780 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3781 -
3782 -(% class="box infomessage" %)
3783 -(((
3784 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3785 -)))
3786 -
3787 -(% class="wikigeneratedid" %)
3788 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3789 -
3790 -(% class="wikigeneratedid" %)
3791 -В пути указывается **vehicleId **- id объекта.
3792 -
3793 -**Заголовок**
3794 -
3795 -**X-Auth: [токен авторизации]**
3796 -
3797 -В теле использовать тип **form-data.**
3798 -
3799 -Ключи:
3800 -
3801 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3802 -|**history**|В значении передавать файл с историей
3803 -
3804 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3805 -
3806 -Ответ:
3807 -
3808 -{
3809 - "results": [
3810 - {
3811 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3812 - "vehicleId": 0,
3813 - "errors": [
3814 - "string"
3815 - ],
3816 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3817 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3818 - "producedCount": 0,
3819 - "msgCount": 0
3820 - }
3821 - ]
3822 -}
3823 -
3824 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3825 -|results|Результаты импорта в разрезе ТС
3826 -|vehicleGuid|Guid ТС
3827 -|vehicleId|ID ТС
3828 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3829 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3830 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3831 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3832 -|msgCount|Кол-во обработанных сообщений всего
3833 -
3834 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3835 -
3836 -(% class="box infomessage" %)
3837 -(((
3838 -**GET /api/v3/vehicles/import/history/status**
3839 -)))
3840 -
3841 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3842 -
3843 -Ответ:
3844 -
3845 -{
3846 - "activity": true,
3847 - "progress": 0,
3848 - "message": "string"
3849 -}
3850 -
3851 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3852 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3853 -|progress|Guid ТС
3854 -
3855 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3856 -
3857 -(% class="box infomessage" %)
3858 -(((
3859 -**POST /api/v3/vehicles/export**
3860 -)))
3861 -
3862 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3863 -
3864 -Тело запроса:
3865 -
3866 -[
3867 - id
3868 -]
3869 -
3870 -Ответ: Success 200, получаете файлы с настройками.
3871 -
3872 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3873 -
3874 -(% class="box infomessage" %)
3875 -(((
3876 -**POST /api/v3/vehicles/export/history**
3877 -)))
3878 -
3879 -Метод возвращает список сообщений терминала объекта за выбранный период.
3880 -
3881 -Тело запроса:
3882 -
3883 -{
3884 - "vehicleId": 0,
3885 - "asArchive": true,
3886 - "from": "2023-09-27T12:17:45.973Z",
3887 - "to": "2023-09-27T12:17:45.973Z"
3888 -}
3889 -
3890 -Ответ:
3891 -
3892 -Получаете файл. Сообщение: Code 200/Success
3893 -
3894 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3895 -|vehicleId|ID объекта
3896 -|asArchive|true - Архивировать файл, False - не архивировать
3897 -|from|Дата и время начала запроса
3898 -|to|Дата и время окончания запроса
3899 -
3900 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3901 -
3902 -(% class="box infomessage" %)
3903 -(((
3904 -**GET /api/v3/vehicles/export/history/status**
3905 -)))
3906 -
3907 -Метод возвращает список сообщений терминала объекта за выбранный период.
3908 -
3909 -Ответ:
3910 -
3911 -{
3912 - "activity": true,
3913 - "progress": 0,
3914 - "message": "string"
3915 -}
3916 -
3917 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3918 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3919 -|progress|Прогресс экспорта, от 0 до 100%
3920 -|message|Текст описывающий статус
3921 -
3922 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3923 -
3924 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3925 -
3926 -(% class="box infomessage" %)
3927 -(((
3928 -**POST /api/v3/EcoDriving/rating**
3929 -)))
3930 -
3931 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3932 -
3933 -Тело запроса:
3934 -
3935 -{
3936 - "vehicleIds": [vehicleId],
3937 - "from": "2023-11-22T09:29:48.051Z",
3938 - "to": "2023-11-22T09:29:48.051Z"
3939 -}
3940 -
3941 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3942 -|vehicleIds|Массив ID объектов
3943 -|from|Дата начала запроса
3944 -|to|Дата окончания запроса
3945 -
3946 -Ответ:
3947 -
3948 -{
3949 - "items": [
3950 - {
3951 - "from": "2023-11-22T09:29:48.052Z",
3952 - "to": "2023-11-22T09:29:48.052Z",
3953 - "vehicleId": 0,
3954 - "vehicleName": "string",
3955 - "vehicleModel": "string",
3956 - "penalty": 0,
3957 - "score": 0,
3958 - "totalViolations": 0,
3959 - "violationsByType": {
3960 - "overspeedingViolations": 0,
3961 - "accelerationViolations": 0,
3962 - "brakingViolations": 0,
3963 - "turningViolations": 0,
3964 - "dangerousDrivingViolations": 0,
3965 - "sensorViolations": 0
3966 - },
3967 - "moveTime": 0,
3968 - "mileage": 0,
3969 - "tripsCount": 0,
3970 - "trips": [
3971 - {
3972 - "penalty": 0,
3973 - "score": 0,
3974 - "violationsCount": 0,
3975 - "violationsByType": {
3976 - "overspeedingViolations": 0,
3977 - "accelerationViolations": 0,
3978 - "brakingViolations": 0,
3979 - "turningViolations": 0,
3980 - "dangerousDrivingViolations": 0,
3981 - "sensorViolations": 0
3982 - },
3983 - "moveTime": 0,
3984 - "mileage": 0,
3985 - "motohours": 0,
3986 - "maxSpeed": 0,
3987 - "startAddress": "string",
3988 - "endAddress": "string",
3989 - "drivers": [
3990 - {
3991 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3992 - "driverName": "string",
3993 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3994 - }
3995 - ]
3996 - }
3997 - ]
3998 - }
3999 - ]
4000 -}
4001 -
4002 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4003 -|from|Дата начала запроса
4004 -|to|Дата  окончания
4005 -|vehicleId|ID объекта
4006 -|vehicleName|Имя объекта
4007 -|vehicleModel|Модель объекта
4008 -|penalty|Сумма штрафных баллов
4009 -|score|Оценка
4010 -|totalViolations|Суммарное количество нарушений
4011 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4012 -|overspeedingViolations|Превышение скорости
4013 -|accelerationViolations|Ускорение
4014 -|brakingViolations|Торможение
4015 -|turningViolations|Резкий поворот
4016 -|dangerousDrivingViolations|Резкое вождение
4017 -|sensorViolations|Нарушение по датчику
4018 -|moveTime|Время в движении
4019 -|mileage|Пробег (км)
4020 -|tripsCount|Количество рейсов
4021 -|motohours|Моточасы
4022 -|maxSpeed|Максимальная скорость
4023 -|startAddress|Адрес начала рейса
4024 -|endAddress|Адрес окончания рейса
4025 -|drivers|Список водителей, которые были на объекте в течениии рейса
4026 -|driverGuid|Guid водителя
4027 -|driverName|Имя водителя
4028 -|driverRfid|Номер Карты-метки
4029 -
4030 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4031 -
4032 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4033 -
4034 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4035 -
4036 -(% class="box infomessage" %)
4037 -(((
4038 -POST /api/v3/fuelcards/transactions
4039 -)))
4040 -
4041 -Метод запроса: POST
4042 -
4043 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4044 -\\В заголовках запроса: X-Auth: Токен авторизации
4045 -
4046 -Параметры в теле запроса (JSON):
4047 -
4048 -{
4049 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4050 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4051 - "ids": [ 
4052 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4053 - ],
4054 - "timezone": 0 ~/~/Таймзона
4055 -}
4056 -
4057 -
4058 -Ответ:
4059 - {
4060 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4061 - "driver": "string", ~/~/Водители, привязанные к ТК
4062 - "object": "string", ~/~/Наименование ТС
4063 - "amount": 0, ~/~/Количество топлива
4064 - "amountDut": 0, ~/~/Количество по ДУТ
4065 - "amountDiff": 0, ~/~/Разница, л
4066 - "amountDiffPerc": 0, ~/~/Разница, %
4067 - "summa": 0, ~/~/Стоимость, руб
4068 - "serviceName": "string", ~/~/Тип топлива
4069 - "price": 0, ~/~/Цена за литр, руб
4070 - "cardName": "string", ~/~/Наименование ТК
4071 - "cardNum": "string", ~/~/Номер ТК
4072 - "operator": "string", ~/~/Оператор ТК
4073 - "address": "string" ~/~/Адрес АЗС
4074 - }
4075 -
4076 -
4077 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4078 -
4079 -
4080 -== **Получение полных данных о ретрансляторе** ==
4081 -
4082 -(% class="box infomessage" %)
4083 -(((
4084 -**GET ** **/api/v3/retranslations/{id}**
4085 -)))
4086 -
4087 -Идентификатор запроса: ID
4088 -
4089 -
4090 -Пример ответа:
4091 -
4092 -{  
4093 -"description": "", ~/~/ Определяет описание
4094 -"subscriberId": "", ~/~/ Подписчик
4095 -"protocolType": 0, ~/~/ Тип протокола
4096 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4097 -"address": "string", ~/~/ Адрес события
4098 -"objects": [ ~/~/Объекты для ретрансляции
4099 -{      
4100 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4101 -"name": "", ~/~/ Наименование объекта ретрансляции
4102 -"imei": "", ~/~/ IMEI объекта  
4103 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4104 -}
4105 - ],  
4106 -"id": "", ~/~/ идентификатор пользователя   
4107 -"parentId": "", ~/~/Guid родителя
4108 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4109 -}
4110 -
4111 -
4112 -== **Удаление данных ретранслятора** ==
4113 -
4114 -(% class="box infomessage" %)
4115 -(((
4116 -**DELETE** **/api/v3/retranslations/{id}**
4117 -)))
4118 -
4119 -Параметр запроса: ID
4120 -
4121 -
4122 -== **Создание ретранслятора** ==
4123 -
4124 -(% class="box infomessage" %)
4125 -(((
4126 -**POST ** **/api/v3/retranslations/{id}**
4127 -)))
4128 -
4129 -Запрос:
4130 -
4131 -{  
4132 -"description": "", ~/~/ Описание
4133 -"subscriberId": "", ~/~/ Подписчик
4134 -"protocolType": 0, ~/~/ Тип протокола
4135 -"address": "", ~/~/ Адрес ретрансляции
4136 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4137 -"objects": [ ~/~/Объекты для ретрансляции
4138 -{      
4139 -"id": "", ~/~/ идентификатор пользователя     
4140 -"imei": "", ~/~/IMEI объекта
4141 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4142 -}
4143 - ]
4144 -}
4145 -
4146 -
4147 -Ответ:
4148 -
4149 -{  
4150 -"description": "string", ~/~/ Определяет описание
4151 -"subscriberId": "", ~/~/ идентификатор запроса
4152 -"protocolType": 0, ~/~/ Тип протокола
4153 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4154 -"address": "", ~/~/ Адрес события
4155 -"objects": [ ~/~/Объекты для ретрансляции
4156 -{      
4157 -"id": "", ~/~/ идентификатор пользователя    
4158 -"name": "string", ~/~/ Название уведомления
4159 -"imei": "string", ~/~/IMEI объекта  
4160 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4161 -}
4162 - ],  
4163 -"id": "", ~/~/ идентификатор пользователя  
4164 -"parentId": "", ~/~/ Guid идентификатор родителя
4165 -"deleted": true ~/~/ Признак удаления
4166 -}
4167 -
4168 -
4169 -== **Редактирование ретранслятора** ==
4170 -
4171 -(% class="box infomessage" %)
4172 -(((
4173 -**PUT** **/api/v3/retranslations**
4174 -)))
4175 -
4176 -Пример запроса:
4177 -
4178 -{  
4179 -"id": "", ~/~/ идентификатор пользователя   
4180 -"description": "string", ~/~/ Определяет описание
4181 -"subscriberId": "", ~/~/ идентификатор запроса
4182 -"protocolType": 0, ~/~/ Тип протокола
4183 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4184 -"address": "string", ~/~/ Адрес события
4185 -"objects": ~/~/Объекты для ретрансляции
4186 -[    
4187 -{      
4188 -"id": "",  ~/~/ идентификатор пользователя         
4189 -"imei": "", ~/~/IMEI объекта
4190 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4191 -}
4192 - ]
4193 -}
4194 -
4195 -
4196 -Пример ответа:
4197 -
4198 -{  
4199 -"description": "", ~/~/ Определяет описание
4200 -"subscriberId": "", ~/~/ идентификатор запроса
4201 -"protocolType": 0, ~/~/ Тип протокола
4202 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4203 -"address": "string", ~/~/ Адрес события
4204 -"objects": [ ~/~/Объекты для ретрансляции
4205 -{      
4206 -"id": "", ~/~/ идентификатор пользователя     
4207 -"name": "string", ~/~/ Название уведомления    
4208 -"imei": "", ~/~/IMEI объекта
4209 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4210 -}
4211 - ],
4212 -"id": "", ~/~/ идентификатор пользователя   
4213 -"parentId": "", ~/~/ Guid идентификатор родителя
4214 -"deleted": true ~/~/ Признак удаления
4215 -}
4216 -
4217 -
4218 -== **Получение списка ретранслятора клиента** ==
4219 -
4220 -(% class="box infomessage" %)
4221 -(((
4222 -**POST /api/v3/retranslations/find**
4223 -)))
4224 -
4225 -Пример запроса:
4226 -
4227 -{  
4228 -"id": "", ~/~/ идентификатор пользователя   
4229 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4230 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4231 -}
4232 -
4233 -Ответ:
4234 -
4235 -[ 
4236 -{    
4237 -"description": "", ~/~/ Определяет описание
4238 -"subscriberId": "", ~/~/ идентификатор запроса
4239 -"protocolType": 0, ~/~/ Тип протокола
4240 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4241 -"address": "string", ~/~/ Адрес события
4242 -"id": "", ~/~/ идентификатор пользователя   
4243 -"parentId": "", ~/~/ Guid идентификатор родителя
4244 -"deleted": true ~/~/ Признак удаления
4245 -}
4246 -]
4247 -
4248 -
4249 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4250 -
4251 -== **API для отчета по выгрузке комбайнов** ==
4252 -
4253 -(% class="box infomessage" %)
4254 -(((
4255 -POST **/api/v3/Reports/harvesterUnloading**
4256 -)))
4257 -
4258 -Пример запроса:
4259 -
4260 -{
4261 - "byTime": 0, ~/~/ Объединение событий по времени
4262 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4263 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4264 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4265 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4266 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4267 - 0
4268 - ],
4269 - "from": "", ~/~/ Дата и время начало запроса
4270 - "to": "", ~/~/ Дата и время окончания запроса
4271 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4272 -}
4273 -
4274 -Пример ответа:
4275 -
4276 -[ 
4277 - {
4278 - "harvesterName": "", ~/~/Комбайн, номер
4279 - "harvesterId": 0, ~/~/Комбайн, id
4280 -"harvesterModel": "", ~/~/ Модель комбайна
4281 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4282 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4283 - "events": [ ~/~/Список событий в разрезе комбайна
4284 - {
4285 - "driverId": "", ~/~/Идентификатор водителя
4286 - "driverName": "", ~/~/Водитель комбайна, ФИО
4287 - "RFID": "", ~/~/ идентификатор карты-метки
4288 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4289 - "vehicleId": 0, ~/~/идентификатор объекта
4290 - "vehicleName": "string", ~/~/ Имя объекта
4291 - "modelName": "string", ~/~/ Имя модели объекта
4292 - "nearestVehicles": [ ~/~/Объекты рядом
4293 - {
4294 - "vehicleId": 0, ~/~/идентификатор объекта
4295 - "vehicleName": "string" ~/~/ Имя объекта
4296 - }
4297 - ],
4298 - "fields": [ ~/~/Поля, где происходила выгрузка
4299 - {
4300 - "id": 0, ~/~/ идентификатор пользователя 
4301 - "name": "string" ~/~/ имя пользователя 
4302 - }
4303 - ],
4304 - "event": "string", ~/~/Событие
4305 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4306 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4307 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4308 - "cultureName": "string", ~/~/ название культуры
4309 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4310 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4311 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4312 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4313 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4314 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4315 - "issued": 0, ~/~/Выдано, бункеров
4316 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4317 - "latitude": 0, ~/~/Широта
4318 - "longitude": 0, ~/~/ Долгота
4319 - "litresAway": 0, ~/~/Отдано, л
4320 - "m3Away": 0 ~/~/Отдано, м3
4321 - }
4322 - ]
4323 - }
4324 -]
4325 -
4326 -
4327 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4328 -
4329 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4330 -
4331 -
4332 -(% class="box infomessage" %)
4333 -(((
4334 -GET api/v3/Vehicles/recyclebin/all
4335 -)))
4336 -
4337 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4338 -
4339 -Параметр запроса: {parentId} - идентификатор агента
4340 -
4341 -В заголовках запроса: X-Auth: Токен авторизации
4342 -
4343 -Ответ:
4344 -
4345 -[ 
4346 - {
4347 - "recordTime": "", ~/~/Время записи
4348 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4349 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4350 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4351 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4352 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4353 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4354 - "items": [ ~/~/ 
4355 -nullable: true ~/~/Детали
4356 - {
4357 - "name": "string", ~/~/наименование столбца
4358 - "value": "string" ~/~/содержание столбца
4359 - }
4360 - ]
4361 - },
4362 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4363 - "string"
4364 - ]
4365 - }
4366 -]
4367 -
4368 -
4369 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4370 -
4371 -(% class="box infomessage" %)
4372 -(((
4373 -POST/api/v3/Vehicles/recyclebin/erase
4374 -)))
4375 -
4376 -В заголовках запроса: X-Auth: Токен авторизации
4377 -
4378 -Пример запроса:
4379 -
4380 -[
4381 -0
4382 -]
4383 -
4384 -
4385 -Пример ответа:
4386 -
4387 -[ 
4388 -{
4389 - "recordTime": "", ~/~/Время записи
4390 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4391 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4392 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
4393 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4394 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4395 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4396 - "items": [ ~/~/Детали
4397 - {
4398 - "name": "", ~/~/Имя свойства
4399 - "value": "" ~/~/Значение свойства
4400 - }
4401 - ]
4402 - },
4403 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4404 - ""
4405 - ]
4406 - }
4407 -]
4408 -
4409 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4410 -
4411 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4412 -
4413 -(% class="box infomessage" %)
4414 -(((
4415 -POST/api/v3/Vehicles/recyclebin/restore
4416 -)))
4417 -
4418 -В заголовках запроса: X-Auth: Токен авторизации
4419 -
4420 -Параметры в теле запроса (JSON):
4421 -
4422 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4423 -
4424 -В заголовках запроса: X-Auth: Токен авторизации
4425 -
4426 -
4427 -Пример запроса:
4428 -
4429 -(((
4430 -[
4431 -)))
4432 -
4433 -(((
4434 - 0
4435 -)))
4436 -
4437 -(((
4438 -]
4439 -)))
4440 -
4441 -
4442 -Пример ответа:
4443 -
4444 -[
4445 -{
4446 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4447 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4448 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4449 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4450 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4451 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4452 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4453 - "items": [ ~/~/Детали
4454 - {
4455 - "name": "string", ~/~/Имя свойства
4456 - "value": "string" ~/~/Значение свойства
4457 - }
4458 - ]
4459 - },
4460 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4461 - "string"
4462 - ]
4463 - }
4464 -]
4465 -
4466 -
4467 -
4468 4468  (% class="box" lang="en-US" style="text-align: center;" %)
4469 4469  (((
4470 4470  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

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