<
From version < 108.1 >
edited by Илья Крайнов
on 2023/09/27 15:57
To version < 160.1 >
edited by Андрей Калиновский
on 2024/07/25 10:10
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
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 infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,21 +40,25 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
47 47  (% style="color:#000000" %){
48 -
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
52 -
53 -(% lang="en-US" %)
47 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
48 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
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 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,51 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96
97 97  {
98 - "agentId": "", ~/~/ идентификатор клиента    (%%)
99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 - "isForeign": true/false, ~/~/ Иностранный контрагент
105 - "district": "string", ~/~/ округ
106 - "region": "string", ~/~/ регион
107 - "city": "string", ~/~/ город
108 - "inn": "string", ~/~/ ИНН клиента
109 - "kpp": "string", ~/~/ КПП клиента
110 - "address": "string", ~/~/ юридический адрес
111 - "addressFact": "string", ~/~/ фактический адрес
112 - "email": "string", ~/~/ почта
113 - "director": "string", ~/~/ ФИО руководителя
114 - "bankName": "string", ~/~/ Банк
115 - "bankBIK": "string", ~/~/ БИК
116 - "bankRS": "string", ~/~/ Номер счета
117 - "bankKS": "string" ~/~/ Корр. счет
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"
118 118   }
119 119  
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 +
120 120  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
122 122  (% class="box infomessage" %)
... ... @@ -130,7 +130,7 @@
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
158 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,23 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
173 + "agentId": "",(% style="color:#000000" %)   (%%)
174 + "parentId": "",
175 + "name": "string",
176 + "fullName": "string",
177 + "agentInfoType": 0,
178 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
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 +
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
... ... @@ -172,7 +172,7 @@
172 172  Параметры в теле запроса (JSON):
173 173  
174 174  {
175 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
208 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 178   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -192,7 +192,6 @@
192 192   "bankKS": "string" ~/~/ корр. счёт
193 193  }
194 194  
195 -
196 196  Ответ:
197 197  
198 198  {
... ... @@ -217,6 +217,28 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
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 +
220 220  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 221  
222 222  (% class="box warningmessage" %)
... ... @@ -232,7 +232,6 @@
232 232  
233 233  В заголовках запроса: X-Auth: Токен авторизации
234 234  
235 -
236 236  Параметры в теле запроса (JSON):
237 237  
238 238  {
... ... @@ -257,7 +257,6 @@
257 257   "bankKS": "string" ~/~/ корр. счёт
258 258  }
259 259  
260 -
261 261  Ответ:
262 262  
263 263  {
... ... @@ -300,6 +300,21 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
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 +
303 303  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 305  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -351,7 +351,6 @@
351 351   ],
352 352   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
353 353  }
354 -
355 355  {
356 356   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 357   "lastName": "string",
... ... @@ -363,15 +363,10 @@
363 363   "password": "string",
364 364   "email": "string",
365 365  
366 -
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)Ответ:
369 -
370 -(% style="text-align:left" %)
371 -(% style="color:#000000; font-weight:normal" %){    
372 -
373 -(% style="text-align:left" %)
374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
434 +{     
435 + "id": "" , ~/~/ ID пользователя
375 375   "lastName": "" , ~/~/ Фамилия ,
376 376   "firstName": "" , ~/~/ Имя
377 377   "position": "" , ~/~/ Должность
... ... @@ -388,9 +388,8 @@
388 388   "kind": "" , ~/~/ тип аутентификации
389 389   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
390 390   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
452 +}
391 391  
392 -(% style="text-align:left" %)
393 -(% style="color:#000000; font-weight:normal" %)}
394 394  
395 395  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 396  
... ... @@ -411,19 +411,16 @@
411 411  
412 412  (% style="color:#000000" %)Параметры в теле запроса (JSON):
413 413  
414 -(% style="color:#000000" %){
415 -
474 +(% style="color:#000000" %){(%%)
416 416   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
417 417   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
418 418   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
419 419   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 -
421 421  (% style="color:#000000" %)}
422 422  
423 423  (% style="color:#000000" %)Ответ:
424 424  
425 425  (% style="color:#000000" %){         (%%)
426 -
427 427   "id": "" , ~/~/ идентификатор пользователя
428 428   "lastName": "" , ~/~/ фамилия
429 429   "firstName": "" , ~/~/ имя
... ... @@ -437,7 +437,6 @@
437 437   "sessionDuration":"", ~/~/ длительность сессии в минутах
438 438   "status": "1",  ~/~/ статус пользователя
439 439   "lastLogged": "", ~/~/ дата/время последней авторизации
440 -
441 441  (% style="color:#000000" %)}
442 442  
443 443  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -511,10 +511,8 @@
511 511  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
512 512  
513 513  (% lang="en-US" style="text-align:left" %)
514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 -
516 -(% lang="en-US" style="text-align:left" %)
517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
570 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
571 + "id": "" , ~/~/ ID пользователя 
518 518   "lastName": "" , ~/~/ фамилия
519 519   "firstName": "" , ~/~/ имя
520 520   "position": "" , ~/~/ должность
... ... @@ -536,9 +536,7 @@
536 536   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 537   },
538 538   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 -
541 -(% lang="en-US" style="text-align:left" %)
593 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
542 542  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
543 543  
544 544  (% lang="en-US" style="text-align:left" %)
... ... @@ -545,10 +545,8 @@
545 545  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
546 546  
547 547  (% lang="en-US" style="text-align:left" %)
548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
549 -
550 -(% lang="en-US" style="text-align:left" %)
551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
600 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
601 + "id": "" , ~/~/ идентификатор пользователя
552 552   "lastName": "" , ~/~/ фамилия
553 553   "firstName": "" , ~/~/ имя
554 554   "position": "" , ~/~/ должность
... ... @@ -569,10 +569,8 @@
569 569   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
570 570   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
571 571   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
622 +}
572 572  
573 -(% lang="en-US" style="text-align:left" %)
574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 -
576 576  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
577 577  
578 578  (% class="box warningmessage" %)
... ... @@ -592,12 +592,10 @@
592 592  
593 593  (% style="color:#000000" %)Параметры в теле запроса (JSON):
594 594  
595 -(% style="color:#000000" %){
596 -
643 +(% style="color:#000000" %){(%%)
597 597   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
598 598   "description": "" , ~/~/ описание
599 599   "data": "" , ~/~/ данные, связанные со сменой статуса
600 -
601 601  (% style="color:#000000" %)}
602 602  
603 603  (% style="text-align:left" %)
... ... @@ -619,7 +619,7 @@
619 619  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
620 620  
621 621   [ 
622 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
668 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
623 623   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
624 624   ]
625 625  
... ... @@ -682,6 +682,249 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
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 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -718,19 +718,15 @@
718 718   "deviceTypeName": "", ~/~/ Название типа устройства
719 719   "sim1": "", ~/~/ Номер SIM1
720 720   "sim2": "", ~/~/ Номер SIM2
721 -
722 722   "parentId": "", ~/~/ ID клиента-родителя
723 723   "parentName": "", ~/~/ Наименование клиента-родителя
724 724   "modelId": "", ~/~/ ID модели объекта
725 725   "modelName": "", ~/~/ Имя модели объекта
726 -
727 727   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 728   "unitName": "string", ~/~/ Наименование подразделения
729 729   "status": 0, ~/~/ Статус объекта
730 -
731 731   "createdAt": "", ~/~/ Дата создания объекта
732 732   },
733 -
734 734  "customFields": [ ~/~/ Произвольные поля
735 735   {
736 736   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -753,8 +753,7 @@
753 753   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 754   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 755   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 -
1041 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
758 758   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 759   "mileageCoeff": 0, ~/~/ коэффициент пробега
760 760   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -784,7 +784,6 @@
784 784   "retries": 0 ~/~/ Количество попыток
785 785   }
786 786   ],
787 -
788 788   "sensors": [ ~/~/ Датчики
789 789   {
790 790   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -825,31 +825,19 @@
825 825   },
826 826  
827 827  ~/~/ Характерные для произвольного:
828 -
829 829  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 -
831 831  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 -
833 833  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 -
835 835  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 -
837 837  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 -
839 839  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 -
841 841  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 -
843 843  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 -
845 845  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 -
847 847  ~/~/ "ValueOn": "Вкл.",
848 -
849 849  ~/~/ "ValueOff": "Выкл."
850 850   "summaryMaxValue": 0 ~/~/ Макс. значение
851 851   }
852 -
853 853   "drivers": [ ~/~/ Водители
854 854   {
855 855   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -858,7 +858,6 @@
858 858   "isDefault": true ~/~/ По умолчанию
859 859   }
860 860   ],
861 -
862 862   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
863 863   {
864 864   "id": "", ~/~/ ID  задания
... ... @@ -875,8 +875,7 @@
875 875   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
876 876   }
877 877   ],
878 -
879 - "statusHistory": [ ~/~/ История статусов
1148 +"statusHistory": [ ~/~/ История статусов
880 880   {
881 881   "status": 0,
882 882   "date": "2023-05-22T09:57:39.562Z",
... ... @@ -884,7 +884,6 @@
884 884   "additionalInfo": "string"
885 885   }
886 886   ]
887 -
888 888  }
889 889  )))
890 890  
... ... @@ -894,6 +894,56 @@
894 894  (% style="text-align:left" %)
895 895  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
896 896  
1165 +
1166 +== **Получить ответ на отправленную на ТС команду** ==
1167 +
1168 +(% class="box infomessage" %)
1169 +(((
1170 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1171 +)))
1172 +
1173 +Идентификатор команды: cmdid
1174 +
1175 +Запрос от терминала на ответ команды
1176 +
1177 +Пример ответ от терминала:
1178 +
1179 +ID= "" ~/~/ идентификатор произвольного поля
1180 +Soft="" ~/~/ версия софта
1181 +GPS=4 ~/~/ тип трекера
1182 +Time=11:05:43 28.06.24 ~/~/ время запроса
1183 +Lat=45.056221 ~/~/ широта
1184 +Lon=39.035938 ~/~/ долгота
1185 +Speed=0.0 ~/~/ скорость
1186 +Course=181.4 ~/~/направление
1187 +
1188 +(((
1189 +== **Список отправленных объекту команд с ответами** ==
1190 +
1191 +(% class="box infomessage" %)
1192 +(((
1193 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1194 +)))
1195 +
1196 +Идентификатор ТС: vehicleId
1197 +
1198 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1199 +
1200 +Пример ответа терминала
1201 +
1202 +[ 
1203 +{    
1204 +"id": "", ~/~/ идентификатор пользователя
1205 +"commandText": "", ~/~/Текст команды.
1206 +"templateId": "", ~/~/Идентификатор шаблона
1207 +"updated": "", ~/~/ Время отправки  
1208 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1209 +"answer": "", ~/~/ Ответ терминала.
1210 +"status": "" ~/~/ Статус отправки
1211 +}
1212 +]
1213 +)))
1214 +
897 897  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
898 898  
899 899  (% class="box successmessage" %)
... ... @@ -911,8 +911,7 @@
911 911  
912 912  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
913 913  
914 -(% style="color:#000000" %){
915 -
1232 +(% style="color:#000000" %){(%%)
916 916   "parentId": "" , ~/~/ ID клиента
917 917   "name": "" , ~/~/ имя ТС
918 918   "imei": "" , ~/~/ IMEI
... ... @@ -933,7 +933,6 @@
933 933   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
934 934   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
935 935   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
936 -
937 937   "mileageCalcMethod": 0,
938 938   "mileageCoeff": 0,
939 939   "locationByCellId": true,
... ... @@ -966,7 +966,6 @@
966 966   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
967 967   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
968 968   }
969 -
970 970  "drivers": [ ~/~/ Водители
971 971   {
972 972   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -981,8 +981,7 @@
981 981   "retries": 0
982 982   }
983 983   ],
984 -
985 - "sensors": [ ~/~/ Датчики
1299 +"sensors": [ ~/~/ Датчики
986 986   {
987 987   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
988 988   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1020,29 +1020,17 @@
1020 1020   "additionalProp2": "string",
1021 1021   "additionalProp3": "string"
1022 1022   },
1023 -
1024 1024  ~/~/ Характерные для произвольного:
1025 -
1026 1026  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1027 -
1028 1028  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1029 -
1030 1030  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1031 -
1032 1032  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1033 -
1034 1034  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1035 -
1036 1036  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1037 -
1038 1038  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1039 -
1040 1040  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1041 -
1042 1042  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1043 -
1044 1044  ~/~/ "ValueOn": "Вкл.",
1045 -
1046 1046  ~/~/ "ValueOff": "Выкл."
1047 1047   "summaryMaxValue": 0 ~/~/ Макс. значение
1048 1048   }
... ... @@ -1061,8 +1061,7 @@
1061 1061  
1062 1062  (% style="color:#000000" %)Ответ:
1063 1063  
1064 -(% style="color:#000000" %){
1065 -
1366 +(% style="color:#000000" %){(%%)
1066 1066   "vehicleId": "", ~/~/ID ТС 
1067 1067   "parentId": "", ~/~/Guid владельца ТС
1068 1068   "name": "", ~/~/Имя объекта
... ... @@ -1100,8 +1100,6 @@
1100 1100   "kind": "", ~/~/ Вид периодичности по времени 
1101 1101   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1102 1102   }
1103 -
1104 -(% style="text-align:left" %)
1105 1105  (% style="color:#000000" %)}
1106 1106  
1107 1107  **Валидация:**
... ... @@ -1116,7 +1116,7 @@
1116 1116  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1117 1117  )))
1118 1118  
1119 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1418 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1120 1120  
1121 1121  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1122 1122  
... ... @@ -1160,8 +1160,7 @@
1160 1160  (% style="color:#000000" %)Ответ:
1161 1161  
1162 1162  (% style="color:#000000" %){
1163 -
1164 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1462 + "vehicleId": "" ~/~/ идентификатор объекта
1165 1165   "name": "" ~/~/ наименование объекта
1166 1166   "imei": "" ~/~/ IMEI объекта
1167 1167   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1220,13 +1220,11 @@
1220 1220   "data": "", ~/~/ Данные
1221 1221   "overwrite": false, ~/~/ Флаг перезаписи
1222 1222   "stage": "", ~/~/ Состояние, может быть null
1223 -
1224 1224  (% style="color:#000000" %)}
1225 1225  
1226 1226  (% style="color:#000000" %)Ответ:
1227 1227  
1228 -(% style="color:#000000" %){
1229 -
1525 +(% style="color:#000000" %){(%%)
1230 1230   "status": "", ~/~/ значение статуса
1231 1231   "date": "", ~/~/ Дата смены статуса 
1232 1232   "description": "", ~/~/ Описание
... ... @@ -1233,10 +1233,25 @@
1233 1233   "data": "", ~/~/ Данные
1234 1234   "overwrite": false, ~/~/ Флаг перезаписи
1235 1235   "stage": "", ~/~/ Состояние
1236 -
1237 -(% style="text-align:left" %)
1238 1238  (% style="color:#000000" %) }
1239 1239  
1534 +== **Отправить команду на терминал** ==
1535 +
1536 +(% class="box successmessage" %)
1537 +(((
1538 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1539 +)))
1540 +
1541 +Команда для отправки на тс.
1542 +
1543 +{  
1544 +"id": "", ~/~/идентификатор произвольного поля
1545 +"command": "", ~/~/ Текст команды
1546 +"retries": "", ~/~/ Количество попыток
1547 +"idTemplate": "" ~/~/ ID шаблона команды
1548 +}
1549 +
1550 +
1240 1240  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1241 1241  
1242 1242  (% class="box warningmessage" %)
... ... @@ -1324,8 +1324,7 @@
1324 1324   "retries": 0
1325 1325   }
1326 1326   ],
1327 -
1328 - "sensors": [ ~/~/ Датчики
1638 +"sensors": [ ~/~/ Датчики
1329 1329   {
1330 1330   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1331 1331   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1363,29 +1363,17 @@
1363 1363   "additionalProp2": "string",
1364 1364   "additionalProp3": "string"
1365 1365   },
1366 -
1367 1367  ~/~/ Характерные для произвольного:
1368 -
1369 1369  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1370 -
1371 1371  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1372 -
1373 1373  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1374 -
1375 1375  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1376 -
1377 1377  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1378 -
1379 1379  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1380 -
1381 1381  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1382 -
1383 1383  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1384 -
1385 1385  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1386 -
1387 1387  ~/~/ "ValueOn": "Вкл.",
1388 -
1389 1389  ~/~/ "ValueOff": "Выкл."
1390 1390   "summaryMaxValue": 0 ~/~/ Макс. значение
1391 1391   }
... ... @@ -1405,9 +1405,7 @@
1405 1405  (% style="color:#000000" %)Ответ:
1406 1406  
1407 1407  (% lang="en-US" style="text-align:left" %)
1408 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1409 -
1410 -(% lang="en-US" style="text-align:left" %)
1706 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1411 1411   "vehicleId": "", ~/~/ ID ТС
1412 1412   "parentId": "", ~/~/ ID клиента
1413 1413   "name": "", ~/~/ имя ТС
... ... @@ -1448,8 +1448,6 @@
1448 1448   "kind": "", ~/~/ Вид периодичности по времени
1449 1449   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1450 1450   }
1451 -
1452 -(% lang="en-US" style="text-align:left" %)
1453 1453  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1454 1454  
1455 1455  **Валидация:**
... ... @@ -1490,18 +1490,15 @@
1490 1490  
1491 1491  (% style="color:#000000" %)Метод запроса: **GET**
1492 1492  
1493 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1787 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1494 1494  
1495 1495  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1496 1496  
1497 1497  (% style="color:#000000" %)Ответ:
1498 1498  
1499 -(% style="color:#000000" %){
1500 -
1793 +(% style="color:#000000" %){(%%)
1501 1501   "deviceTypeId" : "", ~/~/ ID типа устройства
1502 1502   "deviceTypeName" : "" ~/~/ Название типа устройства
1503 -
1504 -(% style="text-align:left" %)
1505 1505  (% style="color:#000000" %)}
1506 1506  
1507 1507  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1523,13 +1523,10 @@
1523 1523  
1524 1524  (% style="color:#000000" %)Ответ:
1525 1525  
1526 -(% style="color:#000000" %){
1527 -
1817 +(% style="color:#000000" %){(%%)
1528 1528   "id": "", ~/~/ ID типа датчика 
1529 1529   "name": "", ~/~/ Название
1530 1530   "description": "", ~/~/ Описание
1531 -
1532 -(% style="text-align:left" %)
1533 1533  (% style="color:#000000" %)}
1534 1534  
1535 1535  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1573,6 +1573,56 @@
1573 1573   }
1574 1574  ]
1575 1575  
1864 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1865 +
1866 +(% class="box infomessage" style="text-align: left;" %)
1867 +(((
1868 +**POST /api/v3/terminalMessages/mapping**
1869 +)))
1870 +
1871 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1872 +
1873 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1874 +
1875 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1876 +
1877 +{
1878 + "protocolType": 0,
1879 + "params": ["string"]
1880 +}
1881 +
1882 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1883 +|protocolType|ID типа протокола
1884 +|params|(((
1885 +Массив наименований параметров в сообщении
1886 +)))
1887 +
1888 +Ответ:
1889 +
1890 +{
1891 + "protocolType": 0,
1892 + "mapping": {
1893 + "additionalProp1": {
1894 + "inputType": 0,
1895 + "inputNumber": 0
1896 + },
1897 + "additionalProp2": {
1898 + "inputType": 0,
1899 + "inputNumber": 0
1900 + }
1901 + }
1902 +}
1903 +
1904 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1905 +|protocolType|Тип протокола
1906 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1907 +|inputNumber|(((
1908 +Номер входа
1909 +)))
1910 +
1911 +(% class="wikigeneratedid" %)
1912 +Перечень 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/]]
1913 +
1576 1576  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 1577  
1578 1578  (% class="box infomessage" %)
... ... @@ -1597,6 +1597,11 @@
1597 1597   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 1598  }
1599 1599  
1938 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1939 +|vehicleId|ID объекта
1940 +|from|Дата и время начала периода запроса
1941 +|to|Дата и время окончания периода запроса
1942 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,80 +1603,43 @@
1603 1603   {
1604 1604   "messages": [
1605 1605   {
1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 - "speed": 0, ~/~/ Скорость, км/ч
1609 - "altitude": 0, ~/~/ Высота, м
1610 - "latitude": 0, ~/~/ Широта [-90°;90°]
1611 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 - "satellites": 0, ~/~/ Кол-во спутников
1613 - "voltage": 0, ~/~/ Напряжение
1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1949 + "deviceTime": "2023-11-29T07:40:44.052Z",
1950 + "serverTime": "2023-11-29T07:40:44.052Z",
1951 + "speed": 0,
1952 + "altitude": 0,
1953 + "latitude": 0,
1954 + "longitude": 0,
1955 + "satellites": 0,
1956 + "course": 0,
1957 + "voltage": 0,
1958 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
1963 + "photoCount": 0,
1964 + "lbsCorrectedCoords": true,
1965 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1625 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) ==
1971 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1972 +|deviceTime|Время сообщения терминала
1973 +|serverTime|Время когда сообщение поступило на сервер
1974 +|speed|Скорость
1975 +|altitude|Высота над уровнем моря
1976 +|latitude|Широта
1977 +|longitude|Долгота
1978 +|satellites|Кол-во спутников
1979 +|course|Курс
1980 +|voltage|Бортовое напряжение
1981 +|parameters|Список параметров и их значений
1982 +|photoCount|Количество фото
1983 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1984 +|protocolType|ID типа протокола
1626 1626  
1627 -(% class="box infomessage" %)
1628 -(((
1629 -**POST /api/v3/vehicles/export/history**
1630 -)))
1631 -
1632 -Метод возвращает список сообщений терминала объекта за выбранный период.
1633 -
1634 -(% style="text-align: left;" %)
1635 -Метод запроса **POST**
1636 -
1637 -(% style="text-align: left;" %)
1638 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1639 -
1640 -(% style="text-align: left;" %)
1641 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1642 -
1643 -{
1644 - "vehicleId": 0, ~/~/ ID объекта
1645 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1646 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1647 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1648 -}
1649 -
1650 -Ответ:
1651 -
1652 -Получаете файл. Сообщение: Code 200/Success
1653 -
1654 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1655 -
1656 -(% class="box infomessage" %)
1657 -(((
1658 -**GET /api/v3/vehicles/export/history/status**
1659 -)))
1660 -
1661 -Метод возвращает список сообщений терминала объекта за выбранный период.
1662 -
1663 -(% style="text-align: left;" %)
1664 -Метод запроса **GET**
1665 -
1666 -(% style="text-align: left;" %)
1667 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1668 -
1669 -(% style="text-align: left;" %)
1670 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1671 -
1672 -Ответ:
1673 -
1674 -{
1675 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1676 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1677 - "message": "string" ~/~/ текст описывающий статус.
1678 -}
1679 -
1680 1680  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1681 1681  
1682 1682  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1810,6 +1810,96 @@
1810 1810   }
1811 1811  ]
1812 1812  
2119 +
2120 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2121 +
2122 +(% class="box infomessage" %)
2123 +(((
2124 +**POST /api/v3/vehicles/moveStop**
2125 +)))
2126 +
2127 +Метод запроса: **POST**
2128 +
2129 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2130 +
2131 +В заголовках запроса: X-Auth: Токен авторизации
2132 +
2133 +
2134 +Тело запроса:
2135 +
2136 +{
2137 + "vehicleIds": [ ], ~/~/ Список ID объектов
2138 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2139 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2140 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2141 +}
2142 +
2143 +Ответ:
2144 +
2145 +[ 
2146 + {
2147 + "vehicleId": 0, ~/~/ ID объекта
2148 + "vehicleName": "string", ~/~/ Имя объекта
2149 + "moves": [ ~/~/ Событие движения
2150 + {
2151 + "mileage": 0, ~/~/ Пробег, км
2152 + "eventId": 0, ~/~/ Идентификатор события
2153 + "eventName": "string", ~/~/ Название события
2154 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2155 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2156 + "duration": 0 ~/~/ Продолжительность события, секунд
2157 + }
2158 + ],
2159 + "stops": [ ~/~/ События стоянок
2160 + {
2161 + "address": "string", ~/~/ Адрес события
2162 + "eventId": 0, ~/~/ Идентификатор события
2163 + "eventName": "string", ~/~/ Название события
2164 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2165 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2166 + "duration": 0 ~/~/ Продолжительность события, секунд
2167 + }
2168 + ]
2169 + }
2170 +]
2171 +
2172 +
2173 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2174 +
2175 +(% class="box infomessage" %)
2176 +(((
2177 +**POST /api/v3/vehicles/getlastdata**
2178 +)))
2179 +
2180 +Метод запроса: **POST**
2181 +
2182 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2183 +
2184 +В заголовках запроса: X-Auth: Токен авторизации
2185 +
2186 +
2187 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2188 +
2189 +Ответ:
2190 + {
2191 + "vehicleId": 0, ~/~/Идентификатор объекта.
2192 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2193 + "vehicleNumber": "string",~/~/Номер объекта.
2194 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2195 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2196 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2197 + "speed": 0,~/~/Скорость объекта.
2198 + "course": 0,~/~/Курс движения [0;360]
2199 + "latitude": 0,~/~/Широта [-90°;90°].
2200 + "longitude": 0,~/~/Долгота [-180°;180°].
2201 + "address": "string",~/~/Адрес.
2202 + "geozones": [ ~/~/Сведения по геозонам.
2203 + {
2204 + "id": 0,
2205 + "name": "string"
2206 + }
2207 +
2208 +
1813 1813  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1814 1814  
1815 1815  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2708,6 +2708,83 @@
2708 2708  Success
2709 2709  
2710 2710  
3107 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3108 +
3109 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3110 +
3111 +(% class="box infomessage" %)
3112 +(((
3113 +**POST /api/v3/Trailers**
3114 +)))
3115 +
3116 +Пример запроса:
3117 +
3118 +{
3119 + "startDate": "2023-11-14T10:48:03.671Z",
3120 + "endDate": "2023-11-14T10:48:03.671Z",
3121 + "ids": [ 0 ],
3122 + "timezone": 0
3123 +}
3124 +
3125 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3126 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3127 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3128 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3129 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3130 +
3131 +Пример ответа:
3132 +
3133 +[
3134 + {
3135 + "SD": "2023-11-14T10:48:03.717Z",
3136 + "ED": "2023-11-14T10:48:03.717Z", 
3137 + "id": 0,
3138 + "SLat": 0,
3139 + "SLon": 0,
3140 + "ELat": 0,
3141 + "ELon": 0,
3142 + "mileage": 0
3143 + "Duration": 0
3144 + "Address": "string",
3145 + "Address2": "string",
3146 + "name": "string",
3147 + "rid": "string",
3148 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3149 + "trailer": {
3150 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 + "Number": "string",
3152 + "Description": "string",
3153 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3154 + "ExternalID": "string",
3155 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3156 + "CreateTime": "2023-11-14T10:48:03.717Z",
3157 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3158 + "IsDeleted": true
3159 + },
3160 + "filesCount": 0,
3161 + }
3162 +]
3163 +
3164 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3165 +|SD|Дата и время начала события
3166 +|ED|Дата и время окончания события
3167 +|id|ID объекта
3168 +|SLat|Широта начальной координаты
3169 +|SLon|Долгота начальной координаты
3170 +|ELat|Широта конечной координаты
3171 +|ELon|Долгота конечной координаты
3172 +|mileage|Пробег
3173 +|Duration|Продолжительность
3174 +|Address|Адрес начального местоположения
3175 +|Address2|Адрес конечного местоположения
3176 +|name|Имя радиометки
3177 +|rid|Номер радиометки
3178 +|rguid|ID радиометки
3179 +|trailer|Информация об агрегате
3180 +|ModelGuid|ID агрегата
3181 +|Number|Название/номер агрегата
3182 +|Description|Текст примечания агрегата
3183 +
2711 2711  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2712 2712  
2713 2713  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2729,13 +2729,18 @@
2729 2729   {
2730 2730   "name": "string",
2731 2731   "number": 0,
2732 - "period": 0, ~/~/ Частота трансляции радиометки
3205 + "period": 0,
2733 2733   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2734 2734   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2735 - "deleted": true
2736 2736   }
2737 2737  ]
2738 2738  
3211 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3212 +|parentId|ID клиента
3213 +|name|Название карты-метки
3214 +|number|Номер
3215 +|period|Период запросов в секундах (работает только для агрегатов)
3216 +|id|ID карты-метки
2739 2739  
2740 2740  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2741 2741  
... ... @@ -2752,13 +2752,18 @@
2752 2752   {
2753 2753   "name": "string",
2754 2754   "number": 0,
2755 - "period": 0, ~/~/ Частота трансляции радиометки
3233 + "period": 0,
2756 2756   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2757 2757   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2758 - "deleted": true
2759 2759   }
2760 2760  ]
2761 2761  
3239 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3240 +|name|Название карты-метки
3241 +|number|Номер
3242 +|period|Период запросов в секундах (работает только для агрегатов)
3243 +|id|ID карты-метки
3244 +|parentId|ID клиента
2762 2762  
2763 2763  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2764 2764  
... ... @@ -2774,7 +2774,6 @@
2774 2774   "number": 0,
2775 2775   "period": 0,
2776 2776   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2777 - "deleted": true
2778 2778  }
2779 2779  
2780 2780  Ответ:
... ... @@ -2785,9 +2785,14 @@
2785 2785   "period": 0,
2786 2786   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2787 2787   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2788 - "deleted": true
2789 2789  }
2790 2790  
3272 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3273 +|name|Название карты-метки
3274 +|number|Номер
3275 +|period|Период запросов в секундах (работает только для агрегатов)
3276 +|id|ID карты-метки
3277 +|parentId|ID клиента
2791 2791  
2792 2792  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2793 2793  
... ... @@ -2804,7 +2804,6 @@
2804 2804   "period": 0,
2805 2805   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2806 2806   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2807 - "deleted": true
2808 2808  }
2809 2809  
2810 2810  Ответ:
... ... @@ -2815,9 +2815,14 @@
2815 2815   "period": 0,
2816 2816   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2817 2817   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2818 - "deleted": true
2819 2819  }
2820 2820  
3306 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3307 +|name|Название карты-метки
3308 +|number|Номер
3309 +|period|Период запросов в секундах (работает только для агрегатов)
3310 +|id|ID карты-метки
3311 +|parentId|ID клиента
2821 2821  
2822 2822  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2823 2823  
... ... @@ -2826,7 +2826,7 @@
2826 2826  **DELETE /api/v3/Rfids/{rfidGuid}**
2827 2827  )))
2828 2828  
2829 -Передаем параметр rfidGuid - идентификатор карты-метки
3320 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2830 2830  
2831 2831  Ответ:
2832 2832  
... ... @@ -2833,6 +2833,1108 @@
2833 2833  Success
2834 2834  
2835 2835  
3327 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3328 +
3329 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3330 +
3331 +(% class="box infomessage" %)
3332 +(((
3333 +**GET /api/v3/Billing/client/balance/{clientId}**
3334 +)))
3335 +
3336 +Параметр запроса: **clientId **- идентификатор клиента.
3337 +
3338 +Ответ:
3339 +
3340 +{
3341 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3342 + "Balance": 0
3343 +}
3344 +
3345 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3346 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3347 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3348 +
3349 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3350 +
3351 +(% class="box infomessage" %)
3352 +(((
3353 +**GET /api/v3/Billing/client/constraint/{clientId}**
3354 +)))
3355 +
3356 +Параметр запроса: **clientId **- идентификатор клиента.
3357 +
3358 +Ответ:
3359 +
3360 +{
3361 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3362 + "CalculationType": 0,
3363 + "PermissibleBalance": 0,
3364 + "DefermentDays": 0,
3365 + "SendUiNotifications": true,
3366 + "SendEmailNotifications": true,
3367 + "IsPrivate": true,
3368 +}
3369 +
3370 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3371 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3372 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3373 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3374 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3375 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3376 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3377 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3378 +
3379 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3380 +
3381 +(% class="box infomessage" %)
3382 +(((
3383 +**GET /api/v3/Billing/client/plan/{clientId}**
3384 +)))
3385 +
3386 +Параметры запроса:
3387 +
3388 +**clientId **- идентификатор клиента.
3389 +
3390 +**planId **- идентификатор тарифного плана.
3391 +
3392 +Ответ:
3393 +
3394 +{
3395 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3396 + "Plan": { **~/~/ Описание тарифного плана**
3397 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3398 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3399 + "Name": "string",
3400 + "IsArchived": true,
3401 + "Constraint": {
3402 + "CalculationType": 0,
3403 + "PermissibleBalance": 0,
3404 + "DefermentDays": 0
3405 + },
3406 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3407 + {
3408 + "Feature": "string",
3409 + "IsFactual": true,
3410 + "Limit": 0,
3411 + "Price": 0,
3412 + "PeriodValue": 0,
3413 + "PeriodType": 0
3414 + }
3415 + ]
3416 + },
3417 + "DebitDate": "2023-10-18T12:46:24.213Z",
3418 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3419 + {
3420 + "Feature": "string",
3421 + "IsEnabled": true,
3422 + "IsPrivate": true,
3423 + "IsFactual": true,
3424 + "Limit": 0,
3425 + "Price": 0,
3426 + "DebitDate": "2023-10-18T12:46:24.213Z",
3427 + "PeriodValue": 0,
3428 + "PeriodType": 0
3429 + }
3430 + ]
3431 +}
3432 +
3433 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3434 +|ClientId|Идентификатор клиента
3435 +|Id|Идентификатор тарифного плана
3436 +|OwnerId|Идентификатор клиента-владельца
3437 +|Name|Наименование тарифного плана
3438 +|IsArchived|Признак, определяющий архивный тарифный план
3439 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3440 +|PermissibleBalance|Допустимый баланс
3441 +|DefermentDays|Отсрочка, количество дней
3442 +|Feature|Код услуги
3443 +|IsEnabled|Признак, определяющий активирована ли услуга
3444 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3445 +|IsFactual|Признак, определяющий расчёт по факту
3446 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3447 +|Price|Цена за единицу.
3448 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3449 +|PeriodValue|Значение периода.
3450 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3451 +
3452 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3453 +
3454 +(% class="box infomessage" %)
3455 +(((
3456 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3457 +)))
3458 +
3459 +Параметр запроса: **clientId **- идентификатор клиента.
3460 +
3461 +Ответ:
3462 +
3463 +[
3464 + {
3465 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3466 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3467 + "Name": "string",
3468 + "IsArchived": true,
3469 + "Constraint": {
3470 + "CalculationType": 0,
3471 + "PermissibleBalance": 0,
3472 + "DefermentDays": 0
3473 + },
3474 + "Features": [
3475 + {
3476 + "Feature": "string",
3477 + "IsFactual": true,
3478 + "Limit": 0,
3479 + "Price": 0,
3480 + "PeriodValue": 0,
3481 + "PeriodType": 0
3482 + }
3483 + ]
3484 + }
3485 +]
3486 +
3487 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3488 +|ClientId|Идентификатор клиента
3489 +|Id|Идентификатор тарифного плана
3490 +|OwnerId|Идентификатор клиента-владельца
3491 +|Name|Наименование тарифного плана
3492 +|IsArchived|Признак, определяющий архивный тарифный план
3493 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3494 +|PermissibleBalance|Допустимый баланс
3495 +|DefermentDays|Отсрочка, количество дней
3496 +|Feature|Код услуги
3497 +|IsFactual|Признак, определяющий расчёт по факту
3498 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3499 +|Price|Цена за единицу.
3500 +|PeriodValue|Значение периода.
3501 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3502 +
3503 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3504 +
3505 +(% class="box infomessage" %)
3506 +(((
3507 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3508 +)))
3509 +
3510 +Параметр запроса: **clientId **- идентификатор клиента.
3511 +
3512 +Ответ:
3513 +
3514 +[
3515 + {
3516 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3517 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3518 + "Name": "string",
3519 + "IsArchived": true,
3520 + "Constraint": {
3521 + "CalculationType": 0,
3522 + "PermissibleBalance": 0,
3523 + "DefermentDays": 0
3524 + },
3525 + "Features": [
3526 + {
3527 + "Feature": "string",
3528 + "IsFactual": true,
3529 + "Limit": 0,
3530 + "Price": 0,
3531 + "PeriodValue": 0,
3532 + "PeriodType": 0
3533 + }
3534 + ]
3535 + }
3536 +]
3537 +
3538 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3539 +|ClientId|Идентификатор клиента
3540 +|Id|Идентификатор тарифного плана
3541 +|OwnerId|Идентификатор клиента-владельца
3542 +|Name|Наименование тарифного плана
3543 +|IsArchived|Признак, определяющий архивный тарифный план
3544 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3545 +|PermissibleBalance|Допустимый баланс
3546 +|DefermentDays|Отсрочка, количество дней
3547 +|Feature|Код услуги
3548 +|IsFactual|Признак, определяющий расчёт по факту
3549 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3550 +|Price|Цена за единицу.
3551 +|PeriodValue|Значение периода.
3552 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3553 +
3554 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3555 +
3556 +(% class="box warningmessage" %)
3557 +(((
3558 +**PUT /api/v3/Billing/client/balance**
3559 +)))
3560 +
3561 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3562 +
3563 +Тело запроса:
3564 +
3565 +{
3566 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3567 + "Balance": 0
3568 +}
3569 +
3570 +Ответ: Success
3571 +
3572 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3573 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3574 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3575 +
3576 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3577 +
3578 +(% class="box warningmessage" %)
3579 +(((
3580 +**PUT /api/v3/billing/client/balance/deposit**
3581 +)))
3582 +
3583 +Создает операцию **Пополнение **с указанной суммой
3584 +
3585 +Тело запроса:
3586 +
3587 +{
3588 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3589 + "Balance": 0
3590 +}
3591 +
3592 +Ответ: Success
3593 +
3594 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3595 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3596 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3597 +
3598 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3599 +
3600 +Создает операцию **Списание **с указанной суммой
3601 +
3602 +(% class="box warningmessage" %)
3603 +(((
3604 +**PUT /api/v3/billing/client/balance/withdraw**
3605 +)))
3606 +
3607 +Тело запроса:
3608 +
3609 +{
3610 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3611 + "Balance": 0
3612 +}
3613 +
3614 +Ответ: Success
3615 +
3616 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3617 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3618 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3619 +
3620 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3621 +
3622 +(% class="box warningmessage" %)
3623 +(((
3624 +**PUT /api/v3/Billing/client/constraint**
3625 +)))
3626 +
3627 +Тело запроса:
3628 +
3629 +{
3630 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3631 + "CalculationType": 0,
3632 + "PermissibleBalance": 0,
3633 + "DefermentDays": 0,
3634 + "SendUiNotifications": true,
3635 + "SendEmailNotifications": true,
3636 + "IsPrivate": true,
3637 +}
3638 +
3639 +Ответ: Success
3640 +
3641 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3642 +|ClientId|Идентификатор клиента
3643 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3644 +|PermissibleBalance|Допустимый баланс
3645 +|DefermentDays|(((
3646 +Отсрочка, количество дней
3647 +)))
3648 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3649 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3650 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3651 +
3652 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3653 +
3654 +(% class="box warningmessage" %)
3655 +(((
3656 +**PUT /api/v3/Billing/client/plan**
3657 +)))
3658 +
3659 +Тело запроса:
3660 +
3661 +{
3662 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3663 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3664 + "Features": [
3665 + {
3666 + "Feature": "string",
3667 + "IsEnabled": true,
3668 + "IsFactual": true,
3669 + "Limit": 0,
3670 + "Price": 0,
3671 + "DebitDate": "2023-10-18T13:26:58.987Z",
3672 + "PeriodValue": 0,
3673 + "PeriodType": 0
3674 + }
3675 + ]
3676 +}
3677 +
3678 +Ответ: Success
3679 +
3680 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3681 +|ClientId|Идентификатор клиента
3682 +|PlanId|Идентификатор тарифного плана
3683 +|Feature|Код услуги
3684 +|IsEnabled|Признак, определяющий активирована ли услуга
3685 +|IsFactual|Признак, определяющий расчёт по факту
3686 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3687 +|Price|Цена за единицу.
3688 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3689 +|PeriodValue|Значение периода.
3690 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3691 +
3692 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3693 +
3694 +(% class="box warningmessage" %)
3695 +(((
3696 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3697 +)))
3698 +
3699 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3700 +
3701 +(% class="box infomessage" %)
3702 +(((
3703 +**POST /api/v3/vehicles/import/{agentId}**
3704 +)))
3705 +
3706 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3707 +
3708 +В пути указывается **agentId** - id клиента.
3709 +
3710 +**Заголовок**
3711 +
3712 +**X-Auth: [токен авторизации]**
3713 +
3714 +**Параметры**
3715 +
3716 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3717 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3718 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3719 +
3720 +В теле использовать тип **form-data,** тип значения** file**
3721 +
3722 +**Ключи**
3723 +
3724 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3725 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3726 +|csv|В значении передаем файл датчиков, формат **csv**
3727 +
3728 +Ответ:
3729 +
3730 +{
3731 + "vehicleId": 0,
3732 + "name": "string",
3733 + "errors": ["string"]
3734 +}
3735 +
3736 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3737 +|vehicleId|ID созданного объекта
3738 +|name|Имя созданного объекта
3739 +|errors|Ошибки и их описание
3740 +
3741 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3742 +
3743 +(% class="box infomessage" %)
3744 +(((
3745 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3746 +)))
3747 +
3748 +(% class="wikigeneratedid" %)
3749 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3750 +
3751 +(% class="wikigeneratedid" %)
3752 +В пути указывается **vehicleId **- id объекта.
3753 +
3754 +**Заголовок**
3755 +
3756 +**X-Auth: [токен авторизации]**
3757 +
3758 +В теле использовать тип **form-data.**
3759 +
3760 +Ключи:
3761 +
3762 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3763 +|**history**|В значении передавать файл с историей
3764 +
3765 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3766 +
3767 +Ответ:
3768 +
3769 +{
3770 + "results": [
3771 + {
3772 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3773 + "vehicleId": 0,
3774 + "errors": [
3775 + "string"
3776 + ],
3777 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3778 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3779 + "producedCount": 0,
3780 + "msgCount": 0
3781 + }
3782 + ]
3783 +}
3784 +
3785 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3786 +|results|Результаты импорта в разрезе ТС
3787 +|vehicleGuid|Guid ТС
3788 +|vehicleId|ID ТС
3789 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3790 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3791 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3792 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3793 +|msgCount|Кол-во обработанных сообщений всего
3794 +
3795 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3796 +
3797 +(% class="box infomessage" %)
3798 +(((
3799 +**GET /api/v3/vehicles/import/history/status**
3800 +)))
3801 +
3802 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3803 +
3804 +Ответ:
3805 +
3806 +{
3807 + "activity": true,
3808 + "progress": 0,
3809 + "message": "string"
3810 +}
3811 +
3812 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3813 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3814 +|progress|Guid ТС
3815 +
3816 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3817 +
3818 +(% class="box infomessage" %)
3819 +(((
3820 +**POST /api/v3/vehicles/export**
3821 +)))
3822 +
3823 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3824 +
3825 +Тело запроса:
3826 +
3827 +[
3828 + id
3829 +]
3830 +
3831 +Ответ: Success 200, получаете файлы с настройками.
3832 +
3833 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3834 +
3835 +(% class="box infomessage" %)
3836 +(((
3837 +**POST /api/v3/vehicles/export/history**
3838 +)))
3839 +
3840 +Метод возвращает список сообщений терминала объекта за выбранный период.
3841 +
3842 +Тело запроса:
3843 +
3844 +{
3845 + "vehicleId": 0,
3846 + "asArchive": true,
3847 + "from": "2023-09-27T12:17:45.973Z",
3848 + "to": "2023-09-27T12:17:45.973Z"
3849 +}
3850 +
3851 +Ответ:
3852 +
3853 +Получаете файл. Сообщение: Code 200/Success
3854 +
3855 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3856 +|vehicleId|ID объекта
3857 +|asArchive|true - Архивировать файл, False - не архивировать
3858 +|from|Дата и время начала запроса
3859 +|to|Дата и время окончания запроса
3860 +
3861 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3862 +
3863 +(% class="box infomessage" %)
3864 +(((
3865 +**GET /api/v3/vehicles/export/history/status**
3866 +)))
3867 +
3868 +Метод возвращает список сообщений терминала объекта за выбранный период.
3869 +
3870 +Ответ:
3871 +
3872 +{
3873 + "activity": true,
3874 + "progress": 0,
3875 + "message": "string"
3876 +}
3877 +
3878 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3879 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3880 +|progress|Прогресс экспорта, от 0 до 100%
3881 +|message|Текст описывающий статус
3882 +
3883 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3884 +
3885 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3886 +
3887 +(% class="box infomessage" %)
3888 +(((
3889 +**POST /api/v3/EcoDriving/rating**
3890 +)))
3891 +
3892 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3893 +
3894 +Тело запроса:
3895 +
3896 +{
3897 + "vehicleIds": [vehicleId],
3898 + "from": "2023-11-22T09:29:48.051Z",
3899 + "to": "2023-11-22T09:29:48.051Z"
3900 +}
3901 +
3902 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3903 +|vehicleIds|Массив ID объектов
3904 +|from|Дата начала запроса
3905 +|to|Дата окончания запроса
3906 +
3907 +Ответ:
3908 +
3909 +{
3910 + "items": [
3911 + {
3912 + "from": "2023-11-22T09:29:48.052Z",
3913 + "to": "2023-11-22T09:29:48.052Z",
3914 + "vehicleId": 0,
3915 + "vehicleName": "string",
3916 + "vehicleModel": "string",
3917 + "penalty": 0,
3918 + "score": 0,
3919 + "totalViolations": 0,
3920 + "violationsByType": {
3921 + "overspeedingViolations": 0,
3922 + "accelerationViolations": 0,
3923 + "brakingViolations": 0,
3924 + "turningViolations": 0,
3925 + "dangerousDrivingViolations": 0,
3926 + "sensorViolations": 0
3927 + },
3928 + "moveTime": 0,
3929 + "mileage": 0,
3930 + "tripsCount": 0,
3931 + "trips": [
3932 + {
3933 + "penalty": 0,
3934 + "score": 0,
3935 + "violationsCount": 0,
3936 + "violationsByType": {
3937 + "overspeedingViolations": 0,
3938 + "accelerationViolations": 0,
3939 + "brakingViolations": 0,
3940 + "turningViolations": 0,
3941 + "dangerousDrivingViolations": 0,
3942 + "sensorViolations": 0
3943 + },
3944 + "moveTime": 0,
3945 + "mileage": 0,
3946 + "motohours": 0,
3947 + "maxSpeed": 0,
3948 + "startAddress": "string",
3949 + "endAddress": "string",
3950 + "drivers": [
3951 + {
3952 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3953 + "driverName": "string",
3954 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3955 + }
3956 + ]
3957 + }
3958 + ]
3959 + }
3960 + ]
3961 +}
3962 +
3963 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3964 +|from|Дата начала запроса
3965 +|to|Дата  окончания
3966 +|vehicleId|ID объекта
3967 +|vehicleName|Имя объекта
3968 +|vehicleModel|Модель объекта
3969 +|penalty|Сумма штрафных баллов
3970 +|score|Оценка
3971 +|totalViolations|Суммарное количество нарушений
3972 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3973 +|overspeedingViolations|Превышение скорости
3974 +|accelerationViolations|Ускорение
3975 +|brakingViolations|Торможение
3976 +|turningViolations|Резкий поворот
3977 +|dangerousDrivingViolations|Резкое вождение
3978 +|sensorViolations|Нарушение по датчику
3979 +|moveTime|Время в движении
3980 +|mileage|Пробег
3981 +|tripsCount|Количество рейсов
3982 +|motohours|Моточасы
3983 +|maxSpeed|Максимальная скорость
3984 +|startAddress|Адрес начала рейса
3985 +|endAddress|Адрес окончания рейса
3986 +|drivers|Список водителей, которые были на объекте в течениии рейса
3987 +|driverGuid|Guid водителя
3988 +|driverName|Имя водителя
3989 +|driverRfid|Номер Карты-метки
3990 +
3991 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3992 +
3993 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
3994 +
3995 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
3996 +
3997 +(% class="box infomessage" %)
3998 +(((
3999 +POST /api/v3/fuelcards/transactions
4000 +)))
4001 +
4002 +Метод запроса: POST
4003 +
4004 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4005 +\\В заголовках запроса: X-Auth: Токен авторизации
4006 +
4007 +Параметры в теле запроса (JSON):
4008 +
4009 +{
4010 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4011 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4012 + "ids": [ 
4013 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4014 + ],
4015 + "timezone": 0 ~/~/Таймзона
4016 +}
4017 +
4018 +
4019 +Ответ:
4020 + {
4021 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4022 + "driver": "string", ~/~/Водители, привязанные к ТК
4023 + "object": "string", ~/~/Наименование ТС
4024 + "amount": 0, ~/~/Количество топлива
4025 + "amountDut": 0, ~/~/Количество по ДУТ
4026 + "amountDiff": 0, ~/~/Разница, л
4027 + "amountDiffPerc": 0, ~/~/Разница, %
4028 + "summa": 0, ~/~/Стоимость, руб
4029 + "serviceName": "string", ~/~/Тип топлива
4030 + "price": 0, ~/~/Цена за литр, руб
4031 + "cardName": "string", ~/~/Наименование ТК
4032 + "cardNum": "string", ~/~/Номер ТК
4033 + "operator": "string", ~/~/Оператор ТК
4034 + "address": "string" ~/~/Адрес АЗС
4035 + }
4036 +
4037 +
4038 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4039 +
4040 +
4041 +== **Получение полных данных о ретрансляторе** ==
4042 +
4043 +(% class="box infomessage" %)
4044 +(((
4045 +**GET ** **/api/v3/retranslations/{id}**
4046 +)))
4047 +
4048 +Идентификатор запроса: ID
4049 +
4050 +
4051 +Пример ответа:
4052 +
4053 +{  
4054 +"description": "", ~/~/ Определяет описание
4055 +"subscriberId": "", ~/~/ Подписчик
4056 +"protocolType": 0, ~/~/ Тип протокола
4057 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4058 +"address": "string", ~/~/ Адрес события
4059 +"objects": [ ~/~/Объекты для ретрансляции
4060 +{      
4061 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4062 +"name": "", ~/~/ Наименование объекта ретрансляции
4063 +"imei": "", ~/~/ IMEI объекта  
4064 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4065 +}
4066 + ],  
4067 +"id": "", ~/~/ идентификатор пользователя   
4068 +"parentId": "", ~/~/Guid родителя
4069 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4070 +}
4071 +
4072 +
4073 +== **Удаление данных ретранслятора** ==
4074 +
4075 +(% class="box infomessage" %)
4076 +(((
4077 +**DELETE** **/api/v3/retranslations/{id}**
4078 +)))
4079 +
4080 +Параметр запроса: ID
4081 +
4082 +
4083 +== **Создание ретранслятора** ==
4084 +
4085 +(% class="box infomessage" %)
4086 +(((
4087 +**POST ** **/api/v3/retranslations/{id}**
4088 +)))
4089 +
4090 +Запрос:
4091 +
4092 +{  
4093 +"description": "", ~/~/ Описание
4094 +"subscriberId": "", ~/~/ Подписчик
4095 +"protocolType": 0, ~/~/ Тип протокола
4096 +"address": "", ~/~/ Адрес ретрансляции
4097 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4098 +"objects": [ ~/~/Объекты для ретрансляции
4099 +{      
4100 +"id": "", ~/~/ идентификатор пользователя     
4101 +"imei": "", ~/~/IMEI объекта
4102 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4103 +}
4104 + ]
4105 +}
4106 +
4107 +
4108 +Ответ:
4109 +
4110 +{  
4111 +"description": "string", ~/~/ Определяет описание
4112 +"subscriberId": "", ~/~/ идентификатор запроса
4113 +"protocolType": 0, ~/~/ Тип протокола
4114 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4115 +"address": "", ~/~/ Адрес события
4116 +"objects": [ ~/~/Объекты для ретрансляции
4117 +{      
4118 +"id": "", ~/~/ идентификатор пользователя    
4119 +"name": "string", ~/~/ Название уведомления
4120 +"imei": "string", ~/~/IMEI объекта  
4121 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4122 +}
4123 + ],  
4124 +"id": "", ~/~/ идентификатор пользователя  
4125 +"parentId": "", ~/~/ Guid идентификатор родителя
4126 +"deleted": true ~/~/ Признак удаления
4127 +}
4128 +
4129 +
4130 +== **Редактирование ретранслятора** ==
4131 +
4132 +(% class="box infomessage" %)
4133 +(((
4134 +**PUT** **/api/v3/retranslations**
4135 +)))
4136 +
4137 +Пример запроса:
4138 +
4139 +{  
4140 +"id": "", ~/~/ идентификатор пользователя   
4141 +"description": "string", ~/~/ Определяет описание
4142 +"subscriberId": "", ~/~/ идентификатор запроса
4143 +"protocolType": 0, ~/~/ Тип протокола
4144 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4145 +"address": "string", ~/~/ Адрес события
4146 +"objects": ~/~/Объекты для ретрансляции
4147 +[    
4148 +{      
4149 +"id": "",  ~/~/ идентификатор пользователя         
4150 +"imei": "", ~/~/IMEI объекта
4151 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4152 +}
4153 + ]
4154 +}
4155 +
4156 +
4157 +Пример ответа:
4158 +
4159 +{  
4160 +"description": "", ~/~/ Определяет описание
4161 +"subscriberId": "", ~/~/ идентификатор запроса
4162 +"protocolType": 0, ~/~/ Тип протокола
4163 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4164 +"address": "string", ~/~/ Адрес события
4165 +"objects": [ ~/~/Объекты для ретрансляции
4166 +{      
4167 +"id": "", ~/~/ идентификатор пользователя     
4168 +"name": "string", ~/~/ Название уведомления    
4169 +"imei": "", ~/~/IMEI объекта
4170 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4171 +}
4172 + ],
4173 +"id": "", ~/~/ идентификатор пользователя   
4174 +"parentId": "", ~/~/ Guid идентификатор родителя
4175 +"deleted": true ~/~/ Признак удаления
4176 +}
4177 +
4178 +
4179 +== **Получение списка ретранслятора клиента** ==
4180 +
4181 +(% class="box infomessage" %)
4182 +(((
4183 +**POST /api/v3/retranslations/find**
4184 +)))
4185 +
4186 +Пример запроса:
4187 +
4188 +{  
4189 +"id": "", ~/~/ идентификатор пользователя   
4190 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4191 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4192 +}
4193 +
4194 +Ответ:
4195 +
4196 +[ 
4197 +{    
4198 +"description": "", ~/~/ Определяет описание
4199 +"subscriberId": "", ~/~/ идентификатор запроса
4200 +"protocolType": 0, ~/~/ Тип протокола
4201 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4202 +"address": "string", ~/~/ Адрес события
4203 +"id": "", ~/~/ идентификатор пользователя   
4204 +"parentId": "", ~/~/ Guid идентификатор родителя
4205 +"deleted": true ~/~/ Признак удаления
4206 +}
4207 +]
4208 +
4209 +
4210 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4211 +
4212 +== **API для отчета по выгрузке комбайнов** ==
4213 +
4214 +(% class="box infomessage" %)
4215 +(((
4216 +POST **/api/v3/Reports/harvesterUnloading**
4217 +)))
4218 +
4219 +Пример запроса:
4220 +
4221 +{
4222 + "byTime": 0, ~/~/ Объединение событий по времени
4223 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4224 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4225 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4226 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4227 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4228 + 0
4229 + ],
4230 + "from": "", ~/~/ Дата и время начало запроса
4231 + "to": "", ~/~/ Дата и время окончания запроса
4232 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4233 +}
4234 +
4235 +Пример ответа:
4236 +
4237 +[ 
4238 + {
4239 + "harvesterName": "", ~/~/Комбайн, номер
4240 + "harvesterId": 0, ~/~/Комбайн, id
4241 +"harvesterModel": "", ~/~/ Модель комбайна
4242 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4243 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4244 + "events": [ ~/~/Список событий в разрезе комбайна
4245 + {
4246 + "driverId": "", ~/~/Идентификатор водителя
4247 + "driverName": "", ~/~/Водитель комбайна, ФИО
4248 + "RFID": "", ~/~/ идентификатор карты-метки
4249 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4250 + "vehicleId": 0, ~/~/идентификатор объекта
4251 + "vehicleName": "string", ~/~/ Имя объекта
4252 + "modelName": "string", ~/~/ Имя модели объекта
4253 + "nearestVehicles": [ ~/~/Объекты рядом
4254 + {
4255 + "vehicleId": 0, ~/~/идентификатор объекта
4256 + "vehicleName": "string" ~/~/ Имя объекта
4257 + }
4258 + ],
4259 + "fields": [ ~/~/Поля, где происходила выгрузка
4260 + {
4261 + "id": 0, ~/~/ идентификатор пользователя 
4262 + "name": "string" ~/~/ имя пользователя 
4263 + }
4264 + ],
4265 + "event": "string", ~/~/Событие
4266 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4267 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4268 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4269 + "cultureName": "string", ~/~/ название культуры
4270 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4271 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4272 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4273 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4274 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4275 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4276 + "issued": 0, ~/~/Выдано, бункеров
4277 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4278 + "latitude": 0, ~/~/Широта
4279 + "longitude": 0, ~/~/ Долгота
4280 + "litresAway": 0, ~/~/Отдано, л
4281 + "m3Away": 0 ~/~/Отдано, м3
4282 + }
4283 + ]
4284 + }
4285 +]
4286 +
4287 +
4288 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4289 +
4290 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4291 +
4292 +
4293 +(% class="box infomessage" %)
4294 +(((
4295 +GET api/v3/Vehicles/recyclebin/all
4296 +)))
4297 +
4298 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4299 +
4300 +Параметр запроса: {parentId} - идентификатор агента
4301 +
4302 +В заголовках запроса: X-Auth: Токен авторизации
4303 +
4304 +Ответ:
4305 +
4306 +[ 
4307 + {
4308 + "recordTime": "", ~/~/Время записи
4309 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4310 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4311 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4312 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4313 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4314 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4315 + "items": [ ~/~/ 
4316 +nullable: true ~/~/Детали
4317 + {
4318 + "name": "string", ~/~/наименование столбца
4319 + "value": "string" ~/~/содержание столбца
4320 + }
4321 + ]
4322 + },
4323 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4324 + "string"
4325 + ]
4326 + }
4327 +]
4328 +
4329 +
4330 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4331 +
4332 +(% class="box infomessage" %)
4333 +(((
4334 +POST/api/v3/Vehicles/recyclebin/erase
4335 +)))
4336 +
4337 +В заголовках запроса: X-Auth: Токен авторизации
4338 +
4339 +Пример запроса:
4340 +
4341 +[
4342 +0
4343 +]
4344 +
4345 +
4346 +Пример ответа:
4347 +
4348 +[ 
4349 +{
4350 + "recordTime": "", ~/~/Время записи
4351 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4352 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4353 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4354 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4355 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4356 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4357 + "items": [ ~/~/Детали
4358 + {
4359 + "name": "", ~/~/Имя свойства
4360 + "value": "" ~/~/Значение свойства
4361 + }
4362 + ]
4363 + },
4364 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4365 + ""
4366 + ]
4367 + }
4368 +]
4369 +
4370 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4371 +
4372 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4373 +
4374 +(% class="box infomessage" %)
4375 +(((
4376 +POST/api/v3/Vehicles/recyclebin/restore
4377 +)))
4378 +
4379 +В заголовках запроса: X-Auth: Токен авторизации
4380 +
4381 +Параметры в теле запроса (JSON):
4382 +
4383 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4384 +
4385 +В заголовках запроса: X-Auth: Токен авторизации
4386 +
4387 +
4388 +Пример запроса:
4389 +
4390 +(((
4391 +[
4392 +)))
4393 +
4394 +(((
4395 + 0
4396 +)))
4397 +
4398 +(((
4399 +]
4400 +)))
4401 +
4402 +
4403 +Пример ответа:
4404 +
4405 +[
4406 +{
4407 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4408 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4409 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4410 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4411 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4412 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4413 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4414 + "items": [ ~/~/Детали
4415 + {
4416 + "name": "string", ~/~/Имя свойства
4417 + "value": "string" ~/~/Значение свойства
4418 + }
4419 + ]
4420 + },
4421 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4422 + "string"
4423 + ]
4424 + }
4425 +]
4426 +
4427 +
4428 +
2836 2836  (% class="box" lang="en-US" style="text-align: center;" %)
2837 2837  (((
2838 2838  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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