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

Summary

Details

Icon Page properties
Content
... ... @@ -1,14 +1,13 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -**Содержание страницы:**
4 -)))
2 += Описание ГЛОНАССSoft Public API 3.0 =
5 5  
4 +
6 6  {{toc/}}
7 7  
8 8  
9 9  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 10  
11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
10 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
... ... @@ -38,7 +38,7 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}
40 +}(%%)
42 42  
43 43  
44 44  (% style="color:#000000" %)**Ответ:**
... ... @@ -75,57 +75,15 @@
75 75  
76 76  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
77 +== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
79 79  
80 80  (% class="box infomessage" %)
81 81  (((
82 -**GET api/v3/agents/{id}**
81 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
83 83  )))
84 84  
85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
84 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
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" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
128 -
129 129  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -132,26 +132,23 @@
132 132  
133 133  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 -(% style="color:#000000" %)Метод запроса: **POST**
92 +(% style="color:#000000" %)Метод запроса: **GET**
136 136  
137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
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>
138 138  
139 -(% style="color:#000000" %)Параметр запроса:
96 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
140 140  
141 -(% style="color:#000000" %){
142 - "parentId": "string"
143 -}
98 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
144 144  
145 145  (% style="color:#000000" %)Ответ:
146 146  
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 - Отказ)
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 - Отказ)
155 155  }
156 156  
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
... ... @@ -175,7 +175,6 @@
175 175   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
179 179   "isForeign": true, ~/~/ иностранный контрагент
180 180   "district": "string", ~/~/ округ
181 181   "region": "string", ~/~/ регион
... ... @@ -200,7 +200,6 @@
200 200   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
201 201   "name": "string", ~/~/ имя
202 202   "fullName": "string", ~/~/ полное наименование
203 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
204 204   "isForeign": true, ~/~/ иностранный контрагент
205 205   "district": "string", ~/~/ округ
206 206   "region": "string", ~/~/ регион
... ... @@ -240,7 +240,6 @@
240 240   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
241 241   "name": "string", ~/~/ имя
242 242   "fullName": "string", ~/~/ полное наименование
243 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
244 244   "isForeign": true, ~/~/ иностранный контрагент
245 245   "district": "string", ~/~/ округ
246 246   "region": "string", ~/~/ регион
... ... @@ -319,8 +319,7 @@
319 319  
320 320  (% style="color:#000000" %)Параметры в теле запроса (JSON):
321 321  
322 -(% style="color:#000000" %)
323 -{ 
273 +(% style="color:#000000" %){ 
324 324   "lastName": "", ~/~/ фамилия
325 325   "firstName": "", ~/~/ имя
326 326   "position": "", ~/~/ должность
... ... @@ -329,41 +329,17 @@
329 329   "login": "", ~/~/ логин (обязателен)
330 330   "password": "", ~/~/ пароль (обязателен)
331 331   "email": "", ~/~/ email (обязателен)
332 - "description": "string", ~/~/ Описание
333 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
282 + "description": "", ~/~/ описание
283 + "isEnabled": "", ~/~/ признак включения
336 336   "parentId": "", ~/~/ Guid родительского агента
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 - Азербайджанский
285 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
286 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
287 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
288 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
289 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
290 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
353 353  }
354 354  
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 -
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)Ответ:
369 369  
... ... @@ -392,9 +392,10 @@
392 392  (% style="text-align:left" %)
393 393  (% style="color:#000000; font-weight:normal" %)}
394 394  
395 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 396  
397 -(% class="box infomessage" %)
322 +== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
323 +
324 +(% class="box successmessage" %)
398 398  (((
399 399  (% lang="en-US" %)**POST /api/v3/users/find**
400 400  )))
... ... @@ -440,9 +440,10 @@
440 440  
441 441  (% style="color:#000000" %)}
442 442  
443 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
444 444  
445 -(% class="box infomessage" %)
371 +== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
372 +
373 +(% class="box successmessage" %)
446 446  (((
447 447  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
448 448  )))
... ... @@ -474,11 +474,8 @@
474 474   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
475 475   "description": "", ~/~/ Описание
476 476   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
477 - "doubleAuth":
478 - {
479 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 - },
405 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
406 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
482 482   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
483 483   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
484 484   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -492,8 +492,9 @@
492 492  )))
493 493  )))
494 494  
495 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
496 496  
421 +== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
422 +
497 497  (% class="box warningmessage" %)
498 498  (((
499 499  (% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -521,9 +521,7 @@
521 521   "phone": "" , ~/~/ телефон
522 522   "organization": "" , ~/~/ организация
523 523   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
524 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
450 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
527 527   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
528 528  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
529 529   "isEnabled": "" , ~/~/ признак включения
... ... @@ -530,12 +530,9 @@
530 530   "parentId": "" , ~/~/ Guid родительского агента
531 531   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
532 532   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
533 - "doubleAuth":
534 - {
535 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 - },
538 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
457 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
458 + "kind": "" , ~/~/ тип аутентификации
459 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
539 539   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 540  
541 541  (% lang="en-US" style="text-align:left" %)
... ... @@ -561,12 +561,8 @@
561 561   "isEnabled": "" , ~/~/ признак включения
562 562   "parentId": "" , ~/~/ Guid родительского агента
563 563   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
564 - "doubleAuth":
565 - {
566 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 - },
569 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
485 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
486 + "kind": "" , ~/~/ тип аутентификации
570 570   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
571 571   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
572 572  
... ... @@ -573,8 +573,9 @@
573 573  (% lang="en-US" style="text-align:left" %)
574 574  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 575  
576 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
577 577  
494 +== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
495 +
578 578  (% class="box warningmessage" %)
579 579  (((
580 580  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
... ... @@ -603,8 +603,9 @@
603 603  (% style="text-align:left" %)
604 604  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
605 605  
606 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
607 607  
525 +== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
526 +
608 608  (% class="box warningmessage" %)
609 609  (((
610 610  **POST /api/v3/users/disable**
... ... @@ -625,8 +625,9 @@
625 625  
626 626  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
627 627  
628 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
629 629  
548 +== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
549 +
630 630  (% class="box warningmessage" %)
631 631  (((
632 632  **POST /api/v3/users/enable**
... ... @@ -660,10 +660,11 @@
660 660  }
661 661  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
662 662  "users" - массив id пользователей, которых не удалось включить или отключить.
583 +
584 +
585 +== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
663 663  )))
664 664  
665 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 -
667 667  (% class="box errormessage" %)
668 668  (((
669 669  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -682,10 +682,12 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
606 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
688 688  
610 +== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
611 +
689 689  (% class="box infomessage" %)
690 690  (((
691 691  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -728,8 +728,6 @@
728 728   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
729 729   "mileage": "", ~/~/ Пробег по нормам в метрах
730 730   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
733 733   },
734 734   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
735 735   {
... ... @@ -756,8 +756,9 @@
756 756  (% style="text-align:left" %)
757 757  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
758 758  
759 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
760 760  
681 +== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
682 +
761 761  (% class="box successmessage" %)
762 762  (((
763 763  (% lang="en-US" %)**POST /api/v3/vehicles**
... ... @@ -876,9 +876,10 @@
876 876  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
877 877  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
878 878  
879 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
880 880  
881 -(% class="box infomessage" %)
802 +== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
803 +
804 +(% class="box successmessage" %)
882 882  (((
883 883  (% lang="en-US" %)**POST /api/v3/vehicles/find**
884 884  )))
... ... @@ -958,8 +958,9 @@
958 958  
959 959  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
960 960  
961 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
962 962  
885 +== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
886 +
963 963  (% class="box successmessage" %)
964 964  (((
965 965  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
... ... @@ -1004,8 +1004,9 @@
1004 1004  (% style="text-align:left" %)
1005 1005  (% style="color:#000000" %) }
1006 1006  
1007 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1008 1008  
932 +== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
933 +
1009 1009  (% class="box warningmessage" %)
1010 1010  (((
1011 1011  (% lang="en-US" %)**PUT /api/v3/vehicles**
... ... @@ -1133,8 +1133,9 @@
1133 1133  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1134 1134  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1135 1135  
1136 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1137 1137  
1062 +== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1063 +
1138 1138  (% class="box errormessage" %)
1139 1139  (((
1140 1140  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -1153,10 +1153,12 @@
1153 1153  (% style="text-align:left" %)
1154 1154  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1155 1155  
1156 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1157 1157  
1158 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1083 +(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1159 1159  
1085 +
1086 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1087 +
1160 1160  (% class="box infomessage" %)
1161 1161  (((
1162 1162  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
... ... @@ -1180,10 +1180,12 @@
1180 1180  (% style="text-align:left" %)
1181 1181  (% style="color:#000000" %)}
1182 1182  
1183 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1184 1184  
1185 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1112 += (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1186 1186  
1114 +
1115 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1116 +
1187 1187  (% class="box infomessage" %)
1188 1188  (((
1189 1189  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
... ... @@ -1195,7 +1195,7 @@
1195 1195  
1196 1196  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1197 1197  
1198 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1128 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1199 1199  
1200 1200  (% style="color:#000000" %)Ответ:
1201 1201  
... ... @@ -1208,99 +1208,7 @@
1208 1208  (% style="text-align:left" %)
1209 1209  (% style="color:#000000" %)}
1210 1210  
1211 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1212 1212  
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 -
1253 -(% style="text-align: left;" %)
1254 -(% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**
1255 -
1256 -(% class="box infomessage" %)
1257 -(((
1258 -**POST /api/v3/terminalMessages**
1259 -)))
1260 -
1261 -Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1262 -
1263 -(% style="text-align: left;" %)
1264 -Метод запроса **POST**
1265 -
1266 -(% style="text-align: left;" %)
1267 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1268 -
1269 -(% style="text-align: left;" %)
1270 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1271 -
1272 -{
1273 - "vehicleId": 0, ~/~/ id объекта
1274 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1275 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1276 -}
1277 -
1278 -Ответ:
1279 -
1280 -[
1281 - {
1282 - "messages": [
1283 - {
1284 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1285 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1286 - "speed": 0, ~/~/ Скорость, км/ч
1287 - "altitude": 0, ~/~/ Высота, м
1288 - "latitude": 0, ~/~/ Широта [-90°;90°]
1289 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1290 - "satellites": 0, ~/~/ Кол-во спутников
1291 - "voltage": 0, ~/~/ Напряжение
1292 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1293 - "additionalProp1": "string",
1294 - "additionalProp2": "string",
1295 - "additionalProp3": "string"
1296 - },
1297 - "photoCount": 0 ~/~/ Кол-во фото
1298 - }
1299 - ]
1300 - }
1301 -]
1302 -
1303 -
1304 1304  (% class="box" lang="en-US" style="text-align: center;" %)
1305 1305  (((
1306 1306  (% 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 г.