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

Summary

Details

Icon Page properties
Content
... ... @@ -1,34 +1,31 @@
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  
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
8 8  
9 -(% class="box" style="text-align: center;" %)
10 -(((
11 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
12 -)))
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
13 13  
14 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
15 -
16 16  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
17 17  
18 18  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
19 -
20 20  
21 -(% class="box" style="text-align: center;" %)
22 -(((
23 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
24 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
25 25  
26 -(% class="box successmessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box infomessage" %)
27 27  (((
28 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
29 29  )))
30 30  
31 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
32 32  
33 33  (% style="color:#000000" %)Метод запроса: **POST**
34 34  
... ... @@ -41,9 +41,9 @@
41 41  (% style="color:#000000" %){
42 42   "login": "testuser",
43 43   "password": "testuser"
44 -}(%%)
45 -
41 +}
46 46  
43 +
47 47  (% style="color:#000000" %)**Ответ:**
48 48  
49 49  (% lang="en-US" %)
... ... @@ -58,13 +58,14 @@
58 58  
59 59  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
60 60  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
61 61  
62 62  (% class="box infomessage" %)
63 63  (((
64 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
65 65  )))
66 66  
67 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
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  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
78 78  
79 -(% class="box" style="text-align: center;" %)
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 +
80 +(% class="box infomessage" %)
80 80  (((
81 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
82 82  )))
83 83  
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
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 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% 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" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
90 90  
91 91  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
92 92  
... ... @@ -94,29 +94,33 @@
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 117  (% class="box successmessage" %)
118 118  (((
119 -**Добавление клиента — POST /api/v3/agents **
161 +**POST /api/v3/agents **
120 120  )))
121 121  
122 122  Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -133,6 +133,7 @@
133 133   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
134 134   "name": "string", ~/~/ имя
135 135   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
136 136   "isForeign": true, ~/~/ иностранный контрагент
137 137   "district": "string", ~/~/ округ
138 138   "region": "string", ~/~/ регион
... ... @@ -157,6 +157,7 @@
157 157   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
158 158   "name": "string", ~/~/ имя
159 159   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
160 160   "isForeign": true, ~/~/ иностранный контрагент
161 161   "district": "string", ~/~/ округ
162 162   "region": "string", ~/~/ регион
... ... @@ -173,10 +173,11 @@
173 173   "bankKS": "string" ~/~/ корр. счёт
174 174  }
175 175  
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
176 176  
177 177  (% class="box warningmessage" %)
178 178  (((
179 -**Редактирование клиента — PUT /api/v3/agents**
224 +**PUT /api/v3/agents**
180 180  )))
181 181  
182 182  Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -195,6 +195,7 @@
195 195   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
196 196   "name": "string", ~/~/ имя
197 197   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
198 198   "isForeign": true, ~/~/ иностранный контрагент
199 199   "district": "string", ~/~/ округ
200 200   "region": "string", ~/~/ регион
... ... @@ -235,13 +235,13 @@
235 235   "bankKS": "string" ~/~/ корр. счёт
236 236  }
237 237  
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
238 238  
239 239  (% class="box errormessage" %)
240 240  (((
241 -**Удаление клиента — DELETE /api/v3/agents/{clientId}**
288 +**DELETE /api/v3/agents/{clientId}**
242 242  )))
243 243  
244 -
245 245  Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
246 246  
247 247  Метод запроса: **DELETE**
... ... @@ -254,19 +254,16 @@
254 254  
255 255  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
256 256  
303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
257 257  
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
258 258  
259 -(% class="box" style="text-align: center;" %)
260 -(((
261 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
262 -)))
263 -
264 264  (% class="box successmessage" %)
265 265  (((
266 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
309 +(% lang="en-US" %)**POST /api/v3/users**
267 267  )))
268 268  
269 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
270 270  
271 271  (% style="color:#000000" %)Метод запроса: **POST**
272 272  
... ... @@ -276,7 +276,8 @@
276 276  
277 277  (% style="color:#000000" %)Параметры в теле запроса (JSON):
278 278  
279 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
280 280   "lastName": "", ~/~/ фамилия
281 281   "firstName": "", ~/~/ имя
282 282   "position": "", ~/~/ должность
... ... @@ -285,17 +285,41 @@
285 285   "login": "", ~/~/ логин (обязателен)
286 286   "password": "", ~/~/ пароль (обязателен)
287 287   "email": "", ~/~/ email (обязателен)
288 - "description": "", ~/~/ описание
289 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
290 290   "parentId": "", ~/~/ Guid родительского агента
291 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
292 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
293 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
294 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
295 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
296 - "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 - Азербайджанский
297 297  }
298 298  
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 +
299 299  (% style="text-align:left" %)
300 300  (% style="color:#000000; font-weight:normal" %)Ответ:
301 301  
... ... @@ -324,13 +324,14 @@
324 324  (% style="text-align:left" %)
325 325  (% style="color:#000000; font-weight:normal" %)}
326 326  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
327 327  
328 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
329 329  (((
330 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
399 +(% lang="en-US" %)**POST /api/v3/users/find**
331 331  )))
332 332  
333 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
334 334  
335 335  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
336 336  
... ... @@ -371,13 +371,14 @@
371 371  
372 372  (% style="color:#000000" %)}
373 373  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
374 374  
375 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
376 376  (((
377 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
378 378  )))
379 379  
380 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
381 381  
382 382  (% style="color:#000000" %)Метод запроса: **GET**
383 383  
... ... @@ -404,8 +404,11 @@
404 404   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
405 405   "description": "", ~/~/ Описание
406 406   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
407 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
408 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
409 409   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
410 410   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
411 411   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -419,13 +419,14 @@
419 419  )))
420 420  )))
421 421  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
422 422  
423 423  (% class="box warningmessage" %)
424 424  (((
425 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
499 +(% lang="en-US" %)**PUT /api/v3/users**
426 426  )))
427 427  
428 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
429 429  
430 430  (% style="color:#000000" %)Метод запроса: **PUT**
431 431  
... ... @@ -433,8 +433,6 @@
433 433  
434 434  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
435 435  
436 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
437 -
438 438  (% lang="en-US" style="text-align:left" %)
439 439  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
440 440  
... ... @@ -449,7 +449,9 @@
449 449   "phone": "" , ~/~/ телефон
450 450   "organization": "" , ~/~/ организация
451 451   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
452 -(% 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 - отключено
453 453   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
454 454  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
455 455   "isEnabled": "" , ~/~/ признак включения
... ... @@ -456,9 +456,12 @@
456 456   "parentId": "" , ~/~/ Guid родительского агента
457 457   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
458 458   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
459 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
460 - "kind": "" , ~/~/ тип аутентификации
461 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
462 462   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
463 463  
464 464  (% lang="en-US" style="text-align:left" %)
... ... @@ -484,8 +484,12 @@
484 484   "isEnabled": "" , ~/~/ признак включения
485 485   "parentId": "" , ~/~/ Guid родительского агента
486 486   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
487 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
488 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
489 489   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
490 490   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
491 491  
... ... @@ -492,13 +492,14 @@
492 492  (% lang="en-US" style="text-align:left" %)
493 493  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
494 494  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
495 495  
496 496  (% class="box warningmessage" %)
497 497  (((
498 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
499 499  )))
500 500  
501 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 502  
503 503  (% style="color:#000000" %)Метод запроса: **PUT**
504 504  
... ... @@ -521,10 +521,11 @@
521 521  (% style="text-align:left" %)
522 522  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
523 523  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
524 524  
525 525  (% class="box warningmessage" %)
526 526  (((
527 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
610 +**POST /api/v3/users/disable**
528 528  )))
529 529  
530 530  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -542,10 +542,11 @@
542 542  
543 543  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
544 544  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
545 545  
546 546  (% class="box warningmessage" %)
547 547  (((
548 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
632 +**POST /api/v3/users/enable**
549 549  )))
550 550  
551 551  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -576,15 +576,16 @@
576 576  }
577 577  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
578 578  "users" - массив id пользователей, которых не удалось включить или отключить.
579 -
580 580  )))
581 581  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
582 582  (% class="box errormessage" %)
583 583  (((
584 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
585 585  )))
586 586  
587 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
588 588  
589 589  (% style="color:#000000" %)Метод запроса: **DELETE**
590 590  
... ... @@ -597,20 +597,18 @@
597 597  (% style="text-align:left" %)
598 598  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
599 599  
685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
600 600  
601 -(% class="box" style="text-align: center;" %)
602 -(((
603 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
604 -)))
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
605 605  
606 606  (% class="box infomessage" %)
607 607  (((
608 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
609 609  )))
610 610  
611 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
612 612  
613 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
614 614  
615 615  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
616 616  
... ... @@ -645,6 +645,8 @@
645 645   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
646 646   "mileage": "", ~/~/ Пробег по нормам в метрах
647 647   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
648 648   },
649 649   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
650 650   {
... ... @@ -671,13 +671,14 @@
671 671  (% style="text-align:left" %)
672 672  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
673 673  
759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
674 674  
675 675  (% class="box successmessage" %)
676 676  (((
677 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
763 +(% lang="en-US" %)**POST /api/v3/vehicles**
678 678  )))
679 679  
680 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
681 681  
682 682  (% style="color:#000000" %)Метод запроса: **POST**
683 683  
... ... @@ -790,15 +790,16 @@
790 790  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
791 791  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
792 792  
879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
793 793  
794 -(% class="box successmessage" %)
881 +(% class="box infomessage" %)
795 795  (((
796 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
883 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
797 797  )))
798 798  
799 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
886 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
800 800  
801 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
802 802  
803 803  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
804 804  
... ... @@ -835,7 +835,7 @@
835 835   "customFields": null ~/~/ значение любого из произвольных полей ТС
836 836  }
837 837  
838 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
925 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
839 839  
840 840  (% style="color:#000000" %)Ответ:
841 841  
... ... @@ -871,13 +871,14 @@
871 871  
872 872  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
873 873  
961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
874 874  
875 875  (% class="box successmessage" %)
876 876  (((
877 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
965 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
878 878  )))
879 879  
880 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
881 881  
882 882  (% style="color:#000000" %)Метод запроса: **POST**
883 883  
... ... @@ -916,13 +916,14 @@
916 916  (% style="text-align:left" %)
917 917  (% style="color:#000000" %) }
918 918  
1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
919 919  
920 920  (% class="box warningmessage" %)
921 921  (((
922 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1011 +(% lang="en-US" %)**PUT /api/v3/vehicles**
923 923  )))
924 924  
925 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
926 926  
927 927  (% style="color:#000000" %)Метод запроса: **PUT**
928 928  
... ... @@ -1044,13 +1044,14 @@
1044 1044  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1045 1045  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1046 1046  
1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1047 1047  
1048 1048  (% class="box errormessage" %)
1049 1049  (((
1050 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1140 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1051 1051  )))
1052 1052  
1053 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1054 1054  
1055 1055  (% style="color:#000000" %)Метод запроса: **DELETE**
1056 1056  
... ... @@ -1063,18 +1063,16 @@
1063 1063  (% style="text-align:left" %)
1064 1064  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1065 1065  
1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1066 1066  
1067 -(% class="box" lang="en-US" style="text-align: center;" %)
1068 -(((
1069 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1070 -)))
1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1071 1071  
1072 1072  (% class="box infomessage" %)
1073 1073  (((
1074 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1162 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1075 1075  )))
1076 1076  
1077 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1078 1078  
1079 1079  (% style="color:#000000" %)Метод запроса: **GET**
1080 1080  
... ... @@ -1092,24 +1092,22 @@
1092 1092  (% style="text-align:left" %)
1093 1093  (% style="color:#000000" %)}
1094 1094  
1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1095 1095  
1096 -(% class="box" style="text-align: center;" %)
1097 -(((
1098 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1099 -)))
1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1100 1100  
1101 1101  (% class="box infomessage" %)
1102 1102  (((
1103 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1189 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1104 1104  )))
1105 1105  
1106 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1107 1107  
1108 1108  (% style="color:#000000" %)Метод запроса: **GET**
1109 1109  
1110 1110  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1111 1111  
1112 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1113 1113  
1114 1114  (% style="color:#000000" %)Ответ:
1115 1115  
... ... @@ -1122,7 +1122,99 @@
1122 1122  (% style="text-align:left" %)
1123 1123  (% style="color:#000000" %)}
1124 1124  
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1125 1125  
1213 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1214 +
1215 +(% class="box infomessage" style="text-align: left;" %)
1216 +(((
1217 +**POST /api/v3/terminalMessages/count**
1218 +)))
1219 +
1220 +(% style="text-align: left;" %)
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1222 +
1223 +(% style="text-align: left;" %)
1224 +Метод запроса **POST**
1225 +
1226 +(% style="text-align: left;" %)
1227 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1228 +
1229 +(% style="text-align: left;" %)
1230 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1231 +
1232 +(% style="text-align: left;" %)
1233 +{
1234 + "vehicleIds": [
1235 + id ~/~/ здесь передается список идентификаторов объектов
1236 + ],
1237 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1238 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1239 +}
1240 +
1241 +(% style="text-align: left;" %)
1242 +Ответ:
1243 +
1244 +(% style="text-align: left;" %)
1245 +[
1246 + {
1247 + "vehicleId": 0, ~/~/ идентификатор объекта
1248 + "count": 0 ~/~/ количество сообщений за период
1249 + }
1250 +]
1251 +
1252 +
1253 +(% style="text-align: left;" %)
1254 +(% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**
1255 +
1256 +(% class="box infomessage" %)
1257 +(((
1258 +**POST /api/v3/terminalMessages**
1259 +)))
1260 +
1261 +Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1262 +
1263 +(% style="text-align: left;" %)
1264 +Метод запроса **POST**
1265 +
1266 +(% style="text-align: left;" %)
1267 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1268 +
1269 +(% style="text-align: left;" %)
1270 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1271 +
1272 +{
1273 + "vehicleId": 0, ~/~/ id объекта
1274 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1275 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1276 +}
1277 +
1278 +Ответ:
1279 +
1280 +[
1281 + {
1282 + "messages": [
1283 + {
1284 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1285 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1286 + "speed": 0, ~/~/ Скорость, км/ч
1287 + "altitude": 0, ~/~/ Высота, м
1288 + "latitude": 0, ~/~/ Широта [-90°;90°]
1289 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1290 + "satellites": 0, ~/~/ Кол-во спутников
1291 + "voltage": 0, ~/~/ Напряжение
1292 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1293 + "additionalProp1": "string",
1294 + "additionalProp2": "string",
1295 + "additionalProp3": "string"
1296 + },
1297 + "photoCount": 0 ~/~/ Кол-во фото
1298 + }
1299 + ]
1300 + }
1301 +]
1302 +
1303 +
1126 1126  (% class="box" lang="en-US" style="text-align: center;" %)
1127 1127  (((
1128 1128  (% 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 г.