Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 142.1 >
edited by Андрей Калиновский
on 2024/02/28 10:46
To version < 112.1 >
edited by Илья Крайнов
on 2023/10/18 17:20
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,6 +40,7 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -54,12 +54,6 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 -
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -98,51 +98,30 @@
98 98  Запрос должен содержать данные параметра "**agentId**"
99 99  
100 100  (% style="color:#000000" %)Ответ:
96 +А
101 101  {
102 - "agentId": "",  (%%)
103 - "parentId": "",
104 - "parentName": "string",
105 - "name": "string",
106 - "fullName": "string",
107 - "agentInfoType": 0,
108 - "isForeign": true/false,
109 - "district": "string", 
110 - "region": "string",
111 - "city": "string",
112 - "inn": "string",
113 - "kpp": "string",
114 - "address": "string",
115 - "addressFact": "string",
116 - "email": "string",
117 - "director": "string",
118 - "bankName": "string",
119 - "bankBIK": "string",
120 - "bankRS": "string",
121 - "bankKS": "string"
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
122 122   }
123 123  
124 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145 -
146 146  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147 147  
148 148  (% class="box infomessage" %)
... ... @@ -156,7 +156,7 @@
156 156  
157 157  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
158 158  
159 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
160 160  
161 161  (% style="color:#000000" %)Метод запроса: **POST**
162 162  
... ... @@ -171,23 +171,15 @@
171 171  (% style="color:#000000" %)Ответ:
172 172  
173 173  {
174 - "agentId": "",(% style="color:#000000" %)   (%%)
175 - "parentId": "",
176 - "name": "string",
177 - "fullName": "string",
178 - "agentInfoType": 0,
179 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
180 180  }
181 181  
182 -
183 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
186 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
189 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
190 -
191 191  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
192 192  
193 193  (% class="box successmessage" %)
... ... @@ -206,7 +206,7 @@
206 206  Параметры в теле запроса (JSON):
207 207  
208 208  {
209 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
210 210   "name": "string", ~/~/ имя
211 211   "fullName": "string", ~/~/ полное наименование
212 212   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -251,28 +251,6 @@
251 251   "bankKS": "string" ~/~/ корр. счёт
252 252  }
253 253  
254 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
255 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
256 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
257 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
258 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
259 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
260 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
261 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
262 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
263 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
264 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
265 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
266 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
267 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
268 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
269 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
270 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
271 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
272 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
273 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
274 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
275 -
276 276  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
277 277  
278 278  (% class="box warningmessage" %)
... ... @@ -288,6 +288,7 @@
288 288  
289 289  В заголовках запроса: X-Auth: Токен авторизации
290 290  
235 +
291 291  Параметры в теле запроса (JSON):
292 292  
293 293  {
... ... @@ -312,6 +312,7 @@
312 312   "bankKS": "string" ~/~/ корр. счёт
313 313  }
314 314  
260 +
315 315  Ответ:
316 316  
317 317  {
... ... @@ -354,21 +354,6 @@
354 354  
355 355  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
356 356  
357 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
358 -
359 -(% class="box warningmessage" %)
360 -(((
361 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
362 -)))
363 -
364 -Метод позволяет изменить статус клиента, указанного в запросе.
365 -
366 -В пути указывается GUID клиента и статус клиента.
367 -
368 -**status **- значение 0 - заблокирован, 1 - активен.
369 -
370 -Ответ: Code 204
371 -
372 372  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
373 373  
374 374  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -432,6 +432,7 @@
432 432   "password": "string",
433 433   "email": "string",
434 434  
366 +
435 435  (% style="text-align:left" %)
436 436  (% style="color:#000000; font-weight:normal" %)Ответ:
437 437  
... ... @@ -460,7 +460,6 @@
460 460  (% style="text-align:left" %)
461 461  (% style="color:#000000; font-weight:normal" %)}
462 462  
463 -
464 464  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465 465  
466 466  (% class="box infomessage" %)
... ... @@ -780,6 +780,7 @@
780 780   "maxspeed": 0,
781 781   "width": 0,
782 782   "imbeddedtrailer": true,
714 + "fueloutlay": 0,
783 783   "hoppercapacity": 0,
784 784   "hopperdischargespeed": 0,
785 785   "modelType": 0,
... ... @@ -796,8 +796,9 @@
796 796  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
797 797  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
798 798  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
799 799  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
800 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
801 801  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
802 802  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
803 803  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -889,24 +889,12 @@
889 889   "maxspeed": 0,
890 890   "width": 0,
891 891   "imbeddedtrailer": true,
825 + "fueloutlay": 0,
892 892   "hoppercapacity": 0,
893 893   "hopperdischargespeed": 0,
894 894   "modelType": 0
895 895  }
896 896  
897 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
898 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
899 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
900 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
901 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
902 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
903 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
904 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
905 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
906 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
907 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
908 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
909 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
910 910  
911 911  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
912 912  
... ... @@ -961,20 +961,6 @@
961 961   "modelType": 0
962 962  }
963 963  
964 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
965 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
966 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
967 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
968 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
969 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
970 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
971 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
972 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
973 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
974 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
975 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
976 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
977 -
978 978  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
979 979  
980 980  (% class="box errormessage" %)
... ... @@ -1802,7 +1802,7 @@
1802 1802  
1803 1803  (% style="color:#000000" %)Метод запроса: **GET**
1804 1804  
1805 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1712 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1806 1806  
1807 1807  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1808 1808  
... ... @@ -1885,51 +1885,6 @@
1885 1885   }
1886 1886  ]
1887 1887  
1888 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889 -
1890 -(% class="box infomessage" style="text-align: left;" %)
1891 -(((
1892 -**POST /api/v3/terminalMessages/mapping**
1893 -)))
1894 -
1895 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896 -
1897 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898 -
1899 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900 -
1901 -{
1902 - "protocolType": 0,
1903 - "params": ["string"]
1904 -}
1905 -
1906 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 -|protocolType|ID типа протокола
1908 -|params|(((
1909 -Массив наименований параметров в сообщении
1910 -)))
1911 -
1912 -Ответ:
1913 -
1914 -{
1915 - "protocolType": 0,
1916 - "mapping": {
1917 - "additionalProp1": {
1918 - "inputType": 0,
1919 - "inputNumber": 0
1920 - },
1921 - "additionalProp2": {
1922 - "inputType": 0,
1923 - "inputNumber": 0
1924 - }
1925 - }
1926 -}
1927 -
1928 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 -|protocolType|Тип протокола
1930 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 -|inputNumber|Номер входа
1932 -
1933 1933  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1934 1934  
1935 1935  (% class="box infomessage" %)
... ... @@ -1954,11 +1954,6 @@
1954 1954   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1955 1955  }
1956 1956  
1957 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 -|vehicleId|ID объекта
1959 -|from|Дата и время начала периода запроса
1960 -|to|Дата и время окончания периода запроса
1961 -
1962 1962  Ответ:
1963 1963  
1964 1964  [
... ... @@ -1965,43 +1965,80 @@
1965 1965   {
1966 1966   "messages": [
1967 1967   {
1968 - "deviceTime": "2023-11-29T07:40:44.052Z",
1969 - "serverTime": "2023-11-29T07:40:44.052Z",
1970 - "speed": 0,
1971 - "altitude": 0,
1972 - "latitude": 0,
1973 - "longitude": 0,
1974 - "satellites": 0,
1975 - "course": 0,
1976 - "voltage": 0,
1977 - "parameters": {
1825 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1826 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1827 + "speed": 0, ~/~/ Скорость, км/ч
1828 + "altitude": 0, ~/~/ Высота, м
1829 + "latitude": 0, ~/~/ Широта [-90°;90°]
1830 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1831 + "satellites": 0, ~/~/ Кол-во спутников
1832 + "voltage": 0, ~/~/ Напряжение
1833 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1978 1978   "additionalProp1": "string",
1979 1979   "additionalProp2": "string",
1980 1980   "additionalProp3": "string"
1981 1981   },
1982 - "photoCount": 0,
1983 - "lbsCorrectedCoords": true,
1984 - "protocolType": 0
1838 + "photoCount": 0 ~/~/ Кол-во фото
1985 1985   }
1986 1986   ]
1987 1987   }
1988 1988  ]
1989 1989  
1990 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 -|deviceTime|Время сообщения терминала
1992 -|serverTime|Время когда сообщение поступило на сервер
1993 -|speed|Скорость
1994 -|altitude|Высота над уровнем моря
1995 -|latitude|Широта
1996 -|longitude|Долгота
1997 -|satellites|Кол-во спутников
1998 -|course|Курс
1999 -|voltage|Бортовое напряжение
2000 -|parameters|Список параметров и их значений
2001 -|photoCount|Количество фото
2002 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 -|protocolType|ID типа протокола
1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
2004 2004  
1846 +(% class="box infomessage" %)
1847 +(((
1848 +**POST /api/v3/vehicles/export/history**
1849 +)))
1850 +
1851 +Метод возвращает список сообщений терминала объекта за выбранный период.
1852 +
1853 +(% style="text-align: left;" %)
1854 +Метод запроса **POST**
1855 +
1856 +(% style="text-align: left;" %)
1857 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1858 +
1859 +(% style="text-align: left;" %)
1860 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1861 +
1862 +{
1863 + "vehicleId": 0, ~/~/ ID объекта
1864 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1865 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1866 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1867 +}
1868 +
1869 +Ответ:
1870 +
1871 +Получаете файл. Сообщение: Code 200/Success
1872 +
1873 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1874 +
1875 +(% class="box infomessage" %)
1876 +(((
1877 +**GET /api/v3/vehicles/export/history/status**
1878 +)))
1879 +
1880 +Метод возвращает список сообщений терминала объекта за выбранный период.
1881 +
1882 +(% style="text-align: left;" %)
1883 +Метод запроса **GET**
1884 +
1885 +(% style="text-align: left;" %)
1886 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1887 +
1888 +(% style="text-align: left;" %)
1889 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1890 +
1891 +Ответ:
1892 +
1893 +{
1894 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1895 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1896 + "message": "string" ~/~/ текст описывающий статус.
1897 +}
1898 +
2005 2005  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 2006  
2007 2007  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2135,129 +2135,6 @@
2135 2135   }
2136 2136  ]
2137 2137  
2138 -
2139 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2140 -
2141 -(% class="box infomessage" %)
2142 -(((
2143 -**POST /api/v3/vehicles/moveStop**
2144 -)))
2145 -
2146 -Метод запроса: **POST**
2147 -
2148 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2149 -
2150 -В заголовках запроса: X-Auth: Токен авторизации
2151 -
2152 -
2153 -Тело запроса:
2154 -
2155 -{
2156 -
2157 - "vehicleIds": [ ], ~/~/ Список ID объектов
2158 -
2159 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2160 -
2161 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2162 -
2163 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2164 -
2165 -}
2166 -
2167 -Ответ:
2168 -
2169 -[
2170 -
2171 - {
2172 -
2173 - "vehicleId": 0, ~/~/ ID объекта
2174 -
2175 - "vehicleName": "string", ~/~/ Имя объекта
2176 -
2177 - "moves": [ ~/~/ Событие движения
2178 -
2179 - {
2180 -
2181 - "mileage": 0, ~/~/ Пробег, км
2182 -
2183 - "eventId": 0, ~/~/ Идентификатор события
2184 -
2185 - "eventName": "string", ~/~/ Название события
2186 -
2187 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2188 -
2189 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2190 -
2191 - "duration": 0 ~/~/ Продолжительность события, секунд
2192 -
2193 - }
2194 -
2195 - ],
2196 -
2197 - "stops": [ ~/~/ События стоянок
2198 -
2199 - {
2200 -
2201 - "address": "string", ~/~/ Адрес события
2202 -
2203 - "eventId": 0, ~/~/ Идентификатор события
2204 -
2205 - "eventName": "string", ~/~/ Название события
2206 -
2207 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2208 -
2209 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2210 -
2211 - "duration": 0 ~/~/ Продолжительность события, секунд
2212 -
2213 -
2214 - }
2215 -
2216 - ]
2217 -
2218 - }
2219 -
2220 -]
2221 -
2222 -
2223 -
2224 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2225 -
2226 -(% class="box infomessage" %)
2227 -(((
2228 -**POST /api/v3/vehicles/getlastdata**
2229 -)))
2230 -
2231 -Метод запроса: **POST**
2232 -
2233 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2234 -
2235 -В заголовках запроса: X-Auth: Токен авторизации
2236 -
2237 -
2238 -В теле запроса перечисляете массив id объектов
2239 -
2240 -Ответ:
2241 - {
2242 - "vehicleId": 0, ~/~/Идентификатор объекта.
2243 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2244 - "vehicleNumber": "string",~/~/Номер объекта.
2245 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2246 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2247 - "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных.
2248 - "speed": 0,~/~/Скорость объекта.
2249 - "course": 0,~/~/Курс движения [0;360]
2250 - "latitude": 0,~/~/Широта [-90°;90°].
2251 - "longitude": 0,~/~/Долгота [-180°;180°].
2252 - "address": "string",~/~/Адрес.
2253 - "geozones": [ ~/~/Сведения по геозонам.
2254 - {
2255 - "id": 0,
2256 - "name": "string"
2257 - }
2258 -
2259 -
2260 -
2261 2261  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2262 2262  
2263 2263  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3156,83 +3156,6 @@
3156 3156  Success
3157 3157  
3158 3158  
3159 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3160 -
3161 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3162 -
3163 -(% class="box infomessage" %)
3164 -(((
3165 -**POST /api/v3/Trailers**
3166 -)))
3167 -
3168 -Пример запроса:
3169 -
3170 -{
3171 - "startDate": "2023-11-14T10:48:03.671Z",
3172 - "endDate": "2023-11-14T10:48:03.671Z",
3173 - "ids": [ 0 ],
3174 - "timezone": 0
3175 -}
3176 -
3177 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3178 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3179 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3180 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3181 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3182 -
3183 -Пример ответа:
3184 -
3185 -[
3186 - {
3187 - "SD": "2023-11-14T10:48:03.717Z",
3188 - "ED": "2023-11-14T10:48:03.717Z", 
3189 - "id": 0,
3190 - "SLat": 0,
3191 - "SLon": 0,
3192 - "ELat": 0,
3193 - "ELon": 0,
3194 - "mileage": 0
3195 - "Duration": 0
3196 - "Address": "string",
3197 - "Address2": "string",
3198 - "name": "string",
3199 - "rid": "string",
3200 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3201 - "trailer": {
3202 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3203 - "Number": "string",
3204 - "Description": "string",
3205 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3206 - "ExternalID": "string",
3207 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3208 - "CreateTime": "2023-11-14T10:48:03.717Z",
3209 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3210 - "IsDeleted": true
3211 - },
3212 - "filesCount": 0,
3213 - }
3214 -]
3215 -
3216 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3217 -|SD|Дата и время начала события
3218 -|ED|Дата и время окончания события
3219 -|id|ID объекта
3220 -|SLat|Широта начальной координаты
3221 -|SLon|Долгота начальной координаты
3222 -|ELat|Широта конечной координаты
3223 -|ELon|Долгота конечной координаты
3224 -|mileage|Пробег
3225 -|Duration|Продолжительность
3226 -|Address|Адрес начального местоположения
3227 -|Address2|Адрес конечного местоположения
3228 -|name|Имя радиометки
3229 -|rid|Номер радиометки
3230 -|rguid|ID радиометки
3231 -|trailer|Информация об агрегате
3232 -|ModelGuid|ID агрегата
3233 -|Number|Название/номер агрегата
3234 -|Description|Текст примечания агрегата
3235 -
3236 3236  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3237 3237  
3238 3238  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3254,19 +3254,13 @@
3254 3254   {
3255 3255   "name": "string",
3256 3256   "number": 0,
3257 - "period": 0,
2951 + "period": 0, ~/~/ Частота трансляции радиометки
3258 3258   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3259 3259   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "deleted": true
3260 3260   }
3261 3261  ]
3262 3262  
3263 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3264 -|parentId|ID клиента
3265 -|name|Название карты-метки
3266 -|number|Номер
3267 -|period|Период запросов в секундах (работает только для агрегатов)
3268 -|id|ID карты-метки
3269 -
3270 3270  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3271 3271  
3272 3272  (% class="box infomessage" %)
... ... @@ -3282,18 +3282,13 @@
3282 3282   {
3283 3283   "name": "string",
3284 3284   "number": 0,
3285 - "period": 0,
2973 + "period": 0, ~/~/ Частота трансляции радиометки
3286 3286   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3287 3287   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "deleted": true
3288 3288   }
3289 3289  ]
3290 3290  
3291 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3292 -|name|Название карты-метки
3293 -|number|Номер
3294 -|period|Период запросов в секундах (работает только для агрегатов)
3295 -|id|ID карты-метки
3296 -|parentId|ID клиента
3297 3297  
3298 3298  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3299 3299  
... ... @@ -3309,6 +3309,7 @@
3309 3309   "number": 0,
3310 3310   "period": 0,
3311 3311   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 + "deleted": true
3312 3312  }
3313 3313  
3314 3314  Ответ:
... ... @@ -3319,15 +3319,9 @@
3319 3319   "period": 0,
3320 3320   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3321 3321   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3006 + "deleted": true
3322 3322  }
3323 3323  
3324 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3325 -|name|Название карты-метки
3326 -|number|Номер
3327 -|period|Период запросов в секундах (работает только для агрегатов)
3328 -|id|ID карты-метки
3329 -|parentId|ID клиента
3330 -
3331 3331  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3332 3332  
3333 3333  (% class="box warningmessage" %)
... ... @@ -3343,6 +3343,7 @@
3343 3343   "period": 0,
3344 3344   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3345 3345   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3024 + "deleted": true
3346 3346  }
3347 3347  
3348 3348  Ответ:
... ... @@ -3353,15 +3353,9 @@
3353 3353   "period": 0,
3354 3354   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3355 3355   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 + "deleted": true
3356 3356  }
3357 3357  
3358 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3359 -|name|Название карты-метки
3360 -|number|Номер
3361 -|period|Период запросов в секундах (работает только для агрегатов)
3362 -|id|ID карты-метки
3363 -|parentId|ID клиента
3364 -
3365 3365  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3366 3366  
3367 3367  (% class="box errormessage" %)
... ... @@ -3369,7 +3369,7 @@
3369 3369  **DELETE /api/v3/Rfids/{rfidGuid}**
3370 3370  )))
3371 3371  
3372 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3045 +Передаем параметр rfidGuid - идентификатор карты-метки
3373 3373  
3374 3374  Ответ:
3375 3375  
... ... @@ -3610,8 +3610,6 @@
3610 3610  **PUT /api/v3/Billing/client/balance**
3611 3611  )))
3612 3612  
3613 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3614 -
3615 3615  Тело запроса:
3616 3616  
3617 3617  {
... ... @@ -3625,50 +3625,6 @@
3625 3625  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3626 3626  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3627 3627  
3628 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3629 -
3630 -(% class="box warningmessage" %)
3631 -(((
3632 -**PUT /api/v3/billing/client/balance/deposit**
3633 -)))
3634 -
3635 -Создает операцию **Пополнение **с указанной суммой
3636 -
3637 -Тело запроса:
3638 -
3639 -{
3640 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3641 - "Balance": 0
3642 -}
3643 -
3644 -Ответ: Success
3645 -
3646 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3647 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3648 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3649 -
3650 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3651 -
3652 -Создает операцию **Списание **с указанной суммой
3653 -
3654 -(% class="box warningmessage" %)
3655 -(((
3656 -**PUT /api/v3/billing/client/balance/withdraw**
3657 -)))
3658 -
3659 -Тело запроса:
3660 -
3661 -{
3662 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3663 - "Balance": 0
3664 -}
3665 -
3666 -Ответ: Success
3667 -
3668 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3669 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3670 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3671 -
3672 3672  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3673 3673  
3674 3674  (% class="box warningmessage" %)
... ... @@ -3741,305 +3741,6 @@
3741 3741  |PeriodValue|Значение периода.
3742 3742  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3743 3743  
3744 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3745 -
3746 -(% class="box warningmessage" %)
3747 -(((
3748 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3749 -)))
3750 -
3751 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3752 -
3753 -(% class="box infomessage" %)
3754 -(((
3755 -**POST /api/v3/vehicles/import/{agentId}**
3756 -)))
3757 -
3758 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3759 -
3760 -В пути указывается **agentId** - id клиента.
3761 -
3762 -**Заголовок**
3763 -
3764 -**X-Auth: [токен авторизации]**
3765 -
3766 -**Параметры**
3767 -
3768 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3769 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3770 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3771 -
3772 -В теле использовать тип **form-data,** тип значения** file**
3773 -
3774 -**Ключи**
3775 -
3776 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3777 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3778 -|csv|В значении передаем файл датчиков, формат **csv**
3779 -
3780 -Ответ:
3781 -
3782 -{
3783 - "vehicleId": 0,
3784 - "name": "string",
3785 - "errors": ["string"]
3786 -}
3787 -
3788 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3789 -|vehicleId|ID созданного объекта
3790 -|name|Имя созданного объекта
3791 -|errors|Ошибки и их описание
3792 -
3793 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3794 -
3795 -(% class="box infomessage" %)
3796 -(((
3797 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3798 -)))
3799 -
3800 -(% class="wikigeneratedid" %)
3801 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3802 -
3803 -(% class="wikigeneratedid" %)
3804 -В пути указывается **vehicleId **- id объекта.
3805 -
3806 -**Заголовок**
3807 -
3808 -**X-Auth: [токен авторизации]**
3809 -
3810 -В теле использовать тип **form-data.**
3811 -
3812 -Ключи:
3813 -
3814 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3815 -|**history**|В значении передавать файл с историей
3816 -
3817 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3818 -
3819 -Ответ:
3820 -
3821 -{
3822 - "results": [
3823 - {
3824 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3825 - "vehicleId": 0,
3826 - "errors": [
3827 - "string"
3828 - ],
3829 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3830 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3831 - "producedCount": 0,
3832 - "msgCount": 0
3833 - }
3834 - ]
3835 -}
3836 -
3837 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3838 -|results|Результаты импорта в разрезе ТС
3839 -|vehicleGuid|Guid ТС
3840 -|vehicleId|ID ТС
3841 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3842 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3843 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3844 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3845 -|msgCount|Кол-во обработанных сообщений всего
3846 -
3847 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3848 -
3849 -(% class="box infomessage" %)
3850 -(((
3851 -**GET /api/v3/vehicles/import/history/status**
3852 -)))
3853 -
3854 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3855 -
3856 -Ответ:
3857 -
3858 -{
3859 - "activity": true,
3860 - "progress": 0,
3861 - "message": "string"
3862 -}
3863 -
3864 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3865 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3866 -|progress|Guid ТС
3867 -
3868 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3869 -
3870 -(% class="box infomessage" %)
3871 -(((
3872 -**POST /api/v3/vehicles/export**
3873 -)))
3874 -
3875 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3876 -
3877 -Тело запроса:
3878 -
3879 -[
3880 - id
3881 -]
3882 -
3883 -Ответ: Success 200, получаете файлы с настройками.
3884 -
3885 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3886 -
3887 -(% class="box infomessage" %)
3888 -(((
3889 -**POST /api/v3/vehicles/export/history**
3890 -)))
3891 -
3892 -Метод возвращает список сообщений терминала объекта за выбранный период.
3893 -
3894 -Тело запроса:
3895 -
3896 -{
3897 - "vehicleId": 0,
3898 - "asArchive": true,
3899 - "from": "2023-09-27T12:17:45.973Z",
3900 - "to": "2023-09-27T12:17:45.973Z"
3901 -}
3902 -
3903 -Ответ:
3904 -
3905 -Получаете файл. Сообщение: Code 200/Success
3906 -
3907 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3908 -|vehicleId|ID объекта
3909 -|asArchive|true - Архивировать файл, False - не архивировать
3910 -|from|Дата и время начала запроса
3911 -|to|Дата и время окончания запроса
3912 -
3913 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3914 -
3915 -(% class="box infomessage" %)
3916 -(((
3917 -**GET /api/v3/vehicles/export/history/status**
3918 -)))
3919 -
3920 -Метод возвращает список сообщений терминала объекта за выбранный период.
3921 -
3922 -Ответ:
3923 -
3924 -{
3925 - "activity": true,
3926 - "progress": 0,
3927 - "message": "string"
3928 -}
3929 -
3930 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3931 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3932 -|progress|Прогресс экспорта, от 0 до 100%
3933 -|message|Текст описывающий статус
3934 -
3935 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3936 -
3937 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3938 -
3939 -(% class="box infomessage" %)
3940 -(((
3941 -**POST /api/v3/EcoDriving/rating**
3942 -)))
3943 -
3944 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3945 -
3946 -Тело запроса:
3947 -
3948 -{
3949 - "vehicleIds": [vehicleId],
3950 - "from": "2023-11-22T09:29:48.051Z",
3951 - "to": "2023-11-22T09:29:48.051Z"
3952 -}
3953 -
3954 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3955 -|vehicleIds|Массив ID объектов
3956 -|from|Дата начала запроса
3957 -|to|Дата окончания запроса
3958 -
3959 -Ответ:
3960 -
3961 -{
3962 - "items": [
3963 - {
3964 - "from": "2023-11-22T09:29:48.052Z",
3965 - "to": "2023-11-22T09:29:48.052Z",
3966 - "vehicleId": 0,
3967 - "vehicleName": "string",
3968 - "vehicleModel": "string",
3969 - "penalty": 0,
3970 - "score": 0,
3971 - "totalViolations": 0,
3972 - "violationsByType": {
3973 - "overspeedingViolations": 0,
3974 - "accelerationViolations": 0,
3975 - "brakingViolations": 0,
3976 - "turningViolations": 0,
3977 - "dangerousDrivingViolations": 0,
3978 - "sensorViolations": 0
3979 - },
3980 - "moveTime": 0,
3981 - "mileage": 0,
3982 - "tripsCount": 0,
3983 - "trips": [
3984 - {
3985 - "penalty": 0,
3986 - "score": 0,
3987 - "violationsCount": 0,
3988 - "violationsByType": {
3989 - "overspeedingViolations": 0,
3990 - "accelerationViolations": 0,
3991 - "brakingViolations": 0,
3992 - "turningViolations": 0,
3993 - "dangerousDrivingViolations": 0,
3994 - "sensorViolations": 0
3995 - },
3996 - "moveTime": 0,
3997 - "mileage": 0,
3998 - "motohours": 0,
3999 - "maxSpeed": 0,
4000 - "startAddress": "string",
4001 - "endAddress": "string",
4002 - "drivers": [
4003 - {
4004 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4005 - "driverName": "string",
4006 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4007 - }
4008 - ]
4009 - }
4010 - ]
4011 - }
4012 - ]
4013 -}
4014 -
4015 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4016 -|from|Дата начала запроса
4017 -|to|Дата  окончания
4018 -|vehicleId|ID объекта
4019 -|vehicleName|Имя объекта
4020 -|vehicleModel|Модель объекта
4021 -|penalty|Сумма штрафных баллов
4022 -|score|Оценка
4023 -|totalViolations|Суммарное количество нарушений
4024 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4025 -|overspeedingViolations|Превышение скорости
4026 -|accelerationViolations|Ускорение
4027 -|brakingViolations|Торможение
4028 -|turningViolations|Резкий поворот
4029 -|dangerousDrivingViolations|Резкое вождение
4030 -|sensorViolations|Нарушение по датчику
4031 -|moveTime|Время в движении
4032 -|mileage|Пробег
4033 -|tripsCount|Количество рейсов
4034 -|motohours|Моточасы
4035 -|maxSpeed|Максимальная скорость
4036 -|startAddress|Адрес начала рейса
4037 -|endAddress|Адрес окончания рейса
4038 -|drivers|Список водителей, которые были на объекте в течениии рейса
4039 -|driverGuid|Guid водителя
4040 -|driverName|Имя водителя
4041 -|driverRfid|Номер Карты-метки
4042 -
4043 4043  (% class="box" lang="en-US" style="text-align: center;" %)
4044 4044  (((
4045 4045  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

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