Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.6 >
edited by Илья Крайнов
on 2022/11/24 13:32
To version < 91.1 >
edited by Илья Крайнов
on 2023/05/22 15:34
>
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" %)
... ... @@ -56,7 +56,6 @@
56 56  
57 57  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
58 58  
59 -
60 60  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
61 61  
62 62  (% class="box infomessage" %)
... ... @@ -64,7 +64,7 @@
64 64  (% lang="en-US" %)**GET /api/v3/auth/check**
65 65  )))
66 66  
67 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
68 68  
69 69  (% style="color:#000000" %)Метод запроса: **GET**
70 70  
... ... @@ -75,18 +75,58 @@
75 75  (% lang="en-US" %)
76 76  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
77 77  
78 -
79 79  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
80 80  
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
81 81  
82 -== (% style="color:#000000" %)**Получение основных параметров клиента**(%%) ==
80 +(% class="box infomessage" %)
81 +(((
82 +**GET api/v3/agents/{id}**
83 +)))
83 83  
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
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 +
84 84  (% class="box infomessage" %)
85 85  (((
86 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
87 87  )))
88 88  
89 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
90 90  
91 91  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
92 92  
... ... @@ -94,34 +94,36 @@
94 94  
95 95  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
96 96  
97 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
98 98  
99 -(% 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
100 100  
101 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
102 102  
103 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
104 104  
105 105  (% style="color:#000000" %)Ответ:
106 106  
107 -(% style="color:#000000" %){
108 - "agentId": "", ~/~/ идентификатор клиента
109 - "parentId": "", ~/~/ идентификатор клиента-родителя
110 - "name": "", ~/~/ наименование клиента
111 - "fullName": "", ~/~/ полное наименование клиента
112 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
113 - "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 - Отказ)
114 114  }
115 115  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
116 116  
117 -== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
118 -
119 119  (% class="box successmessage" %)
120 120  (((
121 121  **POST /api/v3/agents **
122 122  )))
123 123  
124 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
164 +Метод позволяет добавить клиента, указанного в запросе.
125 125  
126 126  Метод запроса: **POST**
127 127  
... ... @@ -135,6 +135,7 @@
135 135   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
136 136   "name": "string", ~/~/ имя
137 137   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
138 138   "isForeign": true, ~/~/ иностранный контрагент
139 139   "district": "string", ~/~/ округ
140 140   "region": "string", ~/~/ регион
... ... @@ -159,6 +159,7 @@
159 159   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
160 160   "name": "string", ~/~/ имя
161 161   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
162 162   "isForeign": true, ~/~/ иностранный контрагент
163 163   "district": "string", ~/~/ округ
164 164   "region": "string", ~/~/ регион
... ... @@ -175,15 +175,14 @@
175 175   "bankKS": "string" ~/~/ корр. счёт
176 176  }
177 177  
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
178 178  
179 -== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
180 -
181 181  (% class="box warningmessage" %)
182 182  (((
183 183  **PUT /api/v3/agents**
184 184  )))
185 185  
186 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
227 +Метод позволяет отредактировать клиента, указанного в запросе.
187 187  
188 188  Метод запроса: **PUT**
189 189  
... ... @@ -199,6 +199,7 @@
199 199   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
200 200   "name": "string", ~/~/ имя
201 201   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
202 202   "isForeign": true, ~/~/ иностранный контрагент
203 203   "district": "string", ~/~/ округ
204 204   "region": "string", ~/~/ регион
... ... @@ -239,15 +239,14 @@
239 239   "bankKS": "string" ~/~/ корр. счёт
240 240  }
241 241  
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
242 242  
243 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
244 -
245 245  (% class="box errormessage" %)
246 246  (((
247 247  **DELETE /api/v3/agents/{clientId}**
248 248  )))
249 249  
250 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
291 +Метод позволяет удалить клиента, указанного в строке запроса.
251 251  
252 252  Метод запроса: **DELETE**
253 253  
... ... @@ -259,18 +259,16 @@
259 259  
260 260  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
261 261  
262 -
263 263  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
264 264  
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
265 265  
266 -== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
267 -
268 268  (% class="box successmessage" %)
269 269  (((
270 270  (% lang="en-US" %)**POST /api/v3/users**
271 271  )))
272 272  
273 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
274 274  
275 275  (% style="color:#000000" %)Метод запроса: **POST**
276 276  
... ... @@ -280,7 +280,8 @@
280 280  
281 281  (% style="color:#000000" %)Параметры в теле запроса (JSON):
282 282  
283 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
284 284   "lastName": "", ~/~/ фамилия
285 285   "firstName": "", ~/~/ имя
286 286   "position": "", ~/~/ должность
... ... @@ -289,17 +289,41 @@
289 289   "login": "", ~/~/ логин (обязателен)
290 290   "password": "", ~/~/ пароль (обязателен)
291 291   "email": "", ~/~/ email (обязателен)
292 - "description": "", ~/~/ описание
293 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
294 294   "parentId": "", ~/~/ Guid родительского агента
295 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
296 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
297 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
298 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
299 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
300 - "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 - Азербайджанский
301 301  }
302 302  
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 +
303 303  (% style="text-align:left" %)
304 304  (% style="color:#000000; font-weight:normal" %)Ответ:
305 305  
... ... @@ -328,10 +328,9 @@
328 328  (% style="text-align:left" %)
329 329  (% style="color:#000000; font-weight:normal" %)}
330 330  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
331 331  
332 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
333 -
334 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
335 335  (((
336 336  (% lang="en-US" %)**POST /api/v3/users/find**
337 337  )))
... ... @@ -373,14 +373,13 @@
373 373   "email": "" , ~/~/ E-mail
374 374   "sessionDuration":"", ~/~/ длительность сессии в минутах
375 375   "status": "1",  ~/~/ статус пользователя
376 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
377 377  
378 378  (% style="color:#000000" %)}
379 379  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
380 380  
381 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
382 -
383 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
384 384  (((
385 385  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
386 386  )))
... ... @@ -412,8 +412,11 @@
412 412   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
413 413   "description": "", ~/~/ Описание
414 414   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
415 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
416 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
417 417   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
418 418   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
419 419   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -427,15 +427,14 @@
427 427  )))
428 428  )))
429 429  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
430 430  
431 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
432 -
433 433  (% class="box warningmessage" %)
434 434  (((
435 435  (% lang="en-US" %)**PUT /api/v3/users**
436 436  )))
437 437  
438 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
439 439  
440 440  (% style="color:#000000" %)Метод запроса: **PUT**
441 441  
... ... @@ -457,7 +457,9 @@
457 457   "phone": "" , ~/~/ телефон
458 458   "organization": "" , ~/~/ организация
459 459   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
460 -(% 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 - отключено
461 461   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
462 462  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
463 463   "isEnabled": "" , ~/~/ признак включения
... ... @@ -464,9 +464,12 @@
464 464   "parentId": "" , ~/~/ Guid родительского агента
465 465   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
466 466   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
467 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
468 - "kind": "" , ~/~/ тип аутентификации
469 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
470 470   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
471 471  
472 472  (% lang="en-US" style="text-align:left" %)
... ... @@ -492,8 +492,12 @@
492 492   "isEnabled": "" , ~/~/ признак включения
493 493   "parentId": "" , ~/~/ Guid родительского агента
494 494   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
495 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
496 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
497 497   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
498 498   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
499 499  
... ... @@ -500,15 +500,14 @@
500 500  (% lang="en-US" style="text-align:left" %)
501 501  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
502 502  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
503 503  
504 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
505 -
506 506  (% class="box warningmessage" %)
507 507  (((
508 508  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
509 509  )))
510 510  
511 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
512 512  
513 513  (% style="color:#000000" %)Метод запроса: **PUT**
514 514  
... ... @@ -531,15 +531,14 @@
531 531  (% style="text-align:left" %)
532 532  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
533 533  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
534 534  
535 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
536 -
537 537  (% class="box warningmessage" %)
538 538  (((
539 539  **POST /api/v3/users/disable**
540 540  )))
541 541  
542 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
543 543  
544 544  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
545 545  
... ... @@ -554,15 +554,14 @@
554 554  
555 555  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
556 556  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
557 557  
558 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
559 -
560 560  (% class="box warningmessage" %)
561 561  (((
562 562  **POST /api/v3/users/enable**
563 563  )))
564 564  
565 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
566 566  
567 567  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
568 568  
... ... @@ -590,17 +590,16 @@
590 590  }
591 591  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
592 592  "users" - массив id пользователей, которых не удалось включить или отключить.
593 -
594 -
595 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
596 596  )))
597 597  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
598 598  (% class="box errormessage" %)
599 599  (((
600 600  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
601 601  )))
602 602  
603 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
604 604  
605 605  (% style="color:#000000" %)Метод запроса: **DELETE**
606 606  
... ... @@ -613,12 +613,10 @@
613 613  (% style="text-align:left" %)
614 614  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
615 615  
616 -
617 617  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
618 618  
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
619 619  
620 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
621 -
622 622  (% class="box infomessage" %)
623 623  (((
624 624  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -626,7 +626,7 @@
626 626  
627 627  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
628 628  
629 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
630 630  
631 631  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
632 632  
... ... @@ -634,9 +634,9 @@
634 634  
635 635  (% style="color:#000000" %)Метод запроса: **GET**
636 636  
637 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
704 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
638 638  
639 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
640 640  
641 641  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
642 642  
... ... @@ -650,18 +650,124 @@
650 650   "deviceTypeId": , ~/~/ ID типа устройства
651 651   "deviceTypeName": "", ~/~/ Название типа устройства
652 652   "sim1": "", ~/~/ Номер SIM1
653 - "parentId": "", Номер SIM2
654 - "parentName": "", Наименование клиента-родителя
655 - "modelId": "", ID модели объекта
656 - "modelName": "", Имя модели объекта
657 - "createdAt": "", Дата создания объекта
658 - "mileageCalcMethod": "", Выбранный метод расчета пробега
659 - "counters": { ~/~/ Нормы
660 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
661 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
662 - "mileage": "", ~/~/ Пробег по нормам в метрах
663 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
720 + "sim2": "", ~/~/ Номер SIM2
721 +
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
726 +
727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 + "unitName": "string", ~/~/ Наименование подразделения
729 + "status": 0, ~/~/ Статус объекта
730 +
731 + "createdAt": "", ~/~/ Дата создания объекта
664 664   },
733 +
734 +"customFields": [ ~/~/ Произвольные поля
735 + {
736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
737 + "name": "string", ~/~/ Имя поля
738 + "value": "string", ~/~/ Значение поля
739 + "forClient": true, ~/~/ Не используемая функция
740 + "forTooltip": true, ~/~/ Отображать в подсказке
741 + "forReport": true ~/~/ Отображать в отчете
742 + }
743 +
744 +], ~/~/ Данные с вкладки нормы
745 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
746 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
747 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
748 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
749 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
750 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
751 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
752 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
753 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 +
758 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 + "mileageCoeff": 0, ~/~/ коэффициент пробега
760 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
761 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
762 + "counters": { ~/~/ Счетчики
763 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
764 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
765 + "mileage": 0, ~/~/ Текущий пробег
766 + "motohours": 0, ~/~/ Текущие моточасы
767 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
768 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
769 + },
770 +
771 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
772 + "id": "string", ~/~/ ID объекта
773 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
774 + "host": "string", ~/~/ CMSV6 Web Host
775 + "login": "string", ~/~/ CMSV6 Account
776 + "password": "string" ~/~/ CMSV6 Password
777 + },
778 +
779 +"commandTemplates": [ ~/~/ Шаблоны команд
780 + {
781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
782 + "name": "string", ~/~/ Наименование команды
783 + "command": "string", ~/~/ Текст команды
784 + "retries": 0 ~/~/ Количество попыток
785 + }
786 + ],
787 +
788 + "sensors": [ ~/~/ Датчики
789 + {
790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
791 + "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный
792 + "type": 0, ~/~/ Тип датчика
793 + "name": "string", ~/~/ Имя датчика
794 + "inputType": 0, ~/~/ Тип входа
795 + "inputNumber": 0, ~/~/ Номер входа
796 + "pseudonym": "string", ~/~/ Псевдоним
797 + "medianDegree": 0, ~/~/ Медианная фильтрация
798 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 + "gradeType": 0, ~/~/ Тип тарировки
801 + "gradesTables": [ ~/~/ Тип тарировки Таблица
802 + {
803 + "grades": [ ~/~/ Тарировка
804 + {
805 + "input": 0, ~/~/ Входящее значение
806 + "output": 0 ~/~/ Выходящее значение
807 + }
808 + ],
809 + "relevanceTime": "2023-05-22T09:57:39.562Z"
810 + }
811 + ],
812 + "showInTooltip": true, ~/~/ Отображать в подсказке
813 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
814 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
815 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
816 + "agrFunction": 0,
817 + "expr": "string",
818 + "children": [
819 + "string"
820 + ],
821 + "customParams": {
822 + "additionalProp1": "string",
823 + "additionalProp2": "string",
824 + "additionalProp3": "string"
825 + },
826 + "summaryMaxValue": 0
827 + }
828 +
829 + "drivers": [ ~/~/ Водители
830 + {
831 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "name": "string",
833 + "description": "string",
834 + "isDefault": true
835 + }
836 + ],
837 +
665 665   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
666 666   {
667 667   "id": "", ~/~/ ID  задания
... ... @@ -677,7 +677,17 @@
677 677   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
678 678   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
679 679   }
680 - ]
853 + ],
854 +
855 + "statusHistory": [ ~/~/ История статусов
856 + {
857 + "status": 0,
858 + "date": "2023-05-22T09:57:39.562Z",
859 + "description": "string",
860 + "additionalInfo": "string"
861 + }
862 + ]
863 +
681 681  }
682 682  )))
683 683  
... ... @@ -687,15 +687,14 @@
687 687  (% style="text-align:left" %)
688 688  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
689 689  
873 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
690 690  
691 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
692 -
693 693  (% class="box successmessage" %)
694 694  (((
695 695  (% lang="en-US" %)**POST /api/v3/vehicles**
696 696  )))
697 697  
698 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
699 699  
700 700  (% style="color:#000000" %)Метод запроса: **POST**
701 701  
... ... @@ -727,6 +727,11 @@
727 727   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
728 728   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
729 729   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
912 +
913 + "mileageCalcMethod": 0,
914 + "mileageCoeff": 0,
915 + "locationByCellId": true,
916 + "dottedLineTrackWhenNoCoords": true,
730 730   "counters": ~/~/ счетчики
731 731   {
732 732   "mileage": "" , ~/~/ пробег
... ... @@ -756,7 +756,72 @@
756 756   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
757 757   }
758 758  
759 -(% style="color:#000000" %) }
946 +"drivers": [ ~/~/ Водители
947 + {
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "isDefault": true
950 + }
951 + ],
952 + "commandTemplates": [ ~/~/ Шаблон команды
953 + {
954 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
955 + "name": "string",
956 + "command": "string",
957 + "retries": 0
958 + }
959 + ],
960 + "sensors": [ ~/~/ Датчики
961 + {
962 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
963 + "kind": 0,
964 + "type": 0,
965 + "name": "string",
966 + "inputType": 0,
967 + "inputNumber": 0,
968 + "pseudonym": "string",
969 + "medianDegree": 0,
970 + "isInverted": true,
971 + "disabled": true,
972 + "gradeType": 0,
973 + "gradesTables": [
974 + {
975 + "grades": [
976 + {
977 + "input": 0,
978 + "output": 0
979 + }
980 + ],
981 + "relevanceTime": "2023-05-22T12:19:59.728Z"
982 + }
983 + ],
984 + "showInTooltip": true,
985 + "showLastValid": true,
986 + "showAsDutOnGraph": true,
987 + "showWithoutIgn": true,
988 + "agrFunction": 0,
989 + "expr": "string",
990 + "children": [
991 + "string"
992 + ],
993 + "customParams": {
994 + "additionalProp1": "string",
995 + "additionalProp2": "string",
996 + "additionalProp3": "string"
997 + },
998 + "summaryMaxValue": 0
999 + }
1000 + ],
1001 + "customFields": [ ~/~/ Произвольные поля
1002 + {
1003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1004 + "name": "string",
1005 + "value": "string",
1006 + "forClient": true,
1007 + "forTooltip": true,
1008 + "forReport": true
1009 + }
1010 + ]
1011 +}
760 760  
761 761  (% style="color:#000000" %)Ответ:
762 762  
... ... @@ -808,10 +808,9 @@
808 808  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
809 809  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
810 810  
1063 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
811 811  
812 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
813 -
814 -(% class="box successmessage" %)
1065 +(% class="box infomessage" %)
815 815  (((
816 816  (% lang="en-US" %)**POST /api/v3/vehicles/find**
817 817  )))
... ... @@ -818,7 +818,7 @@
818 818  
819 819  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
820 820  
821 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1072 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
822 822  
823 823  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
824 824  
... ... @@ -891,15 +891,14 @@
891 891  
892 892  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
893 893  
1145 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
894 894  
895 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
896 -
897 897  (% class="box successmessage" %)
898 898  (((
899 899  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
900 900  )))
901 901  
902 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1152 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
903 903  
904 904  (% style="color:#000000" %)Метод запроса: **POST**
905 905  
... ... @@ -938,15 +938,14 @@
938 938  (% style="text-align:left" %)
939 939  (% style="color:#000000" %) }
940 940  
1191 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
941 941  
942 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
943 -
944 944  (% class="box warningmessage" %)
945 945  (((
946 946  (% lang="en-US" %)**PUT /api/v3/vehicles**
947 947  )))
948 948  
949 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1198 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
950 950  
951 951  (% style="color:#000000" %)Метод запроса: **PUT**
952 952  
... ... @@ -1063,20 +1063,19 @@
1063 1063  (% lang="en-US" style="text-align:left" %)
1064 1064  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1065 1065  
1066 -**валидация:**
1315 +**Валидация:**
1067 1067  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1068 1068  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1069 1069  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1070 1070  
1320 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1071 1071  
1072 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1073 -
1074 1074  (% class="box errormessage" %)
1075 1075  (((
1076 1076  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1077 1077  )))
1078 1078  
1079 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1327 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1080 1080  
1081 1081  (% style="color:#000000" %)Метод запроса: **DELETE**
1082 1082  
... ... @@ -1089,18 +1089,16 @@
1089 1089  (% style="text-align:left" %)
1090 1090  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1091 1091  
1340 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1092 1092  
1093 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1342 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1094 1094  
1095 -
1096 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1097 -
1098 1098  (% class="box infomessage" %)
1099 1099  (((
1100 1100  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1101 1101  )))
1102 1102  
1103 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1349 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1104 1104  
1105 1105  (% style="color:#000000" %)Метод запроса: **GET**
1106 1106  
... ... @@ -1118,24 +1118,22 @@
1118 1118  (% style="text-align:left" %)
1119 1119  (% style="color:#000000" %)}
1120 1120  
1367 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1121 1121  
1122 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1369 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1123 1123  
1124 -
1125 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1126 -
1127 1127  (% class="box infomessage" %)
1128 1128  (((
1129 1129  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1130 1130  )))
1131 1131  
1132 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1376 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1133 1133  
1134 1134  (% style="color:#000000" %)Метод запроса: **GET**
1135 1135  
1136 1136  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1137 1137  
1138 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1139 1139  
1140 1140  (% style="color:#000000" %)Ответ:
1141 1141  
... ... @@ -1148,7 +1148,296 @@
1148 1148  (% style="text-align:left" %)
1149 1149  (% style="color:#000000" %)}
1150 1150  
1395 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1151 1151  
1397 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1398 +
1399 +(% class="box infomessage" style="text-align: left;" %)
1400 +(((
1401 +**POST /api/v3/terminalMessages/count**
1402 +)))
1403 +
1404 +(% style="text-align: left;" %)
1405 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1406 +
1407 +(% style="text-align: left;" %)
1408 +Метод запроса **POST**
1409 +
1410 +(% style="text-align: left;" %)
1411 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1412 +
1413 +(% style="text-align: left;" %)
1414 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1415 +
1416 +(% style="text-align: left;" %)
1417 +{
1418 + "vehicleIds": [
1419 + id ~/~/ здесь передается список идентификаторов объектов
1420 + ],
1421 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1422 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1423 +}
1424 +
1425 +(% style="text-align: left;" %)
1426 +Ответ:
1427 +
1428 +(% style="text-align: left;" %)
1429 +[
1430 + {
1431 + "vehicleId": 0, ~/~/ идентификатор объекта
1432 + "count": 0 ~/~/ количество сообщений за период
1433 + }
1434 +]
1435 +
1436 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1437 +
1438 +(% class="box infomessage" %)
1439 +(((
1440 +**POST /api/v3/terminalMessages**
1441 +)))
1442 +
1443 +Метод возвращает список сообщений терминала объекта за выбранный период.
1444 +
1445 +(% style="text-align: left;" %)
1446 +Метод запроса **POST**
1447 +
1448 +(% style="text-align: left;" %)
1449 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1450 +
1451 +(% style="text-align: left;" %)
1452 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1453 +
1454 +{
1455 + "vehicleId": 0, ~/~/ id объекта
1456 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1457 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1458 +}
1459 +
1460 +Ответ:
1461 +
1462 +[
1463 + {
1464 + "messages": [
1465 + {
1466 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1467 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1468 + "speed": 0, ~/~/ Скорость, км/ч
1469 + "altitude": 0, ~/~/ Высота, м
1470 + "latitude": 0, ~/~/ Широта [-90°;90°]
1471 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1472 + "satellites": 0, ~/~/ Кол-во спутников
1473 + "voltage": 0, ~/~/ Напряжение
1474 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1475 + "additionalProp1": "string",
1476 + "additionalProp2": "string",
1477 + "additionalProp3": "string"
1478 + },
1479 + "photoCount": 0 ~/~/ Кол-во фото
1480 + }
1481 + ]
1482 + }
1483 +]
1484 +
1485 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1486 +
1487 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1488 +
1489 +(% class="box infomessage" %)
1490 +(((
1491 +**POST /api/v3/notifications/find**
1492 +)))
1493 +
1494 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1495 +
1496 +(% style="text-align: left;" %)
1497 +Метод запроса **POST**
1498 +
1499 +(% style="text-align: left;" %)
1500 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1501 +
1502 +(% style="text-align: left;" %)
1503 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1504 +
1505 +{
1506 + "parentId": "" ~/~/ id клиента
1507 +}
1508 +
1509 +Ответ:
1510 +
1511 +[
1512 + {
1513 + "id": 0, ~/~/ ID уведомления
1514 + "name": "string", ~/~/ Название уведомления
1515 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1516 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1517 + "userId": "", ~/~/ Пользователь, создавший уведомление
1518 + "parentId": "", ~/~/ Идентификатор клиента
1519 + "parentName": "string" ~/~/ Имя клиента
1520 + }
1521 +]
1522 +
1523 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1524 +
1525 +(% class="box infomessage" %)
1526 +(((
1527 +**GET /api/v3/notifications/{id}**
1528 +)))
1529 +
1530 +Метод возвращает данные правил формирования выбранного уведомления.
1531 +
1532 +(% style="text-align: left;" %)
1533 +Метод запроса **GET**
1534 +
1535 +(% style="text-align: left;" %)
1536 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1537 +
1538 +(% style="text-align: left;" %)
1539 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1540 +
1541 +(% style="text-align: left;" %)
1542 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1543 +
1544 +(% style="text-align: left;" %)
1545 +(% style="color:#000000" %)Ответ:
1546 +
1547 +(% style="text-align: left;" %)
1548 +(% style="color:#000000" %){
1549 + "id": 0, ~/~/ (%%)id уведомления
1550 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1551 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1552 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1553 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1554 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1555 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1556 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1557 +(% style="color:#000000" %) 0
1558 + ],
1559 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1560 +(% style="color:#000000" %) 0
1561 + ],
1562 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1563 +(% style="color:#000000" %) 0
1564 + ],
1565 + "settings": { ~/~/ Список параметров уведомления
1566 + "additionalProp1": "string",
1567 + "additionalProp2": "string",
1568 + "additionalProp3": "string"
1569 + },
1570 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1571 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1572 +(% style="color:#000000" %) ""
1573 + ],
1574 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1575 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1576 +(% style="color:#000000" %) "string"
1577 + ],
1578 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1579 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1580 +(% style="color:#000000" %) {
1581 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1582 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1583 +(% style="color:#000000" %) }
1584 + ],
1585 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1586 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1587 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1588 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1589 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1590 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1591 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1592 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1593 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1594 +(% style="color:#000000" %)}
1595 +
1596 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1597 +
1598 +(% class="box warningmessage" %)
1599 +(((
1600 +**PUT /api/v3/notifications/**
1601 +)))
1602 +
1603 +Метод позволяет отредактировать уведомление.
1604 +
1605 +Метод запроса **PUT**
1606 +
1607 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1608 +
1609 +В заголовках запроса: X-Auth: Токен авторизации
1610 +
1611 +Тело запроса:
1612 +{
1613 + "id": 0, ~/~/ id уведомления
1614 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1615 + "userId": "", ~/~/ Пользователь, создавший уведомление
1616 + "parentId": "", ~/~/ Идентификатор клиента
1617 + "parentName": "string", ~/~/ Имя клиента
1618 + "name": "string", ~/~/ Название уведомления
1619 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1620 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1621 + 0
1622 + ],
1623 + "geoids": [ ~/~/ Список id геообъектов для анализа
1624 + 0
1625 + ],
1626 + "fieldids": [ ~/~/ Список id полей для анализа
1627 + 0
1628 + ],
1629 + "settings": { ~/~/ Список параметров уведомления
1630 + "additionalProp1": "string",
1631 + "additionalProp2": "string",
1632 + "additionalProp3": "string"
1633 + },
1634 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1635 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1636 + ""
1637 + ],
1638 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1639 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1640 + "string"
1641 + ],
1642 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1643 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1644 + {
1645 + "id": 0, ~/~/ Идентификатор участника чата
1646 + "info": "string" ~/~/ Дополнительные сведения
1647 + }
1648 + ],
1649 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1650 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1651 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1652 + "kind": 0, ~/~/ Определяет вид уведомления
1653 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1654 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1655 + "timezone": 0, ~/~/ Сдвиг часового пояса
1656 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1657 + "autoProlongation": true ~/~/ Автопродление срока действия
1658 +}
1659 +
1660 +Ответ:
1661 +
1662 +Success
1663 +
1664 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1665 +
1666 +(% class="box errormessage" %)
1667 +(((
1668 +**DELETE /api/v3/notifications/{id}**
1669 +)))
1670 +
1671 +Метод позволяет удалить выбранное уведомление.
1672 +
1673 +Метод запроса **DELETE**
1674 +
1675 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1676 +
1677 +Передаваемый параметр: {id} - id уведомления
1678 +
1679 +В заголовках запроса: X-Auth: Токен авторизации
1680 +
1681 +Ответ:
1682 +
1683 +Success
1684 +
1152 1152  (% class="box" lang="en-US" style="text-align: center;" %)
1153 1153  (((
1154 1154  (% 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 г.