Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.9 >
edited by Илья Крайнов
on 2022/11/24 13:34
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,28 +89,30 @@
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  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
111 111  
112 -== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
113 -
114 114  (% class="box successmessage" %)
115 115  (((
116 116  **POST /api/v3/agents **
... ... @@ -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", ~/~/ регион
... ... @@ -170,9 +170,8 @@
170 170   "bankKS": "string" ~/~/ корр. счёт
171 171  }
172 172  
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
173 173  
174 -== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
175 -
176 176  (% class="box warningmessage" %)
177 177  (((
178 178  **PUT /api/v3/agents**
... ... @@ -194,6 +194,7 @@
194 194   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
195 195   "name": "string", ~/~/ имя
196 196   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
197 197   "isForeign": true, ~/~/ иностранный контрагент
198 198   "district": "string", ~/~/ округ
199 199   "region": "string", ~/~/ регион
... ... @@ -234,9 +234,8 @@
234 234   "bankKS": "string" ~/~/ корр. счёт
235 235  }
236 236  
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
237 237  
238 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
239 -
240 240  (% class="box errormessage" %)
241 241  (((
242 242  **DELETE /api/v3/agents/{clientId}**
... ... @@ -254,12 +254,10 @@
254 254  
255 255  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
256 256  
257 -
258 258  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
259 259  
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
260 260  
261 -== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
262 -
263 263  (% class="box successmessage" %)
264 264  (((
265 265  (% lang="en-US" %)**POST /api/v3/users**
... ... @@ -275,7 +275,8 @@
275 275  
276 276  (% style="color:#000000" %)Параметры в теле запроса (JSON):
277 277  
278 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
279 279   "lastName": "", ~/~/ фамилия
280 280   "firstName": "", ~/~/ имя
281 281   "position": "", ~/~/ должность
... ... @@ -284,17 +284,41 @@
284 284   "login": "", ~/~/ логин (обязателен)
285 285   "password": "", ~/~/ пароль (обязателен)
286 286   "email": "", ~/~/ email (обязателен)
287 - "description": "", ~/~/ описание
288 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
289 289   "parentId": "", ~/~/ Guid родительского агента
290 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
291 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
294 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
295 - "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 - Азербайджанский
296 296  }
297 297  
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 +
298 298  (% style="text-align:left" %)
299 299  (% style="color:#000000; font-weight:normal" %)Ответ:
300 300  
... ... @@ -323,10 +323,9 @@
323 323  (% style="text-align:left" %)
324 324  (% style="color:#000000; font-weight:normal" %)}
325 325  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
326 326  
327 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
328 -
329 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
330 330  (((
331 331  (% lang="en-US" %)**POST /api/v3/users/find**
332 332  )))
... ... @@ -372,10 +372,9 @@
372 372  
373 373  (% style="color:#000000" %)}
374 374  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
375 375  
376 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
377 -
378 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
379 379  (((
380 380  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
381 381  )))
... ... @@ -407,8 +407,11 @@
407 407   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
408 408   "description": "", ~/~/ Описание
409 409   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
410 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
411 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
412 412   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
413 413   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
414 414   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -422,9 +422,8 @@
422 422  )))
423 423  )))
424 424  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
425 425  
426 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
427 -
428 428  (% class="box warningmessage" %)
429 429  (((
430 430  (% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -452,7 +452,9 @@
452 452   "phone": "" , ~/~/ телефон
453 453   "organization": "" , ~/~/ организация
454 454   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
455 -(% 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 - отключено
456 456   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
457 457  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
458 458   "isEnabled": "" , ~/~/ признак включения
... ... @@ -459,9 +459,12 @@
459 459   "parentId": "" , ~/~/ Guid родительского агента
460 460   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
461 461   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
462 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
463 - "kind": "" , ~/~/ тип аутентификации
464 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
465 465   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
466 466  
467 467  (% lang="en-US" style="text-align:left" %)
... ... @@ -487,8 +487,12 @@
487 487   "isEnabled": "" , ~/~/ признак включения
488 488   "parentId": "" , ~/~/ Guid родительского агента
489 489   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
490 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
491 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
492 492   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
493 493   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
494 494  
... ... @@ -495,9 +495,8 @@
495 495  (% lang="en-US" style="text-align:left" %)
496 496  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
497 497  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
498 498  
499 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
500 -
501 501  (% class="box warningmessage" %)
502 502  (((
503 503  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
... ... @@ -526,9 +526,8 @@
526 526  (% style="text-align:left" %)
527 527  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
528 528  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
529 529  
530 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
531 -
532 532  (% class="box warningmessage" %)
533 533  (((
534 534  **POST /api/v3/users/disable**
... ... @@ -549,9 +549,8 @@
549 549  
550 550  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
551 551  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
552 552  
553 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
554 -
555 555  (% class="box warningmessage" %)
556 556  (((
557 557  **POST /api/v3/users/enable**
... ... @@ -585,11 +585,10 @@
585 585  }
586 586  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
587 587  "users" - массив id пользователей, которых не удалось включить или отключить.
588 -
589 -
590 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
591 591  )))
592 592  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
593 593  (% class="box errormessage" %)
594 594  (((
595 595  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -608,12 +608,10 @@
608 608  (% style="text-align:left" %)
609 609  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
610 610  
611 -
612 612  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
613 613  
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
614 614  
615 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
616 -
617 617  (% class="box infomessage" %)
618 618  (((
619 619  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -656,6 +656,8 @@
656 656   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
657 657   "mileage": "", ~/~/ Пробег по нормам в метрах
658 658   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
659 659   },
660 660   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
661 661   {
... ... @@ -682,9 +682,8 @@
682 682  (% style="text-align:left" %)
683 683  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
684 684  
759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
685 685  
686 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
687 -
688 688  (% class="box successmessage" %)
689 689  (((
690 690  (% lang="en-US" %)**POST /api/v3/vehicles**
... ... @@ -803,10 +803,9 @@
803 803  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
804 804  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
805 805  
879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
806 806  
807 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
808 -
809 -(% class="box successmessage" %)
881 +(% class="box infomessage" %)
810 810  (((
811 811  (% lang="en-US" %)**POST /api/v3/vehicles/find**
812 812  )))
... ... @@ -886,9 +886,8 @@
886 886  
887 887  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
888 888  
961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
889 889  
890 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
891 -
892 892  (% class="box successmessage" %)
893 893  (((
894 894  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
... ... @@ -933,9 +933,8 @@
933 933  (% style="text-align:left" %)
934 934  (% style="color:#000000" %) }
935 935  
1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
936 936  
937 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
938 -
939 939  (% class="box warningmessage" %)
940 940  (((
941 941  (% lang="en-US" %)**PUT /api/v3/vehicles**
... ... @@ -1063,9 +1063,8 @@
1063 1063  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1064 1064  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1065 1065  
1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1066 1066  
1067 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1068 -
1069 1069  (% class="box errormessage" %)
1070 1070  (((
1071 1071  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -1084,12 +1084,10 @@
1084 1084  (% style="text-align:left" %)
1085 1085  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1086 1086  
1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1087 1087  
1088 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1089 1089  
1090 -
1091 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1092 -
1093 1093  (% class="box infomessage" %)
1094 1094  (((
1095 1095  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
... ... @@ -1113,12 +1113,10 @@
1113 1113  (% style="text-align:left" %)
1114 1114  (% style="color:#000000" %)}
1115 1115  
1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1116 1116  
1117 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1118 1118  
1119 -
1120 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1121 -
1122 1122  (% class="box infomessage" %)
1123 1123  (((
1124 1124  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
... ... @@ -1130,7 +1130,7 @@
1130 1130  
1131 1131  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1132 1132  
1133 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1134 1134  
1135 1135  (% style="color:#000000" %)Ответ:
1136 1136  
... ... @@ -1143,7 +1143,97 @@
1143 1143  (% style="text-align:left" %)
1144 1144  (% style="color:#000000" %)}
1145 1145  
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1146 1146  
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 +
1147 1147  (% class="box" lang="en-US" style="text-align: center;" %)
1148 1148  (((
1149 1149  (% 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 г.