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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Tags
... ... @@ -1,0 +1,1 @@
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,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  }
... ... @@ -54,7 +54,7 @@
54 54  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
55 55  )))
56 56  
57 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
64 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
58 58  
59 59  (% style="color:#000000" %)Метод запроса: **GET**
60 60  
... ... @@ -76,7 +76,7 @@
76 76  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
77 77  )))
78 78  
79 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
86 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
80 80  
81 81  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82 82  
... ... @@ -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  
... ... @@ -114,7 +114,7 @@
114 114  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
115 115  )))
116 116  
117 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
124 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
118 118  
119 119  (% style="color:#000000" %)Метод запроса: **POST**
120 120  
... ... @@ -130,9 +130,9 @@
130 130   "position": "", ~/~/ должность
131 131   "phone": "", ~/~/ телефон
132 132   "organization": "", ~/~/ организация
133 - "login": "", ~/~/ логин
134 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 - "email": "", ~/~/ email
140 + "login": "", ~/~/ логин (обязателен)
141 + "password": "", ~/~/ пароль (обязателен)
142 + "email": "", ~/~/ email (обязателен)
136 136   "description": "", ~/~/ описание
137 137   "isEnabled": "", ~/~/ признак включения
138 138   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -141,7 +141,7 @@
141 141   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
142 142   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 143   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 - "groups": "" , ~/~/ группы пользователя, названия групп
151 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
145 145  }
146 146  
147 147  (% style="text-align:left" %)
... ... @@ -167,7 +167,7 @@
167 167   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
168 168   "kind": "" , ~/~/ тип аутентификации
169 169   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
170 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
177 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
171 171  
172 172  (% style="text-align:left" %)
173 173  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -180,7 +180,7 @@
180 180  
181 181  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
182 182  
183 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
190 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
184 184  
185 185  (% style="color:#000000" %)Метод запроса: **POST**
186 186  
... ... @@ -225,7 +225,7 @@
225 225  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
226 226  )))
227 227  
228 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
235 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
229 229  
230 230  (% style="color:#000000" %)Метод запроса: **PUT**
231 231  
... ... @@ -246,10 +246,10 @@
246 246   "position": "" , ~/~/ должность
247 247   "phone": "" , ~/~/ телефон
248 248   "organization": "" , ~/~/ организация
249 - "login": "" , ~/~/ логин
250 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 - "email": "" , ~/~/ email
252 - "description": "" , ~/~/ описание
256 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%)
257 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
258 + "email": "" , ~/~/ email  (% style="color:#000000" %)(Если null - менять не надо)(%%)
259 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
253 253   "isEnabled": "" , ~/~/ признак включения
254 254   "parentId": "" , ~/~/ Guid родительского агента
255 255   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -296,7 +296,7 @@
296 296  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
297 297  )))
298 298  
299 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
306 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
300 300  
301 301  (% style="color:#000000" %)Метод запроса: **PUT**
302 302  
... ... @@ -320,12 +320,67 @@
320 320  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
321 321  
322 322  
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 +
323 323  (% class="box errormessage" %)
324 324  (((
325 325  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
326 326  )))
327 327  
328 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
390 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
329 329  
330 330  (% style="color:#000000" %)Метод запроса: **DELETE**
331 331  
... ... @@ -351,7 +351,7 @@
351 351  
352 352  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
353 353  
354 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
416 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
355 355  
356 356  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
357 357  
... ... @@ -367,21 +367,76 @@
367 367  
368 368  (% style="color:#000000" %)Ответ:
369 369  
370 -(% style="color:#000000" %){
432 +{
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": "" , ~/~/ статус объекта
434 + "vehicleId": "", ~/~/ ID объекта
384 384  
436 + "name": "", ~/~/ Имя объекта
437 +
438 + "imei": "", ~/~/ IMEI объекта
439 +
440 + "deviceTypeId": , ~/~/ ID типа устройства
441 +
442 + "deviceTypeName": "", ~/~/ Название типа устройства
443 +
444 + "sim1": "", ~/~/ Номер SIM1
445 +
446 + "parentId": "", Номер SIM2
447 +
448 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
449 +
450 + "modelId": "", ID модели объекта
451 +
452 + "modelName": "", Имя модели объекта
453 +
454 + "createdAt": "", Дата создания объекта
455 +
456 + "mileageCalcMethod": "", Выбранный метод расчета пробега
457 +
458 + "counters": { ~/~/ Нормы
459 +
460 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
461 +
462 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
463 +
464 + "mileage": "", ~/~/ Пробег по нормам в метрах
465 +
466 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
467 +
468 + },
469 +
470 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471 +
472 + {
473 +
474 + "id": "", ~/~/ ID  задания
475 +
476 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
477 +
478 + "name": "", ~/~/ Наименование задания
479 +
480 + "description": "", ~/~/ Описание задания
481 +
482 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
483 +
484 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
485 +
486 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
487 +
488 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
489 +
490 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491 +
492 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 +
494 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495 +
496 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497 +
498 + }
499 +
500 + ]
501 +
385 385  }
386 386  
387 387  (% style="text-align:left" %)
... ... @@ -396,7 +396,7 @@
396 396  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
397 397  )))
398 398  
399 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
516 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
400 400  
401 401  (% style="color:#000000" %)Метод запроса: **POST**
402 402  
... ... @@ -418,12 +418,22 @@
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 ~/~/ флаг активности счётчика "моточасы"
538 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
539 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
540 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
541 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
542 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
543 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
544 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
545 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
546 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
547 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
548 + "counters": ~/~/ счетчики
549 + {
550 + "mileage": "" , ~/~/ пробег
551 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
552 + "motohours": "" , ~/~/ моточасы
553 + "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  
624 +**Валидация:**
625 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
626 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
627 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
497 497  
629 +
498 498  (% class="box successmessage" %)
499 499  (((
500 500  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -502,7 +502,7 @@
502 502  
503 503  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
504 504  
505 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
637 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
506 506  
507 507  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
508 508  
... ... @@ -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, опционально) 
665 +(% 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, опционально)##(%%)
671 + "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,23 +558,21 @@
558 558   "modelName": "" ~/~/ наименование модели объекта
559 559   "unitId": "" ~/~/ идентификатор подразделения
560 560   "unitName": "" ~/~/ наименование подразделения
561 - "status": "" ~/~/ статус объекта         
562 - "createdAt": "" ~/~/ дата создания объектов  (%%)
693 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
694 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
695 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
696 +(% 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}**
575 575  )))
576 576  
577 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
707 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
578 578  
579 579  (% style="color:#000000" %)Метод запроса: **POST**
580 580  
... ... @@ -619,7 +619,7 @@
619 619  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
620 620  )))
621 621  
622 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
752 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
623 623  
624 624  (% style="color:#000000" %)Метод запроса: **PUT**
625 625  
... ... @@ -631,6 +631,7 @@
631 631  
632 632  (% style="color:#000000" %){    
633 633  
764 +(((
634 634  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
635 635   "parentId": "", ~/~/ ID клиента
636 636   "name": "", ~/~/ имя ТС
... ... @@ -639,15 +639,25 @@
639 639   "modelId": "", ~/~/ , ID модели    
640 640   "unitId": "", ~/~/ подразделения
641 641   "sim1": "", ~/~/ SIM 1
642 - "sim2": "", ~/~/ SIM2
643 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
644 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
645 - "counters": 
773 + "sim2": "", ~/~/ SIM2     (%%)
774 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
775 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
776 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
777 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
778 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
779 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
780 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
781 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
782 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
783 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
784 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
785 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
786 +(% style="color:#000000" %) "counters": 
646 646   {
647 647   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
648 648   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
649 - "mileage": «», пробег
650 - "motohours": «» моточасы
790 + "mileage": "", ~/~/ пробег, в метрах 
791 + "motohours": "" ~/~/ моточасы, в секундах
651 651   }
652 652   "cmsv6Parameters": ~/~/ параметры CMSv6
653 653   {       
... ... @@ -671,6 +671,7 @@
671 671   "kind": "", ~/~/ Вид периодичности по времени
672 672   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
673 673   } 
815 +)))
674 674  
675 675  (% style="color:#000000" %)}
676 676  
... ... @@ -724,13 +724,18 @@
724 724  (% lang="en-US" style="text-align:left" %)
725 725  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
726 726  
869 +**валидация:**
870 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
871 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
872 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
727 727  
874 +
728 728  (% class="box errormessage" %)
729 729  (((
730 730  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
731 731  )))
732 732  
733 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
880 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
734 734  
735 735  (% style="color:#000000" %)Метод запроса: **DELETE**
736 736  
... ... @@ -754,7 +754,7 @@
754 754  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
755 755  )))
756 756  
757 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
904 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
758 758  
759 759  (% style="color:#000000" %)Метод запроса: **GET**
760 760  
... ... @@ -783,7 +783,7 @@
783 783  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
784 784  )))
785 785  
786 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
933 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
787 787  
788 788  (% style="color:#000000" %)Метод запроса: **GET**
789 789  

Меню

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