Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 20.6 >
edited by Артем Шемяков
on 2022/09/01 17:41
To version < 22.7 >
edited by Артем Шемяков
on 2022/09/02 10:11
>
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,14 +99,11 @@
99 99   "parentId": "", ~/~/ идентификатор клиента-родителя
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента1
102 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
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 -
110 110  (% class="box" style="text-align: center;" %)
111 111  (((
112 112  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -145,13 +145,13 @@
145 145   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 146   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 147   "groups": "" , ~/~/ группы пользователя, названия групп
148 - }
145 +}
149 149  
150 150  (% style="text-align:left" %)
151 151  (% style="color:#000000; font-weight:normal" %)Ответ:
152 152  
153 153  (% style="text-align:left" %)
154 -(% style="color:#000000; font-weight:normal" %){
151 +(% style="color:#000000; font-weight:normal" %){    
155 155  
156 156  (% style="text-align:left" %)
157 157  (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
... ... @@ -173,7 +173,7 @@
173 173   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
174 174  
175 175  (% style="text-align:left" %)
176 -(% style="color:#000000; font-weight:normal" %) }
173 +(% style="color:#000000; font-weight:normal" %)}
177 177  
178 178  
179 179  (% class="box successmessage" %)
... ... @@ -189,8 +189,10 @@
189 189  
190 190  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
191 191  
192 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
189 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
193 193  
191 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
192 +
194 194  (% style="color:#000000" %){
195 195  
196 196   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -198,11 +198,11 @@
198 198   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 199   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
200 200  
201 -(% style="color:#000000" %) }
200 +(% style="color:#000000" %)}
202 202  
203 203  (% style="color:#000000" %)Ответ:
204 204  
205 -(% style="color:#000000" %){ (%%)
204 +(% style="color:#000000" %){         (%%)
206 206  
207 207   "id": "" , ~/~/ идентификатор пользователя
208 208   "lastName": "" , ~/~/ фамилия
... ... @@ -218,7 +218,7 @@
218 218   "status": "1",  ~/~/ статус пользователя
219 219   "astLogged": "", ~/~/ дата/время последней авторизации
220 220  
221 -(% style="color:#000000" %) }
220 +(% style="color:#000000" %)}
222 222  
223 223  
224 224  (% class="box warningmessage" %)
... ... @@ -238,7 +238,7 @@
238 238  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
239 239  
240 240  (% lang="en-US" style="text-align:left" %)
241 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
240 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
242 242  
243 243  (% lang="en-US" style="text-align:left" %)
244 244  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
... ... @@ -261,16 +261,16 @@
261 261   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
262 262  
263 263  (% lang="en-US" style="text-align:left" %)
264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
263 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
265 265  
266 266  (% lang="en-US" style="text-align:left" %)
267 267  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
268 268  
269 269  (% lang="en-US" style="text-align:left" %)
270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ //
269 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
271 271  
272 272  (% lang="en-US" style="text-align:left" %)
273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
272 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
274 274   "lastName": "" , ~/~/ фамилия
275 275   "firstName": "" , ~/~/ имя
276 276   "position": "" , ~/~/ должность
... ... @@ -286,10 +286,10 @@
286 286   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
287 287   "kind": "" , ~/~/ тип аутентификации
288 288   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
288 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
290 290  
291 291  (% lang="en-US" style="text-align:left" %)
292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
291 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
293 293  
294 294  
295 295  (% class="box warningmessage" %)
... ... @@ -301,14 +301,20 @@
301 301  
302 302  (% style="color:#000000" %)Метод запроса: **PUT**
303 303  
304 -(% 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} Параметр запроса:
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}
305 305  
306 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
305 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
307 307  
308 -(% class="western" %)
309 -{{{ "description": "", // описание
310 - "data": "" // данные, связанные со сменой статуса}}}
307 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
311 311  
309 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
310 +
311 +(% style="color:#000000" %){
312 +
313 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
314 + "description": "" , ~/~/ описание
315 + "data": "" , ~/~/ данные, связанные со сменой статуса
316 +
312 312  (% style="color:#000000" %)}
313 313  
314 314  (% style="text-align:left" %)
... ... @@ -326,8 +326,10 @@
326 326  
327 327  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
328 328  
329 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
334 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
330 330  
336 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
337 +
331 331  (% style="text-align:left" %)
332 332  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
333 333  
... ... @@ -348,13 +348,13 @@
348 348  
349 349  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
350 350  
351 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
358 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
352 352  
353 353  (% style="color:#000000" %)Метод запроса: **GET**
354 354  
355 355  (% 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>
356 356  
357 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
364 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
358 358  
359 359  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
360 360  
... ... @@ -362,24 +362,20 @@
362 362  
363 363  (% style="color:#000000" %){
364 364  
365 -(% class="western" %)
366 -{{{ "vehicleId": “”, // идентификатор объекта
367 - "name": "", // имя объекта
368 - "imei": "", // IMEI объекта
369 - "deviceTypeId": “”, // идентификатор устройства объекта
370 - "deviceTypeName": "" // наименование устройства объекта
371 - "parentId": "", // идентификатор клиента-родителя
372 - "parentName": "" // наименование клиента-родителя,
373 - "modelId": "", // идентификатор модели объекта
374 - "modelName": "" // наименование модели объекта,
375 - "unitId": "", // идентификатор подразделения
376 - "unitName": "", // наименование подразделения
377 - "status": “”, // статус объекта
378 - ...
379 - },
380 - ...}}}
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": "" , ~/~/ статус объекта
381 381  
382 -(% style="color:#000000" %)}
385 +}
383 383  
384 384  (% style="text-align:left" %)
385 385  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -401,95 +401,92 @@
401 401  
402 402  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
403 403  
404 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
407 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
405 405  
406 -(% class="western" %)
407 -{{{ "parentId": "", // ID клиента
408 - "name": "", // имя ТС
409 - "imei": "", // IMEI
410 - "deviceTypeId": "",// ID типа устройства
411 - "modelId": "",
412 - "unitId": "", // ID подразделения
413 - "sim1": "", // Номер SIM 1
414 - "sim2": "", // Номер SIM2
415 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
416 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
417 - "consumptionIdle": "",// Расход топлива на холостом ходу
418 - "counters": {
419 - "mileage": "", // пробег
420 - "mileageEnabled": true, // флаг активности счётчика "пробег"
421 - "motohours":"", // моточасы
422 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
423 - },
424 - "cmsv6Parameters": { // параметры CMSv6
425 - "enabled": true, // флаг включения
426 - //"id": "", // идентификатор
427 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
428 - "login": "", // имя учетной записи
429 - "password": "" // пароль учетной записи
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 ~/~/ флаг активности счётчика "моточасы"
430 430   },
431 - "inspectionTasks": [ // задания на ТО
432 - {
433 - "enabled": "", // Признак включения
434 - "name": "", // Имя задания
435 - "description": "", // Описание задания
436 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
437 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
438 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
439 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
440 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
441 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
442 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
443 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
428 + "cmsv6Parameters": { ~/~/ параметры CMSv6
429 + "enabled": true, ~/~/ флаг включения
430 + "id": "" , ~/~/ идентификатор
431 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
432 + "login": "" , ~/~/ имя учетной записи
433 + "password": "" ~/~/ пароль учетной записи
444 444   },
445 - ]}}}
435 + "inspectionTasks": ~/~/ задания на ТО
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 + }
446 446  
447 -(% style="color:#000000" %)… }
450 +(% style="color:#000000" %) }
448 448  
449 449  (% style="color:#000000" %)Ответ:
450 450  
451 451  (% style="color:#000000" %){
452 452  
453 -(% class="western" %)
454 -{{{ "vehicleId": "", //ID ТС
455 - "parentId": "", //Guid владельца ТС
456 - "name": "", //Имя объекта
457 - "imei": "", //IMEI
458 - "deviceTypeId": "", //ID типа устройства
459 - "modelId": "", //ID модели
460 - "unitId": "", //ID подразделения
461 - "sim1": "", //SIM1
462 - "sim2": "", //SIM2
463 - "consumptionPer100Km": "", //Расход топлива на 100 км
464 - "consumptionIdle": "", //Расход топлива на холостом ходу
465 - "counters": { //Счётчики
466 - "mileageEnabled": true,
467 - "motohoursEnabled": true,
468 - "mileage": "",
469 - "motohours": 345.0
470 - },
471 - "cmsv6Parameters": { //Параметры CmsV6
472 - "id": null,
473 - "enabled": true, //флаг включения
474 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
475 - "login": "", // имя учетной записи
476 - "password": "" // пароль учетной записи
477 - },
478 - "inspectionTasks": [ // задания на ТО
479 - {
480 - "id": "", // ID задачи
481 - "enabled": false, // Признак включения
482 - "name": "", // Имя задания
483 - "description": "", // Описание задания
484 - "mileageCondition": "", // Условие по пробегу
485 - "lastMileage": "", // Пробег (в метрах)
486 - "motohoursCondition": "", // Условие по моточасам
487 - "lastMotohours": "", // Моточасы
488 - "periodicCondition": "", // Условие периодичности по времени
489 - "kind": "", // Вид периодичности по времени
490 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
491 - }
492 - ]}}}
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 + }
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" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
511 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
512 512  
513 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
513 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
514 514  
515 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
515 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
516 516  
517 517  (% style="color:#000000" %)Метод запроса: **POST**
518 518  
... ... @@ -520,26 +520,52 @@
520 520  
521 521  (% style="color:#000000" %)В заголовках запроса:
522 522  
523 -(% style="color:#000000" %)− Content-Type: application/json
523 +(% style="color:#000000" %)− Content-Type: __**application/json**__
524 524  
525 525  (% style="color:#000000" %)− X-Auth: Токен авторизации
526 526  
527 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
527 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
528 528  
529 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
529 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
530 530  
531 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
531 +(% class="western" style="color:#000000" %)##{##
532 532  
533 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
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" %)}
534 534  
535 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
542 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
536 536  
537 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
544 +(% style="color:#000000" %)Ответ:
538 538  
539 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
546 +(% style="color:#000000" %){
540 540  
541 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
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" %)}
542 542  
565 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
566 +
567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
568 +
543 543  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
544 544  
545 545  
... ... @@ -558,32 +558,34 @@
558 558  
559 559  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
560 560  
561 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
587 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
562 562  
563 -(% class="western" %)
564 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
565 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
566 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
567 - "date": "", // Дата смены статуса (null если сменить немедленно)
568 - "description": "", // Описание
569 - "data": "", // Данные
570 - "overwrite": false, // Флаг перезаписи
571 - "stage": "", // Состояние, может быть null}}}
589 +(% style="color:#000000" %){
572 572  
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 +
573 573  (% style="color:#000000" %)}
574 574  
575 -(% style="color:#000000" %)Ответ: {
602 +(% style="color:#000000" %)Ответ:
576 576  
577 -(% class="western" %)
578 -{{{ "status": "", // значение статуса
579 - "date": "", // Дата смены статуса
580 - "description": "", // Описание
581 - "data": "", // Данные
582 - "overwrite": false, // Флаг перезаписи
583 - "stage": "", // Состояние}}}
604 +(% style="color:#000000" %){
584 584  
606 + "status": "", ~/~/ значение статуса
607 + "date": "", ~/~/ Дата смены статуса 
608 + "description": "", ~/~/ Описание
609 + "data": "", ~/~/ Данные
610 + "overwrite": false, ~/~/ Флаг перезаписи
611 + "stage": "", ~/~/ Состояние
612 +
585 585  (% style="text-align:left" %)
586 -(% style="color:#000000" %)}
614 +(% style="color:#000000" %) }
587 587  
588 588  
589 589  (% class="box warningmessage" %)
... ... @@ -601,14 +601,102 @@
601 601  
602 602  (% style="color:#000000" %)Параметры в теле запроса (JSON):
603 603  
604 -(% 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»: «» //Сколько раз выполнить задание } ] }
632 +(% style="color:#000000" %){    
605 605  
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 +
606 606  (% style="color:#000000" %)Ответ:
607 607  
608 608  (% lang="en-US" style="text-align:left" %)
609 -(% 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»: «» //Сколько раз выполнить задание } ] }
680 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
610 610  
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 + }
611 611  
724 +(% lang="en-US" style="text-align:left" %)
725 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
726 +
727 +
612 612  (% class="box errormessage" %)
613 613  (((
614 614  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -646,16 +646,15 @@
646 646  
647 647  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
648 648  
649 -(% style="color:#000000" %)Ответ: [
765 +(% style="color:#000000" %)Ответ:
650 650  
651 -(% class="western" %)
652 -{{{ {
653 - "deviceTypeId" : "", // ID типа устройства
654 - "deviceTypeName" : "" // Название типа устройства
655 - },}}}
767 +(% style="color:#000000" %){
656 656  
769 + "deviceTypeId" : "", ~/~/ ID типа устройства
770 + "deviceTypeName" : "" ~/~/ Название типа устройства
771 +
657 657  (% style="text-align:left" %)
658 -(% style="color:#000000" %)…** **]
773 +(% style="color:#000000" %)}
659 659  
660 660  
661 661  (% class="box" style="text-align: center;" %)
... ... @@ -676,19 +676,16 @@
676 676  
677 677  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
678 678  
679 -(% style="color:#000000" %)Ответ: [
794 +(% style="color:#000000" %)Ответ:
680 680  
681 -(% class="western" style="margin-bottom:19px" %)
682 -{{{ {}}}
796 +(% style="color:#000000" %){
683 683  
684 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
798 + "id": "", ~/~/ ID типа датчика 
799 + "name": "", ~/~/ Название
800 + "description": "", ~/~/ Описание
685 685  
686 -(% class="western" %)
687 -{{{ "description": "" // Описание
688 - },}}}
689 -
690 690  (% style="text-align:left" %)
691 -(% style="color:#000000" %)… ]
803 +(% style="color:#000000" %)}
692 692  
693 693  
694 694  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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