Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 161.1 >
edited by Андрей Калиновский
on 2024/07/25 10:14
To version < 107.1 >
edited by Илья Крайнов
on 2023/08/30 15:15
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,25 +40,21 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
46 46  (% style="color:#000000" %){
47 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
48 - "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" %)
49 49  }
50 50  
51 51  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
52 52  
53 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
54 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
55 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
56 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
57 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
58 -
59 -(% class="wikigeneratedid" %)
60 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
61 -
62 62  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
63 63  
64 64  (% class="box infomessage" %)
... ... @@ -97,51 +97,30 @@
97 97  Запрос должен содержать данные параметра "**agentId**"
98 98  
99 99  (% style="color:#000000" %)Ответ:
96 +А
100 100  {
101 - "agentId": "",  (%%)
102 - "parentId": "",
103 - "parentName": "string",
104 - "name": "string",
105 - "fullName": "string",
106 - "agentInfoType": 0,
107 - "isForeign": true/false,
108 - "district": "string", 
109 - "region": "string",
110 - "city": "string",
111 - "inn": "string",
112 - "kpp": "string",
113 - "address": "string",
114 - "addressFact": "string",
115 - "email": "string",
116 - "director": "string",
117 - "bankName": "string",
118 - "bankBIK": "string",
119 - "bankRS": "string",
120 - "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" ~/~/ Корр. счет
121 121   }
122 122  
123 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
124 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
125 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
126 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
127 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
128 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
129 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
130 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
131 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
132 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
133 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
134 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
135 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
136 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
137 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
138 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
139 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
140 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
141 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
142 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
143 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
144 -
145 145  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
146 146  
147 147  (% class="box infomessage" %)
... ... @@ -155,7 +155,7 @@
155 155  
156 156  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
157 157  
158 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
159 159  
160 160  (% style="color:#000000" %)Метод запроса: **POST**
161 161  
... ... @@ -170,23 +170,15 @@
170 170  (% style="color:#000000" %)Ответ:
171 171  
172 172  {
173 - "agentId": "",(% style="color:#000000" %)   (%%)
174 - "parentId": "",
175 - "name": "string",
176 - "fullName": "string",
177 - "agentInfoType": 0,
178 -(% 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 - Отказ)
179 179  }
180 180  
181 -
182 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
183 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
184 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
185 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
186 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
187 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
188 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
189 -
190 190  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
191 191  
192 192  (% class="box successmessage" %)
... ... @@ -205,7 +205,7 @@
205 205  Параметры в теле запроса (JSON):
206 206  
207 207  {
208 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
209 209   "name": "string", ~/~/ имя
210 210   "fullName": "string", ~/~/ полное наименование
211 211   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -225,6 +225,7 @@
225 225   "bankKS": "string" ~/~/ корр. счёт
226 226  }
227 227  
195 +
228 228  Ответ:
229 229  
230 230  {
... ... @@ -249,28 +249,6 @@
249 249   "bankKS": "string" ~/~/ корр. счёт
250 250  }
251 251  
252 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
253 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
254 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
255 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
256 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
257 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
258 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
259 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
260 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
261 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
262 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
263 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
264 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
265 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
266 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
267 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
268 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
269 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
270 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
271 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
272 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
273 -
274 274  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
275 275  
276 276  (% class="box warningmessage" %)
... ... @@ -286,6 +286,7 @@
286 286  
287 287  В заголовках запроса: X-Auth: Токен авторизации
288 288  
235 +
289 289  Параметры в теле запроса (JSON):
290 290  
291 291  {
... ... @@ -310,6 +310,7 @@
310 310   "bankKS": "string" ~/~/ корр. счёт
311 311  }
312 312  
260 +
313 313  Ответ:
314 314  
315 315  {
... ... @@ -352,21 +352,6 @@
352 352  
353 353  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
354 354  
355 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
356 -
357 -(% class="box warningmessage" %)
358 -(((
359 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
360 -)))
361 -
362 -Метод позволяет изменить статус клиента, указанного в запросе.
363 -
364 -В пути указывается GUID клиента и статус клиента.
365 -
366 -**status **- значение 0 - заблокирован, 1 - активен.
367 -
368 -Ответ: Code 204
369 -
370 370  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
371 371  
372 372  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -418,6 +418,7 @@
418 418   ],
419 419   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
420 420  }
354 +
421 421  {
422 422   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
423 423   "lastName": "string",
... ... @@ -429,10 +429,15 @@
429 429   "password": "string",
430 430   "email": "string",
431 431  
366 +
432 432  (% style="text-align:left" %)
433 433  (% style="color:#000000; font-weight:normal" %)Ответ:
434 -{     
435 - "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 пользователя
436 436   "lastName": "" , ~/~/ Фамилия ,
437 437   "firstName": "" , ~/~/ Имя
438 438   "position": "" , ~/~/ Должность
... ... @@ -449,8 +449,9 @@
449 449   "kind": "" , ~/~/ тип аутентификации
450 450   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
451 451   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
452 -}
453 453  
392 +(% style="text-align:left" %)
393 +(% style="color:#000000; font-weight:normal" %)}
454 454  
455 455  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
456 456  
... ... @@ -471,16 +471,19 @@
471 471  
472 472  (% style="color:#000000" %)Параметры в теле запроса (JSON):
473 473  
474 -(% style="color:#000000" %){(%%)
414 +(% style="color:#000000" %){
415 +
475 475   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
476 476   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
477 477   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
478 478   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 +
479 479  (% style="color:#000000" %)}
480 480  
481 481  (% style="color:#000000" %)Ответ:
482 482  
483 483  (% style="color:#000000" %){         (%%)
426 +
484 484   "id": "" , ~/~/ идентификатор пользователя
485 485   "lastName": "" , ~/~/ фамилия
486 486   "firstName": "" , ~/~/ имя
... ... @@ -494,6 +494,7 @@
494 494   "sessionDuration":"", ~/~/ длительность сессии в минутах
495 495   "status": "1",  ~/~/ статус пользователя
496 496   "lastLogged": "", ~/~/ дата/время последней авторизации
440 +
497 497  (% style="color:#000000" %)}
498 498  
499 499  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -567,8 +567,10 @@
567 567  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
568 568  
569 569  (% lang="en-US" style="text-align:left" %)
570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
571 - "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 пользователя 
572 572   "lastName": "" , ~/~/ фамилия
573 573   "firstName": "" , ~/~/ имя
574 574   "position": "" , ~/~/ должность
... ... @@ -590,7 +590,9 @@
590 590   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
591 591   },
592 592   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
593 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 +
541 +(% lang="en-US" style="text-align:left" %)
594 594  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
595 595  
596 596  (% lang="en-US" style="text-align:left" %)
... ... @@ -597,8 +597,10 @@
597 597  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
598 598  
599 599  (% lang="en-US" style="text-align:left" %)
600 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
601 - "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": "" , ~/~/ идентификатор пользователя
602 602   "lastName": "" , ~/~/ фамилия
603 603   "firstName": "" , ~/~/ имя
604 604   "position": "" , ~/~/ должность
... ... @@ -619,8 +619,10 @@
619 619   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
620 620   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
621 621   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
622 -}
623 623  
573 +(% lang="en-US" style="text-align:left" %)
574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 +
624 624  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
625 625  
626 626  (% class="box warningmessage" %)
... ... @@ -640,10 +640,12 @@
640 640  
641 641  (% style="color:#000000" %)Параметры в теле запроса (JSON):
642 642  
643 -(% style="color:#000000" %){(%%)
595 +(% style="color:#000000" %){
596 +
644 644   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
645 645   "description": "" , ~/~/ описание
646 646   "data": "" , ~/~/ данные, связанные со сменой статуса
600 +
647 647  (% style="color:#000000" %)}
648 648  
649 649  (% style="text-align:left" %)
... ... @@ -665,7 +665,7 @@
665 665  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
666 666  
667 667   [ 
668 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
669 669   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
670 670   ]
671 671  
... ... @@ -728,249 +728,6 @@
728 728  (% style="text-align:left" %)
729 729  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
730 730  
731 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
732 -
733 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
734 -
735 -(% class="box infomessage" %)
736 -(((
737 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
738 -)))
739 -
740 -Метод возвращает полную информацию о модели объекта.
741 -
742 -(% style="color:#000000" %)Метод запроса: **GET**
743 -
744 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
745 -
746 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
747 -
748 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
749 -
750 -(% style="color:#000000" %)Ответ:
751 -
752 -(% style="color:#000000" %){
753 - "parentName": "string",
754 - "name": "string",
755 - "picture": "string",
756 - "minspeed": 0,
757 - "maxspeed": 0,
758 - "width": 0,
759 - "imbeddedtrailer": true,
760 - "hoppercapacity": 0,
761 - "hopperdischargespeed": 0,
762 - "modelType": 0,
763 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
764 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
765 - "deleted": true
766 -}
767 -
768 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
769 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
770 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
771 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
772 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
773 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
774 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
775 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
776 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
777 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
778 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
779 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
780 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
781 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
782 -
783 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
784 -
785 -(% class="box successmessage" %)
786 -(((
787 -(% lang="en-US" %)**POST /api/v3/models/find**
788 -)))
789 -
790 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
791 -
792 -(% style="color:#000000" %)Метод запроса: **POST**
793 -
794 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
795 -
796 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
797 -
798 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
799 -
800 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
801 -}
802 -
803 -(% style="color:#000000" %)Ответ:
804 -
805 -(% style="color:#000000" %)[
806 - {
807 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
808 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
809 - "parentName": "string",
810 - "name": "string",
811 - "modelType": 0
812 - }
813 -]
814 -
815 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
816 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
817 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
818 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
819 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
820 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
821 -
822 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
823 -
824 -(% class="box successmessage" %)
825 -(((
826 -(% lang="en-US" %)**POST /api/v3/models**
827 -)))
828 -
829 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
830 -
831 -(% style="color:#000000" %)Метод запроса: **POST**
832 -
833 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
834 -
835 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
836 -
837 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
838 -
839 -{
840 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
841 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
842 - "deleted": true,
843 - "extId": "string",
844 - "name": "string",
845 - "picture": "string",
846 - "minspeed": 0,
847 - "maxspeed": 0,
848 - "width": 0,
849 - "imbeddedtrailer": true,
850 - "fueloutlay": 0,
851 - "hoppercapacity": 0,
852 - "hopperdischargespeed": 0,
853 - "modelType": 0
854 -}
855 -
856 -Ответ:
857 -
858 -{
859 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
860 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
861 - "deleted": true,
862 - "extId": "string",
863 - "name": "string",
864 - "picture": "string",
865 - "minspeed": 0,
866 - "maxspeed": 0,
867 - "width": 0,
868 - "imbeddedtrailer": true,
869 - "hoppercapacity": 0,
870 - "hopperdischargespeed": 0,
871 - "modelType": 0
872 -}
873 -
874 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
875 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
876 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
877 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
878 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
879 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
880 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
881 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
882 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
883 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
884 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
885 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
886 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
887 -
888 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
889 -
890 -(% class="box warningmessage" %)
891 -(((
892 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
893 -)))
894 -
895 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
896 -
897 -(% style="color:#000000" %)Метод запроса: **PUT**
898 -
899 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
900 -
901 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
902 -
903 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
904 -
905 -{
906 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
907 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
908 - "deleted": true,
909 - "extId": "string",
910 - "name": "string",
911 - "picture": "string",
912 - "minspeed": 0,
913 - "maxspeed": 0,
914 - "width": 0,
915 - "imbeddedtrailer": true,
916 - "fueloutlay": 0,
917 - "hoppercapacity": 0,
918 - "hopperdischargespeed": 0,
919 - "modelType": 0
920 -}
921 -
922 -Ответ:
923 -
924 -{
925 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
926 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
927 - "deleted": true,
928 - "extId": "string",
929 - "name": "string",
930 - "picture": "string",
931 - "minspeed": 0,
932 - "maxspeed": 0,
933 - "width": 0,
934 - "imbeddedtrailer": true,
935 - "fueloutlay": 0,
936 - "hoppercapacity": 0,
937 - "hopperdischargespeed": 0,
938 - "modelType": 0
939 -}
940 -
941 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
942 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
943 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
944 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
945 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
946 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
947 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
948 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
949 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
950 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
951 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
952 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
953 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
954 -
955 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
956 -
957 -(% class="box errormessage" %)
958 -(((
959 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
960 -)))
961 -
962 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
963 -
964 -(% style="color:#000000" %)Метод запроса: **DELETE**
965 -
966 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
967 -
968 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
969 -
970 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
971 -
972 -Ответ: В случае успеха **Success 200**
973 -
974 974  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
975 975  
976 976  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1007,15 +1007,19 @@
1007 1007   "deviceTypeName": "", ~/~/ Название типа устройства
1008 1008   "sim1": "", ~/~/ Номер SIM1
1009 1009   "sim2": "", ~/~/ Номер SIM2
721 +
1010 1010   "parentId": "", ~/~/ ID клиента-родителя
1011 1011   "parentName": "", ~/~/ Наименование клиента-родителя
1012 1012   "modelId": "", ~/~/ ID модели объекта
1013 1013   "modelName": "", ~/~/ Имя модели объекта
726 +
1014 1014   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1015 1015   "unitName": "string", ~/~/ Наименование подразделения
1016 1016   "status": 0, ~/~/ Статус объекта
730 +
1017 1017   "createdAt": "", ~/~/ Дата создания объекта
1018 1018   },
733 +
1019 1019  "customFields": [ ~/~/ Произвольные поля
1020 1020   {
1021 1021   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -1038,7 +1038,8 @@
1038 1038   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1039 1039   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1040 1040   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1041 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 +
1042 1042   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1043 1043   "mileageCoeff": 0, ~/~/ коэффициент пробега
1044 1044   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -1068,6 +1068,7 @@
1068 1068   "retries": 0 ~/~/ Количество попыток
1069 1069   }
1070 1070   ],
787 +
1071 1071   "sensors": [ ~/~/ Датчики
1072 1072   {
1073 1073   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -1108,19 +1108,31 @@
1108 1108   },
1109 1109  
1110 1110  ~/~/ Характерные для произвольного:
828 +
1111 1111  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 +
1112 1112  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 +
1113 1113  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 +
1114 1114  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 +
1115 1115  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 +
1116 1116  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 +
1117 1117  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 +
1118 1118  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 +
1119 1119  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 +
1120 1120  ~/~/ "ValueOn": "Вкл.",
848 +
1121 1121  ~/~/ "ValueOff": "Выкл."
1122 1122   "summaryMaxValue": 0 ~/~/ Макс. значение
1123 1123   }
852 +
1124 1124   "drivers": [ ~/~/ Водители
1125 1125   {
1126 1126   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1129,6 +1129,7 @@
1129 1129   "isDefault": true ~/~/ По умолчанию
1130 1130   }
1131 1131   ],
861 +
1132 1132   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1133 1133   {
1134 1134   "id": "", ~/~/ ID  задания
... ... @@ -1145,7 +1145,8 @@
1145 1145   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1146 1146   }
1147 1147   ],
1148 -"statusHistory": [ ~/~/ История статусов
878 +
879 + "statusHistory": [ ~/~/ История статусов
1149 1149   {
1150 1150   "status": 0,
1151 1151   "date": "2023-05-22T09:57:39.562Z",
... ... @@ -1153,6 +1153,7 @@
1153 1153   "additionalInfo": "string"
1154 1154   }
1155 1155   ]
887 +
1156 1156  }
1157 1157  )))
1158 1158  
... ... @@ -1162,75 +1162,6 @@
1162 1162  (% style="text-align:left" %)
1163 1163  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1164 1164  
1165 -
1166 -== **Отправить команду на терминал** ==
1167 -
1168 -(% class="box successmessage" %)
1169 -(((
1170 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1171 -)))
1172 -
1173 -Команда для отправки на тс.
1174 -
1175 -{  
1176 -"id": "", ~/~/идентификатор произвольного поля
1177 -"command": "", ~/~/ Текст команды
1178 -"retries": "", ~/~/ Количество попыток
1179 -"idTemplate": "" ~/~/ ID шаблона команды
1180 -}
1181 -
1182 -(% class="wikigeneratedid" %)
1183 -== ==
1184 -
1185 -== **Получить ответ на отправленную на ТС команду** ==
1186 -
1187 -(% class="box infomessage" %)
1188 -(((
1189 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1190 -)))
1191 -
1192 -Идентификатор команды: cmdid
1193 -
1194 -Запрос от терминала на ответ команды
1195 -
1196 -Пример ответ от терминала:
1197 -
1198 -ID= "" ~/~/ идентификатор произвольного поля
1199 -Soft="" ~/~/ версия софта
1200 -GPS=4 ~/~/ тип трекера
1201 -Time=11:05:43 28.06.24 ~/~/ время запроса
1202 -Lat=45.056221 ~/~/ широта
1203 -Lon=39.035938 ~/~/ долгота
1204 -Speed=0.0 ~/~/ скорость
1205 -Course=181.4 ~/~/направление
1206 -
1207 -(((
1208 -== **Список отправленных объекту команд с ответами** ==
1209 -
1210 -(% class="box infomessage" %)
1211 -(((
1212 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1213 -)))
1214 -
1215 -Идентификатор ТС: vehicleId
1216 -
1217 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1218 -
1219 -Пример ответа терминала
1220 -
1221 -[ 
1222 -{    
1223 -"id": "", ~/~/ идентификатор пользователя
1224 -"commandText": "", ~/~/Текст команды.
1225 -"templateId": "", ~/~/Идентификатор шаблона
1226 -"updated": "", ~/~/ Время отправки  
1227 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1228 -"answer": "", ~/~/ Ответ терминала.
1229 -"status": "" ~/~/ Статус отправки
1230 -}
1231 -]
1232 -)))
1233 -
1234 1234  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1235 1235  
1236 1236  (% class="box successmessage" %)
... ... @@ -1248,7 +1248,8 @@
1248 1248  
1249 1249  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1250 1250  
1251 -(% style="color:#000000" %){(%%)
914 +(% style="color:#000000" %){
915 +
1252 1252   "parentId": "" , ~/~/ ID клиента
1253 1253   "name": "" , ~/~/ имя ТС
1254 1254   "imei": "" , ~/~/ IMEI
... ... @@ -1269,6 +1269,7 @@
1269 1269   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1270 1270   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1271 1271   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
936 +
1272 1272   "mileageCalcMethod": 0,
1273 1273   "mileageCoeff": 0,
1274 1274   "locationByCellId": true,
... ... @@ -1301,6 +1301,7 @@
1301 1301   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1302 1302   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1303 1303   }
969 +
1304 1304  "drivers": [ ~/~/ Водители
1305 1305   {
1306 1306   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1315,7 +1315,8 @@
1315 1315   "retries": 0
1316 1316   }
1317 1317   ],
1318 -"sensors": [ ~/~/ Датчики
984 +
985 + "sensors": [ ~/~/ Датчики
1319 1319   {
1320 1320   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1321 1321   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1353,17 +1353,29 @@
1353 1353   "additionalProp2": "string",
1354 1354   "additionalProp3": "string"
1355 1355   },
1023 +
1356 1356  ~/~/ Характерные для произвольного:
1025 +
1357 1357  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1027 +
1358 1358  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1029 +
1359 1359  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1031 +
1360 1360  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1033 +
1361 1361  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1035 +
1362 1362  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1037 +
1363 1363  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1039 +
1364 1364  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1041 +
1365 1365  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1043 +
1366 1366  ~/~/ "ValueOn": "Вкл.",
1045 +
1367 1367  ~/~/ "ValueOff": "Выкл."
1368 1368   "summaryMaxValue": 0 ~/~/ Макс. значение
1369 1369   }
... ... @@ -1382,7 +1382,8 @@
1382 1382  
1383 1383  (% style="color:#000000" %)Ответ:
1384 1384  
1385 -(% style="color:#000000" %){(%%)
1064 +(% style="color:#000000" %){
1065 +
1386 1386   "vehicleId": "", ~/~/ID ТС 
1387 1387   "parentId": "", ~/~/Guid владельца ТС
1388 1388   "name": "", ~/~/Имя объекта
... ... @@ -1420,6 +1420,8 @@
1420 1420   "kind": "", ~/~/ Вид периодичности по времени 
1421 1421   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1422 1422   }
1103 +
1104 +(% style="text-align:left" %)
1423 1423  (% style="color:#000000" %)}
1424 1424  
1425 1425  **Валидация:**
... ... @@ -1434,7 +1434,7 @@
1434 1434  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1435 1435  )))
1436 1436  
1437 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1119 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1438 1438  
1439 1439  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1440 1440  
... ... @@ -1478,7 +1478,8 @@
1478 1478  (% style="color:#000000" %)Ответ:
1479 1479  
1480 1480  (% style="color:#000000" %){
1481 - "vehicleId": "" ~/~/ идентификатор объекта
1163 +
1164 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1482 1482   "name": "" ~/~/ наименование объекта
1483 1483   "imei": "" ~/~/ IMEI объекта
1484 1484   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1537,11 +1537,13 @@
1537 1537   "data": "", ~/~/ Данные
1538 1538   "overwrite": false, ~/~/ Флаг перезаписи
1539 1539   "stage": "", ~/~/ Состояние, может быть null
1223 +
1540 1540  (% style="color:#000000" %)}
1541 1541  
1542 1542  (% style="color:#000000" %)Ответ:
1543 1543  
1544 -(% style="color:#000000" %){(%%)
1228 +(% style="color:#000000" %){
1229 +
1545 1545   "status": "", ~/~/ значение статуса
1546 1546   "date": "", ~/~/ Дата смены статуса 
1547 1547   "description": "", ~/~/ Описание
... ... @@ -1548,10 +1548,10 @@
1548 1548   "data": "", ~/~/ Данные
1549 1549   "overwrite": false, ~/~/ Флаг перезаписи
1550 1550   "stage": "", ~/~/ Состояние
1236 +
1237 +(% style="text-align:left" %)
1551 1551  (% style="color:#000000" %) }
1552 1552  
1553 -== ==
1554 -
1555 1555  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1556 1556  
1557 1557  (% class="box warningmessage" %)
... ... @@ -1639,7 +1639,8 @@
1639 1639   "retries": 0
1640 1640   }
1641 1641   ],
1642 -"sensors": [ ~/~/ Датчики
1327 +
1328 + "sensors": [ ~/~/ Датчики
1643 1643   {
1644 1644   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1645 1645   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1677,17 +1677,29 @@
1677 1677   "additionalProp2": "string",
1678 1678   "additionalProp3": "string"
1679 1679   },
1366 +
1680 1680  ~/~/ Характерные для произвольного:
1368 +
1681 1681  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1370 +
1682 1682  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1372 +
1683 1683  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1374 +
1684 1684  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1376 +
1685 1685  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1378 +
1686 1686  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1380 +
1687 1687  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1382 +
1688 1688  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1384 +
1689 1689  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1386 +
1690 1690  ~/~/ "ValueOn": "Вкл.",
1388 +
1691 1691  ~/~/ "ValueOff": "Выкл."
1692 1692   "summaryMaxValue": 0 ~/~/ Макс. значение
1693 1693   }
... ... @@ -1707,7 +1707,9 @@
1707 1707  (% style="color:#000000" %)Ответ:
1708 1708  
1709 1709  (% lang="en-US" style="text-align:left" %)
1710 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1408 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1409 +
1410 +(% lang="en-US" style="text-align:left" %)
1711 1711   "vehicleId": "", ~/~/ ID ТС
1712 1712   "parentId": "", ~/~/ ID клиента
1713 1713   "name": "", ~/~/ имя ТС
... ... @@ -1748,6 +1748,8 @@
1748 1748   "kind": "", ~/~/ Вид периодичности по времени
1749 1749   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1750 1750   }
1451 +
1452 +(% lang="en-US" style="text-align:left" %)
1751 1751  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1752 1752  
1753 1753  **Валидация:**
... ... @@ -1788,15 +1788,18 @@
1788 1788  
1789 1789  (% style="color:#000000" %)Метод запроса: **GET**
1790 1790  
1791 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1493 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1792 1792  
1793 1793  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1794 1794  
1795 1795  (% style="color:#000000" %)Ответ:
1796 1796  
1797 -(% style="color:#000000" %){(%%)
1499 +(% style="color:#000000" %){
1500 +
1798 1798   "deviceTypeId" : "", ~/~/ ID типа устройства
1799 1799   "deviceTypeName" : "" ~/~/ Название типа устройства
1503 +
1504 +(% style="text-align:left" %)
1800 1800  (% style="color:#000000" %)}
1801 1801  
1802 1802  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1818,10 +1818,13 @@
1818 1818  
1819 1819  (% style="color:#000000" %)Ответ:
1820 1820  
1821 -(% style="color:#000000" %){(%%)
1526 +(% style="color:#000000" %){
1527 +
1822 1822   "id": "", ~/~/ ID типа датчика 
1823 1823   "name": "", ~/~/ Название
1824 1824   "description": "", ~/~/ Описание
1531 +
1532 +(% style="text-align:left" %)
1825 1825  (% style="color:#000000" %)}
1826 1826  
1827 1827  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1865,56 +1865,6 @@
1865 1865   }
1866 1866  ]
1867 1867  
1868 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1869 -
1870 -(% class="box infomessage" style="text-align: left;" %)
1871 -(((
1872 -**POST /api/v3/terminalMessages/mapping**
1873 -)))
1874 -
1875 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1876 -
1877 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1878 -
1879 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1880 -
1881 -{
1882 - "protocolType": 0,
1883 - "params": ["string"]
1884 -}
1885 -
1886 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1887 -|protocolType|ID типа протокола
1888 -|params|(((
1889 -Массив наименований параметров в сообщении
1890 -)))
1891 -
1892 -Ответ:
1893 -
1894 -{
1895 - "protocolType": 0,
1896 - "mapping": {
1897 - "additionalProp1": {
1898 - "inputType": 0,
1899 - "inputNumber": 0
1900 - },
1901 - "additionalProp2": {
1902 - "inputType": 0,
1903 - "inputNumber": 0
1904 - }
1905 - }
1906 -}
1907 -
1908 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1909 -|protocolType|Тип протокола
1910 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1911 -|inputNumber|(((
1912 -Номер входа
1913 -)))
1914 -
1915 -(% class="wikigeneratedid" %)
1916 -Перечень 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/]]
1917 -
1918 1918  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1919 1919  
1920 1920  (% class="box infomessage" %)
... ... @@ -1939,11 +1939,6 @@
1939 1939   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1940 1940  }
1941 1941  
1942 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1943 -|vehicleId|ID объекта
1944 -|from|Дата и время начала периода запроса
1945 -|to|Дата и время окончания периода запроса
1946 -
1947 1947  Ответ:
1948 1948  
1949 1949  [
... ... @@ -1950,43 +1950,25 @@
1950 1950   {
1951 1951   "messages": [
1952 1952   {
1953 - "deviceTime": "2023-11-29T07:40:44.052Z",
1954 - "serverTime": "2023-11-29T07:40:44.052Z",
1955 - "speed": 0,
1956 - "altitude": 0,
1957 - "latitude": 0,
1958 - "longitude": 0,
1959 - "satellites": 0,
1960 - "course": 0,
1961 - "voltage": 0,
1962 - "parameters": {
1606 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 + "speed": 0, ~/~/ Скорость, км/ч
1609 + "altitude": 0, ~/~/ Высота, м
1610 + "latitude": 0, ~/~/ Широта [-90°;90°]
1611 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 + "satellites": 0, ~/~/ Кол-во спутников
1613 + "voltage": 0, ~/~/ Напряжение
1614 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1963 1963   "additionalProp1": "string",
1964 1964   "additionalProp2": "string",
1965 1965   "additionalProp3": "string"
1966 1966   },
1967 - "photoCount": 0,
1968 - "lbsCorrectedCoords": true,
1969 - "protocolType": 0
1619 + "photoCount": 0 ~/~/ Кол-во фото
1970 1970   }
1971 1971   ]
1972 1972   }
1973 1973  ]
1974 1974  
1975 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1976 -|deviceTime|Время сообщения терминала
1977 -|serverTime|Время когда сообщение поступило на сервер
1978 -|speed|Скорость
1979 -|altitude|Высота над уровнем моря
1980 -|latitude|Широта
1981 -|longitude|Долгота
1982 -|satellites|Кол-во спутников
1983 -|course|Курс
1984 -|voltage|Бортовое напряжение
1985 -|parameters|Список параметров и их значений
1986 -|photoCount|Количество фото
1987 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1988 -|protocolType|ID типа протокола
1989 -
1990 1990  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1991 1991  
1992 1992  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2120,96 +2120,6 @@
2120 2120   }
2121 2121  ]
2122 2122  
2123 -
2124 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2125 -
2126 -(% class="box infomessage" %)
2127 -(((
2128 -**POST /api/v3/vehicles/moveStop**
2129 -)))
2130 -
2131 -Метод запроса: **POST**
2132 -
2133 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2134 -
2135 -В заголовках запроса: X-Auth: Токен авторизации
2136 -
2137 -
2138 -Тело запроса:
2139 -
2140 -{
2141 - "vehicleIds": [ ], ~/~/ Список ID объектов
2142 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2143 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2144 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2145 -}
2146 -
2147 -Ответ:
2148 -
2149 -[ 
2150 - {
2151 - "vehicleId": 0, ~/~/ ID объекта
2152 - "vehicleName": "string", ~/~/ Имя объекта
2153 - "moves": [ ~/~/ Событие движения
2154 - {
2155 - "mileage": 0, ~/~/ Пробег, км
2156 - "eventId": 0, ~/~/ Идентификатор события
2157 - "eventName": "string", ~/~/ Название события
2158 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2159 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2160 - "duration": 0 ~/~/ Продолжительность события, секунд
2161 - }
2162 - ],
2163 - "stops": [ ~/~/ События стоянок
2164 - {
2165 - "address": "string", ~/~/ Адрес события
2166 - "eventId": 0, ~/~/ Идентификатор события
2167 - "eventName": "string", ~/~/ Название события
2168 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2169 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2170 - "duration": 0 ~/~/ Продолжительность события, секунд
2171 - }
2172 - ]
2173 - }
2174 -]
2175 -
2176 -
2177 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2178 -
2179 -(% class="box infomessage" %)
2180 -(((
2181 -**POST /api/v3/vehicles/getlastdata**
2182 -)))
2183 -
2184 -Метод запроса: **POST**
2185 -
2186 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2187 -
2188 -В заголовках запроса: X-Auth: Токен авторизации
2189 -
2190 -
2191 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2192 -
2193 -Ответ:
2194 - {
2195 - "vehicleId": 0, ~/~/Идентификатор объекта.
2196 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2197 - "vehicleNumber": "string",~/~/Номер объекта.
2198 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2199 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2200 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2201 - "speed": 0,~/~/Скорость объекта.
2202 - "course": 0,~/~/Курс движения [0;360]
2203 - "latitude": 0,~/~/Широта [-90°;90°].
2204 - "longitude": 0,~/~/Долгота [-180°;180°].
2205 - "address": "string",~/~/Адрес.
2206 - "geozones": [ ~/~/Сведения по геозонам.
2207 - {
2208 - "id": 0,
2209 - "name": "string"
2210 - }
2211 -
2212 -
2213 2213  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2214 2214  
2215 2215  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3108,83 +3108,6 @@
3108 3108  Success
3109 3109  
3110 3110  
3111 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3112 -
3113 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3114 -
3115 -(% class="box infomessage" %)
3116 -(((
3117 -**POST /api/v3/Trailers**
3118 -)))
3119 -
3120 -Пример запроса:
3121 -
3122 -{
3123 - "startDate": "2023-11-14T10:48:03.671Z",
3124 - "endDate": "2023-11-14T10:48:03.671Z",
3125 - "ids": [ 0 ],
3126 - "timezone": 0
3127 -}
3128 -
3129 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3130 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3131 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3132 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3133 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3134 -
3135 -Пример ответа:
3136 -
3137 -[
3138 - {
3139 - "SD": "2023-11-14T10:48:03.717Z",
3140 - "ED": "2023-11-14T10:48:03.717Z", 
3141 - "id": 0,
3142 - "SLat": 0,
3143 - "SLon": 0,
3144 - "ELat": 0,
3145 - "ELon": 0,
3146 - "mileage": 0
3147 - "Duration": 0
3148 - "Address": "string",
3149 - "Address2": "string",
3150 - "name": "string",
3151 - "rid": "string",
3152 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3153 - "trailer": {
3154 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3155 - "Number": "string",
3156 - "Description": "string",
3157 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3158 - "ExternalID": "string",
3159 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3160 - "CreateTime": "2023-11-14T10:48:03.717Z",
3161 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3162 - "IsDeleted": true
3163 - },
3164 - "filesCount": 0,
3165 - }
3166 -]
3167 -
3168 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3169 -|SD|Дата и время начала события
3170 -|ED|Дата и время окончания события
3171 -|id|ID объекта
3172 -|SLat|Широта начальной координаты
3173 -|SLon|Долгота начальной координаты
3174 -|ELat|Широта конечной координаты
3175 -|ELon|Долгота конечной координаты
3176 -|mileage|Пробег
3177 -|Duration|Продолжительность
3178 -|Address|Адрес начального местоположения
3179 -|Address2|Адрес конечного местоположения
3180 -|name|Имя радиометки
3181 -|rid|Номер радиометки
3182 -|rguid|ID радиометки
3183 -|trailer|Информация об агрегате
3184 -|ModelGuid|ID агрегата
3185 -|Number|Название/номер агрегата
3186 -|Description|Текст примечания агрегата
3187 -
3188 3188  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3189 3189  
3190 3190  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3206,18 +3206,13 @@
3206 3206   {
3207 3207   "name": "string",
3208 3208   "number": 0,
3209 - "period": 0,
2677 + "period": 0, ~/~/ Частота трансляции радиометки
3210 3210   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 3211   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 + "deleted": true
3212 3212   }
3213 3213  ]
3214 3214  
3215 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3216 -|parentId|ID клиента
3217 -|name|Название карты-метки
3218 -|number|Номер
3219 -|period|Период запросов в секундах (работает только для агрегатов)
3220 -|id|ID карты-метки
3221 3221  
3222 3222  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3223 3223  
... ... @@ -3234,18 +3234,13 @@
3234 3234   {
3235 3235   "name": "string",
3236 3236   "number": 0,
3237 - "period": 0,
2700 + "period": 0, ~/~/ Частота трансляции радиометки
3238 3238   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3239 3239   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2703 + "deleted": true
3240 3240   }
3241 3241  ]
3242 3242  
3243 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3244 -|name|Название карты-метки
3245 -|number|Номер
3246 -|period|Период запросов в секундах (работает только для агрегатов)
3247 -|id|ID карты-метки
3248 -|parentId|ID клиента
3249 3249  
3250 3250  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3251 3251  
... ... @@ -3261,6 +3261,7 @@
3261 3261   "number": 0,
3262 3262   "period": 0,
3263 3263   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 + "deleted": true
3264 3264  }
3265 3265  
3266 3266  Ответ:
... ... @@ -3271,14 +3271,9 @@
3271 3271   "period": 0,
3272 3272   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3273 3273   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2733 + "deleted": true
3274 3274  }
3275 3275  
3276 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3277 -|name|Название карты-метки
3278 -|number|Номер
3279 -|period|Период запросов в секундах (работает только для агрегатов)
3280 -|id|ID карты-метки
3281 -|parentId|ID клиента
3282 3282  
3283 3283  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3284 3284  
... ... @@ -3295,6 +3295,7 @@
3295 3295   "period": 0,
3296 3296   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3297 3297   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 + "deleted": true
3298 3298  }
3299 3299  
3300 3300  Ответ:
... ... @@ -3305,14 +3305,9 @@
3305 3305   "period": 0,
3306 3306   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3307 3307   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2763 + "deleted": true
3308 3308  }
3309 3309  
3310 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3311 -|name|Название карты-метки
3312 -|number|Номер
3313 -|period|Период запросов в секундах (работает только для агрегатов)
3314 -|id|ID карты-метки
3315 -|parentId|ID клиента
3316 3316  
3317 3317  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3318 3318  
... ... @@ -3321,7 +3321,7 @@
3321 3321  **DELETE /api/v3/Rfids/{rfidGuid}**
3322 3322  )))
3323 3323  
3324 -Передаем параметр **rfidGuid** - идентификатор карты-метки
2774 +Передаем параметр rfidGuid - идентификатор карты-метки
3325 3325  
3326 3326  Ответ:
3327 3327  
... ... @@ -3328,1108 +3328,6 @@
3328 3328  Success
3329 3329  
3330 3330  
3331 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3332 -
3333 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3334 -
3335 -(% class="box infomessage" %)
3336 -(((
3337 -**GET /api/v3/Billing/client/balance/{clientId}**
3338 -)))
3339 -
3340 -Параметр запроса: **clientId **- идентификатор клиента.
3341 -
3342 -Ответ:
3343 -
3344 -{
3345 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3346 - "Balance": 0
3347 -}
3348 -
3349 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3350 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3351 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3352 -
3353 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3354 -
3355 -(% class="box infomessage" %)
3356 -(((
3357 -**GET /api/v3/Billing/client/constraint/{clientId}**
3358 -)))
3359 -
3360 -Параметр запроса: **clientId **- идентификатор клиента.
3361 -
3362 -Ответ:
3363 -
3364 -{
3365 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3366 - "CalculationType": 0,
3367 - "PermissibleBalance": 0,
3368 - "DefermentDays": 0,
3369 - "SendUiNotifications": true,
3370 - "SendEmailNotifications": true,
3371 - "IsPrivate": true,
3372 -}
3373 -
3374 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3375 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3376 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3377 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3378 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3379 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3380 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3381 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3382 -
3383 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3384 -
3385 -(% class="box infomessage" %)
3386 -(((
3387 -**GET /api/v3/Billing/client/plan/{clientId}**
3388 -)))
3389 -
3390 -Параметры запроса:
3391 -
3392 -**clientId **- идентификатор клиента.
3393 -
3394 -**planId **- идентификатор тарифного плана.
3395 -
3396 -Ответ:
3397 -
3398 -{
3399 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3400 - "Plan": { **~/~/ Описание тарифного плана**
3401 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3402 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3403 - "Name": "string",
3404 - "IsArchived": true,
3405 - "Constraint": {
3406 - "CalculationType": 0,
3407 - "PermissibleBalance": 0,
3408 - "DefermentDays": 0
3409 - },
3410 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3411 - {
3412 - "Feature": "string",
3413 - "IsFactual": true,
3414 - "Limit": 0,
3415 - "Price": 0,
3416 - "PeriodValue": 0,
3417 - "PeriodType": 0
3418 - }
3419 - ]
3420 - },
3421 - "DebitDate": "2023-10-18T12:46:24.213Z",
3422 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3423 - {
3424 - "Feature": "string",
3425 - "IsEnabled": true,
3426 - "IsPrivate": true,
3427 - "IsFactual": true,
3428 - "Limit": 0,
3429 - "Price": 0,
3430 - "DebitDate": "2023-10-18T12:46:24.213Z",
3431 - "PeriodValue": 0,
3432 - "PeriodType": 0
3433 - }
3434 - ]
3435 -}
3436 -
3437 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3438 -|ClientId|Идентификатор клиента
3439 -|Id|Идентификатор тарифного плана
3440 -|OwnerId|Идентификатор клиента-владельца
3441 -|Name|Наименование тарифного плана
3442 -|IsArchived|Признак, определяющий архивный тарифный план
3443 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3444 -|PermissibleBalance|Допустимый баланс
3445 -|DefermentDays|Отсрочка, количество дней
3446 -|Feature|Код услуги
3447 -|IsEnabled|Признак, определяющий активирована ли услуга
3448 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3449 -|IsFactual|Признак, определяющий расчёт по факту
3450 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3451 -|Price|Цена за единицу.
3452 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3453 -|PeriodValue|Значение периода.
3454 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3455 -
3456 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3457 -
3458 -(% class="box infomessage" %)
3459 -(((
3460 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3461 -)))
3462 -
3463 -Параметр запроса: **clientId **- идентификатор клиента.
3464 -
3465 -Ответ:
3466 -
3467 -[
3468 - {
3469 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3470 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3471 - "Name": "string",
3472 - "IsArchived": true,
3473 - "Constraint": {
3474 - "CalculationType": 0,
3475 - "PermissibleBalance": 0,
3476 - "DefermentDays": 0
3477 - },
3478 - "Features": [
3479 - {
3480 - "Feature": "string",
3481 - "IsFactual": true,
3482 - "Limit": 0,
3483 - "Price": 0,
3484 - "PeriodValue": 0,
3485 - "PeriodType": 0
3486 - }
3487 - ]
3488 - }
3489 -]
3490 -
3491 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3492 -|ClientId|Идентификатор клиента
3493 -|Id|Идентификатор тарифного плана
3494 -|OwnerId|Идентификатор клиента-владельца
3495 -|Name|Наименование тарифного плана
3496 -|IsArchived|Признак, определяющий архивный тарифный план
3497 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3498 -|PermissibleBalance|Допустимый баланс
3499 -|DefermentDays|Отсрочка, количество дней
3500 -|Feature|Код услуги
3501 -|IsFactual|Признак, определяющий расчёт по факту
3502 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3503 -|Price|Цена за единицу.
3504 -|PeriodValue|Значение периода.
3505 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3506 -
3507 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3508 -
3509 -(% class="box infomessage" %)
3510 -(((
3511 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3512 -)))
3513 -
3514 -Параметр запроса: **clientId **- идентификатор клиента.
3515 -
3516 -Ответ:
3517 -
3518 -[
3519 - {
3520 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3521 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3522 - "Name": "string",
3523 - "IsArchived": true,
3524 - "Constraint": {
3525 - "CalculationType": 0,
3526 - "PermissibleBalance": 0,
3527 - "DefermentDays": 0
3528 - },
3529 - "Features": [
3530 - {
3531 - "Feature": "string",
3532 - "IsFactual": true,
3533 - "Limit": 0,
3534 - "Price": 0,
3535 - "PeriodValue": 0,
3536 - "PeriodType": 0
3537 - }
3538 - ]
3539 - }
3540 -]
3541 -
3542 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3543 -|ClientId|Идентификатор клиента
3544 -|Id|Идентификатор тарифного плана
3545 -|OwnerId|Идентификатор клиента-владельца
3546 -|Name|Наименование тарифного плана
3547 -|IsArchived|Признак, определяющий архивный тарифный план
3548 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3549 -|PermissibleBalance|Допустимый баланс
3550 -|DefermentDays|Отсрочка, количество дней
3551 -|Feature|Код услуги
3552 -|IsFactual|Признак, определяющий расчёт по факту
3553 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3554 -|Price|Цена за единицу.
3555 -|PeriodValue|Значение периода.
3556 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3557 -
3558 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3559 -
3560 -(% class="box warningmessage" %)
3561 -(((
3562 -**PUT /api/v3/Billing/client/balance**
3563 -)))
3564 -
3565 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3566 -
3567 -Тело запроса:
3568 -
3569 -{
3570 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3571 - "Balance": 0
3572 -}
3573 -
3574 -Ответ: Success
3575 -
3576 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3577 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3578 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3579 -
3580 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3581 -
3582 -(% class="box warningmessage" %)
3583 -(((
3584 -**PUT /api/v3/billing/client/balance/deposit**
3585 -)))
3586 -
3587 -Создает операцию **Пополнение **с указанной суммой
3588 -
3589 -Тело запроса:
3590 -
3591 -{
3592 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3593 - "Balance": 0
3594 -}
3595 -
3596 -Ответ: Success
3597 -
3598 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3599 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3600 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3601 -
3602 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3603 -
3604 -Создает операцию **Списание **с указанной суммой
3605 -
3606 -(% class="box warningmessage" %)
3607 -(((
3608 -**PUT /api/v3/billing/client/balance/withdraw**
3609 -)))
3610 -
3611 -Тело запроса:
3612 -
3613 -{
3614 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3615 - "Balance": 0
3616 -}
3617 -
3618 -Ответ: Success
3619 -
3620 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3621 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3622 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3623 -
3624 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3625 -
3626 -(% class="box warningmessage" %)
3627 -(((
3628 -**PUT /api/v3/Billing/client/constraint**
3629 -)))
3630 -
3631 -Тело запроса:
3632 -
3633 -{
3634 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3635 - "CalculationType": 0,
3636 - "PermissibleBalance": 0,
3637 - "DefermentDays": 0,
3638 - "SendUiNotifications": true,
3639 - "SendEmailNotifications": true,
3640 - "IsPrivate": true,
3641 -}
3642 -
3643 -Ответ: Success
3644 -
3645 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3646 -|ClientId|Идентификатор клиента
3647 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3648 -|PermissibleBalance|Допустимый баланс
3649 -|DefermentDays|(((
3650 -Отсрочка, количество дней
3651 -)))
3652 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3653 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3654 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3655 -
3656 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3657 -
3658 -(% class="box warningmessage" %)
3659 -(((
3660 -**PUT /api/v3/Billing/client/plan**
3661 -)))
3662 -
3663 -Тело запроса:
3664 -
3665 -{
3666 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3667 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3668 - "Features": [
3669 - {
3670 - "Feature": "string",
3671 - "IsEnabled": true,
3672 - "IsFactual": true,
3673 - "Limit": 0,
3674 - "Price": 0,
3675 - "DebitDate": "2023-10-18T13:26:58.987Z",
3676 - "PeriodValue": 0,
3677 - "PeriodType": 0
3678 - }
3679 - ]
3680 -}
3681 -
3682 -Ответ: Success
3683 -
3684 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3685 -|ClientId|Идентификатор клиента
3686 -|PlanId|Идентификатор тарифного плана
3687 -|Feature|Код услуги
3688 -|IsEnabled|Признак, определяющий активирована ли услуга
3689 -|IsFactual|Признак, определяющий расчёт по факту
3690 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3691 -|Price|Цена за единицу.
3692 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3693 -|PeriodValue|Значение периода.
3694 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3695 -
3696 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3697 -
3698 -(% class="box warningmessage" %)
3699 -(((
3700 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3701 -)))
3702 -
3703 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3704 -
3705 -(% class="box infomessage" %)
3706 -(((
3707 -**POST /api/v3/vehicles/import/{agentId}**
3708 -)))
3709 -
3710 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3711 -
3712 -В пути указывается **agentId** - id клиента.
3713 -
3714 -**Заголовок**
3715 -
3716 -**X-Auth: [токен авторизации]**
3717 -
3718 -**Параметры**
3719 -
3720 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3721 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3722 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3723 -
3724 -В теле использовать тип **form-data,** тип значения** file**
3725 -
3726 -**Ключи**
3727 -
3728 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3729 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3730 -|csv|В значении передаем файл датчиков, формат **csv**
3731 -
3732 -Ответ:
3733 -
3734 -{
3735 - "vehicleId": 0,
3736 - "name": "string",
3737 - "errors": ["string"]
3738 -}
3739 -
3740 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3741 -|vehicleId|ID созданного объекта
3742 -|name|Имя созданного объекта
3743 -|errors|Ошибки и их описание
3744 -
3745 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3746 -
3747 -(% class="box infomessage" %)
3748 -(((
3749 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3750 -)))
3751 -
3752 -(% class="wikigeneratedid" %)
3753 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3754 -
3755 -(% class="wikigeneratedid" %)
3756 -В пути указывается **vehicleId **- id объекта.
3757 -
3758 -**Заголовок**
3759 -
3760 -**X-Auth: [токен авторизации]**
3761 -
3762 -В теле использовать тип **form-data.**
3763 -
3764 -Ключи:
3765 -
3766 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3767 -|**history**|В значении передавать файл с историей
3768 -
3769 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3770 -
3771 -Ответ:
3772 -
3773 -{
3774 - "results": [
3775 - {
3776 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3777 - "vehicleId": 0,
3778 - "errors": [
3779 - "string"
3780 - ],
3781 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3782 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3783 - "producedCount": 0,
3784 - "msgCount": 0
3785 - }
3786 - ]
3787 -}
3788 -
3789 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3790 -|results|Результаты импорта в разрезе ТС
3791 -|vehicleGuid|Guid ТС
3792 -|vehicleId|ID ТС
3793 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3794 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3795 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3796 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3797 -|msgCount|Кол-во обработанных сообщений всего
3798 -
3799 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3800 -
3801 -(% class="box infomessage" %)
3802 -(((
3803 -**GET /api/v3/vehicles/import/history/status**
3804 -)))
3805 -
3806 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3807 -
3808 -Ответ:
3809 -
3810 -{
3811 - "activity": true,
3812 - "progress": 0,
3813 - "message": "string"
3814 -}
3815 -
3816 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3817 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3818 -|progress|Guid ТС
3819 -
3820 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3821 -
3822 -(% class="box infomessage" %)
3823 -(((
3824 -**POST /api/v3/vehicles/export**
3825 -)))
3826 -
3827 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3828 -
3829 -Тело запроса:
3830 -
3831 -[
3832 - id
3833 -]
3834 -
3835 -Ответ: Success 200, получаете файлы с настройками.
3836 -
3837 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3838 -
3839 -(% class="box infomessage" %)
3840 -(((
3841 -**POST /api/v3/vehicles/export/history**
3842 -)))
3843 -
3844 -Метод возвращает список сообщений терминала объекта за выбранный период.
3845 -
3846 -Тело запроса:
3847 -
3848 -{
3849 - "vehicleId": 0,
3850 - "asArchive": true,
3851 - "from": "2023-09-27T12:17:45.973Z",
3852 - "to": "2023-09-27T12:17:45.973Z"
3853 -}
3854 -
3855 -Ответ:
3856 -
3857 -Получаете файл. Сообщение: Code 200/Success
3858 -
3859 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3860 -|vehicleId|ID объекта
3861 -|asArchive|true - Архивировать файл, False - не архивировать
3862 -|from|Дата и время начала запроса
3863 -|to|Дата и время окончания запроса
3864 -
3865 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3866 -
3867 -(% class="box infomessage" %)
3868 -(((
3869 -**GET /api/v3/vehicles/export/history/status**
3870 -)))
3871 -
3872 -Метод возвращает список сообщений терминала объекта за выбранный период.
3873 -
3874 -Ответ:
3875 -
3876 -{
3877 - "activity": true,
3878 - "progress": 0,
3879 - "message": "string"
3880 -}
3881 -
3882 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3883 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3884 -|progress|Прогресс экспорта, от 0 до 100%
3885 -|message|Текст описывающий статус
3886 -
3887 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3888 -
3889 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3890 -
3891 -(% class="box infomessage" %)
3892 -(((
3893 -**POST /api/v3/EcoDriving/rating**
3894 -)))
3895 -
3896 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3897 -
3898 -Тело запроса:
3899 -
3900 -{
3901 - "vehicleIds": [vehicleId],
3902 - "from": "2023-11-22T09:29:48.051Z",
3903 - "to": "2023-11-22T09:29:48.051Z"
3904 -}
3905 -
3906 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3907 -|vehicleIds|Массив ID объектов
3908 -|from|Дата начала запроса
3909 -|to|Дата окончания запроса
3910 -
3911 -Ответ:
3912 -
3913 -{
3914 - "items": [
3915 - {
3916 - "from": "2023-11-22T09:29:48.052Z",
3917 - "to": "2023-11-22T09:29:48.052Z",
3918 - "vehicleId": 0,
3919 - "vehicleName": "string",
3920 - "vehicleModel": "string",
3921 - "penalty": 0,
3922 - "score": 0,
3923 - "totalViolations": 0,
3924 - "violationsByType": {
3925 - "overspeedingViolations": 0,
3926 - "accelerationViolations": 0,
3927 - "brakingViolations": 0,
3928 - "turningViolations": 0,
3929 - "dangerousDrivingViolations": 0,
3930 - "sensorViolations": 0
3931 - },
3932 - "moveTime": 0,
3933 - "mileage": 0,
3934 - "tripsCount": 0,
3935 - "trips": [
3936 - {
3937 - "penalty": 0,
3938 - "score": 0,
3939 - "violationsCount": 0,
3940 - "violationsByType": {
3941 - "overspeedingViolations": 0,
3942 - "accelerationViolations": 0,
3943 - "brakingViolations": 0,
3944 - "turningViolations": 0,
3945 - "dangerousDrivingViolations": 0,
3946 - "sensorViolations": 0
3947 - },
3948 - "moveTime": 0,
3949 - "mileage": 0,
3950 - "motohours": 0,
3951 - "maxSpeed": 0,
3952 - "startAddress": "string",
3953 - "endAddress": "string",
3954 - "drivers": [
3955 - {
3956 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3957 - "driverName": "string",
3958 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3959 - }
3960 - ]
3961 - }
3962 - ]
3963 - }
3964 - ]
3965 -}
3966 -
3967 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3968 -|from|Дата начала запроса
3969 -|to|Дата  окончания
3970 -|vehicleId|ID объекта
3971 -|vehicleName|Имя объекта
3972 -|vehicleModel|Модель объекта
3973 -|penalty|Сумма штрафных баллов
3974 -|score|Оценка
3975 -|totalViolations|Суммарное количество нарушений
3976 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3977 -|overspeedingViolations|Превышение скорости
3978 -|accelerationViolations|Ускорение
3979 -|brakingViolations|Торможение
3980 -|turningViolations|Резкий поворот
3981 -|dangerousDrivingViolations|Резкое вождение
3982 -|sensorViolations|Нарушение по датчику
3983 -|moveTime|Время в движении
3984 -|mileage|Пробег
3985 -|tripsCount|Количество рейсов
3986 -|motohours|Моточасы
3987 -|maxSpeed|Максимальная скорость
3988 -|startAddress|Адрес начала рейса
3989 -|endAddress|Адрес окончания рейса
3990 -|drivers|Список водителей, которые были на объекте в течениии рейса
3991 -|driverGuid|Guid водителя
3992 -|driverName|Имя водителя
3993 -|driverRfid|Номер Карты-метки
3994 -
3995 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3996 -
3997 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
3998 -
3999 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4000 -
4001 -(% class="box infomessage" %)
4002 -(((
4003 -POST /api/v3/fuelcards/transactions
4004 -)))
4005 -
4006 -Метод запроса: POST
4007 -
4008 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4009 -\\В заголовках запроса: X-Auth: Токен авторизации
4010 -
4011 -Параметры в теле запроса (JSON):
4012 -
4013 -{
4014 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4015 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4016 - "ids": [ 
4017 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4018 - ],
4019 - "timezone": 0 ~/~/Таймзона
4020 -}
4021 -
4022 -
4023 -Ответ:
4024 - {
4025 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4026 - "driver": "string", ~/~/Водители, привязанные к ТК
4027 - "object": "string", ~/~/Наименование ТС
4028 - "amount": 0, ~/~/Количество топлива
4029 - "amountDut": 0, ~/~/Количество по ДУТ
4030 - "amountDiff": 0, ~/~/Разница, л
4031 - "amountDiffPerc": 0, ~/~/Разница, %
4032 - "summa": 0, ~/~/Стоимость, руб
4033 - "serviceName": "string", ~/~/Тип топлива
4034 - "price": 0, ~/~/Цена за литр, руб
4035 - "cardName": "string", ~/~/Наименование ТК
4036 - "cardNum": "string", ~/~/Номер ТК
4037 - "operator": "string", ~/~/Оператор ТК
4038 - "address": "string" ~/~/Адрес АЗС
4039 - }
4040 -
4041 -
4042 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4043 -
4044 -
4045 -== **Получение полных данных о ретрансляторе** ==
4046 -
4047 -(% class="box infomessage" %)
4048 -(((
4049 -**GET ** **/api/v3/retranslations/{id}**
4050 -)))
4051 -
4052 -Идентификатор запроса: ID
4053 -
4054 -
4055 -Пример ответа:
4056 -
4057 -{  
4058 -"description": "", ~/~/ Определяет описание
4059 -"subscriberId": "", ~/~/ Подписчик
4060 -"protocolType": 0, ~/~/ Тип протокола
4061 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4062 -"address": "string", ~/~/ Адрес события
4063 -"objects": [ ~/~/Объекты для ретрансляции
4064 -{      
4065 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4066 -"name": "", ~/~/ Наименование объекта ретрансляции
4067 -"imei": "", ~/~/ IMEI объекта  
4068 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4069 -}
4070 - ],  
4071 -"id": "", ~/~/ идентификатор пользователя   
4072 -"parentId": "", ~/~/Guid родителя
4073 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4074 -}
4075 -
4076 -
4077 -== **Удаление данных ретранслятора** ==
4078 -
4079 -(% class="box infomessage" %)
4080 -(((
4081 -**DELETE** **/api/v3/retranslations/{id}**
4082 -)))
4083 -
4084 -Параметр запроса: ID
4085 -
4086 -
4087 -== **Создание ретранслятора** ==
4088 -
4089 -(% class="box infomessage" %)
4090 -(((
4091 -**POST ** **/api/v3/retranslations/{id}**
4092 -)))
4093 -
4094 -Запрос:
4095 -
4096 -{  
4097 -"description": "", ~/~/ Описание
4098 -"subscriberId": "", ~/~/ Подписчик
4099 -"protocolType": 0, ~/~/ Тип протокола
4100 -"address": "", ~/~/ Адрес ретрансляции
4101 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4102 -"objects": [ ~/~/Объекты для ретрансляции
4103 -{      
4104 -"id": "", ~/~/ идентификатор пользователя     
4105 -"imei": "", ~/~/IMEI объекта
4106 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4107 -}
4108 - ]
4109 -}
4110 -
4111 -
4112 -Ответ:
4113 -
4114 -{  
4115 -"description": "string", ~/~/ Определяет описание
4116 -"subscriberId": "", ~/~/ идентификатор запроса
4117 -"protocolType": 0, ~/~/ Тип протокола
4118 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4119 -"address": "", ~/~/ Адрес события
4120 -"objects": [ ~/~/Объекты для ретрансляции
4121 -{      
4122 -"id": "", ~/~/ идентификатор пользователя    
4123 -"name": "string", ~/~/ Название уведомления
4124 -"imei": "string", ~/~/IMEI объекта  
4125 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4126 -}
4127 - ],  
4128 -"id": "", ~/~/ идентификатор пользователя  
4129 -"parentId": "", ~/~/ Guid идентификатор родителя
4130 -"deleted": true ~/~/ Признак удаления
4131 -}
4132 -
4133 -
4134 -== **Редактирование ретранслятора** ==
4135 -
4136 -(% class="box infomessage" %)
4137 -(((
4138 -**PUT** **/api/v3/retranslations**
4139 -)))
4140 -
4141 -Пример запроса:
4142 -
4143 -{  
4144 -"id": "", ~/~/ идентификатор пользователя   
4145 -"description": "string", ~/~/ Определяет описание
4146 -"subscriberId": "", ~/~/ идентификатор запроса
4147 -"protocolType": 0, ~/~/ Тип протокола
4148 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4149 -"address": "string", ~/~/ Адрес события
4150 -"objects": ~/~/Объекты для ретрансляции
4151 -[    
4152 -{      
4153 -"id": "",  ~/~/ идентификатор пользователя         
4154 -"imei": "", ~/~/IMEI объекта
4155 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4156 -}
4157 - ]
4158 -}
4159 -
4160 -
4161 -Пример ответа:
4162 -
4163 -{  
4164 -"description": "", ~/~/ Определяет описание
4165 -"subscriberId": "", ~/~/ идентификатор запроса
4166 -"protocolType": 0, ~/~/ Тип протокола
4167 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4168 -"address": "string", ~/~/ Адрес события
4169 -"objects": [ ~/~/Объекты для ретрансляции
4170 -{      
4171 -"id": "", ~/~/ идентификатор пользователя     
4172 -"name": "string", ~/~/ Название уведомления    
4173 -"imei": "", ~/~/IMEI объекта
4174 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4175 -}
4176 - ],
4177 -"id": "", ~/~/ идентификатор пользователя   
4178 -"parentId": "", ~/~/ Guid идентификатор родителя
4179 -"deleted": true ~/~/ Признак удаления
4180 -}
4181 -
4182 -
4183 -== **Получение списка ретранслятора клиента** ==
4184 -
4185 -(% class="box infomessage" %)
4186 -(((
4187 -**POST /api/v3/retranslations/find**
4188 -)))
4189 -
4190 -Пример запроса:
4191 -
4192 -{  
4193 -"id": "", ~/~/ идентификатор пользователя   
4194 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4195 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4196 -}
4197 -
4198 -Ответ:
4199 -
4200 -[ 
4201 -{    
4202 -"description": "", ~/~/ Определяет описание
4203 -"subscriberId": "", ~/~/ идентификатор запроса
4204 -"protocolType": 0, ~/~/ Тип протокола
4205 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4206 -"address": "string", ~/~/ Адрес события
4207 -"id": "", ~/~/ идентификатор пользователя   
4208 -"parentId": "", ~/~/ Guid идентификатор родителя
4209 -"deleted": true ~/~/ Признак удаления
4210 -}
4211 -]
4212 -
4213 -
4214 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4215 -
4216 -== **API для отчета по выгрузке комбайнов** ==
4217 -
4218 -(% class="box infomessage" %)
4219 -(((
4220 -POST **/api/v3/Reports/harvesterUnloading**
4221 -)))
4222 -
4223 -Пример запроса:
4224 -
4225 -{
4226 - "byTime": 0, ~/~/ Объединение событий по времени
4227 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4228 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4229 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4230 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4231 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4232 - 0
4233 - ],
4234 - "from": "", ~/~/ Дата и время начало запроса
4235 - "to": "", ~/~/ Дата и время окончания запроса
4236 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4237 -}
4238 -
4239 -Пример ответа:
4240 -
4241 -[ 
4242 - {
4243 - "harvesterName": "", ~/~/Комбайн, номер
4244 - "harvesterId": 0, ~/~/Комбайн, id
4245 -"harvesterModel": "", ~/~/ Модель комбайна
4246 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4247 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4248 - "events": [ ~/~/Список событий в разрезе комбайна
4249 - {
4250 - "driverId": "", ~/~/Идентификатор водителя
4251 - "driverName": "", ~/~/Водитель комбайна, ФИО
4252 - "RFID": "", ~/~/ идентификатор карты-метки
4253 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4254 - "vehicleId": 0, ~/~/идентификатор объекта
4255 - "vehicleName": "string", ~/~/ Имя объекта
4256 - "modelName": "string", ~/~/ Имя модели объекта
4257 - "nearestVehicles": [ ~/~/Объекты рядом
4258 - {
4259 - "vehicleId": 0, ~/~/идентификатор объекта
4260 - "vehicleName": "string" ~/~/ Имя объекта
4261 - }
4262 - ],
4263 - "fields": [ ~/~/Поля, где происходила выгрузка
4264 - {
4265 - "id": 0, ~/~/ идентификатор пользователя 
4266 - "name": "string" ~/~/ имя пользователя 
4267 - }
4268 - ],
4269 - "event": "string", ~/~/Событие
4270 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4271 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4272 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4273 - "cultureName": "string", ~/~/ название культуры
4274 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4275 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4276 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4277 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4278 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4279 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4280 - "issued": 0, ~/~/Выдано, бункеров
4281 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4282 - "latitude": 0, ~/~/Широта
4283 - "longitude": 0, ~/~/ Долгота
4284 - "litresAway": 0, ~/~/Отдано, л
4285 - "m3Away": 0 ~/~/Отдано, м3
4286 - }
4287 - ]
4288 - }
4289 -]
4290 -
4291 -
4292 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4293 -
4294 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4295 -
4296 -
4297 -(% class="box infomessage" %)
4298 -(((
4299 -GET api/v3/Vehicles/recyclebin/all
4300 -)))
4301 -
4302 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4303 -
4304 -Параметр запроса: {parentId} - идентификатор агента
4305 -
4306 -В заголовках запроса: X-Auth: Токен авторизации
4307 -
4308 -Ответ:
4309 -
4310 -[ 
4311 - {
4312 - "recordTime": "", ~/~/Время записи
4313 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4314 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4315 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4316 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4317 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4318 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4319 - "items": [ ~/~/ 
4320 -nullable: true ~/~/Детали
4321 - {
4322 - "name": "string", ~/~/наименование столбца
4323 - "value": "string" ~/~/содержание столбца
4324 - }
4325 - ]
4326 - },
4327 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4328 - "string"
4329 - ]
4330 - }
4331 -]
4332 -
4333 -
4334 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4335 -
4336 -(% class="box infomessage" %)
4337 -(((
4338 -POST/api/v3/Vehicles/recyclebin/erase
4339 -)))
4340 -
4341 -В заголовках запроса: X-Auth: Токен авторизации
4342 -
4343 -Пример запроса:
4344 -
4345 -[
4346 -0
4347 -]
4348 -
4349 -
4350 -Пример ответа:
4351 -
4352 -[ 
4353 -{
4354 - "recordTime": "", ~/~/Время записи
4355 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4356 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4357 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
4358 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4359 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4360 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4361 - "items": [ ~/~/Детали
4362 - {
4363 - "name": "", ~/~/Имя свойства
4364 - "value": "" ~/~/Значение свойства
4365 - }
4366 - ]
4367 - },
4368 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4369 - ""
4370 - ]
4371 - }
4372 -]
4373 -
4374 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4375 -
4376 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4377 -
4378 -(% class="box infomessage" %)
4379 -(((
4380 -POST/api/v3/Vehicles/recyclebin/restore
4381 -)))
4382 -
4383 -В заголовках запроса: X-Auth: Токен авторизации
4384 -
4385 -Параметры в теле запроса (JSON):
4386 -
4387 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4388 -
4389 -В заголовках запроса: X-Auth: Токен авторизации
4390 -
4391 -
4392 -Пример запроса:
4393 -
4394 -(((
4395 -[
4396 -)))
4397 -
4398 -(((
4399 - 0
4400 -)))
4401 -
4402 -(((
4403 -]
4404 -)))
4405 -
4406 -
4407 -Пример ответа:
4408 -
4409 -[
4410 -{
4411 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4412 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4413 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4414 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4415 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4416 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4417 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4418 - "items": [ ~/~/Детали
4419 - {
4420 - "name": "string", ~/~/Имя свойства
4421 - "value": "string" ~/~/Значение свойства
4422 - }
4423 - ]
4424 - },
4425 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4426 - "string"
4427 - ]
4428 - }
4429 -]
4430 -
4431 -
4432 -
4433 4433  (% class="box" lang="en-US" style="text-align: center;" %)
4434 4434  (((
4435 4435  (% 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 г.