Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 148.1 >
edited by Андрей Калиновский
on 2024/03/18 11:12
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,56 +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 -)))
1934 -
1935 -(% class="wikigeneratedid" %)
1936 -Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
1937 -
1938 1938  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1939 1939  
1940 1940  (% class="box infomessage" %)
... ... @@ -1959,11 +1959,6 @@
1959 1959   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1960 1960  }
1961 1961  
1962 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1963 -|vehicleId|ID объекта
1964 -|from|Дата и время начала периода запроса
1965 -|to|Дата и время окончания периода запроса
1966 -
1967 1967  Ответ:
1968 1968  
1969 1969  [
... ... @@ -1970,43 +1970,80 @@
1970 1970   {
1971 1971   "messages": [
1972 1972   {
1973 - "deviceTime": "2023-11-29T07:40:44.052Z",
1974 - "serverTime": "2023-11-29T07:40:44.052Z",
1975 - "speed": 0,
1976 - "altitude": 0,
1977 - "latitude": 0,
1978 - "longitude": 0,
1979 - "satellites": 0,
1980 - "course": 0,
1981 - "voltage": 0,
1982 - "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": { ~/~/ список параметров датчиков передаваемых терминалом
1983 1983   "additionalProp1": "string",
1984 1984   "additionalProp2": "string",
1985 1985   "additionalProp3": "string"
1986 1986   },
1987 - "photoCount": 0,
1988 - "lbsCorrectedCoords": true,
1989 - "protocolType": 0
1838 + "photoCount": 0 ~/~/ Кол-во фото
1990 1990   }
1991 1991   ]
1992 1992   }
1993 1993  ]
1994 1994  
1995 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1996 -|deviceTime|Время сообщения терминала
1997 -|serverTime|Время когда сообщение поступило на сервер
1998 -|speed|Скорость
1999 -|altitude|Высота над уровнем моря
2000 -|latitude|Широта
2001 -|longitude|Долгота
2002 -|satellites|Кол-во спутников
2003 -|course|Курс
2004 -|voltage|Бортовое напряжение
2005 -|parameters|Список параметров и их значений
2006 -|photoCount|Количество фото
2007 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2008 -|protocolType|ID типа протокола
1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
2009 2009  
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 +
2010 2010  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2011 2011  
2012 2012  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2140,129 +2140,6 @@
2140 2140   }
2141 2141  ]
2142 2142  
2143 -
2144 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2145 -
2146 -(% class="box infomessage" %)
2147 -(((
2148 -**POST /api/v3/vehicles/moveStop**
2149 -)))
2150 -
2151 -Метод запроса: **POST**
2152 -
2153 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2154 -
2155 -В заголовках запроса: X-Auth: Токен авторизации
2156 -
2157 -
2158 -Тело запроса:
2159 -
2160 -{
2161 -
2162 - "vehicleIds": [ ], ~/~/ Список ID объектов
2163 -
2164 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2165 -
2166 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2167 -
2168 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2169 -
2170 -}
2171 -
2172 -Ответ:
2173 -
2174 -[
2175 -
2176 - {
2177 -
2178 - "vehicleId": 0, ~/~/ ID объекта
2179 -
2180 - "vehicleName": "string", ~/~/ Имя объекта
2181 -
2182 - "moves": [ ~/~/ Событие движения
2183 -
2184 - {
2185 -
2186 - "mileage": 0, ~/~/ Пробег, км
2187 -
2188 - "eventId": 0, ~/~/ Идентификатор события
2189 -
2190 - "eventName": "string", ~/~/ Название события
2191 -
2192 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2193 -
2194 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2195 -
2196 - "duration": 0 ~/~/ Продолжительность события, секунд
2197 -
2198 - }
2199 -
2200 - ],
2201 -
2202 - "stops": [ ~/~/ События стоянок
2203 -
2204 - {
2205 -
2206 - "address": "string", ~/~/ Адрес события
2207 -
2208 - "eventId": 0, ~/~/ Идентификатор события
2209 -
2210 - "eventName": "string", ~/~/ Название события
2211 -
2212 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2213 -
2214 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2215 -
2216 - "duration": 0 ~/~/ Продолжительность события, секунд
2217 -
2218 -
2219 - }
2220 -
2221 - ]
2222 -
2223 - }
2224 -
2225 -]
2226 -
2227 -
2228 -
2229 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2230 -
2231 -(% class="box infomessage" %)
2232 -(((
2233 -**POST /api/v3/vehicles/getlastdata**
2234 -)))
2235 -
2236 -Метод запроса: **POST**
2237 -
2238 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2239 -
2240 -В заголовках запроса: X-Auth: Токен авторизации
2241 -
2242 -
2243 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2244 -
2245 -Ответ:
2246 - {
2247 - "vehicleId": 0, ~/~/Идентификатор объекта.
2248 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2249 - "vehicleNumber": "string",~/~/Номер объекта.
2250 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2251 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2252 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2253 - "speed": 0,~/~/Скорость объекта.
2254 - "course": 0,~/~/Курс движения [0;360]
2255 - "latitude": 0,~/~/Широта [-90°;90°].
2256 - "longitude": 0,~/~/Долгота [-180°;180°].
2257 - "address": "string",~/~/Адрес.
2258 - "geozones": [ ~/~/Сведения по геозонам.
2259 - {
2260 - "id": 0,
2261 - "name": "string"
2262 - }
2263 -
2264 -
2265 -
2266 2266  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2267 2267  
2268 2268  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3161,83 +3161,6 @@
3161 3161  Success
3162 3162  
3163 3163  
3164 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3165 -
3166 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3167 -
3168 -(% class="box infomessage" %)
3169 -(((
3170 -**POST /api/v3/Trailers**
3171 -)))
3172 -
3173 -Пример запроса:
3174 -
3175 -{
3176 - "startDate": "2023-11-14T10:48:03.671Z",
3177 - "endDate": "2023-11-14T10:48:03.671Z",
3178 - "ids": [ 0 ],
3179 - "timezone": 0
3180 -}
3181 -
3182 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3183 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3184 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3185 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3186 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3187 -
3188 -Пример ответа:
3189 -
3190 -[
3191 - {
3192 - "SD": "2023-11-14T10:48:03.717Z",
3193 - "ED": "2023-11-14T10:48:03.717Z", 
3194 - "id": 0,
3195 - "SLat": 0,
3196 - "SLon": 0,
3197 - "ELat": 0,
3198 - "ELon": 0,
3199 - "mileage": 0
3200 - "Duration": 0
3201 - "Address": "string",
3202 - "Address2": "string",
3203 - "name": "string",
3204 - "rid": "string",
3205 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3206 - "trailer": {
3207 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3208 - "Number": "string",
3209 - "Description": "string",
3210 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 - "ExternalID": "string",
3212 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3213 - "CreateTime": "2023-11-14T10:48:03.717Z",
3214 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3215 - "IsDeleted": true
3216 - },
3217 - "filesCount": 0,
3218 - }
3219 -]
3220 -
3221 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3222 -|SD|Дата и время начала события
3223 -|ED|Дата и время окончания события
3224 -|id|ID объекта
3225 -|SLat|Широта начальной координаты
3226 -|SLon|Долгота начальной координаты
3227 -|ELat|Широта конечной координаты
3228 -|ELon|Долгота конечной координаты
3229 -|mileage|Пробег
3230 -|Duration|Продолжительность
3231 -|Address|Адрес начального местоположения
3232 -|Address2|Адрес конечного местоположения
3233 -|name|Имя радиометки
3234 -|rid|Номер радиометки
3235 -|rguid|ID радиометки
3236 -|trailer|Информация об агрегате
3237 -|ModelGuid|ID агрегата
3238 -|Number|Название/номер агрегата
3239 -|Description|Текст примечания агрегата
3240 -
3241 3241  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3242 3242  
3243 3243  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3259,19 +3259,13 @@
3259 3259   {
3260 3260   "name": "string",
3261 3261   "number": 0,
3262 - "period": 0,
2951 + "period": 0, ~/~/ Частота трансляции радиометки
3263 3263   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3264 3264   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "deleted": true
3265 3265   }
3266 3266  ]
3267 3267  
3268 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3269 -|parentId|ID клиента
3270 -|name|Название карты-метки
3271 -|number|Номер
3272 -|period|Период запросов в секундах (работает только для агрегатов)
3273 -|id|ID карты-метки
3274 -
3275 3275  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3276 3276  
3277 3277  (% class="box infomessage" %)
... ... @@ -3287,18 +3287,13 @@
3287 3287   {
3288 3288   "name": "string",
3289 3289   "number": 0,
3290 - "period": 0,
2973 + "period": 0, ~/~/ Частота трансляции радиометки
3291 3291   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3292 3292   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "deleted": true
3293 3293   }
3294 3294  ]
3295 3295  
3296 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3297 -|name|Название карты-метки
3298 -|number|Номер
3299 -|period|Период запросов в секундах (работает только для агрегатов)
3300 -|id|ID карты-метки
3301 -|parentId|ID клиента
3302 3302  
3303 3303  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3304 3304  
... ... @@ -3314,6 +3314,7 @@
3314 3314   "number": 0,
3315 3315   "period": 0,
3316 3316   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 + "deleted": true
3317 3317  }
3318 3318  
3319 3319  Ответ:
... ... @@ -3324,15 +3324,9 @@
3324 3324   "period": 0,
3325 3325   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3326 3326   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3006 + "deleted": true
3327 3327  }
3328 3328  
3329 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3330 -|name|Название карты-метки
3331 -|number|Номер
3332 -|period|Период запросов в секундах (работает только для агрегатов)
3333 -|id|ID карты-метки
3334 -|parentId|ID клиента
3335 -
3336 3336  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3337 3337  
3338 3338  (% class="box warningmessage" %)
... ... @@ -3348,6 +3348,7 @@
3348 3348   "period": 0,
3349 3349   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3350 3350   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3024 + "deleted": true
3351 3351  }
3352 3352  
3353 3353  Ответ:
... ... @@ -3358,15 +3358,9 @@
3358 3358   "period": 0,
3359 3359   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3360 3360   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 + "deleted": true
3361 3361  }
3362 3362  
3363 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3364 -|name|Название карты-метки
3365 -|number|Номер
3366 -|period|Период запросов в секундах (работает только для агрегатов)
3367 -|id|ID карты-метки
3368 -|parentId|ID клиента
3369 -
3370 3370  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3371 3371  
3372 3372  (% class="box errormessage" %)
... ... @@ -3374,7 +3374,7 @@
3374 3374  **DELETE /api/v3/Rfids/{rfidGuid}**
3375 3375  )))
3376 3376  
3377 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3045 +Передаем параметр rfidGuid - идентификатор карты-метки
3378 3378  
3379 3379  Ответ:
3380 3380  
... ... @@ -3615,8 +3615,6 @@
3615 3615  **PUT /api/v3/Billing/client/balance**
3616 3616  )))
3617 3617  
3618 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3619 -
3620 3620  Тело запроса:
3621 3621  
3622 3622  {
... ... @@ -3630,50 +3630,6 @@
3630 3630  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3631 3631  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3632 3632  
3633 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3634 -
3635 -(% class="box warningmessage" %)
3636 -(((
3637 -**PUT /api/v3/billing/client/balance/deposit**
3638 -)))
3639 -
3640 -Создает операцию **Пополнение **с указанной суммой
3641 -
3642 -Тело запроса:
3643 -
3644 -{
3645 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3646 - "Balance": 0
3647 -}
3648 -
3649 -Ответ: Success
3650 -
3651 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3652 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3653 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3654 -
3655 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3656 -
3657 -Создает операцию **Списание **с указанной суммой
3658 -
3659 -(% class="box warningmessage" %)
3660 -(((
3661 -**PUT /api/v3/billing/client/balance/withdraw**
3662 -)))
3663 -
3664 -Тело запроса:
3665 -
3666 -{
3667 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3668 - "Balance": 0
3669 -}
3670 -
3671 -Ответ: Success
3672 -
3673 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3674 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3675 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3676 -
3677 3677  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3678 3678  
3679 3679  (% class="box warningmessage" %)
... ... @@ -3746,453 +3746,6 @@
3746 3746  |PeriodValue|Значение периода.
3747 3747  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3748 3748  
3749 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3750 -
3751 -(% class="box warningmessage" %)
3752 -(((
3753 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3754 -)))
3755 -
3756 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3757 -
3758 -(% class="box infomessage" %)
3759 -(((
3760 -**POST /api/v3/vehicles/import/{agentId}**
3761 -)))
3762 -
3763 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3764 -
3765 -В пути указывается **agentId** - id клиента.
3766 -
3767 -**Заголовок**
3768 -
3769 -**X-Auth: [токен авторизации]**
3770 -
3771 -**Параметры**
3772 -
3773 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3774 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3775 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3776 -
3777 -В теле использовать тип **form-data,** тип значения** file**
3778 -
3779 -**Ключи**
3780 -
3781 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3782 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3783 -|csv|В значении передаем файл датчиков, формат **csv**
3784 -
3785 -Ответ:
3786 -
3787 -{
3788 - "vehicleId": 0,
3789 - "name": "string",
3790 - "errors": ["string"]
3791 -}
3792 -
3793 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3794 -|vehicleId|ID созданного объекта
3795 -|name|Имя созданного объекта
3796 -|errors|Ошибки и их описание
3797 -
3798 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3799 -
3800 -(% class="box infomessage" %)
3801 -(((
3802 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3803 -)))
3804 -
3805 -(% class="wikigeneratedid" %)
3806 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3807 -
3808 -(% class="wikigeneratedid" %)
3809 -В пути указывается **vehicleId **- id объекта.
3810 -
3811 -**Заголовок**
3812 -
3813 -**X-Auth: [токен авторизации]**
3814 -
3815 -В теле использовать тип **form-data.**
3816 -
3817 -Ключи:
3818 -
3819 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3820 -|**history**|В значении передавать файл с историей
3821 -
3822 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3823 -
3824 -Ответ:
3825 -
3826 -{
3827 - "results": [
3828 - {
3829 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3830 - "vehicleId": 0,
3831 - "errors": [
3832 - "string"
3833 - ],
3834 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3835 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3836 - "producedCount": 0,
3837 - "msgCount": 0
3838 - }
3839 - ]
3840 -}
3841 -
3842 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3843 -|results|Результаты импорта в разрезе ТС
3844 -|vehicleGuid|Guid ТС
3845 -|vehicleId|ID ТС
3846 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3847 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3848 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3849 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3850 -|msgCount|Кол-во обработанных сообщений всего
3851 -
3852 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3853 -
3854 -(% class="box infomessage" %)
3855 -(((
3856 -**GET /api/v3/vehicles/import/history/status**
3857 -)))
3858 -
3859 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3860 -
3861 -Ответ:
3862 -
3863 -{
3864 - "activity": true,
3865 - "progress": 0,
3866 - "message": "string"
3867 -}
3868 -
3869 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3870 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3871 -|progress|Guid ТС
3872 -
3873 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3874 -
3875 -(% class="box infomessage" %)
3876 -(((
3877 -**POST /api/v3/vehicles/export**
3878 -)))
3879 -
3880 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3881 -
3882 -Тело запроса:
3883 -
3884 -[
3885 - id
3886 -]
3887 -
3888 -Ответ: Success 200, получаете файлы с настройками.
3889 -
3890 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3891 -
3892 -(% class="box infomessage" %)
3893 -(((
3894 -**POST /api/v3/vehicles/export/history**
3895 -)))
3896 -
3897 -Метод возвращает список сообщений терминала объекта за выбранный период.
3898 -
3899 -Тело запроса:
3900 -
3901 -{
3902 - "vehicleId": 0,
3903 - "asArchive": true,
3904 - "from": "2023-09-27T12:17:45.973Z",
3905 - "to": "2023-09-27T12:17:45.973Z"
3906 -}
3907 -
3908 -Ответ:
3909 -
3910 -Получаете файл. Сообщение: Code 200/Success
3911 -
3912 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3913 -|vehicleId|ID объекта
3914 -|asArchive|true - Архивировать файл, False - не архивировать
3915 -|from|Дата и время начала запроса
3916 -|to|Дата и время окончания запроса
3917 -
3918 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3919 -
3920 -(% class="box infomessage" %)
3921 -(((
3922 -**GET /api/v3/vehicles/export/history/status**
3923 -)))
3924 -
3925 -Метод возвращает список сообщений терминала объекта за выбранный период.
3926 -
3927 -Ответ:
3928 -
3929 -{
3930 - "activity": true,
3931 - "progress": 0,
3932 - "message": "string"
3933 -}
3934 -
3935 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3936 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3937 -|progress|Прогресс экспорта, от 0 до 100%
3938 -|message|Текст описывающий статус
3939 -
3940 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3941 -
3942 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3943 -
3944 -(% class="box infomessage" %)
3945 -(((
3946 -**POST /api/v3/EcoDriving/rating**
3947 -)))
3948 -
3949 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3950 -
3951 -Тело запроса:
3952 -
3953 -{
3954 - "vehicleIds": [vehicleId],
3955 - "from": "2023-11-22T09:29:48.051Z",
3956 - "to": "2023-11-22T09:29:48.051Z"
3957 -}
3958 -
3959 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3960 -|vehicleIds|Массив ID объектов
3961 -|from|Дата начала запроса
3962 -|to|Дата окончания запроса
3963 -
3964 -Ответ:
3965 -
3966 -{
3967 - "items": [
3968 - {
3969 - "from": "2023-11-22T09:29:48.052Z",
3970 - "to": "2023-11-22T09:29:48.052Z",
3971 - "vehicleId": 0,
3972 - "vehicleName": "string",
3973 - "vehicleModel": "string",
3974 - "penalty": 0,
3975 - "score": 0,
3976 - "totalViolations": 0,
3977 - "violationsByType": {
3978 - "overspeedingViolations": 0,
3979 - "accelerationViolations": 0,
3980 - "brakingViolations": 0,
3981 - "turningViolations": 0,
3982 - "dangerousDrivingViolations": 0,
3983 - "sensorViolations": 0
3984 - },
3985 - "moveTime": 0,
3986 - "mileage": 0,
3987 - "tripsCount": 0,
3988 - "trips": [
3989 - {
3990 - "penalty": 0,
3991 - "score": 0,
3992 - "violationsCount": 0,
3993 - "violationsByType": {
3994 - "overspeedingViolations": 0,
3995 - "accelerationViolations": 0,
3996 - "brakingViolations": 0,
3997 - "turningViolations": 0,
3998 - "dangerousDrivingViolations": 0,
3999 - "sensorViolations": 0
4000 - },
4001 - "moveTime": 0,
4002 - "mileage": 0,
4003 - "motohours": 0,
4004 - "maxSpeed": 0,
4005 - "startAddress": "string",
4006 - "endAddress": "string",
4007 - "drivers": [
4008 - {
4009 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4010 - "driverName": "string",
4011 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4012 - }
4013 - ]
4014 - }
4015 - ]
4016 - }
4017 - ]
4018 -}
4019 -
4020 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4021 -|from|Дата начала запроса
4022 -|to|Дата  окончания
4023 -|vehicleId|ID объекта
4024 -|vehicleName|Имя объекта
4025 -|vehicleModel|Модель объекта
4026 -|penalty|Сумма штрафных баллов
4027 -|score|Оценка
4028 -|totalViolations|Суммарное количество нарушений
4029 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4030 -|overspeedingViolations|Превышение скорости
4031 -|accelerationViolations|Ускорение
4032 -|brakingViolations|Торможение
4033 -|turningViolations|Резкий поворот
4034 -|dangerousDrivingViolations|Резкое вождение
4035 -|sensorViolations|Нарушение по датчику
4036 -|moveTime|Время в движении
4037 -|mileage|Пробег
4038 -|tripsCount|Количество рейсов
4039 -|motohours|Моточасы
4040 -|maxSpeed|Максимальная скорость
4041 -|startAddress|Адрес начала рейса
4042 -|endAddress|Адрес окончания рейса
4043 -|drivers|Список водителей, которые были на объекте в течениии рейса
4044 -|driverGuid|Guid водителя
4045 -|driverName|Имя водителя
4046 -|driverRfid|Номер Карты-метки
4047 -
4048 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4049 -
4050 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4051 -
4052 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
4053 -
4054 -(% class="box infomessage" %)
4055 -(((
4056 -**POST**/api/v3/fuelcards/transactions
4057 -)))
4058 -
4059 -Запрос должен содержать параметры:
4060 -
4061 -{
4062 -
4063 - "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
4064 -
4065 - "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
4066 -
4067 - "ids": [
4068 -
4069 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
4070 -
4071 - ],
4072 -
4073 - "timezone": 0, ~/~/ Часовой пояс
4074 -
4075 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
4076 -
4077 -}
4078 -
4079 -Ответ:
4080 -
4081 - {
4082 -
4083 - "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
4084 -
4085 - " driver ": "string", ~/~/ Имя водителя
4086 -
4087 - "amount": 0, ~/~/ Количество топлива
4088 -
4089 - "amountDut": 0, ~/~/ Количество топлива по ДУТ
4090 -
4091 - "amountDiff": 0, ~/~/ Разница в литрах
4092 -
4093 - "amountDiffPerc": 0, ~/~/ Разница в %
4094 -
4095 - "summa": 0, ~/~/  Стоимость в руб.
4096 -
4097 - "serviceName": "string", ~/~/ Тип топлива
4098 -
4099 - "price": 0, ~/~/ Цена за литр в руб.
4100 -
4101 - "cardName": "string", ~/~/ Наименование ТК
4102 -
4103 - "cardNum": "string", ~/~/ Номер ТК
4104 -
4105 - "operator": "string", ~/~/ Оператор ТК
4106 -
4107 - "address": "string", ~/~/ Адрес АЗС
4108 -
4109 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
4110 -
4111 - }
4112 -
4113 -
4114 -Раздел: Корзина
4115 -
4116 -Запрос на получение списка всех объектов в корзине
4117 -
4118 -(% class="box infomessage" %)
4119 -(((
4120 -GET api/v3/Vehicles/recyclebin/all
4121 -)))
4122 -
4123 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4124 -
4125 -Параметр запроса: {parentId} - идентификатор агента
4126 -
4127 -В заголовках запроса: X-Auth: Токен авторизации
4128 -
4129 -Ответ:
4130 -
4131 -"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
4132 -"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
4133 -"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
4134 -"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
4135 -"objectType": "Vehicle", - Тип объекта
4136 -"details": {
4137 -"items": [ {
4138 -"name": "ObjectName", - наименование столбца
4139 -"value": "01" - содержание столбца
4140 -},
4141 -
4142 -{
4143 -"parentName": "string",
4144 -"name": "string",
4145 -"picture": "string",
4146 -"minspeed": 0,
4147 -"maxspeed": 0,
4148 -"width": 0,
4149 -"imbeddedtrailer": true,
4150 -"hoppercapacity": 0,
4151 -"hopperdischargespeed": 0,
4152 -"modelType": 0,
4153 -"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4154 -"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4155 -"deleted": true
4156 -}
4157 -
4158 -
4159 -Запрос на удаление объектов из корзины
4160 -
4161 -(% class="box infomessage" %)
4162 -(((
4163 -POST/api/v3/Vehicles/recyclebin/erase
4164 -)))
4165 -
4166 -В заголовках запроса: X-Auth: Токен авторизации
4167 -
4168 -Параметры в теле запроса (JSON):
4169 -[
4170 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4171 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4172 -]
4173 -
4174 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4175 -
4176 -
4177 -Запрос на восстановление объектов из корзины
4178 -
4179 -(% class="box infomessage" %)
4180 -(((
4181 -POST/api/v3/Vehicles/recyclebin/restore
4182 -)))
4183 -
4184 -В заголовках запроса: X-Auth: Токен авторизации
4185 -
4186 -Параметры в теле запроса (JSON):
4187 -[
4188 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4189 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4190 -]
4191 -
4192 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4193 -
4194 -
4195 -
4196 4196  (% class="box" lang="en-US" style="text-align: center;" %)
4197 4197  (((
4198 4198  (% 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 г.