Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.8 >
edited by Илья Крайнов
on 2022/11/24 13:33
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  
... ... @@ -15,10 +15,8 @@
15 15  
16 16  (% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 17  
18 -
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -
22 22  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
23 23  
24 24  (% class="box infomessage" %)
... ... @@ -39,9 +39,9 @@
39 39  (% style="color:#000000" %){
40 40   "login": "testuser",
41 41   "password": "testuser"
42 -}(%%)
43 -
41 +}
44 44  
43 +
45 45  (% style="color:#000000" %)**Ответ:**
46 46  
47 47  (% lang="en-US" %)
... ... @@ -76,15 +76,57 @@
76 76  
77 77  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
78 78  
79 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
80 80  
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +**GET api/v3/agents/{id}**
84 84  )))
85 85  
86 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87 87  
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 +
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
90 90  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -91,28 +91,30 @@
91 91  
92 92  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
95 95  
96 -(% 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
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
101 101  
102 102  (% style="color:#000000" %)Ответ:
103 103  
104 -(% style="color:#000000" %){
105 - "agentId": "", ~/~/ идентификатор клиента
106 - "parentId": "", ~/~/ идентификатор клиента-родителя
107 - "name": "", ~/~/ наименование клиента
108 - "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "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 - Отказ)
111 111  }
112 112  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113 113  
114 -== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
115 -
116 116  (% class="box successmessage" %)
117 117  (((
118 118  **POST /api/v3/agents **
... ... @@ -132,6 +132,7 @@
132 132   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
133 133   "name": "string", ~/~/ имя
134 134   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
135 135   "isForeign": true, ~/~/ иностранный контрагент
136 136   "district": "string", ~/~/ округ
137 137   "region": "string", ~/~/ регион
... ... @@ -156,6 +156,7 @@
156 156   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
157 157   "name": "string", ~/~/ имя
158 158   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
159 159   "isForeign": true, ~/~/ иностранный контрагент
160 160   "district": "string", ~/~/ округ
161 161   "region": "string", ~/~/ регион
... ... @@ -172,9 +172,8 @@
172 172   "bankKS": "string" ~/~/ корр. счёт
173 173  }
174 174  
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
175 175  
176 -== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
177 -
178 178  (% class="box warningmessage" %)
179 179  (((
180 180  **PUT /api/v3/agents**
... ... @@ -196,6 +196,7 @@
196 196   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
197 197   "name": "string", ~/~/ имя
198 198   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
199 199   "isForeign": true, ~/~/ иностранный контрагент
200 200   "district": "string", ~/~/ округ
201 201   "region": "string", ~/~/ регион
... ... @@ -236,9 +236,8 @@
236 236   "bankKS": "string" ~/~/ корр. счёт
237 237  }
238 238  
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
239 239  
240 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
241 -
242 242  (% class="box errormessage" %)
243 243  (((
244 244  **DELETE /api/v3/agents/{clientId}**
... ... @@ -256,12 +256,10 @@
256 256  
257 257  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
258 258  
259 -
260 260  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
261 261  
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
262 262  
263 -== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
264 -
265 265  (% class="box successmessage" %)
266 266  (((
267 267  (% lang="en-US" %)**POST /api/v3/users**
... ... @@ -277,7 +277,8 @@
277 277  
278 278  (% style="color:#000000" %)Параметры в теле запроса (JSON):
279 279  
280 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
281 281   "lastName": "", ~/~/ фамилия
282 282   "firstName": "", ~/~/ имя
283 283   "position": "", ~/~/ должность
... ... @@ -286,17 +286,41 @@
286 286   "login": "", ~/~/ логин (обязателен)
287 287   "password": "", ~/~/ пароль (обязателен)
288 288   "email": "", ~/~/ email (обязателен)
289 - "description": "", ~/~/ описание
290 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
291 291   "parentId": "", ~/~/ Guid родительского агента
292 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
293 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
294 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
295 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
296 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
297 - "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 - Азербайджанский
298 298  }
299 299  
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 +
300 300  (% style="text-align:left" %)
301 301  (% style="color:#000000; font-weight:normal" %)Ответ:
302 302  
... ... @@ -325,10 +325,9 @@
325 325  (% style="text-align:left" %)
326 326  (% style="color:#000000; font-weight:normal" %)}
327 327  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
328 328  
329 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
330 -
331 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
332 332  (((
333 333  (% lang="en-US" %)**POST /api/v3/users/find**
334 334  )))
... ... @@ -374,10 +374,9 @@
374 374  
375 375  (% style="color:#000000" %)}
376 376  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
377 377  
378 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
379 -
380 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
381 381  (((
382 382  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
383 383  )))
... ... @@ -409,8 +409,11 @@
409 409   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
410 410   "description": "", ~/~/ Описание
411 411   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
412 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
413 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
414 414   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
415 415   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
416 416   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -424,9 +424,8 @@
424 424  )))
425 425  )))
426 426  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
427 427  
428 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
429 -
430 430  (% class="box warningmessage" %)
431 431  (((
432 432  (% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -454,7 +454,9 @@
454 454   "phone": "" , ~/~/ телефон
455 455   "organization": "" , ~/~/ организация
456 456   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
457 -(% 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 - отключено
458 458   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
459 459  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
460 460   "isEnabled": "" , ~/~/ признак включения
... ... @@ -461,9 +461,12 @@
461 461   "parentId": "" , ~/~/ Guid родительского агента
462 462   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
463 463   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
464 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
465 - "kind": "" , ~/~/ тип аутентификации
466 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
467 467   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
468 468  
469 469  (% lang="en-US" style="text-align:left" %)
... ... @@ -489,8 +489,12 @@
489 489   "isEnabled": "" , ~/~/ признак включения
490 490   "parentId": "" , ~/~/ Guid родительского агента
491 491   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
492 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
493 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
494 494   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
495 495   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
496 496  
... ... @@ -497,9 +497,8 @@
497 497  (% lang="en-US" style="text-align:left" %)
498 498  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
499 499  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
500 500  
501 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
502 -
503 503  (% class="box warningmessage" %)
504 504  (((
505 505  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
... ... @@ -528,9 +528,8 @@
528 528  (% style="text-align:left" %)
529 529  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
530 530  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
531 531  
532 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
533 -
534 534  (% class="box warningmessage" %)
535 535  (((
536 536  **POST /api/v3/users/disable**
... ... @@ -551,9 +551,8 @@
551 551  
552 552  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
553 553  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
554 554  
555 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
556 -
557 557  (% class="box warningmessage" %)
558 558  (((
559 559  **POST /api/v3/users/enable**
... ... @@ -587,11 +587,10 @@
587 587  }
588 588  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
589 589  "users" - массив id пользователей, которых не удалось включить или отключить.
590 -
591 -
592 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
593 593  )))
594 594  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
595 595  (% class="box errormessage" %)
596 596  (((
597 597  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -610,12 +610,10 @@
610 610  (% style="text-align:left" %)
611 611  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
612 612  
613 -
614 614  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
615 615  
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
616 616  
617 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
618 -
619 619  (% class="box infomessage" %)
620 620  (((
621 621  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -658,6 +658,8 @@
658 658   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
659 659   "mileage": "", ~/~/ Пробег по нормам в метрах
660 660   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
661 661   },
662 662   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
663 663   {
... ... @@ -684,9 +684,8 @@
684 684  (% style="text-align:left" %)
685 685  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
686 686  
759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
687 687  
688 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
689 -
690 690  (% class="box successmessage" %)
691 691  (((
692 692  (% lang="en-US" %)**POST /api/v3/vehicles**
... ... @@ -805,10 +805,9 @@
805 805  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
806 806  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
807 807  
879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
808 808  
809 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
810 -
811 -(% class="box successmessage" %)
881 +(% class="box infomessage" %)
812 812  (((
813 813  (% lang="en-US" %)**POST /api/v3/vehicles/find**
814 814  )))
... ... @@ -888,9 +888,8 @@
888 888  
889 889  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
890 890  
961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
891 891  
892 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
893 -
894 894  (% class="box successmessage" %)
895 895  (((
896 896  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
... ... @@ -935,9 +935,8 @@
935 935  (% style="text-align:left" %)
936 936  (% style="color:#000000" %) }
937 937  
1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
938 938  
939 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
940 -
941 941  (% class="box warningmessage" %)
942 942  (((
943 943  (% lang="en-US" %)**PUT /api/v3/vehicles**
... ... @@ -1065,9 +1065,8 @@
1065 1065  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1066 1066  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1067 1067  
1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1068 1068  
1069 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1070 -
1071 1071  (% class="box errormessage" %)
1072 1072  (((
1073 1073  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -1086,12 +1086,10 @@
1086 1086  (% style="text-align:left" %)
1087 1087  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1088 1088  
1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1089 1089  
1090 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1091 1091  
1092 -
1093 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1094 -
1095 1095  (% class="box infomessage" %)
1096 1096  (((
1097 1097  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
... ... @@ -1115,12 +1115,10 @@
1115 1115  (% style="text-align:left" %)
1116 1116  (% style="color:#000000" %)}
1117 1117  
1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1118 1118  
1119 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1120 1120  
1121 -
1122 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1123 -
1124 1124  (% class="box infomessage" %)
1125 1125  (((
1126 1126  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
... ... @@ -1132,7 +1132,7 @@
1132 1132  
1133 1133  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1134 1134  
1135 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1136 1136  
1137 1137  (% style="color:#000000" %)Ответ:
1138 1138  
... ... @@ -1145,7 +1145,97 @@
1145 1145  (% style="text-align:left" %)
1146 1146  (% style="color:#000000" %)}
1147 1147  
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1148 1148  
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 +
1149 1149  (% class="box" lang="en-US" style="text-align: center;" %)
1150 1150  (((
1151 1151  (% 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 г.