Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 130.1 >
edited by Михаил Жучков
on 2023/12/26 17:47
To version < 109.2 >
edited by Илья Крайнов
on 2023/10/18 15:33
>
Change comment: There is no comment for this version

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,12 +54,6 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 -
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -98,51 +98,30 @@
98 98  Запрос должен содержать данные параметра "**agentId**"
99 99  
100 100  (% style="color:#000000" %)Ответ:
96 +А
101 101  {
102 - "agentId": "",  (%%)
103 - "parentId": "",
104 - "parentName": "string",
105 - "name": "string",
106 - "fullName": "string",
107 - "agentInfoType": 0,
108 - "isForeign": true/false,
109 - "district": "string", 
110 - "region": "string",
111 - "city": "string",
112 - "inn": "string",
113 - "kpp": "string",
114 - "address": "string",
115 - "addressFact": "string",
116 - "email": "string",
117 - "director": "string",
118 - "bankName": "string",
119 - "bankBIK": "string",
120 - "bankRS": "string",
121 - "bankKS": "string"
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
122 122   }
123 123  
124 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145 -
146 146  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147 147  
148 148  (% class="box infomessage" %)
... ... @@ -156,7 +156,7 @@
156 156  
157 157  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
158 158  
159 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
160 160  
161 161  (% style="color:#000000" %)Метод запроса: **POST**
162 162  
... ... @@ -171,23 +171,15 @@
171 171  (% style="color:#000000" %)Ответ:
172 172  
173 173  {
174 - "agentId": "",(% style="color:#000000" %)   (%%)
175 - "parentId": "",
176 - "name": "string",
177 - "fullName": "string",
178 - "agentInfoType": 0,
179 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
180 180  }
181 181  
182 -
183 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
186 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
189 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
190 -
191 191  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
192 192  
193 193  (% class="box successmessage" %)
... ... @@ -206,7 +206,7 @@
206 206  Параметры в теле запроса (JSON):
207 207  
208 208  {
209 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
210 210   "name": "string", ~/~/ имя
211 211   "fullName": "string", ~/~/ полное наименование
212 212   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -251,28 +251,6 @@
251 251   "bankKS": "string" ~/~/ корр. счёт
252 252  }
253 253  
254 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
255 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
256 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
257 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
258 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
259 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
260 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
261 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
262 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
263 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
264 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
265 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
266 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
267 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
268 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
269 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
270 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
271 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
272 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
273 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
274 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
275 -
276 276  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
277 277  
278 278  (% class="box warningmessage" %)
... ... @@ -288,6 +288,7 @@
288 288  
289 289  В заголовках запроса: X-Auth: Токен авторизации
290 290  
235 +
291 291  Параметры в теле запроса (JSON):
292 292  
293 293  {
... ... @@ -312,6 +312,7 @@
312 312   "bankKS": "string" ~/~/ корр. счёт
313 313  }
314 314  
260 +
315 315  Ответ:
316 316  
317 317  {
... ... @@ -354,21 +354,6 @@
354 354  
355 355  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
356 356  
357 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
358 -
359 -(% class="box warningmessage" %)
360 -(((
361 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
362 -)))
363 -
364 -Метод позволяет изменить статус клиента, указанного в запросе.
365 -
366 -В пути указывается GUID клиента и статус клиента.
367 -
368 -**status **- значение 0 - заблокирован, 1 - активен.
369 -
370 -Ответ: Code 204
371 -
372 372  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
373 373  
374 374  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -432,6 +432,7 @@
432 432   "password": "string",
433 433   "email": "string",
434 434  
366 +
435 435  (% style="text-align:left" %)
436 436  (% style="color:#000000; font-weight:normal" %)Ответ:
437 437  
... ... @@ -460,7 +460,6 @@
460 460  (% style="text-align:left" %)
461 461  (% style="color:#000000; font-weight:normal" %)}
462 462  
463 -
464 464  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465 465  
466 466  (% class="box infomessage" %)
... ... @@ -780,6 +780,7 @@
780 780   "maxspeed": 0,
781 781   "width": 0,
782 782   "imbeddedtrailer": true,
714 + "fueloutlay": 0,
783 783   "hoppercapacity": 0,
784 784   "hopperdischargespeed": 0,
785 785   "modelType": 0,
... ... @@ -796,8 +796,9 @@
796 796  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
797 797  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
798 798  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
799 799  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
800 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
801 801  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
802 802  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
803 803  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -889,24 +889,12 @@
889 889   "maxspeed": 0,
890 890   "width": 0,
891 891   "imbeddedtrailer": true,
825 + "fueloutlay": 0,
892 892   "hoppercapacity": 0,
893 893   "hopperdischargespeed": 0,
894 894   "modelType": 0
895 895  }
896 896  
897 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
898 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
899 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
900 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
901 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
902 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
903 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
904 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
905 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
906 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
907 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
908 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
909 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
910 910  
911 911  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
912 912  
... ... @@ -961,20 +961,6 @@
961 961   "modelType": 0
962 962  }
963 963  
964 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
965 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
966 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
967 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
968 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
969 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
970 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
971 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
972 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
973 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
974 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
975 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
976 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
977 -
978 978  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
979 979  
980 980  (% class="box errormessage" %)
... ... @@ -1802,7 +1802,7 @@
1802 1802  
1803 1803  (% style="color:#000000" %)Метод запроса: **GET**
1804 1804  
1805 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1712 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1806 1806  
1807 1807  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1808 1808  
... ... @@ -1885,51 +1885,6 @@
1885 1885   }
1886 1886  ]
1887 1887  
1888 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889 -
1890 -(% class="box infomessage" style="text-align: left;" %)
1891 -(((
1892 -**POST /api/v3/terminalMessages/mapping**
1893 -)))
1894 -
1895 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896 -
1897 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898 -
1899 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900 -
1901 -{
1902 - "protocolType": 0,
1903 - "params": ["string"]
1904 -}
1905 -
1906 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 -|protocolType|ID типа протокола
1908 -|params|(((
1909 -Массив наименований параметров в сообщении
1910 -)))
1911 -
1912 -Ответ:
1913 -
1914 -{
1915 - "protocolType": 0,
1916 - "mapping": {
1917 - "additionalProp1": {
1918 - "inputType": 0,
1919 - "inputNumber": 0
1920 - },
1921 - "additionalProp2": {
1922 - "inputType": 0,
1923 - "inputNumber": 0
1924 - }
1925 - }
1926 -}
1927 -
1928 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 -|protocolType|Тип протокола
1930 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 -|inputNumber|Номер входа
1932 -
1933 1933  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1934 1934  
1935 1935  (% class="box infomessage" %)
... ... @@ -1954,11 +1954,6 @@
1954 1954   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1955 1955  }
1956 1956  
1957 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 -|vehicleId|ID объекта
1959 -|from|Дата и время начала периода запроса
1960 -|to|Дата и время окончания периода запроса
1961 -
1962 1962  Ответ:
1963 1963  
1964 1964  [
... ... @@ -1965,43 +1965,80 @@
1965 1965   {
1966 1966   "messages": [
1967 1967   {
1968 - "deviceTime": "2023-11-29T07:40:44.052Z",
1969 - "serverTime": "2023-11-29T07:40:44.052Z",
1970 - "speed": 0,
1971 - "altitude": 0,
1972 - "latitude": 0,
1973 - "longitude": 0,
1974 - "satellites": 0,
1975 - "course": 0,
1976 - "voltage": 0,
1977 - "parameters": {
1825 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1826 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1827 + "speed": 0, ~/~/ Скорость, км/ч
1828 + "altitude": 0, ~/~/ Высота, м
1829 + "latitude": 0, ~/~/ Широта [-90°;90°]
1830 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1831 + "satellites": 0, ~/~/ Кол-во спутников
1832 + "voltage": 0, ~/~/ Напряжение
1833 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1978 1978   "additionalProp1": "string",
1979 1979   "additionalProp2": "string",
1980 1980   "additionalProp3": "string"
1981 1981   },
1982 - "photoCount": 0,
1983 - "lbsCorrectedCoords": true,
1984 - "protocolType": 0
1838 + "photoCount": 0 ~/~/ Кол-во фото
1985 1985   }
1986 1986   ]
1987 1987   }
1988 1988  ]
1989 1989  
1990 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 -|deviceTime|Время сообщения терминала
1992 -|serverTime|Время когда сообщение поступило на сервер
1993 -|speed|Скорость
1994 -|altitude|Высота над уровнем моря
1995 -|latitude|Широта
1996 -|longitude|Долгота
1997 -|satellites|Кол-во спутников
1998 -|course|Курс
1999 -|voltage|Бортовое напряжение
2000 -|parameters|Список параметров и их значений
2001 -|photoCount|Количество фото
2002 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 -|protocolType|ID типа протокола
1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
2004 2004  
1846 +(% class="box infomessage" %)
1847 +(((
1848 +**POST /api/v3/vehicles/export/history**
1849 +)))
1850 +
1851 +Метод возвращает список сообщений терминала объекта за выбранный период.
1852 +
1853 +(% style="text-align: left;" %)
1854 +Метод запроса **POST**
1855 +
1856 +(% style="text-align: left;" %)
1857 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1858 +
1859 +(% style="text-align: left;" %)
1860 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1861 +
1862 +{
1863 + "vehicleId": 0, ~/~/ ID объекта
1864 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1865 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1866 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1867 +}
1868 +
1869 +Ответ:
1870 +
1871 +Получаете файл. Сообщение: Code 200/Success
1872 +
1873 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1874 +
1875 +(% class="box infomessage" %)
1876 +(((
1877 +**GET /api/v3/vehicles/export/history/status**
1878 +)))
1879 +
1880 +Метод возвращает список сообщений терминала объекта за выбранный период.
1881 +
1882 +(% style="text-align: left;" %)
1883 +Метод запроса **GET**
1884 +
1885 +(% style="text-align: left;" %)
1886 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1887 +
1888 +(% style="text-align: left;" %)
1889 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1890 +
1891 +Ответ:
1892 +
1893 +{
1894 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1895 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1896 + "message": "string" ~/~/ текст описывающий статус.
1897 +}
1898 +
2005 2005  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 2006  
2007 2007  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -3033,83 +3033,6 @@
3033 3033  Success
3034 3034  
3035 3035  
3036 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3037 -
3038 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3039 -
3040 -(% class="box infomessage" %)
3041 -(((
3042 -**POST /api/v3/Trailers**
3043 -)))
3044 -
3045 -Пример запроса:
3046 -
3047 -{
3048 - "startDate": "2023-11-14T10:48:03.671Z",
3049 - "endDate": "2023-11-14T10:48:03.671Z",
3050 - "ids": [ 0 ],
3051 - "timezone": 0
3052 -}
3053 -
3054 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3055 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3056 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3057 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3058 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3059 -
3060 -Пример ответа:
3061 -
3062 -[
3063 - {
3064 - "SD": "2023-11-14T10:48:03.717Z",
3065 - "ED": "2023-11-14T10:48:03.717Z", 
3066 - "id": 0,
3067 - "SLat": 0,
3068 - "SLon": 0,
3069 - "ELat": 0,
3070 - "ELon": 0,
3071 - "mileage": 0
3072 - "Duration": 0
3073 - "Address": "string",
3074 - "Address2": "string",
3075 - "name": "string",
3076 - "rid": "string",
3077 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3078 - "trailer": {
3079 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3080 - "Number": "string",
3081 - "Description": "string",
3082 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 - "ExternalID": "string",
3084 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 - "CreateTime": "2023-11-14T10:48:03.717Z",
3086 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3087 - "IsDeleted": true
3088 - },
3089 - "filesCount": 0,
3090 - }
3091 -]
3092 -
3093 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3094 -|SD|Дата и время начала события
3095 -|ED|Дата и время окончания события
3096 -|id|ID объекта
3097 -|SLat|Широта начальной координаты
3098 -|SLon|Долгота начальной координаты
3099 -|ELat|Широта конечной координаты
3100 -|ELon|Долгота конечной координаты
3101 -|mileage|Пробег
3102 -|Duration|Продолжительность
3103 -|Address|Адрес начального местоположения
3104 -|Address2|Адрес конечного местоположения
3105 -|name|Имя радиометки
3106 -|rid|Номер радиометки
3107 -|rguid|ID радиометки
3108 -|trailer|Информация об агрегате
3109 -|ModelGuid|ID агрегата
3110 -|Number|Название/номер агрегата
3111 -|Description|Текст примечания агрегата
3112 -
3113 3113  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3114 3114  
3115 3115  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3131,18 +3131,13 @@
3131 3131   {
3132 3132   "name": "string",
3133 3133   "number": 0,
3134 - "period": 0,
2951 + "period": 0, ~/~/ Частота трансляции радиометки
3135 3135   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3136 3136   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "deleted": true
3137 3137   }
3138 3138  ]
3139 3139  
3140 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3141 -|parentId|ID клиента
3142 -|name|Название карты-метки
3143 -|number|Номер
3144 -|period|Период запросов в секундах (работает только для агрегатов)
3145 -|id|ID карты-метки
3146 3146  
3147 3147  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3148 3148  
... ... @@ -3159,18 +3159,13 @@
3159 3159   {
3160 3160   "name": "string",
3161 3161   "number": 0,
3162 - "period": 0,
2974 + "period": 0, ~/~/ Частота трансляции радиометки
3163 3163   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3164 3164   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2977 + "deleted": true
3165 3165   }
3166 3166  ]
3167 3167  
3168 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3169 -|name|Название карты-метки
3170 -|number|Номер
3171 -|period|Период запросов в секундах (работает только для агрегатов)
3172 -|id|ID карты-метки
3173 -|parentId|ID клиента
3174 3174  
3175 3175  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3176 3176  
... ... @@ -3186,6 +3186,7 @@
3186 3186   "number": 0,
3187 3187   "period": 0,
3188 3188   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2996 + "deleted": true
3189 3189  }
3190 3190  
3191 3191  Ответ:
... ... @@ -3196,14 +3196,9 @@
3196 3196   "period": 0,
3197 3197   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3198 3198   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3007 + "deleted": true
3199 3199  }
3200 3200  
3201 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3202 -|name|Название карты-метки
3203 -|number|Номер
3204 -|period|Период запросов в секундах (работает только для агрегатов)
3205 -|id|ID карты-метки
3206 -|parentId|ID клиента
3207 3207  
3208 3208  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3209 3209  
... ... @@ -3220,6 +3220,7 @@
3220 3220   "period": 0,
3221 3221   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3222 3222   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3026 + "deleted": true
3223 3223  }
3224 3224  
3225 3225  Ответ:
... ... @@ -3230,14 +3230,9 @@
3230 3230   "period": 0,
3231 3231   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3232 3232   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3037 + "deleted": true
3233 3233  }
3234 3234  
3235 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3236 -|name|Название карты-метки
3237 -|number|Номер
3238 -|period|Период запросов в секундах (работает только для агрегатов)
3239 -|id|ID карты-метки
3240 -|parentId|ID клиента
3241 3241  
3242 3242  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3243 3243  
... ... @@ -3246,7 +3246,7 @@
3246 3246  **DELETE /api/v3/Rfids/{rfidGuid}**
3247 3247  )))
3248 3248  
3249 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3048 +Передаем параметр rfidGuid - идентификатор карты-метки
3250 3250  
3251 3251  Ответ:
3252 3252  
... ... @@ -3253,670 +3253,6 @@
3253 3253  Success
3254 3254  
3255 3255  
3256 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3257 -
3258 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3259 -
3260 -(% class="box infomessage" %)
3261 -(((
3262 -**GET /api/v3/Billing/client/balance/{clientId}**
3263 -)))
3264 -
3265 -Параметр запроса: **clientId **- идентификатор клиента.
3266 -
3267 -Ответ:
3268 -
3269 -{
3270 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3271 - "Balance": 0
3272 -}
3273 -
3274 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3275 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3276 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3277 -
3278 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3279 -
3280 -(% class="box infomessage" %)
3281 -(((
3282 -**GET /api/v3/Billing/client/constraint/{clientId}**
3283 -)))
3284 -
3285 -Параметр запроса: **clientId **- идентификатор клиента.
3286 -
3287 -Ответ:
3288 -
3289 -{
3290 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3291 - "CalculationType": 0,
3292 - "PermissibleBalance": 0,
3293 - "DefermentDays": 0,
3294 - "SendUiNotifications": true,
3295 - "SendEmailNotifications": true,
3296 - "IsPrivate": true,
3297 -}
3298 -
3299 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3300 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3301 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3302 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3303 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3304 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3305 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3306 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3307 -
3308 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3309 -
3310 -(% class="box infomessage" %)
3311 -(((
3312 -**GET /api/v3/Billing/client/plan/{clientId}**
3313 -)))
3314 -
3315 -Параметры запроса:
3316 -
3317 -**clientId **- идентификатор клиента.
3318 -
3319 -**planId **- идентификатор тарифного плана.
3320 -
3321 -Ответ:
3322 -
3323 -{
3324 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3325 - "Plan": { **~/~/ Описание тарифного плана**
3326 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3327 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3328 - "Name": "string",
3329 - "IsArchived": true,
3330 - "Constraint": {
3331 - "CalculationType": 0,
3332 - "PermissibleBalance": 0,
3333 - "DefermentDays": 0
3334 - },
3335 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3336 - {
3337 - "Feature": "string",
3338 - "IsFactual": true,
3339 - "Limit": 0,
3340 - "Price": 0,
3341 - "PeriodValue": 0,
3342 - "PeriodType": 0
3343 - }
3344 - ]
3345 - },
3346 - "DebitDate": "2023-10-18T12:46:24.213Z",
3347 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3348 - {
3349 - "Feature": "string",
3350 - "IsEnabled": true,
3351 - "IsPrivate": true,
3352 - "IsFactual": true,
3353 - "Limit": 0,
3354 - "Price": 0,
3355 - "DebitDate": "2023-10-18T12:46:24.213Z",
3356 - "PeriodValue": 0,
3357 - "PeriodType": 0
3358 - }
3359 - ]
3360 -}
3361 -
3362 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3363 -|ClientId|Идентификатор клиента
3364 -|Id|Идентификатор тарифного плана
3365 -|OwnerId|Идентификатор клиента-владельца
3366 -|Name|Наименование тарифного плана
3367 -|IsArchived|Признак, определяющий архивный тарифный план
3368 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3369 -|PermissibleBalance|Допустимый баланс
3370 -|DefermentDays|Отсрочка, количество дней
3371 -|Feature|Код услуги
3372 -|IsEnabled|Признак, определяющий активирована ли услуга
3373 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3374 -|IsFactual|Признак, определяющий расчёт по факту
3375 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3376 -|Price|Цена за единицу.
3377 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3378 -|PeriodValue|Значение периода.
3379 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3380 -
3381 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3382 -
3383 -(% class="box infomessage" %)
3384 -(((
3385 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3386 -)))
3387 -
3388 -Параметр запроса: **clientId **- идентификатор клиента.
3389 -
3390 -Ответ:
3391 -
3392 -[
3393 - {
3394 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3395 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3396 - "Name": "string",
3397 - "IsArchived": true,
3398 - "Constraint": {
3399 - "CalculationType": 0,
3400 - "PermissibleBalance": 0,
3401 - "DefermentDays": 0
3402 - },
3403 - "Features": [
3404 - {
3405 - "Feature": "string",
3406 - "IsFactual": true,
3407 - "Limit": 0,
3408 - "Price": 0,
3409 - "PeriodValue": 0,
3410 - "PeriodType": 0
3411 - }
3412 - ]
3413 - }
3414 -]
3415 -
3416 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3417 -|ClientId|Идентификатор клиента
3418 -|Id|Идентификатор тарифного плана
3419 -|OwnerId|Идентификатор клиента-владельца
3420 -|Name|Наименование тарифного плана
3421 -|IsArchived|Признак, определяющий архивный тарифный план
3422 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3423 -|PermissibleBalance|Допустимый баланс
3424 -|DefermentDays|Отсрочка, количество дней
3425 -|Feature|Код услуги
3426 -|IsFactual|Признак, определяющий расчёт по факту
3427 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3428 -|Price|Цена за единицу.
3429 -|PeriodValue|Значение периода.
3430 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3431 -
3432 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3433 -
3434 -(% class="box infomessage" %)
3435 -(((
3436 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3437 -)))
3438 -
3439 -Параметр запроса: **clientId **- идентификатор клиента.
3440 -
3441 -Ответ:
3442 -
3443 -[
3444 - {
3445 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3446 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3447 - "Name": "string",
3448 - "IsArchived": true,
3449 - "Constraint": {
3450 - "CalculationType": 0,
3451 - "PermissibleBalance": 0,
3452 - "DefermentDays": 0
3453 - },
3454 - "Features": [
3455 - {
3456 - "Feature": "string",
3457 - "IsFactual": true,
3458 - "Limit": 0,
3459 - "Price": 0,
3460 - "PeriodValue": 0,
3461 - "PeriodType": 0
3462 - }
3463 - ]
3464 - }
3465 -]
3466 -
3467 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3468 -|ClientId|Идентификатор клиента
3469 -|Id|Идентификатор тарифного плана
3470 -|OwnerId|Идентификатор клиента-владельца
3471 -|Name|Наименование тарифного плана
3472 -|IsArchived|Признак, определяющий архивный тарифный план
3473 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3474 -|PermissibleBalance|Допустимый баланс
3475 -|DefermentDays|Отсрочка, количество дней
3476 -|Feature|Код услуги
3477 -|IsFactual|Признак, определяющий расчёт по факту
3478 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3479 -|Price|Цена за единицу.
3480 -|PeriodValue|Значение периода.
3481 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3482 -
3483 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3484 -
3485 -(% class="box warningmessage" %)
3486 -(((
3487 -**PUT /api/v3/Billing/client/balance**
3488 -)))
3489 -
3490 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3491 -
3492 -Тело запроса:
3493 -
3494 -{
3495 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3496 - "Balance": 0
3497 -}
3498 -
3499 -Ответ: Success
3500 -
3501 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3502 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3503 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3504 -
3505 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3506 -
3507 -(% class="box warningmessage" %)
3508 -(((
3509 -**PUT /api/v3/billing/client/balance/deposit**
3510 -)))
3511 -
3512 -Создает операцию **Пополнение **с указанной суммой
3513 -
3514 -Тело запроса:
3515 -
3516 -{
3517 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3518 - "Balance": 0
3519 -}
3520 -
3521 -Ответ: Success
3522 -
3523 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3524 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3525 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3526 -
3527 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3528 -
3529 -Создает операцию **Списание **с указанной суммой
3530 -
3531 -(% class="box warningmessage" %)
3532 -(((
3533 -**PUT /api/v3/billing/client/balance/withdraw**
3534 -)))
3535 -
3536 -Тело запроса:
3537 -
3538 -{
3539 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3540 - "Balance": 0
3541 -}
3542 -
3543 -Ответ: Success
3544 -
3545 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3546 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3547 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3548 -
3549 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3550 -
3551 -(% class="box warningmessage" %)
3552 -(((
3553 -**PUT /api/v3/Billing/client/constraint**
3554 -)))
3555 -
3556 -Тело запроса:
3557 -
3558 -{
3559 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3560 - "CalculationType": 0,
3561 - "PermissibleBalance": 0,
3562 - "DefermentDays": 0,
3563 - "SendUiNotifications": true,
3564 - "SendEmailNotifications": true,
3565 - "IsPrivate": true,
3566 -}
3567 -
3568 -Ответ: Success
3569 -
3570 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3571 -|ClientId|Идентификатор клиента
3572 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3573 -|PermissibleBalance|Допустимый баланс
3574 -|DefermentDays|(((
3575 -Отсрочка, количество дней
3576 -)))
3577 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3578 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3579 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3580 -
3581 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3582 -
3583 -(% class="box warningmessage" %)
3584 -(((
3585 -**PUT /api/v3/Billing/client/plan**
3586 -)))
3587 -
3588 -Тело запроса:
3589 -
3590 -{
3591 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3592 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3593 - "Features": [
3594 - {
3595 - "Feature": "string",
3596 - "IsEnabled": true,
3597 - "IsFactual": true,
3598 - "Limit": 0,
3599 - "Price": 0,
3600 - "DebitDate": "2023-10-18T13:26:58.987Z",
3601 - "PeriodValue": 0,
3602 - "PeriodType": 0
3603 - }
3604 - ]
3605 -}
3606 -
3607 -Ответ: Success
3608 -
3609 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3610 -|ClientId|Идентификатор клиента
3611 -|PlanId|Идентификатор тарифного плана
3612 -|Feature|Код услуги
3613 -|IsEnabled|Признак, определяющий активирована ли услуга
3614 -|IsFactual|Признак, определяющий расчёт по факту
3615 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3616 -|Price|Цена за единицу.
3617 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3618 -|PeriodValue|Значение периода.
3619 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3620 -
3621 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3622 -
3623 -(% class="box warningmessage" %)
3624 -(((
3625 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3626 -)))
3627 -
3628 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3629 -
3630 -(% class="box infomessage" %)
3631 -(((
3632 -**POST /api/v3/vehicles/import/{agentId}**
3633 -)))
3634 -
3635 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3636 -
3637 -В пути указывается **agentId** - id клиента.
3638 -
3639 -**Заголовок**
3640 -
3641 -**X-Auth: [токен авторизации]**
3642 -
3643 -**Параметры**
3644 -
3645 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3646 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3647 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3648 -
3649 -В теле использовать тип **form-data,** тип значения** file**
3650 -
3651 -**Ключи**
3652 -
3653 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3654 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3655 -|csv|В значении передаем файл датчиков, формат **csv**
3656 -
3657 -Ответ:
3658 -
3659 -{
3660 - "vehicleId": 0,
3661 - "name": "string",
3662 - "errors": ["string"]
3663 -}
3664 -
3665 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3666 -|vehicleId|ID созданного объекта
3667 -|name|Имя созданного объекта
3668 -|errors|Ошибки и их описание
3669 -
3670 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3671 -
3672 -(% class="box infomessage" %)
3673 -(((
3674 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3675 -)))
3676 -
3677 -(% class="wikigeneratedid" %)
3678 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3679 -
3680 -(% class="wikigeneratedid" %)
3681 -В пути указывается **vehicleId **- id объекта.
3682 -
3683 -**Заголовок**
3684 -
3685 -**X-Auth: [токен авторизации]**
3686 -
3687 -В теле использовать тип **form-data.**
3688 -
3689 -Ключи:
3690 -
3691 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3692 -|**history**|В значении передавать файл с историей
3693 -
3694 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3695 -
3696 -Ответ:
3697 -
3698 -{
3699 - "results": [
3700 - {
3701 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3702 - "vehicleId": 0,
3703 - "errors": [
3704 - "string"
3705 - ],
3706 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3707 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3708 - "producedCount": 0,
3709 - "msgCount": 0
3710 - }
3711 - ]
3712 -}
3713 -
3714 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3715 -|results|Результаты импорта в разрезе ТС
3716 -|vehicleGuid|Guid ТС
3717 -|vehicleId|ID ТС
3718 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3719 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3720 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3721 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3722 -|msgCount|Кол-во обработанных сообщений всего
3723 -
3724 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3725 -
3726 -(% class="box infomessage" %)
3727 -(((
3728 -**GET /api/v3/vehicles/import/history/status**
3729 -)))
3730 -
3731 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3732 -
3733 -Ответ:
3734 -
3735 -{
3736 - "activity": true,
3737 - "progress": 0,
3738 - "message": "string"
3739 -}
3740 -
3741 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3742 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3743 -|progress|Guid ТС
3744 -
3745 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3746 -
3747 -(% class="box infomessage" %)
3748 -(((
3749 -**POST /api/v3/vehicles/export**
3750 -)))
3751 -
3752 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3753 -
3754 -Тело запроса:
3755 -
3756 -[
3757 - id
3758 -]
3759 -
3760 -Ответ: Success 200, получаете файлы с настройками.
3761 -
3762 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3763 -
3764 -(% class="box infomessage" %)
3765 -(((
3766 -**POST /api/v3/vehicles/export/history**
3767 -)))
3768 -
3769 -Метод возвращает список сообщений терминала объекта за выбранный период.
3770 -
3771 -Тело запроса:
3772 -
3773 -{
3774 - "vehicleId": 0,
3775 - "asArchive": true,
3776 - "from": "2023-09-27T12:17:45.973Z",
3777 - "to": "2023-09-27T12:17:45.973Z"
3778 -}
3779 -
3780 -Ответ:
3781 -
3782 -Получаете файл. Сообщение: Code 200/Success
3783 -
3784 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3785 -|vehicleId|ID объекта
3786 -|asArchive|true - Архивировать файл, False - не архивировать
3787 -|from|Дата и время начала запроса
3788 -|to|Дата и время окончания запроса
3789 -
3790 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3791 -
3792 -(% class="box infomessage" %)
3793 -(((
3794 -**GET /api/v3/vehicles/export/history/status**
3795 -)))
3796 -
3797 -Метод возвращает список сообщений терминала объекта за выбранный период.
3798 -
3799 -Ответ:
3800 -
3801 -{
3802 - "activity": true,
3803 - "progress": 0,
3804 - "message": "string"
3805 -}
3806 -
3807 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3808 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3809 -|progress|Прогресс экспорта, от 0 до 100%
3810 -|message|Текст описывающий статус
3811 -
3812 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3813 -
3814 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3815 -
3816 -(% class="box infomessage" %)
3817 -(((
3818 -**POST /api/v3/EcoDriving/rating**
3819 -)))
3820 -
3821 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3822 -
3823 -Тело запроса:
3824 -
3825 -{
3826 - "vehicleIds": [vehicleId],
3827 - "from": "2023-11-22T09:29:48.051Z",
3828 - "to": "2023-11-22T09:29:48.051Z"
3829 -}
3830 -
3831 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3832 -|vehicleIds|Массив ID объектов
3833 -|from|Дата начала запроса
3834 -|to|Дата окончания запроса
3835 -
3836 -Ответ:
3837 -
3838 -{
3839 - "items": [
3840 - {
3841 - "from": "2023-11-22T09:29:48.052Z",
3842 - "to": "2023-11-22T09:29:48.052Z",
3843 - "vehicleId": 0,
3844 - "vehicleName": "string",
3845 - "vehicleModel": "string",
3846 - "penalty": 0,
3847 - "score": 0,
3848 - "totalViolations": 0,
3849 - "violationsByType": {
3850 - "overspeedingViolations": 0,
3851 - "accelerationViolations": 0,
3852 - "brakingViolations": 0,
3853 - "turningViolations": 0,
3854 - "dangerousDrivingViolations": 0,
3855 - "sensorViolations": 0
3856 - },
3857 - "moveTime": 0,
3858 - "mileage": 0,
3859 - "tripsCount": 0,
3860 - "trips": [
3861 - {
3862 - "penalty": 0,
3863 - "score": 0,
3864 - "violationsCount": 0,
3865 - "violationsByType": {
3866 - "overspeedingViolations": 0,
3867 - "accelerationViolations": 0,
3868 - "brakingViolations": 0,
3869 - "turningViolations": 0,
3870 - "dangerousDrivingViolations": 0,
3871 - "sensorViolations": 0
3872 - },
3873 - "moveTime": 0,
3874 - "mileage": 0,
3875 - "motohours": 0,
3876 - "maxSpeed": 0,
3877 - "startAddress": "string",
3878 - "endAddress": "string",
3879 - "drivers": [
3880 - {
3881 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3882 - "driverName": "string",
3883 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3884 - }
3885 - ]
3886 - }
3887 - ]
3888 - }
3889 - ]
3890 -}
3891 -
3892 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3893 -|from|Дата начала запроса
3894 -|to|Дата  окончания
3895 -|vehicleId|ID объекта
3896 -|vehicleName|Имя объекта
3897 -|vehicleModel|Модель объекта
3898 -|penalty|Сумма штрафных баллов
3899 -|score|Оценка
3900 -|totalViolations|Суммарное количество нарушений
3901 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3902 -|overspeedingViolations|Превышение скорости
3903 -|accelerationViolations|Ускорение
3904 -|brakingViolations|Торможение
3905 -|turningViolations|Резкий поворот
3906 -|dangerousDrivingViolations|Резкое вождение
3907 -|sensorViolations|Нарушение по датчику
3908 -|moveTime|Время в движении
3909 -|mileage|Пробег
3910 -|tripsCount|Количество рейсов
3911 -|motohours|Моточасы
3912 -|maxSpeed|Максимальная скорость
3913 -|startAddress|Адрес начала рейса
3914 -|endAddress|Адрес окончания рейса
3915 -|drivers|Список водителей, которые были на объекте в течениии рейса
3916 -|driverGuid|Guid водителя
3917 -|driverName|Имя водителя
3918 -|driverRfid|Номер Карты-метки
3919 -
3920 3920  (% class="box" lang="en-US" style="text-align: center;" %)
3921 3921  (((
3922 3922  (% 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 г.