Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 126.1 >
edited by Илья Крайнов
on 2023/11/29 10:18
To version < 110.1 >
edited by Илья Крайнов
on 2023/10/18 16:32
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
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,25 +171,15 @@
171 171  (% style="color:#000000" %)Ответ:
172 172  
173 173  {
174 - "agentId": "",(% style="color:#000000" %)   (%%)
175 - "parentId": "",
176 - "parentName": "string",
177 - "name": "string",
178 - "fullName": "string",
179 - "agentInfoType": 0,
180 -(% 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 - Отказ)
181 181  }
182 182  
183 -
184 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
185 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
186 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
188 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
189 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
190 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
191 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
192 -
193 193  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
194 194  
195 195  (% class="box successmessage" %)
... ... @@ -208,7 +208,7 @@
208 208  Параметры в теле запроса (JSON):
209 209  
210 210  {
211 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
212 212   "name": "string", ~/~/ имя
213 213   "fullName": "string", ~/~/ полное наименование
214 214   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -253,28 +253,6 @@
253 253   "bankKS": "string" ~/~/ корр. счёт
254 254  }
255 255  
256 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
257 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
258 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
259 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
260 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
261 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
262 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
263 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
264 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
265 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
266 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
267 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
268 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
269 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
270 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
271 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
272 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
273 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
274 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
275 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
276 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
277 -
278 278  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
279 279  
280 280  (% class="box warningmessage" %)
... ... @@ -290,6 +290,7 @@
290 290  
291 291  В заголовках запроса: X-Auth: Токен авторизации
292 292  
235 +
293 293  Параметры в теле запроса (JSON):
294 294  
295 295  {
... ... @@ -314,6 +314,7 @@
314 314   "bankKS": "string" ~/~/ корр. счёт
315 315  }
316 316  
260 +
317 317  Ответ:
318 318  
319 319  {
... ... @@ -356,21 +356,6 @@
356 356  
357 357  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
358 358  
359 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
360 -
361 -(% class="box warningmessage" %)
362 -(((
363 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
364 -)))
365 -
366 -Метод позволяет изменить статус клиента, указанного в запросе.
367 -
368 -В пути указывается GUID клиента и статус клиента.
369 -
370 -**status **- значение 0 - заблокирован, 1 - активен.
371 -
372 -Ответ: Code 204
373 -
374 374  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
375 375  
376 376  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -434,6 +434,7 @@
434 434   "password": "string",
435 435   "email": "string",
436 436  
366 +
437 437  (% style="text-align:left" %)
438 438  (% style="color:#000000; font-weight:normal" %)Ответ:
439 439  
... ... @@ -462,7 +462,6 @@
462 462  (% style="text-align:left" %)
463 463  (% style="color:#000000; font-weight:normal" %)}
464 464  
465 -
466 466  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
467 467  
468 468  (% class="box infomessage" %)
... ... @@ -782,6 +782,7 @@
782 782   "maxspeed": 0,
783 783   "width": 0,
784 784   "imbeddedtrailer": true,
714 + "fueloutlay": 0,
785 785   "hoppercapacity": 0,
786 786   "hopperdischargespeed": 0,
787 787   "modelType": 0,
... ... @@ -798,8 +798,9 @@
798 798  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
799 799  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
800 800  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
801 801  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
802 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
803 803  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
804 804  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
805 805  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -891,24 +891,12 @@
891 891   "maxspeed": 0,
892 892   "width": 0,
893 893   "imbeddedtrailer": true,
825 + "fueloutlay": 0,
894 894   "hoppercapacity": 0,
895 895   "hopperdischargespeed": 0,
896 896   "modelType": 0
897 897  }
898 898  
899 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
900 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
901 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
902 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
903 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
904 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
905 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
906 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
907 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
908 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
909 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
910 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
911 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
912 912  
913 913  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
914 914  
... ... @@ -963,20 +963,6 @@
963 963   "modelType": 0
964 964  }
965 965  
966 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
967 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
968 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
969 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
970 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
971 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
972 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
973 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
974 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
975 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
976 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
977 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
978 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
979 -
980 980  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
981 981  
982 982  (% class="box errormessage" %)
... ... @@ -1887,51 +1887,6 @@
1887 1887   }
1888 1888  ]
1889 1889  
1890 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1891 -
1892 -(% class="box infomessage" style="text-align: left;" %)
1893 -(((
1894 -**POST /api/v3/terminalMessages/mapping**
1895 -)))
1896 -
1897 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1898 -
1899 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1900 -
1901 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1902 -
1903 -{
1904 - "protocolType": 0,
1905 - "params": ["string"]
1906 -}
1907 -
1908 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1909 -|protocolType|ID типа протокола
1910 -|params|(((
1911 -Массив наименований параметров в сообщении
1912 -)))
1913 -
1914 -Ответ:
1915 -
1916 -{
1917 - "protocolType": 0,
1918 - "mapping": {
1919 - "additionalProp1": {
1920 - "inputType": 0,
1921 - "inputNumber": 0
1922 - },
1923 - "additionalProp2": {
1924 - "inputType": 0,
1925 - "inputNumber": 0
1926 - }
1927 - }
1928 -}
1929 -
1930 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1931 -|protocolType|Тип протокола
1932 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1933 -|inputNumber|Номер входа
1934 -
1935 1935  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1936 1936  
1937 1937  (% class="box infomessage" %)
... ... @@ -1981,6 +1981,61 @@
1981 1981   }
1982 1982  ]
1983 1983  
1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1845 +
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 +
1984 1984  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1985 1985  
1986 1986  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -3012,83 +3012,6 @@
3012 3012  Success
3013 3013  
3014 3014  
3015 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3016 -
3017 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3018 -
3019 -(% class="box infomessage" %)
3020 -(((
3021 -**POST /api/v3/Trailers**
3022 -)))
3023 -
3024 -Пример запроса:
3025 -
3026 -{
3027 - "startDate": "2023-11-14T10:48:03.671Z",
3028 - "endDate": "2023-11-14T10:48:03.671Z",
3029 - "ids": [ 0 ],
3030 - "timezone": 0
3031 -}
3032 -
3033 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3034 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3035 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3036 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3037 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3038 -
3039 -Пример ответа:
3040 -
3041 -[
3042 - {
3043 - "SD": "2023-11-14T10:48:03.717Z",
3044 - "ED": "2023-11-14T10:48:03.717Z", 
3045 - "id": 0,
3046 - "SLat": 0,
3047 - "SLon": 0,
3048 - "ELat": 0,
3049 - "ELon": 0,
3050 - "mileage": 0
3051 - "Duration": 0
3052 - "Address": "string",
3053 - "Address2": "string",
3054 - "name": "string",
3055 - "rid": "string",
3056 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3057 - "trailer": {
3058 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3059 - "Number": "string",
3060 - "Description": "string",
3061 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3062 - "ExternalID": "string",
3063 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3064 - "CreateTime": "2023-11-14T10:48:03.717Z",
3065 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3066 - "IsDeleted": true
3067 - },
3068 - "filesCount": 0,
3069 - }
3070 -]
3071 -
3072 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3073 -|SD|Дата и время начала события
3074 -|ED|Дата и время окончания события
3075 -|id|ID объекта
3076 -|SLat|Широта начальной координаты
3077 -|SLon|Долгота начальной координаты
3078 -|ELat|Широта конечной координаты
3079 -|ELon|Долгота конечной координаты
3080 -|mileage|Пробег
3081 -|Duration|Продолжительность
3082 -|Address|Адрес начального местоположения
3083 -|Address2|Адрес конечного местоположения
3084 -|name|Имя радиометки
3085 -|rid|Номер радиометки
3086 -|rguid|ID радиометки
3087 -|trailer|Информация об агрегате
3088 -|ModelGuid|ID агрегата
3089 -|Number|Название/номер агрегата
3090 -|Description|Текст примечания агрегата
3091 -
3092 3092  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3093 3093  
3094 3094  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3110,19 +3110,13 @@
3110 3110   {
3111 3111   "name": "string",
3112 3112   "number": 0,
3113 - "period": 0,
2951 + "period": 0, ~/~/ Частота трансляции радиометки
3114 3114   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3115 3115   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "deleted": true
3116 3116   }
3117 3117  ]
3118 3118  
3119 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3120 -|parentId|ID клиента
3121 -|name|Название карты-метки
3122 -|number|Номер
3123 -|period|Период запросов в секундах (работает только для агрегатов)
3124 -|id|ID карты-метки
3125 -
3126 3126  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3127 3127  
3128 3128  (% class="box infomessage" %)
... ... @@ -3138,18 +3138,13 @@
3138 3138   {
3139 3139   "name": "string",
3140 3140   "number": 0,
3141 - "period": 0,
2973 + "period": 0, ~/~/ Частота трансляции радиометки
3142 3142   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3143 3143   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "deleted": true
3144 3144   }
3145 3145  ]
3146 3146  
3147 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3148 -|name|Название карты-метки
3149 -|number|Номер
3150 -|period|Период запросов в секундах (работает только для агрегатов)
3151 -|id|ID карты-метки
3152 -|parentId|ID клиента
3153 3153  
3154 3154  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3155 3155  
... ... @@ -3165,6 +3165,7 @@
3165 3165   "number": 0,
3166 3166   "period": 0,
3167 3167   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 + "deleted": true
3168 3168  }
3169 3169  
3170 3170  Ответ:
... ... @@ -3175,15 +3175,9 @@
3175 3175   "period": 0,
3176 3176   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3177 3177   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3006 + "deleted": true
3178 3178  }
3179 3179  
3180 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3181 -|name|Название карты-метки
3182 -|number|Номер
3183 -|period|Период запросов в секундах (работает только для агрегатов)
3184 -|id|ID карты-метки
3185 -|parentId|ID клиента
3186 -
3187 3187  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3188 3188  
3189 3189  (% class="box warningmessage" %)
... ... @@ -3199,6 +3199,7 @@
3199 3199   "period": 0,
3200 3200   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3201 3201   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3024 + "deleted": true
3202 3202  }
3203 3203  
3204 3204  Ответ:
... ... @@ -3209,15 +3209,9 @@
3209 3209   "period": 0,
3210 3210   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 3211   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 + "deleted": true
3212 3212  }
3213 3213  
3214 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3215 -|name|Название карты-метки
3216 -|number|Номер
3217 -|period|Период запросов в секундах (работает только для агрегатов)
3218 -|id|ID карты-метки
3219 -|parentId|ID клиента
3220 -
3221 3221  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3222 3222  
3223 3223  (% class="box errormessage" %)
... ... @@ -3225,7 +3225,7 @@
3225 3225  **DELETE /api/v3/Rfids/{rfidGuid}**
3226 3226  )))
3227 3227  
3228 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3045 +Передаем параметр rfidGuid - идентификатор карты-метки
3229 3229  
3230 3230  Ответ:
3231 3231  
... ... @@ -3234,6 +3234,7 @@
3234 3234  
3235 3235  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3236 3236  
3054 +(% class="wikigeneratedid" %)
3237 3237  == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3238 3238  
3239 3239  (% class="box infomessage" %)
... ... @@ -3254,6 +3254,7 @@
3254 3254  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3255 3255  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3256 3256  
3075 +(% class="wikigeneratedid" %)
3257 3257  == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3258 3258  
3259 3259  (% class="box infomessage" %)
... ... @@ -3284,6 +3284,7 @@
3284 3284  |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3285 3285  |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3286 3286  
3106 +(% class="wikigeneratedid" %)
3287 3287  == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3288 3288  
3289 3289  (% class="box infomessage" %)
... ... @@ -3357,6 +3357,7 @@
3357 3357  |PeriodValue|Значение периода.
3358 3358  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3359 3359  
3180 +(% class="wikigeneratedid" %)
3360 3360  == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3361 3361  
3362 3362  (% class="box infomessage" %)
... ... @@ -3408,6 +3408,7 @@
3408 3408  |PeriodValue|Значение периода.
3409 3409  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3410 3410  
3232 +(% class="wikigeneratedid" %)
3411 3411  == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3412 3412  
3413 3413  (% class="box infomessage" %)
... ... @@ -3459,72 +3459,6 @@
3459 3459  |PeriodValue|Значение периода.
3460 3460  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3461 3461  
3462 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3463 -
3464 -(% class="box warningmessage" %)
3465 -(((
3466 -**PUT /api/v3/Billing/client/balance**
3467 -)))
3468 -
3469 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3470 -
3471 -Тело запроса:
3472 -
3473 -{
3474 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3475 - "Balance": 0
3476 -}
3477 -
3478 -Ответ: Success
3479 -
3480 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3481 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3482 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3483 -
3484 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3485 -
3486 -(% class="box warningmessage" %)
3487 -(((
3488 -**PUT /api/v3/billing/client/balance/deposit**
3489 -)))
3490 -
3491 -Создает операцию **Пополнение **с указанной суммой
3492 -
3493 -Тело запроса:
3494 -
3495 -{
3496 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3497 - "Balance": 0
3498 -}
3499 -
3500 -Ответ: Success
3501 -
3502 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3503 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3504 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3505 -
3506 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3507 -
3508 -Создает операцию **Списание **с указанной суммой
3509 -
3510 -(% class="box warningmessage" %)
3511 -(((
3512 -**PUT /api/v3/billing/client/balance/withdraw**
3513 -)))
3514 -
3515 -Тело запроса:
3516 -
3517 -{
3518 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 - "Balance": 0
3520 -}
3521 -
3522 -Ответ: Success
3523 -
3524 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3525 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3526 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3527 -
3528 3528  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3529 3529  
3530 3530  (% class="box warningmessage" %)
... ... @@ -3587,7 +3587,6 @@
3587 3587  
3588 3588  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3589 3589  |ClientId|Идентификатор клиента
3590 -|PlanId|Идентификатор тарифного плана
3591 3591  |Feature|Код услуги
3592 3592  |IsEnabled|Признак, определяющий активирована ли услуга
3593 3593  |IsFactual|Признак, определяющий расчёт по факту
... ... @@ -3597,305 +3597,7 @@
3597 3597  |PeriodValue|Значение периода.
3598 3598  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3599 3599  
3600 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3601 3601  
3602 -(% class="box warningmessage" %)
3603 -(((
3604 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3605 -)))
3606 -
3607 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3608 -
3609 -(% class="box infomessage" %)
3610 -(((
3611 -**POST /api/v3/vehicles/import/{agentId}**
3612 -)))
3613 -
3614 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3615 -
3616 -В пути указывается **agentId** - id клиента.
3617 -
3618 -**Заголовок**
3619 -
3620 -**X-Auth: [токен авторизации]**
3621 -
3622 -**Параметры**
3623 -
3624 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3625 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3626 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3627 -
3628 -В теле использовать тип **form-data,** тип значения** file**
3629 -
3630 -**Ключи**
3631 -
3632 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3633 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3634 -|csv|В значении передаем файл датчиков, формат **csv**
3635 -
3636 -Ответ:
3637 -
3638 -{
3639 - "vehicleId": 0,
3640 - "name": "string",
3641 - "errors": ["string"]
3642 -}
3643 -
3644 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3645 -|vehicleId|ID созданного объекта
3646 -|name|Имя созданного объекта
3647 -|errors|Ошибки и их описание
3648 -
3649 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3650 -
3651 -(% class="box infomessage" %)
3652 -(((
3653 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3654 -)))
3655 -
3656 -(% class="wikigeneratedid" %)
3657 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3658 -
3659 -(% class="wikigeneratedid" %)
3660 -В пути указывается **vehicleId **- id объекта.
3661 -
3662 -**Заголовок**
3663 -
3664 -**X-Auth: [токен авторизации]**
3665 -
3666 -В теле использовать тип **form-data.**
3667 -
3668 -Ключи:
3669 -
3670 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3671 -|**history**|В значении передавать файл с историей
3672 -
3673 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3674 -
3675 -Ответ:
3676 -
3677 -{
3678 - "results": [
3679 - {
3680 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3681 - "vehicleId": 0,
3682 - "errors": [
3683 - "string"
3684 - ],
3685 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3686 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3687 - "producedCount": 0,
3688 - "msgCount": 0
3689 - }
3690 - ]
3691 -}
3692 -
3693 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3694 -|results|Результаты импорта в разрезе ТС
3695 -|vehicleGuid|Guid ТС
3696 -|vehicleId|ID ТС
3697 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3698 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3699 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3700 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3701 -|msgCount|Кол-во обработанных сообщений всего
3702 -
3703 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3704 -
3705 -(% class="box infomessage" %)
3706 -(((
3707 -**GET /api/v3/vehicles/import/history/status**
3708 -)))
3709 -
3710 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3711 -
3712 -Ответ:
3713 -
3714 -{
3715 - "activity": true,
3716 - "progress": 0,
3717 - "message": "string"
3718 -}
3719 -
3720 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3721 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3722 -|progress|Guid ТС
3723 -
3724 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3725 -
3726 -(% class="box infomessage" %)
3727 -(((
3728 -**POST /api/v3/vehicles/export**
3729 -)))
3730 -
3731 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3732 -
3733 -Тело запроса:
3734 -
3735 -[
3736 - id
3737 -]
3738 -
3739 -Ответ: Success 200, получаете файлы с настройками.
3740 -
3741 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3742 -
3743 -(% class="box infomessage" %)
3744 -(((
3745 -**POST /api/v3/vehicles/export/history**
3746 -)))
3747 -
3748 -Метод возвращает список сообщений терминала объекта за выбранный период.
3749 -
3750 -Тело запроса:
3751 -
3752 -{
3753 - "vehicleId": 0,
3754 - "asArchive": true,
3755 - "from": "2023-09-27T12:17:45.973Z",
3756 - "to": "2023-09-27T12:17:45.973Z"
3757 -}
3758 -
3759 -Ответ:
3760 -
3761 -Получаете файл. Сообщение: Code 200/Success
3762 -
3763 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3764 -|vehicleId|ID объекта
3765 -|asArchive|true - Архивировать файл, False - не архивировать
3766 -|from|Дата и время начала запроса
3767 -|to|Дата и время окончания запроса
3768 -
3769 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3770 -
3771 -(% class="box infomessage" %)
3772 -(((
3773 -**GET /api/v3/vehicles/export/history/status**
3774 -)))
3775 -
3776 -Метод возвращает список сообщений терминала объекта за выбранный период.
3777 -
3778 -Ответ:
3779 -
3780 -{
3781 - "activity": true,
3782 - "progress": 0,
3783 - "message": "string"
3784 -}
3785 -
3786 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3787 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3788 -|progress|Прогресс экспорта, от 0 до 100%
3789 -|message|Текст описывающий статус
3790 -
3791 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3792 -
3793 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3794 -
3795 -(% class="box infomessage" %)
3796 -(((
3797 -**POST /api/v3/EcoDriving/rating**
3798 -)))
3799 -
3800 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3801 -
3802 -Тело запроса:
3803 -
3804 -{
3805 - "vehicleIds": [vehicleId],
3806 - "from": "2023-11-22T09:29:48.051Z",
3807 - "to": "2023-11-22T09:29:48.051Z"
3808 -}
3809 -
3810 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3811 -|vehicleIds|Массив ID объектов
3812 -|from|Дата начала запроса
3813 -|to|Дата окончания запроса
3814 -
3815 -Ответ:
3816 -
3817 -{
3818 - "items": [
3819 - {
3820 - "from": "2023-11-22T09:29:48.052Z",
3821 - "to": "2023-11-22T09:29:48.052Z",
3822 - "vehicleId": 0,
3823 - "vehicleName": "string",
3824 - "vehicleModel": "string",
3825 - "penalty": 0,
3826 - "score": 0,
3827 - "totalViolations": 0,
3828 - "violationsByType": {
3829 - "overspeedingViolations": 0,
3830 - "accelerationViolations": 0,
3831 - "brakingViolations": 0,
3832 - "turningViolations": 0,
3833 - "dangerousDrivingViolations": 0,
3834 - "sensorViolations": 0
3835 - },
3836 - "moveTime": 0,
3837 - "mileage": 0,
3838 - "tripsCount": 0,
3839 - "trips": [
3840 - {
3841 - "penalty": 0,
3842 - "score": 0,
3843 - "violationsCount": 0,
3844 - "violationsByType": {
3845 - "overspeedingViolations": 0,
3846 - "accelerationViolations": 0,
3847 - "brakingViolations": 0,
3848 - "turningViolations": 0,
3849 - "dangerousDrivingViolations": 0,
3850 - "sensorViolations": 0
3851 - },
3852 - "moveTime": 0,
3853 - "mileage": 0,
3854 - "motohours": 0,
3855 - "maxSpeed": 0,
3856 - "startAddress": "string",
3857 - "endAddress": "string",
3858 - "drivers": [
3859 - {
3860 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3861 - "driverName": "string",
3862 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3863 - }
3864 - ]
3865 - }
3866 - ]
3867 - }
3868 - ]
3869 -}
3870 -
3871 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3872 -|from|Дата начала запроса
3873 -|to|Дата  окончания
3874 -|vehicleId|ID объекта
3875 -|vehicleName|Имя объекта
3876 -|vehicleModel|Модель объекта
3877 -|penalty|Сумма штрафных баллов
3878 -|score|Оценка
3879 -|totalViolations|Суммарное количество нарушений
3880 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3881 -|overspeedingViolations|Превышение скорости
3882 -|accelerationViolations|Ускорение
3883 -|brakingViolations|Торможение
3884 -|turningViolations|Резкий поворот
3885 -|dangerousDrivingViolations|Резкое вождение
3886 -|sensorViolations|Нарушение по датчику
3887 -|moveTime|Время в движении
3888 -|mileage|Пробег
3889 -|tripsCount|Количество рейсов
3890 -|motohours|Моточасы
3891 -|maxSpeed|Максимальная скорость
3892 -|startAddress|Адрес начала рейса
3893 -|endAddress|Адрес окончания рейса
3894 -|drivers|Список водителей, которые были на объекте в течениии рейса
3895 -|driverGuid|Guid водителя
3896 -|driverName|Имя водителя
3897 -|driverRfid|Номер Карты-метки
3898 -
3899 3899  (% class="box" lang="en-US" style="text-align: center;" %)
3900 3900  (((
3901 3901  (% 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 г.