Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 22.7 >
edited by Артем Шемяков
on 2022/09/02 10:11
To version < 20.5 >
edited by Артем Шемяков
on 2022/09/01 17:32
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% lang="en-US" %)
37 37  (% style="color:#000000" %)**Ответ:**
... ... @@ -44,7 +44,7 @@
44 44   "User": "" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 -}
47 + }
48 48  
49 49  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50 50  
... ... @@ -82,13 +82,13 @@
82 82  
83 83  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 84  
85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
86 86  
87 87  (% style="color:#000000" %)Метод запроса: **GET**
88 88  
89 89  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
91 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
92 92  
93 93  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94 94  
... ... @@ -99,11 +99,14 @@
99 99   "parentId": "", ~/~/ идентификатор клиента-родителя
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
102 + "agentInfoType": "", ~/~/ тип клиента1
103 103   "status": "", ~/~/ статус клиента
104 -}
104 + }
105 105  
106 106  
107 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
108 +
109 +
107 107  (% class="box" style="text-align: center;" %)
108 108  (((
109 109  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -142,13 +142,13 @@
142 142   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 143   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 144   "groups": "" , ~/~/ группы пользователя, названия групп
145 -}
148 + }
146 146  
147 147  (% style="text-align:left" %)
148 148  (% style="color:#000000; font-weight:normal" %)Ответ:
149 149  
150 150  (% style="text-align:left" %)
151 -(% style="color:#000000; font-weight:normal" %){    
154 +(% style="color:#000000; font-weight:normal" %){
152 152  
153 153  (% style="text-align:left" %)
154 154  (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
... ... @@ -170,7 +170,7 @@
170 170   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
171 171  
172 172  (% style="text-align:left" %)
173 -(% style="color:#000000; font-weight:normal" %)}
176 +(% style="color:#000000; font-weight:normal" %) }
174 174  
175 175  
176 176  (% class="box successmessage" %)
... ... @@ -186,10 +186,8 @@
186 186  
187 187  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
188 188  
189 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
190 190  
191 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
192 -
193 193  (% style="color:#000000" %){
194 194  
195 195   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -197,11 +197,11 @@
197 197   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
198 198   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
199 199  
200 -(% style="color:#000000" %)}
201 +(% style="color:#000000" %) }
201 201  
202 202  (% style="color:#000000" %)Ответ:
203 203  
204 -(% style="color:#000000" %){         (%%)
205 +(% style="color:#000000" %){ (%%)
205 205  
206 206   "id": "" , ~/~/ идентификатор пользователя
207 207   "lastName": "" , ~/~/ фамилия
... ... @@ -217,7 +217,7 @@
217 217   "status": "1",  ~/~/ статус пользователя
218 218   "astLogged": "", ~/~/ дата/время последней авторизации
219 219  
220 -(% style="color:#000000" %)}
221 +(% style="color:#000000" %) }
221 221  
222 222  
223 223  (% class="box warningmessage" %)
... ... @@ -234,63 +234,9 @@
234 234  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
235 235  
236 236  (% lang="en-US" style="text-align:left" %)
237 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
238 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
238 238  
239 -(% lang="en-US" style="text-align:left" %)
240 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
241 241  
242 -(% lang="en-US" style="text-align:left" %)
243 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
244 - "lastName": "" , ~/~/ фамилия
245 - "firstName": "" , ~/~/ имя
246 - "position": "" , ~/~/ должность
247 - "phone": "" , ~/~/ телефон
248 - "organization": "" , ~/~/ организация
249 - "login": "" , ~/~/ логин
250 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 - "email": "" , ~/~/ email
252 - "description": "" , ~/~/ описание
253 - "isEnabled": "" , ~/~/ признак включения
254 - "parentId": "" , ~/~/ Guid родительского агента
255 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
256 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
257 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
258 - "kind": "" , ~/~/ тип аутентификации
259 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
260 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
261 -
262 -(% lang="en-US" style="text-align:left" %)
263 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
264 -
265 -(% lang="en-US" style="text-align:left" %)
266 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
267 -
268 -(% lang="en-US" style="text-align:left" %)
269 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
270 -
271 -(% lang="en-US" style="text-align:left" %)
272 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
273 - "lastName": "" , ~/~/ фамилия
274 - "firstName": "" , ~/~/ имя
275 - "position": "" , ~/~/ должность
276 - "phone": "" , ~/~/ телефон
277 - "organization": "" , ~/~/ организация
278 - "login": "" , ~/~/ логин
279 - "password": "" , ~/~/ пароль 
280 - "email": "" , ~/~/ email
281 - "description": "" , ~/~/ описание
282 - "isEnabled": "" , ~/~/ признак включения
283 - "parentId": "" , ~/~/ Guid родительского агента
284 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
285 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
286 - "kind": "" , ~/~/ тип аутентификации
287 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
288 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
289 -
290 -(% lang="en-US" style="text-align:left" %)
291 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
292 -
293 -
294 294  (% class="box warningmessage" %)
295 295  (((
296 296  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
... ... @@ -300,20 +300,14 @@
300 300  
301 301  (% style="color:#000000" %)Метод запроса: **PUT**
302 302  
303 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
250 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:
304 304  
305 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
252 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
306 306  
307 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
254 +(% class="western" %)
255 +{{{ "description": "", // описание
256 + "data": "" // данные, связанные со сменой статуса}}}
308 308  
309 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
310 -
311 -(% style="color:#000000" %){
312 -
313 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
314 - "description": "" , ~/~/ описание
315 - "data": "" , ~/~/ данные, связанные со сменой статуса
316 -
317 317  (% style="color:#000000" %)}
318 318  
319 319  (% style="text-align:left" %)
... ... @@ -331,10 +331,8 @@
331 331  
332 332  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
333 333  
334 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
275 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
335 335  
336 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
337 -
338 338  (% style="text-align:left" %)
339 339  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
340 340  
... ... @@ -355,13 +355,13 @@
355 355  
356 356  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
357 357  
358 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
297 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
359 359  
360 360  (% style="color:#000000" %)Метод запроса: **GET**
361 361  
362 362  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
363 363  
364 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
303 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
365 365  
366 366  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
367 367  
... ... @@ -369,20 +369,24 @@
369 369  
370 370  (% style="color:#000000" %){
371 371  
372 - "vehicleId": "" , ~/~/ идентификатор объекта
373 - "name": "" , ~/~/ имя объекта
374 - "imei": "" , ~/~/ IMEI объекта
375 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
376 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
377 - "parentId": "" , ~/~/ идентификатор клиента-родителя
378 - "parentName": "" , ~/~/ наименование клиента-родителя,
379 - "modelId": "" , ~/~/ идентификатор модели объекта
380 - "modelName": "" , ~/~/ наименование модели объекта,
381 - "unitId": "" , ~/~/ идентификатор подразделения
382 - "unitName": "" , ~/~/ наименование подразделения
383 - "status": "" , ~/~/ статус объекта
311 +(% class="western" %)
312 +{{{ "vehicleId": “”, // идентификатор объекта
313 + "name": "", // имя объекта
314 + "imei": "", // IMEI объекта
315 + "deviceTypeId": “”, // идентификатор устройства объекта
316 + "deviceTypeName": "" // наименование устройства объекта
317 + "parentId": "", // идентификатор клиента-родителя
318 + "parentName": "" // наименование клиента-родителя,
319 + "modelId": "", // идентификатор модели объекта
320 + "modelName": "" // наименование модели объекта,
321 + "unitId": "", // идентификатор подразделения
322 + "unitName": "", // наименование подразделения
323 + "status": “”, // статус объекта
324 + ...
325 + },
326 + ...}}}
384 384  
385 -}
328 +(% style="color:#000000" %)}
386 386  
387 387  (% style="text-align:left" %)
388 388  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -404,92 +404,95 @@
404 404  
405 405  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
406 406  
407 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
350 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
408 408  
409 -(% style="color:#000000" %){
410 -
411 - "parentId": "" , ~/~/ ID клиента
412 - "name": "" , ~/~/ имя ТС
413 - "imei": "" , ~/~/ IMEI
414 - "deviceTypeId": "" , ~/~/ ID типа устройства
415 - "modelId": "" , ~/~/ ID модели
416 - "unitId": "" , ~/~/ ID подразделения
417 - "sim1": "" , ~/~/ Номер SIM 1
418 - "sim2": "" , ~/~/ Номер SIM2
419 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
420 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
421 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 - "counters": {
423 - "mileage": "" , ~/~/ пробег
424 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 - "motohours": "" , ~/~/ моточасы
426 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
352 +(% class="western" %)
353 +{{{ "parentId": "", // ID клиента
354 + "name": "", // имя ТС
355 + "imei": "", // IMEI
356 + "deviceTypeId": "",// ID типа устройства
357 + "modelId": "",
358 + "unitId": "", // ID подразделения
359 + "sim1": "", // Номер SIM 1
360 + "sim2": "", // Номер SIM2
361 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
362 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
363 + "consumptionIdle": "",// Расход топлива на холостом ходу
364 + "counters": {
365 + "mileage": "", // пробег
366 + "mileageEnabled": true, // флаг активности счётчика "пробег"
367 + "motohours":"", // моточасы
368 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
369 + },
370 + "cmsv6Parameters": { // параметры CMSv6
371 + "enabled": true, // флаг включения
372 + //"id": "", // идентификатор
373 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
374 + "login": "", // имя учетной записи
375 + "password": "" // пароль учетной записи
427 427   },
428 - "cmsv6Parameters": { ~/~/ параметры CMSv6
429 - "enabled": true, ~/~/ флаг включения
430 - "id": "" , ~/~/ идентификатор
431 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
432 - "login": "" , ~/~/ имя учетной записи
433 - "password": "" ~/~/ пароль учетной записи
434 - },
435 - "inspectionTasks": ~/~/ задания на ТО
377 + "inspectionTasks": [ // задания на ТО
436 436   {
437 - "enabled": "" , ~/~/ Признак включения
438 - "name": "" , ~/~/ Имя задания
439 - "description": "" , ~/~/ Описание задания
440 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
441 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
442 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
443 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
444 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
445 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
446 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
447 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
448 - }
379 + "enabled": "", // Признак включения
380 + "name": "", // Имя задания
381 + "description": "", // Описание задания
382 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
383 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
384 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
385 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
386 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
387 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
388 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
389 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
390 + },
391 + ]}}}
449 449  
450 -(% style="color:#000000" %) }
393 +(% style="color:#000000" %)… }
451 451  
452 452  (% style="color:#000000" %)Ответ:
453 453  
454 454  (% style="color:#000000" %){
455 455  
456 - "vehicleId": "", ~/~/ID ТС 
457 - "parentId": "", ~/~/Guid владельца ТС
458 - "name": "", ~/~/Имя объекта
459 - "imei": "", ~/~/IMEI
460 - "deviceTypeId": "", ~/~/ID типа устройства
461 - "modelId": "", ~/~/ID модели
462 - "unitId": "", ~/~/ID подразделения
463 - "sim1": "", ~/~/SIM1
464 - "sim2": "", ~/~/SIM2
465 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
466 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
467 - "counters": { ~/~/Счётчики
468 - "mileageEnabled": true,
469 - "motohoursEnabled": true,
470 - "mileage": "",
471 - "motohours": 345.0
472 - },
473 - "cmsv6Parameters": { ~/~/Параметры CmsV6
474 - "id": null,
475 - "enabled": true, ~/~/флаг включения
476 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
477 - "login": "", ~/~/ имя учетной записи
478 - "password": "" ~/~/ пароль учетной записи
479 - },
480 - "inspectionTasks": { ~/~/ задания на ТО
481 - "id": "", ~/~/ ID задачи
482 - "enabled": false, ~/~/ Признак включения
483 - "name": "", ~/~/ Имя задания
484 - "description": "", ~/~/ Описание задания
485 - "mileageCondition": "", ~/~/ Условие по пробегу
486 - "lastMileage": "", ~/~/ Пробег (в метрах)
487 - "motohoursCondition": "", ~/~/ Условие по моточасам
488 - "lastMotohours": "", ~/~/ Моточасы
489 - "periodicCondition": "", ~/~/ Условие периодичности по времени
490 - "kind": "", ~/~/ Вид периодичности по времени 
491 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
492 - }
399 +(% class="western" %)
400 +{{{ "vehicleId": "", //ID ТС
401 + "parentId": "", //Guid владельца ТС
402 + "name": "", //Имя объекта
403 + "imei": "", //IMEI
404 + "deviceTypeId": "", //ID типа устройства
405 + "modelId": "", //ID модели
406 + "unitId": "", //ID подразделения
407 + "sim1": "", //SIM1
408 + "sim2": "", //SIM2
409 + "consumptionPer100Km": "", //Расход топлива на 100 км
410 + "consumptionIdle": "", //Расход топлива на холостом ходу
411 + "counters": { //Счётчики
412 + "mileageEnabled": true,
413 + "motohoursEnabled": true,
414 + "mileage": "",
415 + "motohours": 345.0
416 + },
417 + "cmsv6Parameters": { //Параметры CmsV6
418 + "id": null,
419 + "enabled": true, //флаг включения
420 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
421 + "login": "", // имя учетной записи
422 + "password": "" // пароль учетной записи
423 + },
424 + "inspectionTasks": [ // задания на ТО
425 + {
426 + "id": "", // ID задачи
427 + "enabled": false, // Признак включения
428 + "name": "", // Имя задания
429 + "description": "", // Описание задания
430 + "mileageCondition": "", // Условие по пробегу
431 + "lastMileage": "", // Пробег (в метрах)
432 + "motohoursCondition": "", // Условие по моточасам
433 + "lastMotohours": "", // Моточасы
434 + "periodicCondition": "", // Условие периодичности по времени
435 + "kind": "", // Вид периодичности по времени
436 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
437 + }
438 + ]}}}
493 493  
494 494  (% style="text-align:left" %)
495 495  (% style="color:#000000" %)}
... ... @@ -508,11 +508,11 @@
508 508  
509 509  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
510 510  
511 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
457 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
512 512  
513 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
459 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
514 514  
515 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
461 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
516 516  
517 517  (% style="color:#000000" %)Метод запроса: **POST**
518 518  
... ... @@ -520,52 +520,26 @@
520 520  
521 521  (% style="color:#000000" %)В заголовках запроса:
522 522  
523 -(% style="color:#000000" %)− Content-Type: __**application/json**__
469 +(% style="color:#000000" %)− Content-Type: application/json
524 524  
525 525  (% style="color:#000000" %)− X-Auth: Токен авторизации
526 526  
527 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
473 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
528 528  
529 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
475 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
530 530  
531 -(% class="western" style="color:#000000" %)##{##
477 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
532 532  
533 -(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
534 - "name": null, ~/~/ Имя ТС (string, опционально) 
535 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
536 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
537 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
538 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
539 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
540 -(% style="color:#000000" %)}
479 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
541 541  
542 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
481 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
543 543  
544 -(% style="color:#000000" %)Ответ:
483 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
545 545  
546 -(% style="color:#000000" %){
485 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
547 547  
548 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
549 - "name": "" ~/~/ наименование объекта
550 - "imei": "" ~/~/ IMEI объекта
551 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
552 - "deviceTypeName": "" ~/~/ наименование типа устройства
553 - "sim1": "" ~/~/ первый номер телефона
554 - "sim2": "" ~/~/ второй номер телефона
555 - "parentId": "" ~/~/ идентификатор клиента-родителя
556 - "parentName": "" ~/~/ наименование клиента-родителя
557 - "modelId": "" ~/~/ идентификатор модели объекта
558 - "modelName": "" ~/~/ наименование модели объекта
559 - "unitId": "" ~/~/ идентификатор подразделения
560 - "unitName": "" ~/~/ наименование подразделения
561 - "status": "" ~/~/ статус объекта         
562 - "createdAt": "" ~/~/ дата создания объектов  (%%)
563 -(% style="color:#000000" %)}
487 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
564 564  
565 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
566 -
567 -(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
568 -
569 569  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 570  
571 571  
... ... @@ -584,34 +584,32 @@
584 584  
585 585  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
586 586  
587 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
507 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
588 588  
589 -(% style="color:#000000" %){
509 +(% class="western" %)
510 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
511 +  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
512 +  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
513 + "date": "", // Дата смены статуса (null если сменить немедленно)
514 + "description": "", // Описание
515 + "data": "", // Данные
516 + "overwrite": false, // Флаг перезаписи
517 + "stage": "", // Состояние, может быть null}}}
590 590  
591 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
592 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
593 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
594 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
595 - "description": "", ~/~/ Описание
596 - "data": "", ~/~/ Данные
597 - "overwrite": false, ~/~/ Флаг перезаписи
598 - "stage": "", ~/~/ Состояние, может быть null
599 -
600 600  (% style="color:#000000" %)}
601 601  
602 -(% style="color:#000000" %)Ответ:
521 +(% style="color:#000000" %)Ответ: {
603 603  
604 -(% style="color:#000000" %){
523 +(% class="western" %)
524 +{{{ "status": "", // значение статуса
525 + "date": "", // Дата смены статуса
526 + "description": "", // Описание
527 + "data": "", // Данные
528 + "overwrite": false, // Флаг перезаписи
529 + "stage": "", // Состояние}}}
605 605  
606 - "status": "", ~/~/ значение статуса
607 - "date": "", ~/~/ Дата смены статуса 
608 - "description": "", ~/~/ Описание
609 - "data": "", ~/~/ Данные
610 - "overwrite": false, ~/~/ Флаг перезаписи
611 - "stage": "", ~/~/ Состояние
612 -
613 613  (% style="text-align:left" %)
614 -(% style="color:#000000" %) }
532 +(% style="color:#000000" %)}
615 615  
616 616  
617 617  (% class="box warningmessage" %)
... ... @@ -629,102 +629,14 @@
629 629  
630 630  (% style="color:#000000" %)Параметры в теле запроса (JSON):
631 631  
632 -(% style="color:#000000" %){    
550 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
633 633  
634 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
635 - "parentId": "", ~/~/ ID клиента
636 - "name": "", ~/~/ имя ТС
637 - "imei": "", ~/~/ IMEI
638 - "deviceTypeId": "", ~/~/ ID типа устройства
639 - "modelId": "", ~/~/ , ID модели    
640 - "unitId": "", ~/~/ подразделения
641 - "sim1": "", ~/~/ SIM 1
642 - "sim2": "", ~/~/ SIM2
643 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
644 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
645 - "counters": 
646 - {
647 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
648 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
649 - "mileage": «», пробег
650 - "motohours": «» моточасы
651 - }
652 - "cmsv6Parameters": ~/~/ параметры CMSv6
653 - {       
654 - "id": "", ~/~/ идентификатор
655 - "enabled": true, ~/~/ флаг включения
656 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
657 - "login": "", ~/~/ имя учетной записи
658 - "password": "", ~/~/ пароль учетной записи
659 - }
660 - "inspectionTasks": ~/~/ задания на ТО
661 - {
662 - "id": "", ~/~/ ID задания
663 - "enabled": false, ~/~/ Признак включения
664 - "name": "", ~/~/ Имя задания
665 - "description": "", ~/~/ Описание задания
666 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
667 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
668 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
669 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
671 - "kind": "", ~/~/ Вид периодичности по времени
672 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
673 - } 
674 -
675 -(% style="color:#000000" %)}
676 -
677 677  (% style="color:#000000" %)Ответ:
678 678  
679 679  (% lang="en-US" style="text-align:left" %)
680 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
555 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
681 681  
682 -(% lang="en-US" style="text-align:left" %)
683 - "vehicleId": "", ~/~/ ID ТС
684 - "parentId": "", ~/~/ ID клиента
685 - "name": "", ~/~/ имя ТС
686 - "imei": "", ~/~/ IMEI
687 - "deviceTypeId": "", ~/~/ типа устройства
688 - "modelId": "", ~/~/ ID модели
689 - "unitId": "", ~/~/ ID подразделения
690 - "sim1": "", ~/~/ SIM 1
691 - "sim2": "", ~/~/ SIM2
692 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
693 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
694 - "counters": 
695 - {
696 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
697 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
698 - "mileage": "", ~/~/ пробег
699 - "motohours": "", ~/~/ моточасы
700 - }
701 - "cmsv6Parameters": ~/~/ параметры CMSv6
702 - {
703 - "id": ~/~/ идентификатор
704 - "enabled": true, ~/~/ флаг включения
705 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
706 - "login": "", ~/~/ имя учетной записи
707 - "password": "", ~/~/ пароль учетной записи
708 - }
709 - "inspectionTasks": ~/~/ задания на ТО
710 - {
711 - "id": "", ~/~/ ID задания
712 - "enabled": false, ~/~/ Признак включения
713 - "name": "", ~/~/ Имя задания
714 - "description": "", ~/~/ Описание задания
715 - "mileageCondition": "", ~/~/ Условие по пробегу
716 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
717 - "motohoursCondition": "", ~/~/ Условие по моточасам
718 - "lastMotohours": "", ~/~/ Моточасы
719 - "periodicCondition": "", ~/~/ Условие периодичности по времени
720 - "kind": "", ~/~/ Вид периодичности по времени
721 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
722 - }
723 723  
724 -(% lang="en-US" style="text-align:left" %)
725 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
726 -
727 -
728 728  (% class="box errormessage" %)
729 729  (((
730 730  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -762,15 +762,16 @@
762 762  
763 763  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
764 764  
765 -(% style="color:#000000" %)Ответ:
595 +(% style="color:#000000" %)Ответ: [
766 766  
767 -(% style="color:#000000" %){
597 +(% class="western" %)
598 +{{{ {
599 + "deviceTypeId" : "", // ID типа устройства
600 + "deviceTypeName" : "" // Название типа устройства
601 + },}}}
768 768  
769 - "deviceTypeId" : "", ~/~/ ID типа устройства
770 - "deviceTypeName" : "" ~/~/ Название типа устройства
771 -
772 772  (% style="text-align:left" %)
773 -(% style="color:#000000" %)}
604 +(% style="color:#000000" %)…** **]
774 774  
775 775  
776 776  (% class="box" style="text-align: center;" %)
... ... @@ -791,16 +791,19 @@
791 791  
792 792  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
793 793  
794 -(% style="color:#000000" %)Ответ:
625 +(% style="color:#000000" %)Ответ: [
795 795  
796 -(% style="color:#000000" %){
627 +(% class="western" style="margin-bottom:19px" %)
628 +{{{ {}}}
797 797  
798 - "id": "", ~/~/ ID типа датчика 
799 - "name": "", ~/~/ Название
800 - "description": "", ~/~/ Описание
630 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
801 801  
632 +(% class="western" %)
633 +{{{ "description": "" // Описание
634 + },}}}
635 +
802 802  (% style="text-align:left" %)
803 -(% style="color:#000000" %)}
637 +(% style="color:#000000" %)… ]
804 804  
805 805  
806 806  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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