Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.11 >
edited by Илья Крайнов
on 2022/11/24 13:36
To version < 80.1 >
edited by Илья Крайнов
on 2023/03/29 12:23
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,13 +1,14 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -= Описание ГЛОНАССSoft Public API 3.0 =
2 +(((
3 +**Содержание страницы:**
4 +)))
3 3  
4 -
5 5  {{toc/}}
6 6  
7 7  
8 8  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
9 9  
10 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 11  
12 12  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 13  
... ... @@ -37,7 +37,7 @@
37 37  (% style="color:#000000" %){
38 38   "login": "testuser",
39 39   "password": "testuser"
40 -}(%%)
41 +}
41 41  
42 42  
43 43  (% style="color:#000000" %)**Ответ:**
... ... @@ -74,15 +74,57 @@
74 74  
75 75  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
76 76  
77 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
78 78  
79 79  (% class="box infomessage" %)
80 80  (((
81 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +**GET api/v3/agents/{id}**
82 82  )))
83 83  
84 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 85  
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" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
128 +
86 86  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
87 87  
88 88  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -89,23 +89,26 @@
89 89  
90 90  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
91 91  
92 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
93 93  
94 -(% 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
95 95  
96 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
97 97  
98 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
99 99  
100 100  (% style="color:#000000" %)Ответ:
101 101  
102 -(% style="color:#000000" %){
103 - "agentId": "", ~/~/ идентификатор клиента
104 - "parentId": "", ~/~/ идентификатор клиента-родителя
105 - "name": "", ~/~/ наименование клиента
106 - "fullName": "", ~/~/ полное наименование клиента
107 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
108 - "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 - Отказ)
109 109  }
110 110  
111 111  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
... ... @@ -129,6 +129,7 @@
129 129   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
130 130   "name": "string", ~/~/ имя
131 131   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
132 132   "isForeign": true, ~/~/ иностранный контрагент
133 133   "district": "string", ~/~/ округ
134 134   "region": "string", ~/~/ регион
... ... @@ -153,6 +153,7 @@
153 153   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
154 154   "name": "string", ~/~/ имя
155 155   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
156 156   "isForeign": true, ~/~/ иностранный контрагент
157 157   "district": "string", ~/~/ округ
158 158   "region": "string", ~/~/ регион
... ... @@ -192,6 +192,7 @@
192 192   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
193 193   "name": "string", ~/~/ имя
194 194   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
195 195   "isForeign": true, ~/~/ иностранный контрагент
196 196   "district": "string", ~/~/ округ
197 197   "region": "string", ~/~/ регион
... ... @@ -270,7 +270,8 @@
270 270  
271 271  (% style="color:#000000" %)Параметры в теле запроса (JSON):
272 272  
273 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
274 274   "lastName": "", ~/~/ фамилия
275 275   "firstName": "", ~/~/ имя
276 276   "position": "", ~/~/ должность
... ... @@ -279,17 +279,41 @@
279 279   "login": "", ~/~/ логин (обязателен)
280 280   "password": "", ~/~/ пароль (обязателен)
281 281   "email": "", ~/~/ email (обязателен)
282 - "description": "", ~/~/ описание
283 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
284 284   "parentId": "", ~/~/ Guid родительского агента
285 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
286 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
287 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
288 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
289 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
290 - "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 - Азербайджанский
291 291  }
292 292  
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 +
293 293  (% style="text-align:left" %)
294 294  (% style="color:#000000; font-weight:normal" %)Ответ:
295 295  
... ... @@ -318,10 +318,9 @@
318 318  (% style="text-align:left" %)
319 319  (% style="color:#000000; font-weight:normal" %)}
320 320  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
321 321  
322 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
323 -
324 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
325 325  (((
326 326  (% lang="en-US" %)**POST /api/v3/users/find**
327 327  )))
... ... @@ -367,10 +367,9 @@
367 367  
368 368  (% style="color:#000000" %)}
369 369  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
370 370  
371 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
372 -
373 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
374 374  (((
375 375  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
376 376  )))
... ... @@ -402,8 +402,11 @@
402 402   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
403 403   "description": "", ~/~/ Описание
404 404   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
405 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
406 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
407 407   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
408 408   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
409 409   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -417,9 +417,8 @@
417 417  )))
418 418  )))
419 419  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
420 420  
421 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
422 -
423 423  (% class="box warningmessage" %)
424 424  (((
425 425  (% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -447,7 +447,9 @@
447 447   "phone": "" , ~/~/ телефон
448 448   "organization": "" , ~/~/ организация
449 449   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
450 -(% 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 - отключено
451 451   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
452 452  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
453 453   "isEnabled": "" , ~/~/ признак включения
... ... @@ -454,9 +454,12 @@
454 454   "parentId": "" , ~/~/ Guid родительского агента
455 455   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
456 456   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
457 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
458 - "kind": "" , ~/~/ тип аутентификации
459 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
460 460   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
461 461  
462 462  (% lang="en-US" style="text-align:left" %)
... ... @@ -482,8 +482,12 @@
482 482   "isEnabled": "" , ~/~/ признак включения
483 483   "parentId": "" , ~/~/ Guid родительского агента
484 484   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
485 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
486 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
487 487   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
488 488   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
489 489  
... ... @@ -490,9 +490,8 @@
490 490  (% lang="en-US" style="text-align:left" %)
491 491  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
492 492  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
493 493  
494 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
495 -
496 496  (% class="box warningmessage" %)
497 497  (((
498 498  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
... ... @@ -521,9 +521,8 @@
521 521  (% style="text-align:left" %)
522 522  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
523 523  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
524 524  
525 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
526 -
527 527  (% class="box warningmessage" %)
528 528  (((
529 529  **POST /api/v3/users/disable**
... ... @@ -544,9 +544,8 @@
544 544  
545 545  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
546 546  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
547 547  
548 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
549 -
550 550  (% class="box warningmessage" %)
551 551  (((
552 552  **POST /api/v3/users/enable**
... ... @@ -580,11 +580,10 @@
580 580  }
581 581  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
582 582  "users" - массив id пользователей, которых не удалось включить или отключить.
583 -
584 -
585 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
586 586  )))
587 587  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
588 588  (% class="box errormessage" %)
589 589  (((
590 590  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -603,12 +603,10 @@
603 603  (% style="text-align:left" %)
604 604  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
605 605  
606 -
607 607  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
608 608  
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
609 609  
610 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
611 -
612 612  (% class="box infomessage" %)
613 613  (((
614 614  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -651,6 +651,8 @@
651 651   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
652 652   "mileage": "", ~/~/ Пробег по нормам в метрах
653 653   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
654 654   },
655 655   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
656 656   {
... ... @@ -677,9 +677,8 @@
677 677  (% style="text-align:left" %)
678 678  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
679 679  
759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
680 680  
681 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
682 -
683 683  (% class="box successmessage" %)
684 684  (((
685 685  (% lang="en-US" %)**POST /api/v3/vehicles**
... ... @@ -798,10 +798,9 @@
798 798  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
799 799  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
800 800  
879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
801 801  
802 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
803 -
804 -(% class="box successmessage" %)
881 +(% class="box infomessage" %)
805 805  (((
806 806  (% lang="en-US" %)**POST /api/v3/vehicles/find**
807 807  )))
... ... @@ -881,9 +881,8 @@
881 881  
882 882  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
883 883  
961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
884 884  
885 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
886 -
887 887  (% class="box successmessage" %)
888 888  (((
889 889  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
... ... @@ -928,9 +928,8 @@
928 928  (% style="text-align:left" %)
929 929  (% style="color:#000000" %) }
930 930  
1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
931 931  
932 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
933 -
934 934  (% class="box warningmessage" %)
935 935  (((
936 936  (% lang="en-US" %)**PUT /api/v3/vehicles**
... ... @@ -1058,9 +1058,8 @@
1058 1058  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1059 1059  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1060 1060  
1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1061 1061  
1062 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1063 -
1064 1064  (% class="box errormessage" %)
1065 1065  (((
1066 1066  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -1079,12 +1079,10 @@
1079 1079  (% style="text-align:left" %)
1080 1080  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1081 1081  
1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1082 1082  
1083 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1084 1084  
1085 -
1086 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1087 -
1088 1088  (% class="box infomessage" %)
1089 1089  (((
1090 1090  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
... ... @@ -1108,12 +1108,10 @@
1108 1108  (% style="text-align:left" %)
1109 1109  (% style="color:#000000" %)}
1110 1110  
1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1111 1111  
1112 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1113 1113  
1114 -
1115 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1116 -
1117 1117  (% class="box infomessage" %)
1118 1118  (((
1119 1119  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
... ... @@ -1125,7 +1125,7 @@
1125 1125  
1126 1126  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1127 1127  
1128 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1129 1129  
1130 1130  (% style="color:#000000" %)Ответ:
1131 1131  
... ... @@ -1138,7 +1138,97 @@
1138 1138  (% style="text-align:left" %)
1139 1139  (% style="color:#000000" %)}
1140 1140  
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1141 1141  
1213 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1214 +
1215 +(% class="box infomessage" style="text-align: left;" %)
1216 +(((
1217 +**POST /api/v3/terminalMessages/count**
1218 +)))
1219 +
1220 +(% style="text-align: left;" %)
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1222 +
1223 +(% style="text-align: left;" %)
1224 +Метод запроса **POST**
1225 +
1226 +(% style="text-align: left;" %)
1227 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1228 +
1229 +(% style="text-align: left;" %)
1230 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1231 +
1232 +(% style="text-align: left;" %)
1233 +{
1234 + "vehicleIds": [
1235 + id ~/~/ здесь передается список идентификаторов объектов
1236 + ],
1237 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1238 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1239 +}
1240 +
1241 +(% style="text-align: left;" %)
1242 +Ответ:
1243 +
1244 +(% style="text-align: left;" %)
1245 +[
1246 + {
1247 + "vehicleId": 0, ~/~/ идентификатор объекта
1248 + "count": 0 ~/~/ количество сообщений за период
1249 + }
1250 +]
1251 +
1252 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1253 +
1254 +(% class="box infomessage" %)
1255 +(((
1256 +**POST /api/v3/terminalMessages**
1257 +)))
1258 +
1259 +Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
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 +
1142 1142  (% class="box" lang="en-US" style="text-align: center;" %)
1143 1143  (((
1144 1144  (% 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 г.