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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.SupportZhuchkov
Content
... ... @@ -14,13 +14,18 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 +
20 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
21 +
22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
23 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box infomessage" %)
28 +(% 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**__».
39 +(% 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" %)
52 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
53 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
59 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
60 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
61 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
62 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
63 +
64 +(% class="wikigeneratedid" %)
65 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
66 +
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" ~/~/ Корр. счет
106 + "agentId": "",  (%%)
107 + "parentId": "",
108 + "parentName": "string",
109 + "name": "string",
110 + "fullName": "string",
111 + "agentInfoType": 0,
112 + "isForeign": true/false,
113 + "district": "string", 
114 + "region": "string",
115 + "city": "string",
116 + "inn": "string",
117 + "kpp": "string",
118 + "address": "string",
119 + "addressFact": "string",
120 + "email": "string",
121 + "director": "string",
122 + "bankName": "string",
123 + "bankBIK": "string",
124 + "bankRS": "string",
125 + "bankKS": "string"
118 118   }
119 119  
128 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
129 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
130 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
131 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
132 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
133 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
134 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
135 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
136 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
137 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
138 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
139 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
140 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
141 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
142 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
143 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
144 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
145 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
146 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
147 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
148 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
149 +
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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
163 +(% 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 - Отказ)
178 + "agentId": "",(% style="color:#000000" %)   (%%)
179 + "parentId": "",
180 + "name": "string",
181 + "fullName": "string",
182 + "agentInfoType": 0,
183 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
186 +
187 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
188 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
189 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
190 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
191 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
192 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
193 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
194 +
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", ~/~/ идентификатор клиента-родителя 
213 + "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  
257 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
258 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
259 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
260 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
261 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
262 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
263 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
264 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
265 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
266 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
267 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
268 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
269 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
270 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
271 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
272 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
273 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
274 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
275 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
276 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
277 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
278 +
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  
360 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
361 +
362 +(% class="box warningmessage" %)
363 +(((
364 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 +)))
366 +
367 +Метод позволяет изменить статус клиента, указанного в запросе.
368 +
369 +В пути указывается GUID клиента и статус клиента.
370 +
371 +**status **- значение 0 - заблокирован, 1 - активен.
372 +
373 +Ответ: Code 204
374 +
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 пользователя
439 +{     
440 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя
457 +}
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 -
479 +(% 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 пользователя 
575 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
576 + "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" %)
598 + "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": "" , ~/~/ идентификатор пользователя
605 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
606 + "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» названия группы пользователя
627 +}
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 -
648 +(% 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",
673 + "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  
736 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
737 +
738 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
739 +
740 +(% class="box infomessage" %)
741 +(((
742 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
743 +)))
744 +
745 +Метод возвращает полную информацию о модели объекта.
746 +
747 +(% style="color:#000000" %)Метод запроса: **GET**
748 +
749 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
750 +
751 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
752 +
753 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
754 +
755 +(% style="color:#000000" %)Ответ:
756 +
757 +(% style="color:#000000" %){
758 + "parentName": "string",
759 + "name": "string",
760 + "picture": "string",
761 + "minspeed": 0,
762 + "maxspeed": 0,
763 + "width": 0,
764 + "imbeddedtrailer": true,
765 + "hoppercapacity": 0,
766 + "hopperdischargespeed": 0,
767 + "modelType": 0,
768 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
769 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
770 + "deleted": true
771 +}
772 +
773 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
774 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
775 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
776 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
777 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
778 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
779 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
780 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
781 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
782 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
783 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
784 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
785 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
786 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
787 +
788 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
789 +
790 +(% class="box successmessage" %)
791 +(((
792 +(% lang="en-US" %)**POST /api/v3/models/find**
793 +)))
794 +
795 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
796 +
797 +(% style="color:#000000" %)Метод запроса: **POST**
798 +
799 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
800 +
801 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
802 +
803 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
804 +
805 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
806 +}
807 +
808 +(% style="color:#000000" %)Ответ:
809 +
810 +(% style="color:#000000" %)[
811 + {
812 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
813 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
814 + "parentName": "string",
815 + "name": "string",
816 + "modelType": 0
817 + }
818 +]
819 +
820 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
821 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
822 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
823 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
824 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
825 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
826 +
827 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
828 +
829 +(% class="box successmessage" %)
830 +(((
831 +(% lang="en-US" %)**POST /api/v3/models**
832 +)))
833 +
834 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
835 +
836 +(% style="color:#000000" %)Метод запроса: **POST**
837 +
838 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
839 +
840 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
841 +
842 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
843 +
844 +{
845 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
846 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
847 + "deleted": true,
848 + "extId": "string",
849 + "name": "string",
850 + "picture": "string",
851 + "minspeed": 0,
852 + "maxspeed": 0,
853 + "width": 0,
854 + "imbeddedtrailer": true,
855 + "fueloutlay": 0,
856 + "hoppercapacity": 0,
857 + "hopperdischargespeed": 0,
858 + "modelType": 0
859 +}
860 +
861 +Ответ:
862 +
863 +{
864 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
865 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
866 + "deleted": true,
867 + "extId": "string",
868 + "name": "string",
869 + "picture": "string",
870 + "minspeed": 0,
871 + "maxspeed": 0,
872 + "width": 0,
873 + "imbeddedtrailer": true,
874 + "hoppercapacity": 0,
875 + "hopperdischargespeed": 0,
876 + "modelType": 0
877 +}
878 +
879 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
880 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
881 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
882 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
883 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
884 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
885 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
886 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
887 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
888 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
889 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
890 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
891 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
892 +
893 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
894 +
895 +(% class="box warningmessage" %)
896 +(((
897 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
898 +)))
899 +
900 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
901 +
902 +(% style="color:#000000" %)Метод запроса: **PUT**
903 +
904 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
905 +
906 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
907 +
908 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
909 +
910 +{
911 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
912 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
913 + "deleted": true,
914 + "extId": "string",
915 + "name": "string",
916 + "picture": "string",
917 + "minspeed": 0,
918 + "maxspeed": 0,
919 + "width": 0,
920 + "imbeddedtrailer": true,
921 + "fueloutlay": 0,
922 + "hoppercapacity": 0,
923 + "hopperdischargespeed": 0,
924 + "modelType": 0
925 +}
926 +
927 +Ответ:
928 +
929 +{
930 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
931 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
932 + "deleted": true,
933 + "extId": "string",
934 + "name": "string",
935 + "picture": "string",
936 + "minspeed": 0,
937 + "maxspeed": 0,
938 + "width": 0,
939 + "imbeddedtrailer": true,
940 + "fueloutlay": 0,
941 + "hoppercapacity": 0,
942 + "hopperdischargespeed": 0,
943 + "modelType": 0
944 +}
945 +
946 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
947 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
948 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
949 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
950 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
951 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
952 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
953 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
954 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
955 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
956 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
957 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
958 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
959 +
960 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
961 +
962 +(% class="box errormessage" %)
963 +(((
964 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
965 +)))
966 +
967 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
968 +
969 +(% style="color:#000000" %)Метод запроса: **DELETE**
970 +
971 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
972 +
973 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
974 +
975 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
976 +
977 +Ответ: В случае успеха **Success 200**
978 +
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 -
1046 + "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": [ ~/~/ История статусов
1153 +"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  
1170 +
1171 +== **Отправить команду на терминал** ==
1172 +
1173 +(% class="box successmessage" %)
1174 +(((
1175 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1176 +)))
1177 +
1178 +Команда для отправки на тс.
1179 +
1180 +{  
1181 +"id": "", ~/~/идентификатор произвольного поля
1182 +"command": "", ~/~/ Текст команды
1183 +"retries": "", ~/~/ Количество попыток
1184 +"idTemplate": "" ~/~/ ID шаблона команды
1185 +}
1186 +
1187 +
1188 +== **Получить ответ на отправленную на ТС команду** ==
1189 +
1190 +(% class="box infomessage" %)
1191 +(((
1192 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1193 +)))
1194 +
1195 +Идентификатор команды: cmdid
1196 +
1197 +Запрос от терминала на ответ команды
1198 +
1199 +Пример ответ от терминала:
1200 +
1201 +ID= "" ~/~/ идентификатор произвольного поля
1202 +Soft="" ~/~/ версия софта
1203 +GPS=4 ~/~/ тип трекера
1204 +Time=11:05:43 28.06.24 ~/~/ время запроса
1205 +Lat=45.056221 ~/~/ широта
1206 +Lon=39.035938 ~/~/ долгота
1207 +Speed=0.0 ~/~/ скорость
1208 +Course=181.4 ~/~/направление
1209 +
1210 +(((
1211 +== **Список отправленных объекту команд с ответами** ==
1212 +
1213 +(% class="box infomessage" %)
1214 +(((
1215 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1216 +)))
1217 +
1218 +Идентификатор ТС: vehicleId
1219 +
1220 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1221 +
1222 +Пример ответа терминала
1223 +
1224 +[ 
1225 +{    
1226 +"id": "", ~/~/ идентификатор пользователя
1227 +"commandText": "", ~/~/Текст команды.
1228 +"templateId": "", ~/~/Идентификатор шаблона
1229 +"updated": "", ~/~/ Время отправки  
1230 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1231 +"answer": "", ~/~/ Ответ терминала.
1232 +"status": "" ~/~/ Статус отправки
1233 +}
1234 +]
1235 +)))
1236 +
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 -
1254 +(% 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": [ ~/~/ Датчики
1321 +"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 -
1388 +(% 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, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1440 +(% 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": "" ~/~/ идентификатор объекта
1484 + "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 -
1547 +(% 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  
1556 +== ==
1557 +
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": [ ~/~/ Датчики
1645 +"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" %)
1713 +(% 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]]
1794 +(% 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 -
1800 +(% 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 -
1824 +(% 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  
1871 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1872 +
1873 +(% class="box infomessage" style="text-align: left;" %)
1874 +(((
1875 +**POST /api/v3/terminalMessages/mapping**
1876 +)))
1877 +
1878 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1879 +
1880 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1881 +
1882 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1883 +
1884 +{
1885 + "protocolType": 0,
1886 + "params": ["string"]
1887 +}
1888 +
1889 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1890 +|protocolType|ID типа протокола
1891 +|params|(((
1892 +Массив наименований параметров в сообщении
1893 +)))
1894 +
1895 +Ответ:
1896 +
1897 +{
1898 + "protocolType": 0,
1899 + "mapping": {
1900 + "additionalProp1": {
1901 + "inputType": 0,
1902 + "inputNumber": 0
1903 + },
1904 + "additionalProp2": {
1905 + "inputType": 0,
1906 + "inputNumber": 0
1907 + }
1908 + }
1909 +}
1910 +
1911 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1912 +|protocolType|Тип протокола
1913 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1914 +|inputNumber|(((
1915 +Номер входа
1916 +)))
1917 +
1918 +(% class="wikigeneratedid" %)
1919 +Перечень 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/]]
1920 +
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  
1945 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1946 +|vehicleId|ID объекта
1947 +|from|Дата и время начала периода запроса
1948 +|to|Дата и время окончания периода запроса
1949 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,25 +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": { ~/~/ список параметров датчиков передаваемых терминалом
1956 + "deviceTime": "2023-11-29T07:40:44.052Z",
1957 + "serverTime": "2023-11-29T07:40:44.052Z",
1958 + "speed": 0,
1959 + "altitude": 0,
1960 + "latitude": 0,
1961 + "longitude": 0,
1962 + "satellites": 0,
1963 + "course": 0,
1964 + "voltage": 0,
1965 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
1970 + "photoCount": 0,
1971 + "lbsCorrectedCoords": true,
1972 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1978 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1979 +|deviceTime|Время сообщения терминала
1980 +|serverTime|Время когда сообщение поступило на сервер
1981 +|speed|Скорость
1982 +|altitude|Высота над уровнем моря
1983 +|latitude|Широта
1984 +|longitude|Долгота
1985 +|satellites|Кол-во спутников
1986 +|course|Курс
1987 +|voltage|Бортовое напряжение
1988 +|parameters|Список параметров и их значений
1989 +|photoCount|Количество фото
1990 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1991 +|protocolType|ID типа протокола
1992 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1755,6 +1755,96 @@
1755 1755   }
1756 1756  ]
1757 1757  
2126 +
2127 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2128 +
2129 +(% class="box infomessage" %)
2130 +(((
2131 +**POST /api/v3/vehicles/moveStop**
2132 +)))
2133 +
2134 +Метод запроса: **POST**
2135 +
2136 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2137 +
2138 +В заголовках запроса: X-Auth: Токен авторизации
2139 +
2140 +
2141 +Тело запроса:
2142 +
2143 +{
2144 + "vehicleIds": [ ], ~/~/ Список ID объектов
2145 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2146 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2147 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2148 +}
2149 +
2150 +Ответ:
2151 +
2152 +[ 
2153 + {
2154 + "vehicleId": 0, ~/~/ ID объекта
2155 + "vehicleName": "string", ~/~/ Имя объекта
2156 + "moves": [ ~/~/ Событие движения
2157 + {
2158 + "mileage": 0, ~/~/ Пробег, км
2159 + "eventId": 0, ~/~/ Идентификатор события
2160 + "eventName": "string", ~/~/ Название события
2161 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2162 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2163 + "duration": 0 ~/~/ Продолжительность события, секунд
2164 + }
2165 + ],
2166 + "stops": [ ~/~/ События стоянок
2167 + {
2168 + "address": "string", ~/~/ Адрес события
2169 + "eventId": 0, ~/~/ Идентификатор события
2170 + "eventName": "string", ~/~/ Название события
2171 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2172 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2173 + "duration": 0 ~/~/ Продолжительность события, секунд
2174 + }
2175 + ]
2176 + }
2177 +]
2178 +
2179 +
2180 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2181 +
2182 +(% class="box infomessage" %)
2183 +(((
2184 +**POST /api/v3/vehicles/getlastdata**
2185 +)))
2186 +
2187 +Метод запроса: **POST**
2188 +
2189 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2190 +
2191 +В заголовках запроса: X-Auth: Токен авторизации
2192 +
2193 +
2194 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2195 +
2196 +Ответ:
2197 + {
2198 + "vehicleId": 0, ~/~/Идентификатор объекта.
2199 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2200 + "vehicleNumber": "string",~/~/Номер объекта.
2201 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2202 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2203 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2204 + "speed": 0,~/~/Скорость объекта.
2205 + "course": 0,~/~/Курс движения [0;360]
2206 + "latitude": 0,~/~/Широта [-90°;90°].
2207 + "longitude": 0,~/~/Долгота [-180°;180°].
2208 + "address": "string",~/~/Адрес.
2209 + "geozones": [ ~/~/Сведения по геозонам.
2210 + {
2211 + "id": 0,
2212 + "name": "string"
2213 + }
2214 +
2215 +
1758 1758  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1759 1759  
1760 1760  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2653,6 +2653,83 @@
2653 2653  Success
2654 2654  
2655 2655  
3114 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3115 +
3116 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3117 +
3118 +(% class="box infomessage" %)
3119 +(((
3120 +**POST /api/v3/Trailers**
3121 +)))
3122 +
3123 +Пример запроса:
3124 +
3125 +{
3126 + "startDate": "2023-11-14T10:48:03.671Z",
3127 + "endDate": "2023-11-14T10:48:03.671Z",
3128 + "ids": [ 0 ],
3129 + "timezone": 0
3130 +}
3131 +
3132 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3133 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3134 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3135 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3136 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3137 +
3138 +Пример ответа:
3139 +
3140 +[
3141 + {
3142 + "SD": "2023-11-14T10:48:03.717Z",
3143 + "ED": "2023-11-14T10:48:03.717Z", 
3144 + "id": 0,
3145 + "SLat": 0,
3146 + "SLon": 0,
3147 + "ELat": 0,
3148 + "ELon": 0,
3149 + "mileage": 0
3150 + "Duration": 0
3151 + "Address": "string",
3152 + "Address2": "string",
3153 + "name": "string",
3154 + "rid": "string",
3155 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3156 + "trailer": {
3157 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3158 + "Number": "string",
3159 + "Description": "string",
3160 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3161 + "ExternalID": "string",
3162 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3163 + "CreateTime": "2023-11-14T10:48:03.717Z",
3164 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3165 + "IsDeleted": true
3166 + },
3167 + "filesCount": 0,
3168 + }
3169 +]
3170 +
3171 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3172 +|SD|Дата и время начала события
3173 +|ED|Дата и время окончания события
3174 +|id|ID объекта
3175 +|SLat|Широта начальной координаты
3176 +|SLon|Долгота начальной координаты
3177 +|ELat|Широта конечной координаты
3178 +|ELon|Долгота конечной координаты
3179 +|mileage|Пробег
3180 +|Duration|Продолжительность
3181 +|Address|Адрес начального местоположения
3182 +|Address2|Адрес конечного местоположения
3183 +|name|Имя радиометки
3184 +|rid|Номер радиометки
3185 +|rguid|ID радиометки
3186 +|trailer|Информация об агрегате
3187 +|ModelGuid|ID агрегата
3188 +|Number|Название/номер агрегата
3189 +|Description|Текст примечания агрегата
3190 +
2656 2656  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2657 2657  
2658 2658  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2674,13 +2674,18 @@
2674 2674   {
2675 2675   "name": "string",
2676 2676   "number": 0,
2677 - "period": 0, ~/~/ Частота трансляции радиометки
3212 + "period": 0,
2678 2678   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2679 2679   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 - "deleted": true
2681 2681   }
2682 2682  ]
2683 2683  
3218 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3219 +|parentId|ID клиента
3220 +|name|Название карты-метки
3221 +|number|Номер
3222 +|period|Период запросов в секундах (работает только для агрегатов)
3223 +|id|ID карты-метки
2684 2684  
2685 2685  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2686 2686  
... ... @@ -2697,13 +2697,18 @@
2697 2697   {
2698 2698   "name": "string",
2699 2699   "number": 0,
2700 - "period": 0, ~/~/ Частота трансляции радиометки
3240 + "period": 0,
2701 2701   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2702 2702   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2703 - "deleted": true
2704 2704   }
2705 2705  ]
2706 2706  
3246 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3247 +|name|Название карты-метки
3248 +|number|Номер
3249 +|period|Период запросов в секундах (работает только для агрегатов)
3250 +|id|ID карты-метки
3251 +|parentId|ID клиента
2707 2707  
2708 2708  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2709 2709  
... ... @@ -2719,7 +2719,6 @@
2719 2719   "number": 0,
2720 2720   "period": 0,
2721 2721   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 - "deleted": true
2723 2723  }
2724 2724  
2725 2725  Ответ:
... ... @@ -2730,9 +2730,14 @@
2730 2730   "period": 0,
2731 2731   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2732 2732   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2733 - "deleted": true
2734 2734  }
2735 2735  
3279 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3280 +|name|Название карты-метки
3281 +|number|Номер
3282 +|period|Период запросов в секундах (работает только для агрегатов)
3283 +|id|ID карты-метки
3284 +|parentId|ID клиента
2736 2736  
2737 2737  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2738 2738  
... ... @@ -2749,7 +2749,6 @@
2749 2749   "period": 0,
2750 2750   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2751 2751   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 - "deleted": true
2753 2753  }
2754 2754  
2755 2755  Ответ:
... ... @@ -2760,9 +2760,14 @@
2760 2760   "period": 0,
2761 2761   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2762 2762   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2763 - "deleted": true
2764 2764  }
2765 2765  
3313 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3314 +|name|Название карты-метки
3315 +|number|Номер
3316 +|period|Период запросов в секундах (работает только для агрегатов)
3317 +|id|ID карты-метки
3318 +|parentId|ID клиента
2766 2766  
2767 2767  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2768 2768  
... ... @@ -2771,7 +2771,7 @@
2771 2771  **DELETE /api/v3/Rfids/{rfidGuid}**
2772 2772  )))
2773 2773  
2774 -Передаем параметр rfidGuid - идентификатор карты-метки
3327 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2775 2775  
2776 2776  Ответ:
2777 2777  
... ... @@ -2778,6 +2778,1108 @@
2778 2778  Success
2779 2779  
2780 2780  
3334 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3335 +
3336 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3337 +
3338 +(% class="box infomessage" %)
3339 +(((
3340 +**GET /api/v3/Billing/client/balance/{clientId}**
3341 +)))
3342 +
3343 +Параметр запроса: **clientId **- идентификатор клиента.
3344 +
3345 +Ответ:
3346 +
3347 +{
3348 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3349 + "Balance": 0
3350 +}
3351 +
3352 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3353 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3354 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3355 +
3356 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3357 +
3358 +(% class="box infomessage" %)
3359 +(((
3360 +**GET /api/v3/Billing/client/constraint/{clientId}**
3361 +)))
3362 +
3363 +Параметр запроса: **clientId **- идентификатор клиента.
3364 +
3365 +Ответ:
3366 +
3367 +{
3368 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3369 + "CalculationType": 0,
3370 + "PermissibleBalance": 0,
3371 + "DefermentDays": 0,
3372 + "SendUiNotifications": true,
3373 + "SendEmailNotifications": true,
3374 + "IsPrivate": true,
3375 +}
3376 +
3377 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3378 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3379 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3380 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3381 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3382 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3383 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3384 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3385 +
3386 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3387 +
3388 +(% class="box infomessage" %)
3389 +(((
3390 +**GET /api/v3/Billing/client/plan/{clientId}**
3391 +)))
3392 +
3393 +Параметры запроса:
3394 +
3395 +**clientId **- идентификатор клиента.
3396 +
3397 +**planId **- идентификатор тарифного плана.
3398 +
3399 +Ответ:
3400 +
3401 +{
3402 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3403 + "Plan": { **~/~/ Описание тарифного плана**
3404 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3405 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3406 + "Name": "string",
3407 + "IsArchived": true,
3408 + "Constraint": {
3409 + "CalculationType": 0,
3410 + "PermissibleBalance": 0,
3411 + "DefermentDays": 0
3412 + },
3413 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3414 + {
3415 + "Feature": "string",
3416 + "IsFactual": true,
3417 + "Limit": 0,
3418 + "Price": 0,
3419 + "PeriodValue": 0,
3420 + "PeriodType": 0
3421 + }
3422 + ]
3423 + },
3424 + "DebitDate": "2023-10-18T12:46:24.213Z",
3425 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3426 + {
3427 + "Feature": "string",
3428 + "IsEnabled": true,
3429 + "IsPrivate": true,
3430 + "IsFactual": true,
3431 + "Limit": 0,
3432 + "Price": 0,
3433 + "DebitDate": "2023-10-18T12:46:24.213Z",
3434 + "PeriodValue": 0,
3435 + "PeriodType": 0
3436 + }
3437 + ]
3438 +}
3439 +
3440 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3441 +|ClientId|Идентификатор клиента
3442 +|Id|Идентификатор тарифного плана
3443 +|OwnerId|Идентификатор клиента-владельца
3444 +|Name|Наименование тарифного плана
3445 +|IsArchived|Признак, определяющий архивный тарифный план
3446 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3447 +|PermissibleBalance|Допустимый баланс
3448 +|DefermentDays|Отсрочка, количество дней
3449 +|Feature|Код услуги
3450 +|IsEnabled|Признак, определяющий активирована ли услуга
3451 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3452 +|IsFactual|Признак, определяющий расчёт по факту
3453 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3454 +|Price|Цена за единицу.
3455 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3456 +|PeriodValue|Значение периода.
3457 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3458 +
3459 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3460 +
3461 +(% class="box infomessage" %)
3462 +(((
3463 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3464 +)))
3465 +
3466 +Параметр запроса: **clientId **- идентификатор клиента.
3467 +
3468 +Ответ:
3469 +
3470 +[
3471 + {
3472 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3473 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3474 + "Name": "string",
3475 + "IsArchived": true,
3476 + "Constraint": {
3477 + "CalculationType": 0,
3478 + "PermissibleBalance": 0,
3479 + "DefermentDays": 0
3480 + },
3481 + "Features": [
3482 + {
3483 + "Feature": "string",
3484 + "IsFactual": true,
3485 + "Limit": 0,
3486 + "Price": 0,
3487 + "PeriodValue": 0,
3488 + "PeriodType": 0
3489 + }
3490 + ]
3491 + }
3492 +]
3493 +
3494 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3495 +|ClientId|Идентификатор клиента
3496 +|Id|Идентификатор тарифного плана
3497 +|OwnerId|Идентификатор клиента-владельца
3498 +|Name|Наименование тарифного плана
3499 +|IsArchived|Признак, определяющий архивный тарифный план
3500 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3501 +|PermissibleBalance|Допустимый баланс
3502 +|DefermentDays|Отсрочка, количество дней
3503 +|Feature|Код услуги
3504 +|IsFactual|Признак, определяющий расчёт по факту
3505 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3506 +|Price|Цена за единицу.
3507 +|PeriodValue|Значение периода.
3508 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3509 +
3510 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3511 +
3512 +(% class="box infomessage" %)
3513 +(((
3514 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3515 +)))
3516 +
3517 +Параметр запроса: **clientId **- идентификатор клиента.
3518 +
3519 +Ответ:
3520 +
3521 +[
3522 + {
3523 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3524 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3525 + "Name": "string",
3526 + "IsArchived": true,
3527 + "Constraint": {
3528 + "CalculationType": 0,
3529 + "PermissibleBalance": 0,
3530 + "DefermentDays": 0
3531 + },
3532 + "Features": [
3533 + {
3534 + "Feature": "string",
3535 + "IsFactual": true,
3536 + "Limit": 0,
3537 + "Price": 0,
3538 + "PeriodValue": 0,
3539 + "PeriodType": 0
3540 + }
3541 + ]
3542 + }
3543 +]
3544 +
3545 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3546 +|ClientId|Идентификатор клиента
3547 +|Id|Идентификатор тарифного плана
3548 +|OwnerId|Идентификатор клиента-владельца
3549 +|Name|Наименование тарифного плана
3550 +|IsArchived|Признак, определяющий архивный тарифный план
3551 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3552 +|PermissibleBalance|Допустимый баланс
3553 +|DefermentDays|Отсрочка, количество дней
3554 +|Feature|Код услуги
3555 +|IsFactual|Признак, определяющий расчёт по факту
3556 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3557 +|Price|Цена за единицу.
3558 +|PeriodValue|Значение периода.
3559 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3560 +
3561 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3562 +
3563 +(% class="box warningmessage" %)
3564 +(((
3565 +**PUT /api/v3/Billing/client/balance**
3566 +)))
3567 +
3568 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3569 +
3570 +Тело запроса:
3571 +
3572 +{
3573 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3574 + "Balance": 0
3575 +}
3576 +
3577 +Ответ: Success
3578 +
3579 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3580 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3581 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3582 +
3583 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3584 +
3585 +(% class="box warningmessage" %)
3586 +(((
3587 +**PUT /api/v3/billing/client/balance/deposit**
3588 +)))
3589 +
3590 +Создает операцию **Пополнение **с указанной суммой
3591 +
3592 +Тело запроса:
3593 +
3594 +{
3595 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3596 + "Balance": 0
3597 +}
3598 +
3599 +Ответ: Success
3600 +
3601 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3602 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3603 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3604 +
3605 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3606 +
3607 +Создает операцию **Списание **с указанной суммой
3608 +
3609 +(% class="box warningmessage" %)
3610 +(((
3611 +**PUT /api/v3/billing/client/balance/withdraw**
3612 +)))
3613 +
3614 +Тело запроса:
3615 +
3616 +{
3617 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3618 + "Balance": 0
3619 +}
3620 +
3621 +Ответ: Success
3622 +
3623 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3624 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3625 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3626 +
3627 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3628 +
3629 +(% class="box warningmessage" %)
3630 +(((
3631 +**PUT /api/v3/Billing/client/constraint**
3632 +)))
3633 +
3634 +Тело запроса:
3635 +
3636 +{
3637 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3638 + "CalculationType": 0,
3639 + "PermissibleBalance": 0,
3640 + "DefermentDays": 0,
3641 + "SendUiNotifications": true,
3642 + "SendEmailNotifications": true,
3643 + "IsPrivate": true,
3644 +}
3645 +
3646 +Ответ: Success
3647 +
3648 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3649 +|ClientId|Идентификатор клиента
3650 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3651 +|PermissibleBalance|Допустимый баланс
3652 +|DefermentDays|(((
3653 +Отсрочка, количество дней
3654 +)))
3655 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3656 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3657 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3658 +
3659 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3660 +
3661 +(% class="box warningmessage" %)
3662 +(((
3663 +**PUT /api/v3/Billing/client/plan**
3664 +)))
3665 +
3666 +Тело запроса:
3667 +
3668 +{
3669 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3670 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3671 + "Features": [
3672 + {
3673 + "Feature": "string",
3674 + "IsEnabled": true,
3675 + "IsFactual": true,
3676 + "Limit": 0,
3677 + "Price": 0,
3678 + "DebitDate": "2023-10-18T13:26:58.987Z",
3679 + "PeriodValue": 0,
3680 + "PeriodType": 0
3681 + }
3682 + ]
3683 +}
3684 +
3685 +Ответ: Success
3686 +
3687 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3688 +|ClientId|Идентификатор клиента
3689 +|PlanId|Идентификатор тарифного плана
3690 +|Feature|Код услуги
3691 +|IsEnabled|Признак, определяющий активирована ли услуга
3692 +|IsFactual|Признак, определяющий расчёт по факту
3693 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3694 +|Price|Цена за единицу.
3695 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3696 +|PeriodValue|Значение периода.
3697 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3698 +
3699 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3700 +
3701 +(% class="box warningmessage" %)
3702 +(((
3703 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3704 +)))
3705 +
3706 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3707 +
3708 +(% class="box infomessage" %)
3709 +(((
3710 +**POST /api/v3/vehicles/import/{agentId}**
3711 +)))
3712 +
3713 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
3714 +
3715 +В пути указывается **agentId** - id клиента.
3716 +
3717 +**Заголовок**
3718 +
3719 +**X-Auth: [токен авторизации]**
3720 +
3721 +**Параметры**
3722 +
3723 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3724 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3725 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
3726 +
3727 +В теле использовать тип **form-data,** тип значения** file**
3728 +
3729 +**Ключи**
3730 +
3731 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3732 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3733 +|csv|В значении передаем файл датчиков, формат **csv**
3734 +
3735 +Ответ:
3736 +
3737 +{
3738 + "vehicleId": 0,
3739 + "name": "string",
3740 + "errors": ["string"]
3741 +}
3742 +
3743 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3744 +|vehicleId|ID созданного объекта
3745 +|name|Имя созданного объекта
3746 +|errors|Ошибки и их описание
3747 +
3748 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3749 +
3750 +(% class="box infomessage" %)
3751 +(((
3752 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3753 +)))
3754 +
3755 +(% class="wikigeneratedid" %)
3756 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3757 +
3758 +(% class="wikigeneratedid" %)
3759 +В пути указывается **vehicleId **- id объекта.
3760 +
3761 +**Заголовок**
3762 +
3763 +**X-Auth: [токен авторизации]**
3764 +
3765 +В теле использовать тип **form-data.**
3766 +
3767 +Ключи:
3768 +
3769 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3770 +|**history**|В значении передавать файл с историей
3771 +
3772 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3773 +
3774 +Ответ:
3775 +
3776 +{
3777 + "results": [
3778 + {
3779 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3780 + "vehicleId": 0,
3781 + "errors": [
3782 + "string"
3783 + ],
3784 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3785 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3786 + "producedCount": 0,
3787 + "msgCount": 0
3788 + }
3789 + ]
3790 +}
3791 +
3792 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3793 +|results|Результаты импорта в разрезе ТС
3794 +|vehicleGuid|Guid ТС
3795 +|vehicleId|ID ТС
3796 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3797 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3798 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3799 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3800 +|msgCount|Кол-во обработанных сообщений всего
3801 +
3802 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3803 +
3804 +(% class="box infomessage" %)
3805 +(((
3806 +**GET /api/v3/vehicles/import/history/status**
3807 +)))
3808 +
3809 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3810 +
3811 +Ответ:
3812 +
3813 +{
3814 + "activity": true,
3815 + "progress": 0,
3816 + "message": "string"
3817 +}
3818 +
3819 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3820 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3821 +|progress|Guid ТС
3822 +
3823 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3824 +
3825 +(% class="box infomessage" %)
3826 +(((
3827 +**POST /api/v3/vehicles/export**
3828 +)))
3829 +
3830 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3831 +
3832 +Тело запроса:
3833 +
3834 +[
3835 + id
3836 +]
3837 +
3838 +Ответ: Success 200, получаете файлы с настройками.
3839 +
3840 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3841 +
3842 +(% class="box infomessage" %)
3843 +(((
3844 +**POST /api/v3/vehicles/export/history**
3845 +)))
3846 +
3847 +Метод возвращает список сообщений терминала объекта за выбранный период.
3848 +
3849 +Тело запроса:
3850 +
3851 +{
3852 + "vehicleId": 0,
3853 + "asArchive": true,
3854 + "from": "2023-09-27T12:17:45.973Z",
3855 + "to": "2023-09-27T12:17:45.973Z"
3856 +}
3857 +
3858 +Ответ:
3859 +
3860 +Получаете файл. Сообщение: Code 200/Success
3861 +
3862 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3863 +|vehicleId|ID объекта
3864 +|asArchive|true - Архивировать файл, False - не архивировать
3865 +|from|Дата и время начала запроса
3866 +|to|Дата и время окончания запроса
3867 +
3868 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3869 +
3870 +(% class="box infomessage" %)
3871 +(((
3872 +**GET /api/v3/vehicles/export/history/status**
3873 +)))
3874 +
3875 +Метод возвращает список сообщений терминала объекта за выбранный период.
3876 +
3877 +Ответ:
3878 +
3879 +{
3880 + "activity": true,
3881 + "progress": 0,
3882 + "message": "string"
3883 +}
3884 +
3885 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3886 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3887 +|progress|Прогресс экспорта, от 0 до 100%
3888 +|message|Текст описывающий статус
3889 +
3890 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3891 +
3892 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3893 +
3894 +(% class="box infomessage" %)
3895 +(((
3896 +**POST /api/v3/EcoDriving/rating**
3897 +)))
3898 +
3899 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3900 +
3901 +Тело запроса:
3902 +
3903 +{
3904 + "vehicleIds": [vehicleId],
3905 + "from": "2023-11-22T09:29:48.051Z",
3906 + "to": "2023-11-22T09:29:48.051Z"
3907 +}
3908 +
3909 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3910 +|vehicleIds|Массив ID объектов
3911 +|from|Дата начала запроса
3912 +|to|Дата окончания запроса
3913 +
3914 +Ответ:
3915 +
3916 +{
3917 + "items": [
3918 + {
3919 + "from": "2023-11-22T09:29:48.052Z",
3920 + "to": "2023-11-22T09:29:48.052Z",
3921 + "vehicleId": 0,
3922 + "vehicleName": "string",
3923 + "vehicleModel": "string",
3924 + "penalty": 0,
3925 + "score": 0,
3926 + "totalViolations": 0,
3927 + "violationsByType": {
3928 + "overspeedingViolations": 0,
3929 + "accelerationViolations": 0,
3930 + "brakingViolations": 0,
3931 + "turningViolations": 0,
3932 + "dangerousDrivingViolations": 0,
3933 + "sensorViolations": 0
3934 + },
3935 + "moveTime": 0,
3936 + "mileage": 0,
3937 + "tripsCount": 0,
3938 + "trips": [
3939 + {
3940 + "penalty": 0,
3941 + "score": 0,
3942 + "violationsCount": 0,
3943 + "violationsByType": {
3944 + "overspeedingViolations": 0,
3945 + "accelerationViolations": 0,
3946 + "brakingViolations": 0,
3947 + "turningViolations": 0,
3948 + "dangerousDrivingViolations": 0,
3949 + "sensorViolations": 0
3950 + },
3951 + "moveTime": 0,
3952 + "mileage": 0,
3953 + "motohours": 0,
3954 + "maxSpeed": 0,
3955 + "startAddress": "string",
3956 + "endAddress": "string",
3957 + "drivers": [
3958 + {
3959 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3960 + "driverName": "string",
3961 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3962 + }
3963 + ]
3964 + }
3965 + ]
3966 + }
3967 + ]
3968 +}
3969 +
3970 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3971 +|from|Дата начала запроса
3972 +|to|Дата  окончания
3973 +|vehicleId|ID объекта
3974 +|vehicleName|Имя объекта
3975 +|vehicleModel|Модель объекта
3976 +|penalty|Сумма штрафных баллов
3977 +|score|Оценка
3978 +|totalViolations|Суммарное количество нарушений
3979 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3980 +|overspeedingViolations|Превышение скорости
3981 +|accelerationViolations|Ускорение
3982 +|brakingViolations|Торможение
3983 +|turningViolations|Резкий поворот
3984 +|dangerousDrivingViolations|Резкое вождение
3985 +|sensorViolations|Нарушение по датчику
3986 +|moveTime|Время в движении
3987 +|mileage|Пробег
3988 +|tripsCount|Количество рейсов
3989 +|motohours|Моточасы
3990 +|maxSpeed|Максимальная скорость
3991 +|startAddress|Адрес начала рейса
3992 +|endAddress|Адрес окончания рейса
3993 +|drivers|Список водителей, которые были на объекте в течениии рейса
3994 +|driverGuid|Guid водителя
3995 +|driverName|Имя водителя
3996 +|driverRfid|Номер Карты-метки
3997 +
3998 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3999 +
4000 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4001 +
4002 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4003 +
4004 +(% class="box infomessage" %)
4005 +(((
4006 +POST /api/v3/fuelcards/transactions
4007 +)))
4008 +
4009 +Метод запроса: POST
4010 +
4011 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4012 +\\В заголовках запроса: X-Auth: Токен авторизации
4013 +
4014 +Параметры в теле запроса (JSON):
4015 +
4016 +{
4017 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4018 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4019 + "ids": [ 
4020 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4021 + ],
4022 + "timezone": 0 ~/~/Таймзона
4023 +}
4024 +
4025 +
4026 +Ответ:
4027 + {
4028 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4029 + "driver": "string", ~/~/Водители, привязанные к ТК
4030 + "object": "string", ~/~/Наименование ТС
4031 + "amount": 0, ~/~/Количество топлива
4032 + "amountDut": 0, ~/~/Количество по ДУТ
4033 + "amountDiff": 0, ~/~/Разница, л
4034 + "amountDiffPerc": 0, ~/~/Разница, %
4035 + "summa": 0, ~/~/Стоимость, руб
4036 + "serviceName": "string", ~/~/Тип топлива
4037 + "price": 0, ~/~/Цена за литр, руб
4038 + "cardName": "string", ~/~/Наименование ТК
4039 + "cardNum": "string", ~/~/Номер ТК
4040 + "operator": "string", ~/~/Оператор ТК
4041 + "address": "string" ~/~/Адрес АЗС
4042 + }
4043 +
4044 +
4045 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4046 +
4047 +
4048 +== **Получение полных данных о ретрансляторе** ==
4049 +
4050 +(% class="box infomessage" %)
4051 +(((
4052 +**GET ** **/api/v3/retranslations/{id}**
4053 +)))
4054 +
4055 +Идентификатор запроса: ID
4056 +
4057 +
4058 +Пример ответа:
4059 +
4060 +{  
4061 +"description": "", ~/~/ Определяет описание
4062 +"subscriberId": "", ~/~/ Подписчик
4063 +"protocolType": 0, ~/~/ Тип протокола
4064 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4065 +"address": "string", ~/~/ Адрес события
4066 +"objects": [ ~/~/Объекты для ретрансляции
4067 +{      
4068 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4069 +"name": "", ~/~/ Наименование объекта ретрансляции
4070 +"imei": "", ~/~/ IMEI объекта  
4071 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4072 +}
4073 + ],  
4074 +"id": "", ~/~/ идентификатор пользователя   
4075 +"parentId": "", ~/~/Guid родителя
4076 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4077 +}
4078 +
4079 +
4080 +== **Удаление данных ретранслятора** ==
4081 +
4082 +(% class="box infomessage" %)
4083 +(((
4084 +**DELETE** **/api/v3/retranslations/{id}**
4085 +)))
4086 +
4087 +Параметр запроса: ID
4088 +
4089 +
4090 +== **Создание ретранслятора** ==
4091 +
4092 +(% class="box infomessage" %)
4093 +(((
4094 +**POST ** **/api/v3/retranslations/{id}**
4095 +)))
4096 +
4097 +Запрос:
4098 +
4099 +{  
4100 +"description": "", ~/~/ Описание
4101 +"subscriberId": "", ~/~/ Подписчик
4102 +"protocolType": 0, ~/~/ Тип протокола
4103 +"address": "", ~/~/ Адрес ретрансляции
4104 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4105 +"objects": [ ~/~/Объекты для ретрансляции
4106 +{      
4107 +"id": "", ~/~/ идентификатор пользователя     
4108 +"imei": "", ~/~/IMEI объекта
4109 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4110 +}
4111 + ]
4112 +}
4113 +
4114 +
4115 +Ответ:
4116 +
4117 +{  
4118 +"description": "string", ~/~/ Определяет описание
4119 +"subscriberId": "", ~/~/ идентификатор запроса
4120 +"protocolType": 0, ~/~/ Тип протокола
4121 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4122 +"address": "", ~/~/ Адрес события
4123 +"objects": [ ~/~/Объекты для ретрансляции
4124 +{      
4125 +"id": "", ~/~/ идентификатор пользователя    
4126 +"name": "string", ~/~/ Название уведомления
4127 +"imei": "string", ~/~/IMEI объекта  
4128 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4129 +}
4130 + ],  
4131 +"id": "", ~/~/ идентификатор пользователя  
4132 +"parentId": "", ~/~/ Guid идентификатор родителя
4133 +"deleted": true ~/~/ Признак удаления
4134 +}
4135 +
4136 +
4137 +== **Редактирование ретранслятора** ==
4138 +
4139 +(% class="box infomessage" %)
4140 +(((
4141 +**PUT** **/api/v3/retranslations**
4142 +)))
4143 +
4144 +Пример запроса:
4145 +
4146 +{  
4147 +"id": "", ~/~/ идентификатор пользователя   
4148 +"description": "string", ~/~/ Определяет описание
4149 +"subscriberId": "", ~/~/ идентификатор запроса
4150 +"protocolType": 0, ~/~/ Тип протокола
4151 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4152 +"address": "string", ~/~/ Адрес события
4153 +"objects": ~/~/Объекты для ретрансляции
4154 +[    
4155 +{      
4156 +"id": "",  ~/~/ идентификатор пользователя         
4157 +"imei": "", ~/~/IMEI объекта
4158 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4159 +}
4160 + ]
4161 +}
4162 +
4163 +
4164 +Пример ответа:
4165 +
4166 +{  
4167 +"description": "", ~/~/ Определяет описание
4168 +"subscriberId": "", ~/~/ идентификатор запроса
4169 +"protocolType": 0, ~/~/ Тип протокола
4170 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4171 +"address": "string", ~/~/ Адрес события
4172 +"objects": [ ~/~/Объекты для ретрансляции
4173 +{      
4174 +"id": "", ~/~/ идентификатор пользователя     
4175 +"name": "string", ~/~/ Название уведомления    
4176 +"imei": "", ~/~/IMEI объекта
4177 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4178 +}
4179 + ],
4180 +"id": "", ~/~/ идентификатор пользователя   
4181 +"parentId": "", ~/~/ Guid идентификатор родителя
4182 +"deleted": true ~/~/ Признак удаления
4183 +}
4184 +
4185 +
4186 +== **Получение списка ретранслятора клиента** ==
4187 +
4188 +(% class="box infomessage" %)
4189 +(((
4190 +**POST /api/v3/retranslations/find**
4191 +)))
4192 +
4193 +Пример запроса:
4194 +
4195 +{  
4196 +"id": "", ~/~/ идентификатор пользователя   
4197 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4198 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4199 +}
4200 +
4201 +Ответ:
4202 +
4203 +[ 
4204 +{    
4205 +"description": "", ~/~/ Определяет описание
4206 +"subscriberId": "", ~/~/ идентификатор запроса
4207 +"protocolType": 0, ~/~/ Тип протокола
4208 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4209 +"address": "string", ~/~/ Адрес события
4210 +"id": "", ~/~/ идентификатор пользователя   
4211 +"parentId": "", ~/~/ Guid идентификатор родителя
4212 +"deleted": true ~/~/ Признак удаления
4213 +}
4214 +]
4215 +
4216 +
4217 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4218 +
4219 +== **API для отчета по выгрузке комбайнов** ==
4220 +
4221 +(% class="box infomessage" %)
4222 +(((
4223 +POST **/api/v3/Reports/harvesterUnloading**
4224 +)))
4225 +
4226 +Пример запроса:
4227 +
4228 +{
4229 + "byTime": 0, ~/~/ Объединение событий по времени
4230 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4231 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4232 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4233 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4234 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4235 + 0
4236 + ],
4237 + "from": "", ~/~/ Дата и время начало запроса
4238 + "to": "", ~/~/ Дата и время окончания запроса
4239 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4240 +}
4241 +
4242 +Пример ответа:
4243 +
4244 +[ 
4245 + {
4246 + "harvesterName": "", ~/~/Комбайн, номер
4247 + "harvesterId": 0, ~/~/Комбайн, id
4248 +"harvesterModel": "", ~/~/ Модель комбайна
4249 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4250 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4251 + "events": [ ~/~/Список событий в разрезе комбайна
4252 + {
4253 + "driverId": "", ~/~/Идентификатор водителя
4254 + "driverName": "", ~/~/Водитель комбайна, ФИО
4255 + "RFID": "", ~/~/ идентификатор карты-метки
4256 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4257 + "vehicleId": 0, ~/~/идентификатор объекта
4258 + "vehicleName": "string", ~/~/ Имя объекта
4259 + "modelName": "string", ~/~/ Имя модели объекта
4260 + "nearestVehicles": [ ~/~/Объекты рядом
4261 + {
4262 + "vehicleId": 0, ~/~/идентификатор объекта
4263 + "vehicleName": "string" ~/~/ Имя объекта
4264 + }
4265 + ],
4266 + "fields": [ ~/~/Поля, где происходила выгрузка
4267 + {
4268 + "id": 0, ~/~/ идентификатор пользователя 
4269 + "name": "string" ~/~/ имя пользователя 
4270 + }
4271 + ],
4272 + "event": "string", ~/~/Событие
4273 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4274 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4275 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4276 + "cultureName": "string", ~/~/ название культуры
4277 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4278 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4279 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4280 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4281 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4282 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4283 + "issued": 0, ~/~/Выдано, бункеров
4284 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4285 + "latitude": 0, ~/~/Широта
4286 + "longitude": 0, ~/~/ Долгота
4287 + "litresAway": 0, ~/~/Отдано, л
4288 + "m3Away": 0 ~/~/Отдано, м3
4289 + }
4290 + ]
4291 + }
4292 +]
4293 +
4294 +
4295 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4296 +
4297 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4298 +
4299 +
4300 +(% class="box infomessage" %)
4301 +(((
4302 +GET api/v3/Vehicles/recyclebin/all
4303 +)))
4304 +
4305 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4306 +
4307 +Параметр запроса: {parentId} - идентификатор агента
4308 +
4309 +В заголовках запроса: X-Auth: Токен авторизации
4310 +
4311 +Ответ:
4312 +
4313 +[ 
4314 + {
4315 + "recordTime": "", ~/~/Время записи
4316 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4317 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4318 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4319 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4320 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4321 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4322 + "items": [ ~/~/ 
4323 +nullable: true ~/~/Детали
4324 + {
4325 + "name": "string", ~/~/наименование столбца
4326 + "value": "string" ~/~/содержание столбца
4327 + }
4328 + ]
4329 + },
4330 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4331 + "string"
4332 + ]
4333 + }
4334 +]
4335 +
4336 +
4337 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4338 +
4339 +(% class="box infomessage" %)
4340 +(((
4341 +POST/api/v3/Vehicles/recyclebin/erase
4342 +)))
4343 +
4344 +В заголовках запроса: X-Auth: Токен авторизации
4345 +
4346 +Пример запроса:
4347 +
4348 +[
4349 +0
4350 +]
4351 +
4352 +
4353 +Пример ответа:
4354 +
4355 +[ 
4356 +{
4357 + "recordTime": "", ~/~/Время записи
4358 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4359 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4360 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4361 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4362 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4363 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4364 + "items": [ ~/~/Детали
4365 + {
4366 + "name": "", ~/~/Имя свойства
4367 + "value": "" ~/~/Значение свойства
4368 + }
4369 + ]
4370 + },
4371 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4372 + ""
4373 + ]
4374 + }
4375 +]
4376 +
4377 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4378 +
4379 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4380 +
4381 +(% class="box infomessage" %)
4382 +(((
4383 +POST/api/v3/Vehicles/recyclebin/restore
4384 +)))
4385 +
4386 +В заголовках запроса: X-Auth: Токен авторизации
4387 +
4388 +Параметры в теле запроса (JSON):
4389 +
4390 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4391 +
4392 +В заголовках запроса: X-Auth: Токен авторизации
4393 +
4394 +
4395 +Пример запроса:
4396 +
4397 +(((
4398 +[
4399 +)))
4400 +
4401 +(((
4402 + 0
4403 +)))
4404 +
4405 +(((
4406 +]
4407 +)))
4408 +
4409 +
4410 +Пример ответа:
4411 +
4412 +[
4413 +{
4414 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4415 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4416 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4417 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4418 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4419 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4420 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4421 + "items": [ ~/~/Детали
4422 + {
4423 + "name": "string", ~/~/Имя свойства
4424 + "value": "string" ~/~/Значение свойства
4425 + }
4426 + ]
4427 + },
4428 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4429 + "string"
4430 + ]
4431 + }
4432 +]
4433 +
4434 +
4435 +
2781 2781  (% class="box" lang="en-US" style="text-align: center;" %)
2782 2782  (((
2783 2783  (% 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 г.