Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 71.1 >
edited by Илья Крайнов
on 2023/03/14 10:30
To version < 88.1 >
edited by Михаил Жучков
on 2023/05/17 14:40
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.SupportZhuchkov
Content
... ... @@ -62,7 +62,7 @@
62 62  (% lang="en-US" %)**GET /api/v3/auth/check**
63 63  )))
64 64  
65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
66 66  
67 67  (% style="color:#000000" %)Метод запроса: **GET**
68 68  
... ... @@ -75,15 +75,57 @@
75 75  
76 76  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 79  
80 80  (% class="box infomessage" %)
81 81  (((
82 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +**GET api/v3/agents/{id}**
83 83  )))
84 84  
85 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
86 86  
87 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
88 +
89 +(% style="color:#000000" %)Метод запроса: **GET**
90 +
91 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
92 +
93 +Запрос должен содержать данные параметра "**agentId**"
94 +
95 +(% style="color:#000000" %)Ответ:
96 +А
97 +{
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
118 + }
119 +
120 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 +
122 +(% class="box infomessage" %)
123 +(((
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
125 +)))
126 +
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
128 +
87 87  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
88 88  
89 89  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -90,23 +90,26 @@
90 90  
91 91  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
92 92  
93 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
94 94  
95 -(% 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>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
96 96  
97 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
98 98  
99 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
100 100  
101 101  (% style="color:#000000" %)Ответ:
102 102  
103 -(% style="color:#000000" %){
104 - "agentId": "", ~/~/ идентификатор клиента
105 - "parentId": "", ~/~/ идентификатор клиента-родителя
106 - "name": "", ~/~/ наименование клиента
107 - "fullName": "", ~/~/ полное наименование клиента
108 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
109 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
147 +{
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
110 110  }
111 111  
112 112  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
... ... @@ -116,7 +116,7 @@
116 116  **POST /api/v3/agents **
117 117  )))
118 118  
119 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
164 +Метод позволяет добавить клиента, указанного в запросе.
120 120  
121 121  Метод запроса: **POST**
122 122  
... ... @@ -130,6 +130,7 @@
130 130   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
131 131   "name": "string", ~/~/ имя
132 132   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
133 133   "isForeign": true, ~/~/ иностранный контрагент
134 134   "district": "string", ~/~/ округ
135 135   "region": "string", ~/~/ регион
... ... @@ -154,6 +154,7 @@
154 154   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
155 155   "name": "string", ~/~/ имя
156 156   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
157 157   "isForeign": true, ~/~/ иностранный контрагент
158 158   "district": "string", ~/~/ округ
159 159   "region": "string", ~/~/ регион
... ... @@ -177,7 +177,7 @@
177 177  **PUT /api/v3/agents**
178 178  )))
179 179  
180 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
227 +Метод позволяет отредактировать клиента, указанного в запросе.
181 181  
182 182  Метод запроса: **PUT**
183 183  
... ... @@ -193,6 +193,7 @@
193 193   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
194 194   "name": "string", ~/~/ имя
195 195   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
196 196   "isForeign": true, ~/~/ иностранный контрагент
197 197   "district": "string", ~/~/ округ
198 198   "region": "string", ~/~/ регион
... ... @@ -240,7 +240,7 @@
240 240  **DELETE /api/v3/agents/{clientId}**
241 241  )))
242 242  
243 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
291 +Метод позволяет удалить клиента, указанного в строке запроса.
244 244  
245 245  Метод запроса: **DELETE**
246 246  
... ... @@ -261,7 +261,7 @@
261 261  (% lang="en-US" %)**POST /api/v3/users**
262 262  )))
263 263  
264 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
265 265  
266 266  (% style="color:#000000" %)Метод запроса: **POST**
267 267  
... ... @@ -271,7 +271,8 @@
271 271  
272 272  (% style="color:#000000" %)Параметры в теле запроса (JSON):
273 273  
274 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
275 275   "lastName": "", ~/~/ фамилия
276 276   "firstName": "", ~/~/ имя
277 277   "position": "", ~/~/ должность
... ... @@ -280,17 +280,41 @@
280 280   "login": "", ~/~/ логин (обязателен)
281 281   "password": "", ~/~/ пароль (обязателен)
282 282   "email": "", ~/~/ email (обязателен)
283 - "description": "", ~/~/ описание
284 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
285 285   "parentId": "", ~/~/ Guid родительского агента
286 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
287 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
288 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
289 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
290 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
291 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
339 + "doubleAuth":
340 + {
341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
343 + },
344 + "groups":
345 + [
346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
347 + ],
348 + "customGroups":
349 + [
350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
351 + ],
352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
292 292  }
293 293  
355 +{
356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 + "lastName": "string",
358 + "firstName": "string",
359 + "position": "string",
360 + "phone": "string",
361 + "organization": "string",
362 + "login": "string",
363 + "password": "string",
364 + "email": "string",
365 +
366 +
294 294  (% style="text-align:left" %)
295 295  (% style="color:#000000; font-weight:normal" %)Ответ:
296 296  
... ... @@ -321,7 +321,7 @@
321 321  
322 322  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
323 323  
324 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
325 325  (((
326 326  (% lang="en-US" %)**POST /api/v3/users/find**
327 327  )))
... ... @@ -363,13 +363,13 @@
363 363   "email": "" , ~/~/ E-mail
364 364   "sessionDuration":"", ~/~/ длительность сессии в минутах
365 365   "status": "1",  ~/~/ статус пользователя
366 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
367 367  
368 368  (% style="color:#000000" %)}
369 369  
370 370  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
371 371  
372 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
373 373  (((
374 374  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
375 375  )))
... ... @@ -401,8 +401,11 @@
401 401   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
402 402   "description": "", ~/~/ Описание
403 403   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
404 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
405 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
406 406   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
407 407   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
408 408   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -423,7 +423,7 @@
423 423  (% lang="en-US" %)**PUT /api/v3/users**
424 424  )))
425 425  
426 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
427 427  
428 428  (% style="color:#000000" %)Метод запроса: **PUT**
429 429  
... ... @@ -445,7 +445,9 @@
445 445   "phone": "" , ~/~/ телефон
446 446   "organization": "" , ~/~/ организация
447 447   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
448 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
449 449   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
450 450  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
451 451   "isEnabled": "" , ~/~/ признак включения
... ... @@ -452,9 +452,12 @@
452 452   "parentId": "" , ~/~/ Guid родительского агента
453 453   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
454 454   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
455 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
456 - "kind": "" , ~/~/ тип аутентификации
457 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
458 458   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
459 459  
460 460  (% lang="en-US" style="text-align:left" %)
... ... @@ -480,8 +480,12 @@
480 480   "isEnabled": "" , ~/~/ признак включения
481 481   "parentId": "" , ~/~/ Guid родительского агента
482 482   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
483 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
484 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
485 485   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
486 486   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
487 487  
... ... @@ -495,7 +495,7 @@
495 495  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
496 496  )))
497 497  
498 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
499 499  
500 500  (% style="color:#000000" %)Метод запроса: **PUT**
501 501  
... ... @@ -525,7 +525,7 @@
525 525  **POST /api/v3/users/disable**
526 526  )))
527 527  
528 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
529 529  
530 530  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
531 531  
... ... @@ -547,7 +547,7 @@
547 547  **POST /api/v3/users/enable**
548 548  )))
549 549  
550 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
551 551  
552 552  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
553 553  
... ... @@ -584,7 +584,7 @@
584 584  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
585 585  )))
586 586  
587 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
588 588  
589 589  (% style="color:#000000" %)Метод запроса: **DELETE**
590 590  
... ... @@ -608,7 +608,7 @@
608 608  
609 609  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
610 610  
611 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
612 612  
613 613  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
614 614  
... ... @@ -616,9 +616,9 @@
616 616  
617 617  (% style="color:#000000" %)Метод запроса: **GET**
618 618  
619 -(% 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>
704 +(% 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}
620 620  
621 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
622 622  
623 623  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
624 624  
... ... @@ -643,6 +643,8 @@
643 643   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
644 644   "mileage": "", ~/~/ Пробег по нормам в метрах
645 645   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
646 646   },
647 647   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
648 648   {
... ... @@ -676,7 +676,7 @@
676 676  (% lang="en-US" %)**POST /api/v3/vehicles**
677 677  )))
678 678  
679 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
766 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
680 680  
681 681  (% style="color:#000000" %)Метод запроса: **POST**
682 682  
... ... @@ -791,7 +791,7 @@
791 791  
792 792  == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
793 793  
794 -(% class="box successmessage" %)
881 +(% class="box infomessage" %)
795 795  (((
796 796  (% lang="en-US" %)**POST /api/v3/vehicles/find**
797 797  )))
... ... @@ -798,7 +798,7 @@
798 798  
799 799  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
800 800  
801 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
802 802  
803 803  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
804 804  
... ... @@ -878,7 +878,7 @@
878 878  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
879 879  )))
880 880  
881 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
882 882  
883 883  (% style="color:#000000" %)Метод запроса: **POST**
884 884  
... ... @@ -924,7 +924,7 @@
924 924  (% lang="en-US" %)**PUT /api/v3/vehicles**
925 925  )))
926 926  
927 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
928 928  
929 929  (% style="color:#000000" %)Метод запроса: **PUT**
930 930  
... ... @@ -1041,7 +1041,7 @@
1041 1041  (% lang="en-US" style="text-align:left" %)
1042 1042  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1043 1043  
1044 -**валидация:**
1131 +**Валидация:**
1045 1045  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1046 1046  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1047 1047  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
... ... @@ -1053,7 +1053,7 @@
1053 1053  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1054 1054  )))
1055 1055  
1056 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1143 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1057 1057  
1058 1058  (% style="color:#000000" %)Метод запроса: **DELETE**
1059 1059  
... ... @@ -1075,7 +1075,7 @@
1075 1075  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1076 1076  )))
1077 1077  
1078 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1079 1079  
1080 1080  (% style="color:#000000" %)Метод запроса: **GET**
1081 1081  
... ... @@ -1102,7 +1102,7 @@
1102 1102  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1103 1103  )))
1104 1104  
1105 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1106 1106  
1107 1107  (% style="color:#000000" %)Метод запроса: **GET**
1108 1108  
... ... @@ -1121,9 +1121,9 @@
1121 1121  (% style="text-align:left" %)
1122 1122  (% style="color:#000000" %)}
1123 1123  
1124 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1125 1125  
1126 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта (кол-во сообщений за период)**(%%) ==
1213 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1127 1127  
1128 1128  (% class="box infomessage" style="text-align: left;" %)
1129 1129  (((
... ... @@ -1131,7 +1131,7 @@
1131 1131  )))
1132 1132  
1133 1133  (% style="text-align: left;" %)
1134 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1135 1135  
1136 1136  (% style="text-align: left;" %)
1137 1137  Метод запроса **POST**
... ... @@ -1144,7 +1144,7 @@
1144 1144  
1145 1145  (% style="text-align: left;" %)
1146 1146  {
1147 - "objectIds": [
1234 + "vehicleIds": [
1148 1148   id ~/~/ здесь передается список идентификаторов объектов
1149 1149   ],
1150 1150   "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
... ... @@ -1157,12 +1157,260 @@
1157 1157  (% style="text-align: left;" %)
1158 1158  [
1159 1159   {
1160 - "id": 0, ~/~/ идентификатор объекта
1247 + "vehicleId": 0, ~/~/ идентификатор объекта
1161 1161   "count": 0 ~/~/ количество сообщений за период
1162 1162   }
1163 1163  ]
1164 1164  
1252 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1165 1165  
1254 +(% class="box infomessage" %)
1255 +(((
1256 +**POST /api/v3/terminalMessages**
1257 +)))
1258 +
1259 +Метод возвращает список сообщений терминала объекта за выбранный период.
1260 +
1261 +(% style="text-align: left;" %)
1262 +Метод запроса **POST**
1263 +
1264 +(% style="text-align: left;" %)
1265 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1266 +
1267 +(% style="text-align: left;" %)
1268 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1269 +
1270 +{
1271 + "vehicleId": 0, ~/~/ id объекта
1272 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1273 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1274 +}
1275 +
1276 +Ответ:
1277 +
1278 +[
1279 + {
1280 + "messages": [
1281 + {
1282 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1283 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1284 + "speed": 0, ~/~/ Скорость, км/ч
1285 + "altitude": 0, ~/~/ Высота, м
1286 + "latitude": 0, ~/~/ Широта [-90°;90°]
1287 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1288 + "satellites": 0, ~/~/ Кол-во спутников
1289 + "voltage": 0, ~/~/ Напряжение
1290 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1291 + "additionalProp1": "string",
1292 + "additionalProp2": "string",
1293 + "additionalProp3": "string"
1294 + },
1295 + "photoCount": 0 ~/~/ Кол-во фото
1296 + }
1297 + ]
1298 + }
1299 +]
1300 +
1301 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1302 +
1303 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1304 +
1305 +(% class="box infomessage" %)
1306 +(((
1307 +**POST /api/v3/notifications/find**
1308 +)))
1309 +
1310 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1311 +
1312 +(% style="text-align: left;" %)
1313 +Метод запроса **POST**
1314 +
1315 +(% style="text-align: left;" %)
1316 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1317 +
1318 +(% style="text-align: left;" %)
1319 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1320 +
1321 +{
1322 + "parentId": "" ~/~/ id клиента
1323 +}
1324 +
1325 +Ответ:
1326 +
1327 +[
1328 + {
1329 + "id": 0, ~/~/ ID уведомления
1330 + "name": "string", ~/~/ Название уведомления
1331 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1332 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1333 + "userId": "", ~/~/ Пользователь, создавший уведомление
1334 + "parentId": "", ~/~/ Идентификатор клиента
1335 + "parentName": "string" ~/~/ Имя клиента
1336 + }
1337 +]
1338 +
1339 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1340 +
1341 +(% class="box infomessage" %)
1342 +(((
1343 +**GET /api/v3/notifications/{id}**
1344 +)))
1345 +
1346 +Метод возвращает данные правил формирования выбранного уведомления.
1347 +
1348 +(% style="text-align: left;" %)
1349 +Метод запроса **GET**
1350 +
1351 +(% style="text-align: left;" %)
1352 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1353 +
1354 +(% style="text-align: left;" %)
1355 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1356 +
1357 +(% style="text-align: left;" %)
1358 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1359 +
1360 +(% style="text-align: left;" %)
1361 +(% style="color:#000000" %)Ответ:
1362 +
1363 +(% style="text-align: left;" %)
1364 +(% style="color:#000000" %){
1365 + "id": 0, ~/~/ (%%)id уведомления
1366 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1367 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1368 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1369 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1370 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1371 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1372 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1373 +(% style="color:#000000" %) 0
1374 + ],
1375 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1376 +(% style="color:#000000" %) 0
1377 + ],
1378 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1379 +(% style="color:#000000" %) 0
1380 + ],
1381 + "settings": { ~/~/ Список параметров уведомления
1382 + "additionalProp1": "string",
1383 + "additionalProp2": "string",
1384 + "additionalProp3": "string"
1385 + },
1386 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1387 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1388 +(% style="color:#000000" %) ""
1389 + ],
1390 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1391 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1392 +(% style="color:#000000" %) "string"
1393 + ],
1394 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1395 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1396 +(% style="color:#000000" %) {
1397 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1398 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1399 +(% style="color:#000000" %) }
1400 + ],
1401 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1402 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1403 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1404 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1405 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1406 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1407 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1408 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1409 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1410 +(% style="color:#000000" %)}
1411 +
1412 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1413 +
1414 +(% class="box warningmessage" %)
1415 +(((
1416 +**PUT /api/v3/notifications/**
1417 +)))
1418 +
1419 +Метод позволяет отредактировать уведомление.
1420 +
1421 +Метод запроса **PUT**
1422 +
1423 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1424 +
1425 +В заголовках запроса: X-Auth: Токен авторизации
1426 +
1427 +Тело запроса:
1428 +{
1429 + "id": 0, ~/~/ id уведомления
1430 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1431 + "userId": "", ~/~/ Пользователь, создавший уведомление
1432 + "parentId": "", ~/~/ Идентификатор клиента
1433 + "parentName": "string", ~/~/ Имя клиента
1434 + "name": "string", ~/~/ Название уведомления
1435 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1436 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1437 + 0
1438 + ],
1439 + "geoids": [ ~/~/ Список id геообъектов для анализа
1440 + 0
1441 + ],
1442 + "fieldids": [ ~/~/ Список id полей для анализа
1443 + 0
1444 + ],
1445 + "settings": { ~/~/ Список параметров уведомления
1446 + "additionalProp1": "string",
1447 + "additionalProp2": "string",
1448 + "additionalProp3": "string"
1449 + },
1450 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1451 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1452 + ""
1453 + ],
1454 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1455 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1456 + "string"
1457 + ],
1458 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1459 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1460 + {
1461 + "id": 0, ~/~/ Идентификатор участника чата
1462 + "info": "string" ~/~/ Дополнительные сведения
1463 + }
1464 + ],
1465 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1466 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1467 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1468 + "kind": 0, ~/~/ Определяет вид уведомления
1469 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1470 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1471 + "timezone": 0, ~/~/ Сдвиг часового пояса
1472 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1473 + "autoProlongation": true ~/~/ Автопродление срока действия
1474 +}
1475 +
1476 +Ответ:
1477 +
1478 +Success
1479 +
1480 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1481 +
1482 +(% class="box errormessage" %)
1483 +(((
1484 +**DELETE /api/v3/notifications/{id}**
1485 +)))
1486 +
1487 +Метод позволяет удалить выбранное уведомление.
1488 +
1489 +Метод запроса **DELETE**
1490 +
1491 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1492 +
1493 +Передаваемый параметр: {id} - id уведомления
1494 +
1495 +В заголовках запроса: X-Auth: Токен авторизации
1496 +
1497 +Ответ:
1498 +
1499 +Success
1500 +
1166 1166  (% class="box" lang="en-US" style="text-align: center;" %)
1167 1167  (((
1168 1168  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

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