Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 153.1 >
edited by Михаил Жучков
on 2024/04/11 08:08
To version < 113.1 >
edited by Илья Крайнов
on 2023/10/20 12:44
>
Change comment: Загрузить новое вложение image-20231020124453-1.png

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SupportZhuchkov
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,15 +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 -(% class="wikigeneratedid" %)
64 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
65 -
66 66  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
67 67  
68 68  (% class="box infomessage" %)
... ... @@ -101,51 +101,30 @@
101 101  Запрос должен содержать данные параметра "**agentId**"
102 102  
103 103  (% style="color:#000000" %)Ответ:
96 +А
104 104  {
105 - "agentId": "",  (%%)
106 - "parentId": "",
107 - "parentName": "string",
108 - "name": "string",
109 - "fullName": "string",
110 - "agentInfoType": 0,
111 - "isForeign": true/false,
112 - "district": "string", 
113 - "region": "string",
114 - "city": "string",
115 - "inn": "string",
116 - "kpp": "string",
117 - "address": "string",
118 - "addressFact": "string",
119 - "email": "string",
120 - "director": "string",
121 - "bankName": "string",
122 - "bankBIK": "string",
123 - "bankRS": "string",
124 - "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" ~/~/ Корр. счет
125 125   }
126 126  
127 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
128 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
129 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
130 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
131 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
132 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
133 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
134 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
135 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
136 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
137 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
138 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
139 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
140 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
141 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
142 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
143 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
144 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
145 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
146 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
147 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
148 -
149 149  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
150 150  
151 151  (% class="box infomessage" %)
... ... @@ -159,7 +159,7 @@
159 159  
160 160  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
161 161  
162 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
163 163  
164 164  (% style="color:#000000" %)Метод запроса: **POST**
165 165  
... ... @@ -174,23 +174,15 @@
174 174  (% style="color:#000000" %)Ответ:
175 175  
176 176  {
177 - "agentId": "",(% style="color:#000000" %)   (%%)
178 - "parentId": "",
179 - "name": "string",
180 - "fullName": "string",
181 - "agentInfoType": 0,
182 -(% 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 - Отказ)
183 183  }
184 184  
185 -
186 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
187 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
188 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
189 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
190 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
191 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
192 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
193 -
194 194  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
195 195  
196 196  (% class="box successmessage" %)
... ... @@ -209,7 +209,7 @@
209 209  Параметры в теле запроса (JSON):
210 210  
211 211  {
212 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
213 213   "name": "string", ~/~/ имя
214 214   "fullName": "string", ~/~/ полное наименование
215 215   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -254,28 +254,6 @@
254 254   "bankKS": "string" ~/~/ корр. счёт
255 255  }
256 256  
257 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
258 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
259 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
260 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
261 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
262 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
263 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
264 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
265 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
266 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
267 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
268 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
269 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
270 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
271 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
272 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
273 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
274 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
275 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
276 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
277 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
278 -
279 279  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
280 280  
281 281  (% class="box warningmessage" %)
... ... @@ -291,6 +291,7 @@
291 291  
292 292  В заголовках запроса: X-Auth: Токен авторизации
293 293  
235 +
294 294  Параметры в теле запроса (JSON):
295 295  
296 296  {
... ... @@ -315,6 +315,7 @@
315 315   "bankKS": "string" ~/~/ корр. счёт
316 316  }
317 317  
260 +
318 318  Ответ:
319 319  
320 320  {
... ... @@ -357,21 +357,6 @@
357 357  
358 358  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
359 359  
360 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
361 -
362 -(% class="box warningmessage" %)
363 -(((
364 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 -)))
366 -
367 -Метод позволяет изменить статус клиента, указанного в запросе.
368 -
369 -В пути указывается GUID клиента и статус клиента.
370 -
371 -**status **- значение 0 - заблокирован, 1 - активен.
372 -
373 -Ответ: Code 204
374 -
375 375  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
376 376  
377 377  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -435,6 +435,7 @@
435 435   "password": "string",
436 436   "email": "string",
437 437  
366 +
438 438  (% style="text-align:left" %)
439 439  (% style="color:#000000; font-weight:normal" %)Ответ:
440 440  
... ... @@ -463,7 +463,6 @@
463 463  (% style="text-align:left" %)
464 464  (% style="color:#000000; font-weight:normal" %)}
465 465  
466 -
467 467  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
468 468  
469 469  (% class="box infomessage" %)
... ... @@ -783,6 +783,7 @@
783 783   "maxspeed": 0,
784 784   "width": 0,
785 785   "imbeddedtrailer": true,
714 + "fueloutlay": 0,
786 786   "hoppercapacity": 0,
787 787   "hopperdischargespeed": 0,
788 788   "modelType": 0,
... ... @@ -799,8 +799,9 @@
799 799  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
800 800  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
801 801  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
802 802  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
803 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
804 804  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
805 805  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
806 806  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -892,24 +892,12 @@
892 892   "maxspeed": 0,
893 893   "width": 0,
894 894   "imbeddedtrailer": true,
825 + "fueloutlay": 0,
895 895   "hoppercapacity": 0,
896 896   "hopperdischargespeed": 0,
897 897   "modelType": 0
898 898  }
899 899  
900 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
901 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
902 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
903 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
904 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
905 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
906 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
907 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
908 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
909 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
910 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
911 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
912 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
913 913  
914 914  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
915 915  
... ... @@ -964,20 +964,6 @@
964 964   "modelType": 0
965 965  }
966 966  
967 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
968 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
969 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
970 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
971 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
972 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
973 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
974 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
975 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
976 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
977 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
978 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
979 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
980 -
981 981  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
982 982  
983 983  (% class="box errormessage" %)
... ... @@ -1431,7 +1431,7 @@
1431 1431  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1432 1432  )))
1433 1433  
1434 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1338 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1435 1435  
1436 1436  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1437 1437  
... ... @@ -1805,7 +1805,7 @@
1805 1805  
1806 1806  (% style="color:#000000" %)Метод запроса: **GET**
1807 1807  
1808 -(% 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]]
1809 1809  
1810 1810  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1811 1811  
... ... @@ -1888,56 +1888,6 @@
1888 1888   }
1889 1889  ]
1890 1890  
1891 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1892 -
1893 -(% class="box infomessage" style="text-align: left;" %)
1894 -(((
1895 -**POST /api/v3/terminalMessages/mapping**
1896 -)))
1897 -
1898 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1899 -
1900 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1901 -
1902 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1903 -
1904 -{
1905 - "protocolType": 0,
1906 - "params": ["string"]
1907 -}
1908 -
1909 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1910 -|protocolType|ID типа протокола
1911 -|params|(((
1912 -Массив наименований параметров в сообщении
1913 -)))
1914 -
1915 -Ответ:
1916 -
1917 -{
1918 - "protocolType": 0,
1919 - "mapping": {
1920 - "additionalProp1": {
1921 - "inputType": 0,
1922 - "inputNumber": 0
1923 - },
1924 - "additionalProp2": {
1925 - "inputType": 0,
1926 - "inputNumber": 0
1927 - }
1928 - }
1929 -}
1930 -
1931 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1932 -|protocolType|Тип протокола
1933 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1934 -|inputNumber|(((
1935 -Номер входа
1936 -)))
1937 -
1938 -(% class="wikigeneratedid" %)
1939 -Перечень 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/]]
1940 -
1941 1941  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1942 1942  
1943 1943  (% class="box infomessage" %)
... ... @@ -1962,11 +1962,6 @@
1962 1962   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1963 1963  }
1964 1964  
1965 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1966 -|vehicleId|ID объекта
1967 -|from|Дата и время начала периода запроса
1968 -|to|Дата и время окончания периода запроса
1969 -
1970 1970  Ответ:
1971 1971  
1972 1972  [
... ... @@ -1973,43 +1973,80 @@
1973 1973   {
1974 1974   "messages": [
1975 1975   {
1976 - "deviceTime": "2023-11-29T07:40:44.052Z",
1977 - "serverTime": "2023-11-29T07:40:44.052Z",
1978 - "speed": 0,
1979 - "altitude": 0,
1980 - "latitude": 0,
1981 - "longitude": 0,
1982 - "satellites": 0,
1983 - "course": 0,
1984 - "voltage": 0,
1985 - "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": { ~/~/ список параметров датчиков передаваемых терминалом
1986 1986   "additionalProp1": "string",
1987 1987   "additionalProp2": "string",
1988 1988   "additionalProp3": "string"
1989 1989   },
1990 - "photoCount": 0,
1991 - "lbsCorrectedCoords": true,
1992 - "protocolType": 0
1838 + "photoCount": 0 ~/~/ Кол-во фото
1993 1993   }
1994 1994   ]
1995 1995   }
1996 1996  ]
1997 1997  
1998 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1999 -|deviceTime|Время сообщения терминала
2000 -|serverTime|Время когда сообщение поступило на сервер
2001 -|speed|Скорость
2002 -|altitude|Высота над уровнем моря
2003 -|latitude|Широта
2004 -|longitude|Долгота
2005 -|satellites|Кол-во спутников
2006 -|course|Курс
2007 -|voltage|Бортовое напряжение
2008 -|parameters|Список параметров и их значений
2009 -|photoCount|Количество фото
2010 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2011 -|protocolType|ID типа протокола
1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
2012 2012  
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 +
2013 2013  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2014 2014  
2015 2015  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2143,129 +2143,6 @@
2143 2143   }
2144 2144  ]
2145 2145  
2146 -
2147 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2148 -
2149 -(% class="box infomessage" %)
2150 -(((
2151 -**POST /api/v3/vehicles/moveStop**
2152 -)))
2153 -
2154 -Метод запроса: **POST**
2155 -
2156 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2157 -
2158 -В заголовках запроса: X-Auth: Токен авторизации
2159 -
2160 -
2161 -Тело запроса:
2162 -
2163 -{
2164 -
2165 - "vehicleIds": [ ], ~/~/ Список ID объектов
2166 -
2167 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2168 -
2169 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2170 -
2171 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2172 -
2173 -}
2174 -
2175 -Ответ:
2176 -
2177 -[
2178 -
2179 - {
2180 -
2181 - "vehicleId": 0, ~/~/ ID объекта
2182 -
2183 - "vehicleName": "string", ~/~/ Имя объекта
2184 -
2185 - "moves": [ ~/~/ Событие движения
2186 -
2187 - {
2188 -
2189 - "mileage": 0, ~/~/ Пробег, км
2190 -
2191 - "eventId": 0, ~/~/ Идентификатор события
2192 -
2193 - "eventName": "string", ~/~/ Название события
2194 -
2195 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2196 -
2197 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2198 -
2199 - "duration": 0 ~/~/ Продолжительность события, секунд
2200 -
2201 - }
2202 -
2203 - ],
2204 -
2205 - "stops": [ ~/~/ События стоянок
2206 -
2207 - {
2208 -
2209 - "address": "string", ~/~/ Адрес события
2210 -
2211 - "eventId": 0, ~/~/ Идентификатор события
2212 -
2213 - "eventName": "string", ~/~/ Название события
2214 -
2215 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2216 -
2217 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2218 -
2219 - "duration": 0 ~/~/ Продолжительность события, секунд
2220 -
2221 -
2222 - }
2223 -
2224 - ]
2225 -
2226 - }
2227 -
2228 -]
2229 -
2230 -
2231 -
2232 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2233 -
2234 -(% class="box infomessage" %)
2235 -(((
2236 -**POST /api/v3/vehicles/getlastdata**
2237 -)))
2238 -
2239 -Метод запроса: **POST**
2240 -
2241 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2242 -
2243 -В заголовках запроса: X-Auth: Токен авторизации
2244 -
2245 -
2246 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2247 -
2248 -Ответ:
2249 - {
2250 - "vehicleId": 0, ~/~/Идентификатор объекта.
2251 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2252 - "vehicleNumber": "string",~/~/Номер объекта.
2253 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2254 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2255 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2256 - "speed": 0,~/~/Скорость объекта.
2257 - "course": 0,~/~/Курс движения [0;360]
2258 - "latitude": 0,~/~/Широта [-90°;90°].
2259 - "longitude": 0,~/~/Долгота [-180°;180°].
2260 - "address": "string",~/~/Адрес.
2261 - "geozones": [ ~/~/Сведения по геозонам.
2262 - {
2263 - "id": 0,
2264 - "name": "string"
2265 - }
2266 -
2267 -
2268 -
2269 2269  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2270 2270  
2271 2271  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3164,83 +3164,6 @@
3164 3164  Success
3165 3165  
3166 3166  
3167 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3168 -
3169 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3170 -
3171 -(% class="box infomessage" %)
3172 -(((
3173 -**POST /api/v3/Trailers**
3174 -)))
3175 -
3176 -Пример запроса:
3177 -
3178 -{
3179 - "startDate": "2023-11-14T10:48:03.671Z",
3180 - "endDate": "2023-11-14T10:48:03.671Z",
3181 - "ids": [ 0 ],
3182 - "timezone": 0
3183 -}
3184 -
3185 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3186 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3187 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3188 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3189 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3190 -
3191 -Пример ответа:
3192 -
3193 -[
3194 - {
3195 - "SD": "2023-11-14T10:48:03.717Z",
3196 - "ED": "2023-11-14T10:48:03.717Z", 
3197 - "id": 0,
3198 - "SLat": 0,
3199 - "SLon": 0,
3200 - "ELat": 0,
3201 - "ELon": 0,
3202 - "mileage": 0
3203 - "Duration": 0
3204 - "Address": "string",
3205 - "Address2": "string",
3206 - "name": "string",
3207 - "rid": "string",
3208 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3209 - "trailer": {
3210 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 - "Number": "string",
3212 - "Description": "string",
3213 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3214 - "ExternalID": "string",
3215 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3216 - "CreateTime": "2023-11-14T10:48:03.717Z",
3217 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3218 - "IsDeleted": true
3219 - },
3220 - "filesCount": 0,
3221 - }
3222 -]
3223 -
3224 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3225 -|SD|Дата и время начала события
3226 -|ED|Дата и время окончания события
3227 -|id|ID объекта
3228 -|SLat|Широта начальной координаты
3229 -|SLon|Долгота начальной координаты
3230 -|ELat|Широта конечной координаты
3231 -|ELon|Долгота конечной координаты
3232 -|mileage|Пробег
3233 -|Duration|Продолжительность
3234 -|Address|Адрес начального местоположения
3235 -|Address2|Адрес конечного местоположения
3236 -|name|Имя радиометки
3237 -|rid|Номер радиометки
3238 -|rguid|ID радиометки
3239 -|trailer|Информация об агрегате
3240 -|ModelGuid|ID агрегата
3241 -|Number|Название/номер агрегата
3242 -|Description|Текст примечания агрегата
3243 -
3244 3244  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3245 3245  
3246 3246  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3262,19 +3262,13 @@
3262 3262   {
3263 3263   "name": "string",
3264 3264   "number": 0,
3265 - "period": 0,
2951 + "period": 0, ~/~/ Частота трансляции радиометки
3266 3266   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3267 3267   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "deleted": true
3268 3268   }
3269 3269  ]
3270 3270  
3271 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3272 -|parentId|ID клиента
3273 -|name|Название карты-метки
3274 -|number|Номер
3275 -|period|Период запросов в секундах (работает только для агрегатов)
3276 -|id|ID карты-метки
3277 -
3278 3278  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3279 3279  
3280 3280  (% class="box infomessage" %)
... ... @@ -3290,18 +3290,13 @@
3290 3290   {
3291 3291   "name": "string",
3292 3292   "number": 0,
3293 - "period": 0,
2973 + "period": 0, ~/~/ Частота трансляции радиометки
3294 3294   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3295 3295   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "deleted": true
3296 3296   }
3297 3297  ]
3298 3298  
3299 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3300 -|name|Название карты-метки
3301 -|number|Номер
3302 -|period|Период запросов в секундах (работает только для агрегатов)
3303 -|id|ID карты-метки
3304 -|parentId|ID клиента
3305 3305  
3306 3306  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3307 3307  
... ... @@ -3317,6 +3317,7 @@
3317 3317   "number": 0,
3318 3318   "period": 0,
3319 3319   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 + "deleted": true
3320 3320  }
3321 3321  
3322 3322  Ответ:
... ... @@ -3327,15 +3327,9 @@
3327 3327   "period": 0,
3328 3328   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3329 3329   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3006 + "deleted": true
3330 3330  }
3331 3331  
3332 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3333 -|name|Название карты-метки
3334 -|number|Номер
3335 -|period|Период запросов в секундах (работает только для агрегатов)
3336 -|id|ID карты-метки
3337 -|parentId|ID клиента
3338 -
3339 3339  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3340 3340  
3341 3341  (% class="box warningmessage" %)
... ... @@ -3351,6 +3351,7 @@
3351 3351   "period": 0,
3352 3352   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3353 3353   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3024 + "deleted": true
3354 3354  }
3355 3355  
3356 3356  Ответ:
... ... @@ -3361,15 +3361,9 @@
3361 3361   "period": 0,
3362 3362   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3363 3363   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 + "deleted": true
3364 3364  }
3365 3365  
3366 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3367 -|name|Название карты-метки
3368 -|number|Номер
3369 -|period|Период запросов в секундах (работает только для агрегатов)
3370 -|id|ID карты-метки
3371 -|parentId|ID клиента
3372 -
3373 3373  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3374 3374  
3375 3375  (% class="box errormessage" %)
... ... @@ -3377,7 +3377,7 @@
3377 3377  **DELETE /api/v3/Rfids/{rfidGuid}**
3378 3378  )))
3379 3379  
3380 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3045 +Передаем параметр rfidGuid - идентификатор карты-метки
3381 3381  
3382 3382  Ответ:
3383 3383  
... ... @@ -3618,8 +3618,6 @@
3618 3618  **PUT /api/v3/Billing/client/balance**
3619 3619  )))
3620 3620  
3621 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3622 -
3623 3623  Тело запроса:
3624 3624  
3625 3625  {
... ... @@ -3633,50 +3633,6 @@
3633 3633  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3634 3634  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3635 3635  
3636 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3637 -
3638 -(% class="box warningmessage" %)
3639 -(((
3640 -**PUT /api/v3/billing/client/balance/deposit**
3641 -)))
3642 -
3643 -Создает операцию **Пополнение **с указанной суммой
3644 -
3645 -Тело запроса:
3646 -
3647 -{
3648 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3649 - "Balance": 0
3650 -}
3651 -
3652 -Ответ: Success
3653 -
3654 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3655 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3656 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3657 -
3658 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3659 -
3660 -Создает операцию **Списание **с указанной суммой
3661 -
3662 -(% class="box warningmessage" %)
3663 -(((
3664 -**PUT /api/v3/billing/client/balance/withdraw**
3665 -)))
3666 -
3667 -Тело запроса:
3668 -
3669 -{
3670 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3671 - "Balance": 0
3672 -}
3673 -
3674 -Ответ: Success
3675 -
3676 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3677 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3678 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3679 -
3680 3680  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3681 3681  
3682 3682  (% class="box warningmessage" %)
... ... @@ -3749,451 +3749,6 @@
3749 3749  |PeriodValue|Значение периода.
3750 3750  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3751 3751  
3752 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3753 -
3754 -(% class="box warningmessage" %)
3755 -(((
3756 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3757 -)))
3758 -
3759 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3760 -
3761 -(% class="box infomessage" %)
3762 -(((
3763 -**POST /api/v3/vehicles/import/{agentId}**
3764 -)))
3765 -
3766 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3767 -
3768 -В пути указывается **agentId** - id клиента.
3769 -
3770 -**Заголовок**
3771 -
3772 -**X-Auth: [токен авторизации]**
3773 -
3774 -**Параметры**
3775 -
3776 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3777 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3778 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3779 -
3780 -В теле использовать тип **form-data,** тип значения** file**
3781 -
3782 -**Ключи**
3783 -
3784 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3785 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3786 -|csv|В значении передаем файл датчиков, формат **csv**
3787 -
3788 -Ответ:
3789 -
3790 -{
3791 - "vehicleId": 0,
3792 - "name": "string",
3793 - "errors": ["string"]
3794 -}
3795 -
3796 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3797 -|vehicleId|ID созданного объекта
3798 -|name|Имя созданного объекта
3799 -|errors|Ошибки и их описание
3800 -
3801 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3802 -
3803 -(% class="box infomessage" %)
3804 -(((
3805 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3806 -)))
3807 -
3808 -(% class="wikigeneratedid" %)
3809 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3810 -
3811 -(% class="wikigeneratedid" %)
3812 -В пути указывается **vehicleId **- id объекта.
3813 -
3814 -**Заголовок**
3815 -
3816 -**X-Auth: [токен авторизации]**
3817 -
3818 -В теле использовать тип **form-data.**
3819 -
3820 -Ключи:
3821 -
3822 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3823 -|**history**|В значении передавать файл с историей
3824 -
3825 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3826 -
3827 -Ответ:
3828 -
3829 -{
3830 - "results": [
3831 - {
3832 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3833 - "vehicleId": 0,
3834 - "errors": [
3835 - "string"
3836 - ],
3837 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3838 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3839 - "producedCount": 0,
3840 - "msgCount": 0
3841 - }
3842 - ]
3843 -}
3844 -
3845 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3846 -|results|Результаты импорта в разрезе ТС
3847 -|vehicleGuid|Guid ТС
3848 -|vehicleId|ID ТС
3849 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3850 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3851 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3852 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3853 -|msgCount|Кол-во обработанных сообщений всего
3854 -
3855 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3856 -
3857 -(% class="box infomessage" %)
3858 -(((
3859 -**GET /api/v3/vehicles/import/history/status**
3860 -)))
3861 -
3862 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3863 -
3864 -Ответ:
3865 -
3866 -{
3867 - "activity": true,
3868 - "progress": 0,
3869 - "message": "string"
3870 -}
3871 -
3872 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3873 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3874 -|progress|Guid ТС
3875 -
3876 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3877 -
3878 -(% class="box infomessage" %)
3879 -(((
3880 -**POST /api/v3/vehicles/export**
3881 -)))
3882 -
3883 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3884 -
3885 -Тело запроса:
3886 -
3887 -[
3888 - id
3889 -]
3890 -
3891 -Ответ: Success 200, получаете файлы с настройками.
3892 -
3893 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3894 -
3895 -(% class="box infomessage" %)
3896 -(((
3897 -**POST /api/v3/vehicles/export/history**
3898 -)))
3899 -
3900 -Метод возвращает список сообщений терминала объекта за выбранный период.
3901 -
3902 -Тело запроса:
3903 -
3904 -{
3905 - "vehicleId": 0,
3906 - "asArchive": true,
3907 - "from": "2023-09-27T12:17:45.973Z",
3908 - "to": "2023-09-27T12:17:45.973Z"
3909 -}
3910 -
3911 -Ответ:
3912 -
3913 -Получаете файл. Сообщение: Code 200/Success
3914 -
3915 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3916 -|vehicleId|ID объекта
3917 -|asArchive|true - Архивировать файл, False - не архивировать
3918 -|from|Дата и время начала запроса
3919 -|to|Дата и время окончания запроса
3920 -
3921 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3922 -
3923 -(% class="box infomessage" %)
3924 -(((
3925 -**GET /api/v3/vehicles/export/history/status**
3926 -)))
3927 -
3928 -Метод возвращает список сообщений терминала объекта за выбранный период.
3929 -
3930 -Ответ:
3931 -
3932 -{
3933 - "activity": true,
3934 - "progress": 0,
3935 - "message": "string"
3936 -}
3937 -
3938 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3939 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3940 -|progress|Прогресс экспорта, от 0 до 100%
3941 -|message|Текст описывающий статус
3942 -
3943 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3944 -
3945 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3946 -
3947 -(% class="box infomessage" %)
3948 -(((
3949 -**POST /api/v3/EcoDriving/rating**
3950 -)))
3951 -
3952 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3953 -
3954 -Тело запроса:
3955 -
3956 -{
3957 - "vehicleIds": [vehicleId],
3958 - "from": "2023-11-22T09:29:48.051Z",
3959 - "to": "2023-11-22T09:29:48.051Z"
3960 -}
3961 -
3962 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3963 -|vehicleIds|Массив ID объектов
3964 -|from|Дата начала запроса
3965 -|to|Дата окончания запроса
3966 -
3967 -Ответ:
3968 -
3969 -{
3970 - "items": [
3971 - {
3972 - "from": "2023-11-22T09:29:48.052Z",
3973 - "to": "2023-11-22T09:29:48.052Z",
3974 - "vehicleId": 0,
3975 - "vehicleName": "string",
3976 - "vehicleModel": "string",
3977 - "penalty": 0,
3978 - "score": 0,
3979 - "totalViolations": 0,
3980 - "violationsByType": {
3981 - "overspeedingViolations": 0,
3982 - "accelerationViolations": 0,
3983 - "brakingViolations": 0,
3984 - "turningViolations": 0,
3985 - "dangerousDrivingViolations": 0,
3986 - "sensorViolations": 0
3987 - },
3988 - "moveTime": 0,
3989 - "mileage": 0,
3990 - "tripsCount": 0,
3991 - "trips": [
3992 - {
3993 - "penalty": 0,
3994 - "score": 0,
3995 - "violationsCount": 0,
3996 - "violationsByType": {
3997 - "overspeedingViolations": 0,
3998 - "accelerationViolations": 0,
3999 - "brakingViolations": 0,
4000 - "turningViolations": 0,
4001 - "dangerousDrivingViolations": 0,
4002 - "sensorViolations": 0
4003 - },
4004 - "moveTime": 0,
4005 - "mileage": 0,
4006 - "motohours": 0,
4007 - "maxSpeed": 0,
4008 - "startAddress": "string",
4009 - "endAddress": "string",
4010 - "drivers": [
4011 - {
4012 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4013 - "driverName": "string",
4014 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4015 - }
4016 - ]
4017 - }
4018 - ]
4019 - }
4020 - ]
4021 -}
4022 -
4023 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4024 -|from|Дата начала запроса
4025 -|to|Дата  окончания
4026 -|vehicleId|ID объекта
4027 -|vehicleName|Имя объекта
4028 -|vehicleModel|Модель объекта
4029 -|penalty|Сумма штрафных баллов
4030 -|score|Оценка
4031 -|totalViolations|Суммарное количество нарушений
4032 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4033 -|overspeedingViolations|Превышение скорости
4034 -|accelerationViolations|Ускорение
4035 -|brakingViolations|Торможение
4036 -|turningViolations|Резкий поворот
4037 -|dangerousDrivingViolations|Резкое вождение
4038 -|sensorViolations|Нарушение по датчику
4039 -|moveTime|Время в движении
4040 -|mileage|Пробег
4041 -|tripsCount|Количество рейсов
4042 -|motohours|Моточасы
4043 -|maxSpeed|Максимальная скорость
4044 -|startAddress|Адрес начала рейса
4045 -|endAddress|Адрес окончания рейса
4046 -|drivers|Список водителей, которые были на объекте в течениии рейса
4047 -|driverGuid|Guid водителя
4048 -|driverName|Имя водителя
4049 -|driverRfid|Номер Карты-метки
4050 -
4051 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4052 -
4053 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4054 -
4055 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
4056 -
4057 -(% class="box infomessage" %)
4058 -(((
4059 -**POST**/api/v3/fuelcards/transactions
4060 -)))
4061 -
4062 -Запрос должен содержать параметры:
4063 -
4064 -{
4065 -
4066 - "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
4067 -
4068 - "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
4069 -
4070 - "ids": [
4071 -
4072 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
4073 -
4074 - ],
4075 -
4076 - "timezone": 0, ~/~/ Часовой пояс
4077 -
4078 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
4079 -
4080 -}
4081 -
4082 -Ответ:
4083 -
4084 - {
4085 -
4086 - "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
4087 -
4088 - " driver ": "string", ~/~/ Имя водителя
4089 -
4090 - "amount": 0, ~/~/ Количество топлива
4091 -
4092 - "amountDut": 0, ~/~/ Количество топлива по ДУТ
4093 -
4094 - "amountDiff": 0, ~/~/ Разница в литрах
4095 -
4096 - "amountDiffPerc": 0, ~/~/ Разница в %
4097 -
4098 - "summa": 0, ~/~/  Стоимость в руб.
4099 -
4100 - "serviceName": "string", ~/~/ Тип топлива
4101 -
4102 - "price": 0, ~/~/ Цена за литр в руб.
4103 -
4104 - "cardName": "string", ~/~/ Наименование ТК
4105 -
4106 - "cardNum": "string", ~/~/ Номер ТК
4107 -
4108 - "operator": "string", ~/~/ Оператор ТК
4109 -
4110 - "address": "string", ~/~/ Адрес АЗС
4111 -
4112 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
4113 -
4114 - }
4115 -
4116 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4117 -
4118 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4119 -
4120 -
4121 -(% class="box infomessage" %)
4122 -(((
4123 -GET api/v3/Vehicles/recyclebin/all
4124 -)))
4125 -
4126 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4127 -
4128 -Параметр запроса: {parentId} - идентификатор агента
4129 -
4130 -В заголовках запроса: X-Auth: Токен авторизации
4131 -
4132 -Ответ:
4133 -
4134 -"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
4135 -"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
4136 -"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
4137 -"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
4138 -"objectType": "Vehicle", - Тип объекта
4139 -"details": {
4140 -"items": [ {
4141 -"name": "ObjectName", - наименование столбца
4142 -"value": "01" - содержание столбца
4143 -},
4144 -
4145 -{
4146 -"parentName": "string",
4147 -"name": "string",
4148 -"picture": "string",
4149 -"minspeed": 0,
4150 -"maxspeed": 0,
4151 -"width": 0,
4152 -"imbeddedtrailer": true,
4153 -"hoppercapacity": 0,
4154 -"hopperdischargespeed": 0,
4155 -"modelType": 0,
4156 -"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4157 -"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4158 -"deleted": true
4159 -}
4160 -
4161 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4162 -
4163 -(% class="box infomessage" %)
4164 -(((
4165 -POST/api/v3/Vehicles/recyclebin/erase
4166 -)))
4167 -
4168 -В заголовках запроса: X-Auth: Токен авторизации
4169 -
4170 -Параметры в теле запроса (JSON):
4171 -[
4172 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4173 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4174 -]
4175 -
4176 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4177 -
4178 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4179 -
4180 -(% class="box infomessage" %)
4181 -(((
4182 -POST/api/v3/Vehicles/recyclebin/restore
4183 -)))
4184 -
4185 -В заголовках запроса: X-Auth: Токен авторизации
4186 -
4187 -Параметры в теле запроса (JSON):
4188 -[
4189 -"eb737fdf-c422-4df7-8727-bd61439b8460",
4190 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4191 -]
4192 -
4193 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4194 -
4195 -
4196 -
4197 4197  (% class="box" lang="en-US" style="text-align: center;" %)
4198 4198  (((
4199 4199  (% 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]] **

Меню

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