Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 23.2 >
edited by Артем Шемяков
on 2022/09/02 12:30
To version < 28.5 >
edited by Артем Шемяков
on 2022/09/22 09:57
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -20,20 +20,27 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **GET**
30 +(% style="color:#000000" %)Метод запроса: **POST**
31 31  
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]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% lang="en-US" %)
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 +
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}(%%)
42 +
43 +
37 37  (% style="color:#000000" %)**Ответ:**
38 38  
39 39  (% lang="en-US" %)
... ... @@ -40,8 +40,8 @@
40 40  (% style="color:#000000" %){
41 41  
42 42  (% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 47  }
... ... @@ -100,7 +100,7 @@
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 102   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 - "status": "", ~/~/ статус клиента
110 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
104 104  }
105 105  
106 106  
... ... @@ -418,12 +418,21 @@
418 418   "sim2": "" , ~/~/ Номер SIM2
419 419   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
420 420   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
421 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 - "counters": {
423 - "mileage": "" , ~/~/ пробег
424 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 - "motohours": "" , ~/~/ моточасы
426 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
428 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
429 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
430 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
431 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
432 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
433 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
434 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
435 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
436 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
437 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
438 + "counters": {
439 + "mileage": "" , ~/~/ пробег
440 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
441 + "motohours": "" , ~/~/ моточасы
442 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
427 427   },
428 428   "cmsv6Parameters": { ~/~/ параметры CMSv6
429 429   "enabled": true, ~/~/ флаг включения
... ... @@ -494,7 +494,12 @@
494 494  (% style="text-align:left" %)
495 495  (% style="color:#000000" %)}
496 496  
513 +**Валидация:**
514 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
515 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
516 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
497 497  
518 +
498 498  (% class="box successmessage" %)
499 499  (((
500 500  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -530,13 +530,13 @@
530 530  
531 531  (% class="western" style="color:#000000" %)##{##
532 532  
533 -(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
554 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
534 534   "name": null, ~/~/ Имя ТС (string, опционально) 
535 535   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
536 536   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
537 537   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
538 538   "parentId": null, ~/~/ ID клиента (Guid, опционально) 
539 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
560 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
540 540  (% style="color:#000000" %)}
541 541  
542 542  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -558,17 +558,15 @@
558 558   "modelName": "" ~/~/ наименование модели объекта
559 559   "unitId": "" ~/~/ идентификатор подразделения
560 560   "unitName": "" ~/~/ наименование подразделения
561 - "status": "" ~/~/ статус объекта         
562 - "createdAt": "" ~/~/ дата создания объектов  (%%)
582 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
583 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
584 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
585 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
563 563  (% style="color:#000000" %)}
564 564  
565 565  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
566 566  
567 -(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
568 568  
569 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 -
571 -
572 572  (% class="box successmessage" %)
573 573  (((
574 574  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

Меню

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