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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.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,73 @@
894 894  (% style="text-align:left" %)
895 895  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
896 896  
1165 +
1166 +== **Отправить команду на терминал** ==
1167 +
1168 +(% class="box successmessage" %)
1169 +(((
1170 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1171 +)))
1172 +
1173 +Команда для отправки на тс.
1174 +
1175 +{  
1176 +"id": "", ~/~/идентификатор произвольного поля
1177 +"command": "", ~/~/ Текст команды
1178 +"retries": "", ~/~/ Количество попыток
1179 +"idTemplate": "" ~/~/ ID шаблона команды
1180 +}
1181 +
1182 +
1183 +== **Получить ответ на отправленную на ТС команду** ==
1184 +
1185 +(% class="box infomessage" %)
1186 +(((
1187 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1188 +)))
1189 +
1190 +Идентификатор команды: cmdid
1191 +
1192 +Запрос от терминала на ответ команды
1193 +
1194 +Пример ответ от терминала:
1195 +
1196 +ID= "" ~/~/ идентификатор произвольного поля
1197 +Soft="" ~/~/ версия софта
1198 +GPS=4 ~/~/ тип трекера
1199 +Time=11:05:43 28.06.24 ~/~/ время запроса
1200 +Lat=45.056221 ~/~/ широта
1201 +Lon=39.035938 ~/~/ долгота
1202 +Speed=0.0 ~/~/ скорость
1203 +Course=181.4 ~/~/направление
1204 +
1205 +(((
1206 +== **Список отправленных объекту команд с ответами** ==
1207 +
1208 +(% class="box infomessage" %)
1209 +(((
1210 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1211 +)))
1212 +
1213 +Идентификатор ТС: vehicleId
1214 +
1215 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1216 +
1217 +Пример ответа терминала
1218 +
1219 +[ 
1220 +{    
1221 +"id": "", ~/~/ идентификатор пользователя
1222 +"commandText": "", ~/~/Текст команды.
1223 +"templateId": "", ~/~/Идентификатор шаблона
1224 +"updated": "", ~/~/ Время отправки  
1225 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1226 +"answer": "", ~/~/ Ответ терминала.
1227 +"status": "" ~/~/ Статус отправки
1228 +}
1229 +]
1230 +)))
1231 +
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 -
1249 +(% 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": [ ~/~/ Датчики
1316 +"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 -
1383 +(% 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, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1435 +(% 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": "" ~/~/ идентификатор объекта
1479 + "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 -
1542 +(% style="color:#000000" %){(%%)
1230 1230   "status": "", ~/~/ значение статуса
1231 1231   "date": "", ~/~/ Дата смены статуса 
1232 1232   "description": "", ~/~/ Описание
... ... @@ -1233,10 +1233,10 @@
1233 1233   "data": "", ~/~/ Данные
1234 1234   "overwrite": false, ~/~/ Флаг перезаписи
1235 1235   "stage": "", ~/~/ Состояние
1236 -
1237 -(% style="text-align:left" %)
1238 1238  (% style="color:#000000" %) }
1239 1239  
1551 +== ==
1552 +
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": [ ~/~/ Датчики
1640 +"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" %)
1708 +(% 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]]
1789 +(% 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 -
1795 +(% 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 -
1819 +(% 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  
1866 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1867 +
1868 +(% class="box infomessage" style="text-align: left;" %)
1869 +(((
1870 +**POST /api/v3/terminalMessages/mapping**
1871 +)))
1872 +
1873 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1874 +
1875 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1876 +
1877 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1878 +
1879 +{
1880 + "protocolType": 0,
1881 + "params": ["string"]
1882 +}
1883 +
1884 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1885 +|protocolType|ID типа протокола
1886 +|params|(((
1887 +Массив наименований параметров в сообщении
1888 +)))
1889 +
1890 +Ответ:
1891 +
1892 +{
1893 + "protocolType": 0,
1894 + "mapping": {
1895 + "additionalProp1": {
1896 + "inputType": 0,
1897 + "inputNumber": 0
1898 + },
1899 + "additionalProp2": {
1900 + "inputType": 0,
1901 + "inputNumber": 0
1902 + }
1903 + }
1904 +}
1905 +
1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 +|protocolType|Тип протокола
1908 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1909 +|inputNumber|(((
1910 +Номер входа
1911 +)))
1912 +
1913 +(% class="wikigeneratedid" %)
1914 +Перечень 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/]]
1915 +
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  
1940 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1941 +|vehicleId|ID объекта
1942 +|from|Дата и время начала периода запроса
1943 +|to|Дата и время окончания периода запроса
1944 +
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": { ~/~/ список параметров датчиков передаваемых терминалом
1951 + "deviceTime": "2023-11-29T07:40:44.052Z",
1952 + "serverTime": "2023-11-29T07:40:44.052Z",
1953 + "speed": 0,
1954 + "altitude": 0,
1955 + "latitude": 0,
1956 + "longitude": 0,
1957 + "satellites": 0,
1958 + "course": 0,
1959 + "voltage": 0,
1960 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
1965 + "photoCount": 0,
1966 + "lbsCorrectedCoords": true,
1967 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1625 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) ==
1973 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1974 +|deviceTime|Время сообщения терминала
1975 +|serverTime|Время когда сообщение поступило на сервер
1976 +|speed|Скорость
1977 +|altitude|Высота над уровнем моря
1978 +|latitude|Широта
1979 +|longitude|Долгота
1980 +|satellites|Кол-во спутников
1981 +|course|Курс
1982 +|voltage|Бортовое напряжение
1983 +|parameters|Список параметров и их значений
1984 +|photoCount|Количество фото
1985 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1986 +|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  
2121 +
2122 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2123 +
2124 +(% class="box infomessage" %)
2125 +(((
2126 +**POST /api/v3/vehicles/moveStop**
2127 +)))
2128 +
2129 +Метод запроса: **POST**
2130 +
2131 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2132 +
2133 +В заголовках запроса: X-Auth: Токен авторизации
2134 +
2135 +
2136 +Тело запроса:
2137 +
2138 +{
2139 + "vehicleIds": [ ], ~/~/ Список ID объектов
2140 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2141 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2142 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2143 +}
2144 +
2145 +Ответ:
2146 +
2147 +[ 
2148 + {
2149 + "vehicleId": 0, ~/~/ ID объекта
2150 + "vehicleName": "string", ~/~/ Имя объекта
2151 + "moves": [ ~/~/ Событие движения
2152 + {
2153 + "mileage": 0, ~/~/ Пробег, км
2154 + "eventId": 0, ~/~/ Идентификатор события
2155 + "eventName": "string", ~/~/ Название события
2156 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2157 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2158 + "duration": 0 ~/~/ Продолжительность события, секунд
2159 + }
2160 + ],
2161 + "stops": [ ~/~/ События стоянок
2162 + {
2163 + "address": "string", ~/~/ Адрес события
2164 + "eventId": 0, ~/~/ Идентификатор события
2165 + "eventName": "string", ~/~/ Название события
2166 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2167 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2168 + "duration": 0 ~/~/ Продолжительность события, секунд
2169 + }
2170 + ]
2171 + }
2172 +]
2173 +
2174 +
2175 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2176 +
2177 +(% class="box infomessage" %)
2178 +(((
2179 +**POST /api/v3/vehicles/getlastdata**
2180 +)))
2181 +
2182 +Метод запроса: **POST**
2183 +
2184 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2185 +
2186 +В заголовках запроса: X-Auth: Токен авторизации
2187 +
2188 +
2189 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2190 +
2191 +Ответ:
2192 + {
2193 + "vehicleId": 0, ~/~/Идентификатор объекта.
2194 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2195 + "vehicleNumber": "string",~/~/Номер объекта.
2196 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2197 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2198 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2199 + "speed": 0,~/~/Скорость объекта.
2200 + "course": 0,~/~/Курс движения [0;360]
2201 + "latitude": 0,~/~/Широта [-90°;90°].
2202 + "longitude": 0,~/~/Долгота [-180°;180°].
2203 + "address": "string",~/~/Адрес.
2204 + "geozones": [ ~/~/Сведения по геозонам.
2205 + {
2206 + "id": 0,
2207 + "name": "string"
2208 + }
2209 +
2210 +
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  
3109 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3110 +
3111 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3112 +
3113 +(% class="box infomessage" %)
3114 +(((
3115 +**POST /api/v3/Trailers**
3116 +)))
3117 +
3118 +Пример запроса:
3119 +
3120 +{
3121 + "startDate": "2023-11-14T10:48:03.671Z",
3122 + "endDate": "2023-11-14T10:48:03.671Z",
3123 + "ids": [ 0 ],
3124 + "timezone": 0
3125 +}
3126 +
3127 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3128 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3129 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3130 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3131 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3132 +
3133 +Пример ответа:
3134 +
3135 +[
3136 + {
3137 + "SD": "2023-11-14T10:48:03.717Z",
3138 + "ED": "2023-11-14T10:48:03.717Z", 
3139 + "id": 0,
3140 + "SLat": 0,
3141 + "SLon": 0,
3142 + "ELat": 0,
3143 + "ELon": 0,
3144 + "mileage": 0
3145 + "Duration": 0
3146 + "Address": "string",
3147 + "Address2": "string",
3148 + "name": "string",
3149 + "rid": "string",
3150 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 + "trailer": {
3152 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3153 + "Number": "string",
3154 + "Description": "string",
3155 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3156 + "ExternalID": "string",
3157 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3158 + "CreateTime": "2023-11-14T10:48:03.717Z",
3159 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3160 + "IsDeleted": true
3161 + },
3162 + "filesCount": 0,
3163 + }
3164 +]
3165 +
3166 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3167 +|SD|Дата и время начала события
3168 +|ED|Дата и время окончания события
3169 +|id|ID объекта
3170 +|SLat|Широта начальной координаты
3171 +|SLon|Долгота начальной координаты
3172 +|ELat|Широта конечной координаты
3173 +|ELon|Долгота конечной координаты
3174 +|mileage|Пробег
3175 +|Duration|Продолжительность
3176 +|Address|Адрес начального местоположения
3177 +|Address2|Адрес конечного местоположения
3178 +|name|Имя радиометки
3179 +|rid|Номер радиометки
3180 +|rguid|ID радиометки
3181 +|trailer|Информация об агрегате
3182 +|ModelGuid|ID агрегата
3183 +|Number|Название/номер агрегата
3184 +|Description|Текст примечания агрегата
3185 +
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, ~/~/ Частота трансляции радиометки
3207 + "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  
3213 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3214 +|parentId|ID клиента
3215 +|name|Название карты-метки
3216 +|number|Номер
3217 +|period|Период запросов в секундах (работает только для агрегатов)
3218 +|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, ~/~/ Частота трансляции радиометки
3235 + "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  
3241 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3242 +|name|Название карты-метки
3243 +|number|Номер
3244 +|period|Период запросов в секундах (работает только для агрегатов)
3245 +|id|ID карты-метки
3246 +|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  
3274 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3275 +|name|Название карты-метки
3276 +|number|Номер
3277 +|period|Период запросов в секундах (работает только для агрегатов)
3278 +|id|ID карты-метки
3279 +|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  
3308 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3309 +|name|Название карты-метки
3310 +|number|Номер
3311 +|period|Период запросов в секундах (работает только для агрегатов)
3312 +|id|ID карты-метки
3313 +|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 - идентификатор карты-метки
3322 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2830 2830  
2831 2831  Ответ:
2832 2832  
... ... @@ -2833,6 +2833,1108 @@
2833 2833  Success
2834 2834  
2835 2835  
3329 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3330 +
3331 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3332 +
3333 +(% class="box infomessage" %)
3334 +(((
3335 +**GET /api/v3/Billing/client/balance/{clientId}**
3336 +)))
3337 +
3338 +Параметр запроса: **clientId **- идентификатор клиента.
3339 +
3340 +Ответ:
3341 +
3342 +{
3343 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3344 + "Balance": 0
3345 +}
3346 +
3347 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3348 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3349 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3350 +
3351 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3352 +
3353 +(% class="box infomessage" %)
3354 +(((
3355 +**GET /api/v3/Billing/client/constraint/{clientId}**
3356 +)))
3357 +
3358 +Параметр запроса: **clientId **- идентификатор клиента.
3359 +
3360 +Ответ:
3361 +
3362 +{
3363 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3364 + "CalculationType": 0,
3365 + "PermissibleBalance": 0,
3366 + "DefermentDays": 0,
3367 + "SendUiNotifications": true,
3368 + "SendEmailNotifications": true,
3369 + "IsPrivate": true,
3370 +}
3371 +
3372 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3373 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3374 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3375 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3376 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3377 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3378 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3379 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3380 +
3381 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3382 +
3383 +(% class="box infomessage" %)
3384 +(((
3385 +**GET /api/v3/Billing/client/plan/{clientId}**
3386 +)))
3387 +
3388 +Параметры запроса:
3389 +
3390 +**clientId **- идентификатор клиента.
3391 +
3392 +**planId **- идентификатор тарифного плана.
3393 +
3394 +Ответ:
3395 +
3396 +{
3397 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3398 + "Plan": { **~/~/ Описание тарифного плана**
3399 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3400 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3401 + "Name": "string",
3402 + "IsArchived": true,
3403 + "Constraint": {
3404 + "CalculationType": 0,
3405 + "PermissibleBalance": 0,
3406 + "DefermentDays": 0
3407 + },
3408 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3409 + {
3410 + "Feature": "string",
3411 + "IsFactual": true,
3412 + "Limit": 0,
3413 + "Price": 0,
3414 + "PeriodValue": 0,
3415 + "PeriodType": 0
3416 + }
3417 + ]
3418 + },
3419 + "DebitDate": "2023-10-18T12:46:24.213Z",
3420 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3421 + {
3422 + "Feature": "string",
3423 + "IsEnabled": true,
3424 + "IsPrivate": true,
3425 + "IsFactual": true,
3426 + "Limit": 0,
3427 + "Price": 0,
3428 + "DebitDate": "2023-10-18T12:46:24.213Z",
3429 + "PeriodValue": 0,
3430 + "PeriodType": 0
3431 + }
3432 + ]
3433 +}
3434 +
3435 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3436 +|ClientId|Идентификатор клиента
3437 +|Id|Идентификатор тарифного плана
3438 +|OwnerId|Идентификатор клиента-владельца
3439 +|Name|Наименование тарифного плана
3440 +|IsArchived|Признак, определяющий архивный тарифный план
3441 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3442 +|PermissibleBalance|Допустимый баланс
3443 +|DefermentDays|Отсрочка, количество дней
3444 +|Feature|Код услуги
3445 +|IsEnabled|Признак, определяющий активирована ли услуга
3446 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3447 +|IsFactual|Признак, определяющий расчёт по факту
3448 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3449 +|Price|Цена за единицу.
3450 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3451 +|PeriodValue|Значение периода.
3452 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3453 +
3454 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3455 +
3456 +(% class="box infomessage" %)
3457 +(((
3458 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3459 +)))
3460 +
3461 +Параметр запроса: **clientId **- идентификатор клиента.
3462 +
3463 +Ответ:
3464 +
3465 +[
3466 + {
3467 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3468 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3469 + "Name": "string",
3470 + "IsArchived": true,
3471 + "Constraint": {
3472 + "CalculationType": 0,
3473 + "PermissibleBalance": 0,
3474 + "DefermentDays": 0
3475 + },
3476 + "Features": [
3477 + {
3478 + "Feature": "string",
3479 + "IsFactual": true,
3480 + "Limit": 0,
3481 + "Price": 0,
3482 + "PeriodValue": 0,
3483 + "PeriodType": 0
3484 + }
3485 + ]
3486 + }
3487 +]
3488 +
3489 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3490 +|ClientId|Идентификатор клиента
3491 +|Id|Идентификатор тарифного плана
3492 +|OwnerId|Идентификатор клиента-владельца
3493 +|Name|Наименование тарифного плана
3494 +|IsArchived|Признак, определяющий архивный тарифный план
3495 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3496 +|PermissibleBalance|Допустимый баланс
3497 +|DefermentDays|Отсрочка, количество дней
3498 +|Feature|Код услуги
3499 +|IsFactual|Признак, определяющий расчёт по факту
3500 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3501 +|Price|Цена за единицу.
3502 +|PeriodValue|Значение периода.
3503 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3504 +
3505 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3506 +
3507 +(% class="box infomessage" %)
3508 +(((
3509 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3510 +)))
3511 +
3512 +Параметр запроса: **clientId **- идентификатор клиента.
3513 +
3514 +Ответ:
3515 +
3516 +[
3517 + {
3518 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3520 + "Name": "string",
3521 + "IsArchived": true,
3522 + "Constraint": {
3523 + "CalculationType": 0,
3524 + "PermissibleBalance": 0,
3525 + "DefermentDays": 0
3526 + },
3527 + "Features": [
3528 + {
3529 + "Feature": "string",
3530 + "IsFactual": true,
3531 + "Limit": 0,
3532 + "Price": 0,
3533 + "PeriodValue": 0,
3534 + "PeriodType": 0
3535 + }
3536 + ]
3537 + }
3538 +]
3539 +
3540 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3541 +|ClientId|Идентификатор клиента
3542 +|Id|Идентификатор тарифного плана
3543 +|OwnerId|Идентификатор клиента-владельца
3544 +|Name|Наименование тарифного плана
3545 +|IsArchived|Признак, определяющий архивный тарифный план
3546 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3547 +|PermissibleBalance|Допустимый баланс
3548 +|DefermentDays|Отсрочка, количество дней
3549 +|Feature|Код услуги
3550 +|IsFactual|Признак, определяющий расчёт по факту
3551 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3552 +|Price|Цена за единицу.
3553 +|PeriodValue|Значение периода.
3554 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3555 +
3556 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3557 +
3558 +(% class="box warningmessage" %)
3559 +(((
3560 +**PUT /api/v3/Billing/client/balance**
3561 +)))
3562 +
3563 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3564 +
3565 +Тело запроса:
3566 +
3567 +{
3568 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3569 + "Balance": 0
3570 +}
3571 +
3572 +Ответ: Success
3573 +
3574 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3575 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3576 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3577 +
3578 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3579 +
3580 +(% class="box warningmessage" %)
3581 +(((
3582 +**PUT /api/v3/billing/client/balance/deposit**
3583 +)))
3584 +
3585 +Создает операцию **Пополнение **с указанной суммой
3586 +
3587 +Тело запроса:
3588 +
3589 +{
3590 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3591 + "Balance": 0
3592 +}
3593 +
3594 +Ответ: Success
3595 +
3596 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3597 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3598 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3599 +
3600 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3601 +
3602 +Создает операцию **Списание **с указанной суммой
3603 +
3604 +(% class="box warningmessage" %)
3605 +(((
3606 +**PUT /api/v3/billing/client/balance/withdraw**
3607 +)))
3608 +
3609 +Тело запроса:
3610 +
3611 +{
3612 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3613 + "Balance": 0
3614 +}
3615 +
3616 +Ответ: Success
3617 +
3618 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3619 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3620 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3621 +
3622 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3623 +
3624 +(% class="box warningmessage" %)
3625 +(((
3626 +**PUT /api/v3/Billing/client/constraint**
3627 +)))
3628 +
3629 +Тело запроса:
3630 +
3631 +{
3632 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3633 + "CalculationType": 0,
3634 + "PermissibleBalance": 0,
3635 + "DefermentDays": 0,
3636 + "SendUiNotifications": true,
3637 + "SendEmailNotifications": true,
3638 + "IsPrivate": true,
3639 +}
3640 +
3641 +Ответ: Success
3642 +
3643 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3644 +|ClientId|Идентификатор клиента
3645 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3646 +|PermissibleBalance|Допустимый баланс
3647 +|DefermentDays|(((
3648 +Отсрочка, количество дней
3649 +)))
3650 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3651 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3652 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3653 +
3654 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3655 +
3656 +(% class="box warningmessage" %)
3657 +(((
3658 +**PUT /api/v3/Billing/client/plan**
3659 +)))
3660 +
3661 +Тело запроса:
3662 +
3663 +{
3664 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3665 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3666 + "Features": [
3667 + {
3668 + "Feature": "string",
3669 + "IsEnabled": true,
3670 + "IsFactual": true,
3671 + "Limit": 0,
3672 + "Price": 0,
3673 + "DebitDate": "2023-10-18T13:26:58.987Z",
3674 + "PeriodValue": 0,
3675 + "PeriodType": 0
3676 + }
3677 + ]
3678 +}
3679 +
3680 +Ответ: Success
3681 +
3682 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3683 +|ClientId|Идентификатор клиента
3684 +|PlanId|Идентификатор тарифного плана
3685 +|Feature|Код услуги
3686 +|IsEnabled|Признак, определяющий активирована ли услуга
3687 +|IsFactual|Признак, определяющий расчёт по факту
3688 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3689 +|Price|Цена за единицу.
3690 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3691 +|PeriodValue|Значение периода.
3692 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3693 +
3694 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3695 +
3696 +(% class="box warningmessage" %)
3697 +(((
3698 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3699 +)))
3700 +
3701 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3702 +
3703 +(% class="box infomessage" %)
3704 +(((
3705 +**POST /api/v3/vehicles/import/{agentId}**
3706 +)))
3707 +
3708 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3709 +
3710 +В пути указывается **agentId** - id клиента.
3711 +
3712 +**Заголовок**
3713 +
3714 +**X-Auth: [токен авторизации]**
3715 +
3716 +**Параметры**
3717 +
3718 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3719 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3720 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3721 +
3722 +В теле использовать тип **form-data,** тип значения** file**
3723 +
3724 +**Ключи**
3725 +
3726 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3727 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3728 +|csv|В значении передаем файл датчиков, формат **csv**
3729 +
3730 +Ответ:
3731 +
3732 +{
3733 + "vehicleId": 0,
3734 + "name": "string",
3735 + "errors": ["string"]
3736 +}
3737 +
3738 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3739 +|vehicleId|ID созданного объекта
3740 +|name|Имя созданного объекта
3741 +|errors|Ошибки и их описание
3742 +
3743 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3744 +
3745 +(% class="box infomessage" %)
3746 +(((
3747 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3748 +)))
3749 +
3750 +(% class="wikigeneratedid" %)
3751 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3752 +
3753 +(% class="wikigeneratedid" %)
3754 +В пути указывается **vehicleId **- id объекта.
3755 +
3756 +**Заголовок**
3757 +
3758 +**X-Auth: [токен авторизации]**
3759 +
3760 +В теле использовать тип **form-data.**
3761 +
3762 +Ключи:
3763 +
3764 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3765 +|**history**|В значении передавать файл с историей
3766 +
3767 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3768 +
3769 +Ответ:
3770 +
3771 +{
3772 + "results": [
3773 + {
3774 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3775 + "vehicleId": 0,
3776 + "errors": [
3777 + "string"
3778 + ],
3779 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3780 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3781 + "producedCount": 0,
3782 + "msgCount": 0
3783 + }
3784 + ]
3785 +}
3786 +
3787 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3788 +|results|Результаты импорта в разрезе ТС
3789 +|vehicleGuid|Guid ТС
3790 +|vehicleId|ID ТС
3791 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3792 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3793 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3794 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3795 +|msgCount|Кол-во обработанных сообщений всего
3796 +
3797 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3798 +
3799 +(% class="box infomessage" %)
3800 +(((
3801 +**GET /api/v3/vehicles/import/history/status**
3802 +)))
3803 +
3804 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3805 +
3806 +Ответ:
3807 +
3808 +{
3809 + "activity": true,
3810 + "progress": 0,
3811 + "message": "string"
3812 +}
3813 +
3814 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3815 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3816 +|progress|Guid ТС
3817 +
3818 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3819 +
3820 +(% class="box infomessage" %)
3821 +(((
3822 +**POST /api/v3/vehicles/export**
3823 +)))
3824 +
3825 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3826 +
3827 +Тело запроса:
3828 +
3829 +[
3830 + id
3831 +]
3832 +
3833 +Ответ: Success 200, получаете файлы с настройками.
3834 +
3835 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3836 +
3837 +(% class="box infomessage" %)
3838 +(((
3839 +**POST /api/v3/vehicles/export/history**
3840 +)))
3841 +
3842 +Метод возвращает список сообщений терминала объекта за выбранный период.
3843 +
3844 +Тело запроса:
3845 +
3846 +{
3847 + "vehicleId": 0,
3848 + "asArchive": true,
3849 + "from": "2023-09-27T12:17:45.973Z",
3850 + "to": "2023-09-27T12:17:45.973Z"
3851 +}
3852 +
3853 +Ответ:
3854 +
3855 +Получаете файл. Сообщение: Code 200/Success
3856 +
3857 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3858 +|vehicleId|ID объекта
3859 +|asArchive|true - Архивировать файл, False - не архивировать
3860 +|from|Дата и время начала запроса
3861 +|to|Дата и время окончания запроса
3862 +
3863 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3864 +
3865 +(% class="box infomessage" %)
3866 +(((
3867 +**GET /api/v3/vehicles/export/history/status**
3868 +)))
3869 +
3870 +Метод возвращает список сообщений терминала объекта за выбранный период.
3871 +
3872 +Ответ:
3873 +
3874 +{
3875 + "activity": true,
3876 + "progress": 0,
3877 + "message": "string"
3878 +}
3879 +
3880 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3881 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3882 +|progress|Прогресс экспорта, от 0 до 100%
3883 +|message|Текст описывающий статус
3884 +
3885 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3886 +
3887 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3888 +
3889 +(% class="box infomessage" %)
3890 +(((
3891 +**POST /api/v3/EcoDriving/rating**
3892 +)))
3893 +
3894 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3895 +
3896 +Тело запроса:
3897 +
3898 +{
3899 + "vehicleIds": [vehicleId],
3900 + "from": "2023-11-22T09:29:48.051Z",
3901 + "to": "2023-11-22T09:29:48.051Z"
3902 +}
3903 +
3904 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3905 +|vehicleIds|Массив ID объектов
3906 +|from|Дата начала запроса
3907 +|to|Дата окончания запроса
3908 +
3909 +Ответ:
3910 +
3911 +{
3912 + "items": [
3913 + {
3914 + "from": "2023-11-22T09:29:48.052Z",
3915 + "to": "2023-11-22T09:29:48.052Z",
3916 + "vehicleId": 0,
3917 + "vehicleName": "string",
3918 + "vehicleModel": "string",
3919 + "penalty": 0,
3920 + "score": 0,
3921 + "totalViolations": 0,
3922 + "violationsByType": {
3923 + "overspeedingViolations": 0,
3924 + "accelerationViolations": 0,
3925 + "brakingViolations": 0,
3926 + "turningViolations": 0,
3927 + "dangerousDrivingViolations": 0,
3928 + "sensorViolations": 0
3929 + },
3930 + "moveTime": 0,
3931 + "mileage": 0,
3932 + "tripsCount": 0,
3933 + "trips": [
3934 + {
3935 + "penalty": 0,
3936 + "score": 0,
3937 + "violationsCount": 0,
3938 + "violationsByType": {
3939 + "overspeedingViolations": 0,
3940 + "accelerationViolations": 0,
3941 + "brakingViolations": 0,
3942 + "turningViolations": 0,
3943 + "dangerousDrivingViolations": 0,
3944 + "sensorViolations": 0
3945 + },
3946 + "moveTime": 0,
3947 + "mileage": 0,
3948 + "motohours": 0,
3949 + "maxSpeed": 0,
3950 + "startAddress": "string",
3951 + "endAddress": "string",
3952 + "drivers": [
3953 + {
3954 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3955 + "driverName": "string",
3956 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3957 + }
3958 + ]
3959 + }
3960 + ]
3961 + }
3962 + ]
3963 +}
3964 +
3965 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3966 +|from|Дата начала запроса
3967 +|to|Дата  окончания
3968 +|vehicleId|ID объекта
3969 +|vehicleName|Имя объекта
3970 +|vehicleModel|Модель объекта
3971 +|penalty|Сумма штрафных баллов
3972 +|score|Оценка
3973 +|totalViolations|Суммарное количество нарушений
3974 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3975 +|overspeedingViolations|Превышение скорости
3976 +|accelerationViolations|Ускорение
3977 +|brakingViolations|Торможение
3978 +|turningViolations|Резкий поворот
3979 +|dangerousDrivingViolations|Резкое вождение
3980 +|sensorViolations|Нарушение по датчику
3981 +|moveTime|Время в движении
3982 +|mileage|Пробег
3983 +|tripsCount|Количество рейсов
3984 +|motohours|Моточасы
3985 +|maxSpeed|Максимальная скорость
3986 +|startAddress|Адрес начала рейса
3987 +|endAddress|Адрес окончания рейса
3988 +|drivers|Список водителей, которые были на объекте в течениии рейса
3989 +|driverGuid|Guid водителя
3990 +|driverName|Имя водителя
3991 +|driverRfid|Номер Карты-метки
3992 +
3993 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3994 +
3995 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
3996 +
3997 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
3998 +
3999 +(% class="box infomessage" %)
4000 +(((
4001 +POST /api/v3/fuelcards/transactions
4002 +)))
4003 +
4004 +Метод запроса: POST
4005 +
4006 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4007 +\\В заголовках запроса: X-Auth: Токен авторизации
4008 +
4009 +Параметры в теле запроса (JSON):
4010 +
4011 +{
4012 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4013 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4014 + "ids": [ 
4015 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4016 + ],
4017 + "timezone": 0 ~/~/Таймзона
4018 +}
4019 +
4020 +
4021 +Ответ:
4022 + {
4023 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4024 + "driver": "string", ~/~/Водители, привязанные к ТК
4025 + "object": "string", ~/~/Наименование ТС
4026 + "amount": 0, ~/~/Количество топлива
4027 + "amountDut": 0, ~/~/Количество по ДУТ
4028 + "amountDiff": 0, ~/~/Разница, л
4029 + "amountDiffPerc": 0, ~/~/Разница, %
4030 + "summa": 0, ~/~/Стоимость, руб
4031 + "serviceName": "string", ~/~/Тип топлива
4032 + "price": 0, ~/~/Цена за литр, руб
4033 + "cardName": "string", ~/~/Наименование ТК
4034 + "cardNum": "string", ~/~/Номер ТК
4035 + "operator": "string", ~/~/Оператор ТК
4036 + "address": "string" ~/~/Адрес АЗС
4037 + }
4038 +
4039 +
4040 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4041 +
4042 +
4043 +== **Получение полных данных о ретрансляторе** ==
4044 +
4045 +(% class="box infomessage" %)
4046 +(((
4047 +**GET ** **/api/v3/retranslations/{id}**
4048 +)))
4049 +
4050 +Идентификатор запроса: ID
4051 +
4052 +
4053 +Пример ответа:
4054 +
4055 +{  
4056 +"description": "", ~/~/ Определяет описание
4057 +"subscriberId": "", ~/~/ Подписчик
4058 +"protocolType": 0, ~/~/ Тип протокола
4059 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4060 +"address": "string", ~/~/ Адрес события
4061 +"objects": [ ~/~/Объекты для ретрансляции
4062 +{      
4063 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4064 +"name": "", ~/~/ Наименование объекта ретрансляции
4065 +"imei": "", ~/~/ IMEI объекта  
4066 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4067 +}
4068 + ],  
4069 +"id": "", ~/~/ идентификатор пользователя   
4070 +"parentId": "", ~/~/Guid родителя
4071 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4072 +}
4073 +
4074 +
4075 +== **Удаление данных ретранслятора** ==
4076 +
4077 +(% class="box infomessage" %)
4078 +(((
4079 +**DELETE** **/api/v3/retranslations/{id}**
4080 +)))
4081 +
4082 +Параметр запроса: ID
4083 +
4084 +
4085 +== **Создание ретранслятора** ==
4086 +
4087 +(% class="box infomessage" %)
4088 +(((
4089 +**POST ** **/api/v3/retranslations/{id}**
4090 +)))
4091 +
4092 +Запрос:
4093 +
4094 +{  
4095 +"description": "", ~/~/ Описание
4096 +"subscriberId": "", ~/~/ Подписчик
4097 +"protocolType": 0, ~/~/ Тип протокола
4098 +"address": "", ~/~/ Адрес ретрансляции
4099 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4100 +"objects": [ ~/~/Объекты для ретрансляции
4101 +{      
4102 +"id": "", ~/~/ идентификатор пользователя     
4103 +"imei": "", ~/~/IMEI объекта
4104 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4105 +}
4106 + ]
4107 +}
4108 +
4109 +
4110 +Ответ:
4111 +
4112 +{  
4113 +"description": "string", ~/~/ Определяет описание
4114 +"subscriberId": "", ~/~/ идентификатор запроса
4115 +"protocolType": 0, ~/~/ Тип протокола
4116 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4117 +"address": "", ~/~/ Адрес события
4118 +"objects": [ ~/~/Объекты для ретрансляции
4119 +{      
4120 +"id": "", ~/~/ идентификатор пользователя    
4121 +"name": "string", ~/~/ Название уведомления
4122 +"imei": "string", ~/~/IMEI объекта  
4123 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4124 +}
4125 + ],  
4126 +"id": "", ~/~/ идентификатор пользователя  
4127 +"parentId": "", ~/~/ Guid идентификатор родителя
4128 +"deleted": true ~/~/ Признак удаления
4129 +}
4130 +
4131 +
4132 +== **Редактирование ретранслятора** ==
4133 +
4134 +(% class="box infomessage" %)
4135 +(((
4136 +**PUT** **/api/v3/retranslations**
4137 +)))
4138 +
4139 +Пример запроса:
4140 +
4141 +{  
4142 +"id": "", ~/~/ идентификатор пользователя   
4143 +"description": "string", ~/~/ Определяет описание
4144 +"subscriberId": "", ~/~/ идентификатор запроса
4145 +"protocolType": 0, ~/~/ Тип протокола
4146 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4147 +"address": "string", ~/~/ Адрес события
4148 +"objects": ~/~/Объекты для ретрансляции
4149 +[    
4150 +{      
4151 +"id": "",  ~/~/ идентификатор пользователя         
4152 +"imei": "", ~/~/IMEI объекта
4153 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4154 +}
4155 + ]
4156 +}
4157 +
4158 +
4159 +Пример ответа:
4160 +
4161 +{  
4162 +"description": "", ~/~/ Определяет описание
4163 +"subscriberId": "", ~/~/ идентификатор запроса
4164 +"protocolType": 0, ~/~/ Тип протокола
4165 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4166 +"address": "string", ~/~/ Адрес события
4167 +"objects": [ ~/~/Объекты для ретрансляции
4168 +{      
4169 +"id": "", ~/~/ идентификатор пользователя     
4170 +"name": "string", ~/~/ Название уведомления    
4171 +"imei": "", ~/~/IMEI объекта
4172 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4173 +}
4174 + ],
4175 +"id": "", ~/~/ идентификатор пользователя   
4176 +"parentId": "", ~/~/ Guid идентификатор родителя
4177 +"deleted": true ~/~/ Признак удаления
4178 +}
4179 +
4180 +
4181 +== **Получение списка ретранслятора клиента** ==
4182 +
4183 +(% class="box infomessage" %)
4184 +(((
4185 +**POST /api/v3/retranslations/find**
4186 +)))
4187 +
4188 +Пример запроса:
4189 +
4190 +{  
4191 +"id": "", ~/~/ идентификатор пользователя   
4192 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4193 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4194 +}
4195 +
4196 +Ответ:
4197 +
4198 +[ 
4199 +{    
4200 +"description": "", ~/~/ Определяет описание
4201 +"subscriberId": "", ~/~/ идентификатор запроса
4202 +"protocolType": 0, ~/~/ Тип протокола
4203 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4204 +"address": "string", ~/~/ Адрес события
4205 +"id": "", ~/~/ идентификатор пользователя   
4206 +"parentId": "", ~/~/ Guid идентификатор родителя
4207 +"deleted": true ~/~/ Признак удаления
4208 +}
4209 +]
4210 +
4211 +
4212 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4213 +
4214 +== **API для отчета по выгрузке комбайнов** ==
4215 +
4216 +(% class="box infomessage" %)
4217 +(((
4218 +POST **/api/v3/Reports/harvesterUnloading**
4219 +)))
4220 +
4221 +Пример запроса:
4222 +
4223 +{
4224 + "byTime": 0, ~/~/ Объединение событий по времени
4225 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4226 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4227 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4228 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4229 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4230 + 0
4231 + ],
4232 + "from": "", ~/~/ Дата и время начало запроса
4233 + "to": "", ~/~/ Дата и время окончания запроса
4234 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4235 +}
4236 +
4237 +Пример ответа:
4238 +
4239 +[ 
4240 + {
4241 + "harvesterName": "", ~/~/Комбайн, номер
4242 + "harvesterId": 0, ~/~/Комбайн, id
4243 +"harvesterModel": "", ~/~/ Модель комбайна
4244 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4245 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4246 + "events": [ ~/~/Список событий в разрезе комбайна
4247 + {
4248 + "driverId": "", ~/~/Идентификатор водителя
4249 + "driverName": "", ~/~/Водитель комбайна, ФИО
4250 + "RFID": "", ~/~/ идентификатор карты-метки
4251 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4252 + "vehicleId": 0, ~/~/идентификатор объекта
4253 + "vehicleName": "string", ~/~/ Имя объекта
4254 + "modelName": "string", ~/~/ Имя модели объекта
4255 + "nearestVehicles": [ ~/~/Объекты рядом
4256 + {
4257 + "vehicleId": 0, ~/~/идентификатор объекта
4258 + "vehicleName": "string" ~/~/ Имя объекта
4259 + }
4260 + ],
4261 + "fields": [ ~/~/Поля, где происходила выгрузка
4262 + {
4263 + "id": 0, ~/~/ идентификатор пользователя 
4264 + "name": "string" ~/~/ имя пользователя 
4265 + }
4266 + ],
4267 + "event": "string", ~/~/Событие
4268 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4269 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4270 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4271 + "cultureName": "string", ~/~/ название культуры
4272 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4273 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4274 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4275 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4276 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4277 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4278 + "issued": 0, ~/~/Выдано, бункеров
4279 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4280 + "latitude": 0, ~/~/Широта
4281 + "longitude": 0, ~/~/ Долгота
4282 + "litresAway": 0, ~/~/Отдано, л
4283 + "m3Away": 0 ~/~/Отдано, м3
4284 + }
4285 + ]
4286 + }
4287 +]
4288 +
4289 +
4290 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4291 +
4292 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4293 +
4294 +
4295 +(% class="box infomessage" %)
4296 +(((
4297 +GET api/v3/Vehicles/recyclebin/all
4298 +)))
4299 +
4300 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4301 +
4302 +Параметр запроса: {parentId} - идентификатор агента
4303 +
4304 +В заголовках запроса: X-Auth: Токен авторизации
4305 +
4306 +Ответ:
4307 +
4308 +[ 
4309 + {
4310 + "recordTime": "", ~/~/Время записи
4311 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4312 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4313 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4314 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4315 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4316 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4317 + "items": [ ~/~/ 
4318 +nullable: true ~/~/Детали
4319 + {
4320 + "name": "string", ~/~/наименование столбца
4321 + "value": "string" ~/~/содержание столбца
4322 + }
4323 + ]
4324 + },
4325 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4326 + "string"
4327 + ]
4328 + }
4329 +]
4330 +
4331 +
4332 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4333 +
4334 +(% class="box infomessage" %)
4335 +(((
4336 +POST/api/v3/Vehicles/recyclebin/erase
4337 +)))
4338 +
4339 +В заголовках запроса: X-Auth: Токен авторизации
4340 +
4341 +Пример запроса:
4342 +
4343 +[
4344 +0
4345 +]
4346 +
4347 +
4348 +Пример ответа:
4349 +
4350 +[ 
4351 +{
4352 + "recordTime": "", ~/~/Время записи
4353 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4354 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4355 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4356 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4357 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4358 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4359 + "items": [ ~/~/Детали
4360 + {
4361 + "name": "", ~/~/Имя свойства
4362 + "value": "" ~/~/Значение свойства
4363 + }
4364 + ]
4365 + },
4366 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4367 + ""
4368 + ]
4369 + }
4370 +]
4371 +
4372 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4373 +
4374 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4375 +
4376 +(% class="box infomessage" %)
4377 +(((
4378 +POST/api/v3/Vehicles/recyclebin/restore
4379 +)))
4380 +
4381 +В заголовках запроса: X-Auth: Токен авторизации
4382 +
4383 +Параметры в теле запроса (JSON):
4384 +
4385 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4386 +
4387 +В заголовках запроса: X-Auth: Токен авторизации
4388 +
4389 +
4390 +Пример запроса:
4391 +
4392 +(((
4393 +[
4394 +)))
4395 +
4396 +(((
4397 + 0
4398 +)))
4399 +
4400 +(((
4401 +]
4402 +)))
4403 +
4404 +
4405 +Пример ответа:
4406 +
4407 +[
4408 +{
4409 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4410 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4411 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4412 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4413 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4414 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4415 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4416 + "items": [ ~/~/Детали
4417 + {
4418 + "name": "string", ~/~/Имя свойства
4419 + "value": "string" ~/~/Значение свойства
4420 + }
4421 + ]
4422 + },
4423 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4424 + "string"
4425 + ]
4426 + }
4427 +]
4428 +
4429 +
4430 +
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 г.