Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 35.1 >
edited by Илья Крайнов
on 2022/11/17 13:26
To version < 23.1 >
edited by Артем Шемяков
on 2022/09/02 10:15
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
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  
... ... @@ -20,27 +20,20 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
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 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 -
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}(%%)
42 -
43 -
36 +(% lang="en-US" %)
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -47,8 +47,8 @@
47 47  (% style="color:#000000" %){
48 48  
49 49  (% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
52 52  
53 53  (% lang="en-US" %)
54 54  }
... ... @@ -61,7 +61,7 @@
61 61  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -83,7 +83,7 @@
83 83  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -107,7 +107,7 @@
107 107   "name": "", ~/~/ наименование клиента
108 108   "fullName": "", ~/~/ полное наименование клиента
109 109   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
103 + "status": "", ~/~/ статус клиента
111 111  }
112 112  
113 113  
... ... @@ -121,7 +121,7 @@
121 121  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -187,7 +187,7 @@
187 187  
188 188  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
191 191  
192 192  (% style="color:#000000" %)Метод запроса: **POST**
193 193  
... ... @@ -232,7 +232,7 @@
232 232  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -303,7 +303,7 @@
303 303  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -327,67 +327,12 @@
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
329 329  
330 -(% class="box warningmessage" %)
331 -(((
332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
333 -)))
334 -
335 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
336 -
337 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
338 -
339 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
340 -
341 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
342 -
343 - [ 
344 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
345 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
346 - ]
347 -
348 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
349 -
350 -
351 -(% class="box warningmessage" %)
352 -(((
353 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
354 -)))
355 -
356 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
357 -
358 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
359 -
360 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
361 -
362 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
363 -
364 - [ 
365 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
366 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
367 - ]
368 -
369 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371 -
372 -В теле ответа:
373 -{
374 - "errorMessages": [
375 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
376 - ],
377 - "users": [
378 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
379 - ]
380 -}
381 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 -"users" - массив id пользователей, которых не удалось включить или отключить.
383 -
384 -
385 385  (% class="box errormessage" %)
386 386  (((
387 387  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
388 388  )))
389 389  
390 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
391 391  
392 392  (% style="color:#000000" %)Метод запроса: **DELETE**
393 393  
... ... @@ -413,7 +413,7 @@
413 413  
414 414  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
415 415  
416 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
417 417  
418 418  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
419 419  
... ... @@ -429,74 +429,21 @@
429 429  
430 430  (% style="color:#000000" %)Ответ:
431 431  
432 -{
370 +(% style="color:#000000" %){
433 433  
434 - "vehicleId": ,
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": "" , ~/~/ статус объекта
435 435  
436 - "name": "",
437 -
438 - "imei": "",
439 -
440 - "deviceTypeId": ,
441 -
442 - "deviceTypeName": "",
443 -
444 - "sim1": "",
445 -
446 - "parentId": "",
447 -
448 - "parentName": "",
449 -
450 - "modelId": "",
451 -
452 - "modelName": "",
453 -
454 - "createdAt": "",
455 -
456 - "mileageCalcMethod": "",
457 -
458 - "counters": {
459 -
460 - "mileageEnabled": ,
461 -
462 - "motohoursEnabled": ,
463 -
464 - "mileage": 22438858.137653351, ~/~/ пробег по нормам в метрах
465 -
466 - "motohours": 54545302.0 ~/~/ моточасы по нормам, в секундах
467 -
468 - },
469 -
470 - "inspectionTasks": [
471 -
472 - {
473 -
474 - "id": "",
475 -
476 - "enabled": ,
477 -
478 - "name": "",
479 -
480 - "description": "",
481 -
482 - "mileageCondition": ,
483 -
484 - "lastMileage": ,
485 -
486 - "motohoursCondition": ,
487 -
488 - "lastMotohours": ,
489 -
490 - "periodicCondition": ,
491 -
492 - "kind": "",
493 -
494 - "lastInspectionDate": ""
495 -
496 - }
497 -
498 - ]
499 -
500 500  }
501 501  
502 502  (% style="text-align:left" %)
... ... @@ -511,7 +511,7 @@
511 511  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
512 512  )))
513 513  
514 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
399 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
515 515  
516 516  (% style="color:#000000" %)Метод запроса: **POST**
517 517  
... ... @@ -533,22 +533,12 @@
533 533   "sim2": "" , ~/~/ Номер SIM2
534 534   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
535 535   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
536 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
537 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
538 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
539 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
540 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
541 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
542 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
543 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
544 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
545 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
546 - "counters": ~/~/ счетчики
547 - {
548 - "mileage": "" , ~/~/ пробег
549 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
550 - "motohours": "" , ~/~/ моточасы
551 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 + "counters": {
423 + "mileage": "" , ~/~/ пробег
424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 + "motohours": "" , ~/~/ моточасы
426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
552 552   },
553 553   "cmsv6Parameters": { ~/~/ параметры CMSv6
554 554   "enabled": true, ~/~/ флаг включения
... ... @@ -619,12 +619,7 @@
619 619  (% style="text-align:left" %)
620 620  (% style="color:#000000" %)}
621 621  
622 -**Валидация:**
623 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
624 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
625 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
626 626  
627 -
628 628  (% class="box successmessage" %)
629 629  (((
630 630  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -632,7 +632,7 @@
632 632  
633 633  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
634 634  
635 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
636 636  
637 637  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
638 638  
... ... @@ -660,13 +660,13 @@
660 660  
661 661  (% class="western" style="color:#000000" %)##{##
662 662  
663 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
664 664   "name": null, ~/~/ Имя ТС (string, опционально) 
665 665   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
666 666   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
667 667   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
668 668   "parentId": null, ~/~/ ID клиента (Guid, опционально) 
669 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
670 670  (% style="color:#000000" %)}
671 671  
672 672  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -688,21 +688,23 @@
688 688   "modelName": "" ~/~/ наименование модели объекта
689 689   "unitId": "" ~/~/ идентификатор подразделения
690 690   "unitName": "" ~/~/ наименование подразделения
691 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
692 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
693 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
694 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
561 + "status": "" ~/~/ статус объекта         
562 + "createdAt": "" ~/~/ дата создания объектов  (%%)
695 695  (% style="color:#000000" %)}
696 696  
697 697  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
698 698  
567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
699 699  
569 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 +
571 +
700 700  (% class="box successmessage" %)
701 701  (((
702 702  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
703 703  )))
704 704  
705 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
706 706  
707 707  (% style="color:#000000" %)Метод запроса: **POST**
708 708  
... ... @@ -747,7 +747,7 @@
747 747  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
748 748  )))
749 749  
750 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
751 751  
752 752  (% style="color:#000000" %)Метод запроса: **PUT**
753 753  
... ... @@ -759,7 +759,6 @@
759 759  
760 760  (% style="color:#000000" %){    
761 761  
762 -(((
763 763  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
764 764   "parentId": "", ~/~/ ID клиента
765 765   "name": "", ~/~/ имя ТС
... ... @@ -768,25 +768,15 @@
768 768   "modelId": "", ~/~/ , ID модели    
769 769   "unitId": "", ~/~/ подразделения
770 770   "sim1": "", ~/~/ SIM 1
771 - "sim2": "", ~/~/ SIM2     (%%)
772 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
773 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
774 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
775 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
776 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
777 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
778 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
779 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
780 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
781 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
782 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
783 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
784 -(% style="color:#000000" %) "counters": 
642 + "sim2": "", ~/~/ SIM2
643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
645 + "counters": 
785 785   {
786 786   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
787 787   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
788 - "mileage": "", ~/~/ пробег, в метрах 
789 - "motohours": "" ~/~/ моточасы, в секундах
649 + "mileage": «», пробег
650 + "motohours": «» моточасы
790 790   }
791 791   "cmsv6Parameters": ~/~/ параметры CMSv6
792 792   {       
... ... @@ -810,7 +810,6 @@
810 810   "kind": "", ~/~/ Вид периодичности по времени
811 811   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
812 812   } 
813 -)))
814 814  
815 815  (% style="color:#000000" %)}
816 816  
... ... @@ -864,18 +864,13 @@
864 864  (% lang="en-US" style="text-align:left" %)
865 865  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
866 866  
867 -**валидация:**
868 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
869 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
870 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
871 871  
872 -
873 873  (% class="box errormessage" %)
874 874  (((
875 875  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
876 876  )))
877 877  
878 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
879 879  
880 880  (% style="color:#000000" %)Метод запроса: **DELETE**
881 881  
... ... @@ -899,7 +899,7 @@
899 899  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
900 900  )))
901 901  
902 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
903 903  
904 904  (% style="color:#000000" %)Метод запроса: **GET**
905 905  
... ... @@ -928,7 +928,7 @@
928 928  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
929 929  )))
930 930  
931 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
932 932  
933 933  (% style="color:#000000" %)Метод запроса: **GET**
934 934  

Меню

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