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

Summary

Details

Icon Page properties
Content
... ... @@ -1,36 +1,31 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
2 +(((
3 +**Содержание страницы:**
4 +)))
3 3  
6 +{{toc/}}
4 4  
5 -~{~{box cssClass="floatinginfobox" title="~*~*Contents~*~*"}}~{~{toc/}}~{~{/box}}
6 -\\= Level 1
7 -\\Hello
8 -\\== Level 2
9 9  
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 10  
11 -(% class="box" style="text-align: center;" %)
12 -(((
13 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
14 -)))
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
15 15  
16 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
17 -
18 18  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
19 19  
20 20  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
21 -
22 22  
23 -(% class="box" style="text-align: center;" %)
24 -(((
25 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
26 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
27 27  
28 -(% class="box successmessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box infomessage" %)
29 29  (((
30 - (% 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**
31 31  )))
32 32  
33 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
34 34  
35 35  (% style="color:#000000" %)Метод запроса: **POST**
36 36  
... ... @@ -43,9 +43,9 @@
43 43  (% style="color:#000000" %){
44 44   "login": "testuser",
45 45   "password": "testuser"
46 -}(%%)
47 -
41 +}
48 48  
43 +
49 49  (% style="color:#000000" %)**Ответ:**
50 50  
51 51  (% lang="en-US" %)
... ... @@ -60,13 +60,14 @@
60 60  
61 61  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
62 62  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
63 63  
64 64  (% class="box infomessage" %)
65 65  (((
66 -(% 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**
67 67  )))
68 68  
69 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
70 70  
71 71  (% style="color:#000000" %)Метод запроса: **GET**
72 72  
... ... @@ -77,18 +77,58 @@
77 77  (% lang="en-US" %)
78 78  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
79 79  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
80 80  
81 -(% class="box" style="text-align: center;" %)
78 +Получение информации о клиенте
79 +
80 +(% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
84 84  )))
85 85  
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": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%)
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 +
86 86  (% class="box infomessage" %)
87 87  (((
88 -(% 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(%%)**
89 89  )))
90 90  
91 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
92 92  
93 93  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
94 94  
... ... @@ -96,29 +96,46 @@
96 96  
97 97  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
98 98  
99 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
100 100  
101 -(% 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
102 102  
103 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
104 104  
105 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
106 106  
107 107  (% style="color:#000000" %)Ответ:
108 108  
109 -(% style="color:#000000" %){
110 - "agentId": "", ~/~/ идентификатор клиента
111 - "parentId": "", ~/~/ идентификатор клиента-родителя
112 - "name": "", ~/~/ наименование клиента
113 - "fullName": "", ~/~/ полное наименование клиента
114 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
115 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
116 -}
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 + "isForeign": true/false, ~/~/ Иностранный контрагент
155 + "district": "string", ~/~/ округ
156 + "region": "string", ~/~/ регион
157 + "city": "string", ~/~/ город
158 + "inn": "string", ~/~/ ИНН клиента
159 + "kpp": "string", ~/~/ КПП клиента
160 + "address": "string", ~/~/ юридический адрес
161 + "addressFact": "string", ~/~/ фактический адрес
162 + "email": "string", ~/~/ почта
163 + "director": "string", ~/~/ ФИО руководителя
164 + "bankName": "string", ~/~/ Банк
165 + "bankBIK": "string", ~/~/ БИК
166 + "bankRS": "string", ~/~/ Номер счета
167 + "bankKS": "string" ~/~/ Корр. счет
168 + }
117 117  
170 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
118 118  
119 119  (% class="box successmessage" %)
120 120  (((
121 -**Добавление клиента — POST /api/v3/agents **
174 +**POST /api/v3/agents **
122 122  )))
123 123  
124 124  Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -175,10 +175,11 @@
175 175   "bankKS": "string" ~/~/ корр. счёт
176 176  }
177 177  
231 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
178 178  
179 179  (% class="box warningmessage" %)
180 180  (((
181 -**Редактирование клиента — PUT /api/v3/agents**
235 +**PUT /api/v3/agents**
182 182  )))
183 183  
184 184  Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -237,13 +237,13 @@
237 237   "bankKS": "string" ~/~/ корр. счёт
238 238  }
239 239  
294 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
240 240  
241 241  (% class="box errormessage" %)
242 242  (((
243 -**Удаление клиента — DELETE /api/v3/agents/{clientId}**
298 +**DELETE /api/v3/agents/{clientId}**
244 244  )))
245 245  
246 -
247 247  Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
248 248  
249 249  Метод запроса: **DELETE**
... ... @@ -256,19 +256,16 @@
256 256  
257 257  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
258 258  
313 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
259 259  
315 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
260 260  
261 -(% class="box" style="text-align: center;" %)
262 -(((
263 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
264 -)))
265 -
266 266  (% class="box successmessage" %)
267 267  (((
268 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
319 +(% lang="en-US" %)**POST /api/v3/users**
269 269  )))
270 270  
271 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
322 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
272 272  
273 273  (% style="color:#000000" %)Метод запроса: **POST**
274 274  
... ... @@ -326,13 +326,14 @@
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000; font-weight:normal" %)}
328 328  
380 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
329 329  
330 330  (% class="box successmessage" %)
331 331  (((
332 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
384 +(% lang="en-US" %)**POST /api/v3/users/find**
333 333  )))
334 334  
335 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
387 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
336 336  
337 337  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
338 338  
... ... @@ -373,13 +373,14 @@
373 373  
374 374  (% style="color:#000000" %)}
375 375  
428 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
376 376  
377 377  (% class="box successmessage" %)
378 378  (((
379 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
432 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
380 380  )))
381 381  
382 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
435 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
383 383  
384 384  (% style="color:#000000" %)Метод запроса: **GET**
385 385  
... ... @@ -421,13 +421,14 @@
421 421  )))
422 422  )))
423 423  
477 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
424 424  
425 425  (% class="box warningmessage" %)
426 426  (((
427 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
481 +(% lang="en-US" %)**PUT /api/v3/users**
428 428  )))
429 429  
430 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
484 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
431 431  
432 432  (% style="color:#000000" %)Метод запроса: **PUT**
433 433  
... ... @@ -435,8 +435,6 @@
435 435  
436 436  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
437 437  
438 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
439 -
440 440  (% lang="en-US" style="text-align:left" %)
441 441  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
442 442  
... ... @@ -494,13 +494,14 @@
494 494  (% lang="en-US" style="text-align:left" %)
495 495  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
496 496  
549 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
497 497  
498 498  (% class="box warningmessage" %)
499 499  (((
500 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
553 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
501 501  )))
502 502  
503 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
556 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
504 504  
505 505  (% style="color:#000000" %)Метод запроса: **PUT**
506 506  
... ... @@ -523,10 +523,11 @@
523 523  (% style="text-align:left" %)
524 524  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
525 525  
579 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
526 526  
527 527  (% class="box warningmessage" %)
528 528  (((
529 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
583 +**POST /api/v3/users/disable**
530 530  )))
531 531  
532 532  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -544,10 +544,11 @@
544 544  
545 545  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
546 546  
601 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
547 547  
548 548  (% class="box warningmessage" %)
549 549  (((
550 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
605 +**POST /api/v3/users/enable**
551 551  )))
552 552  
553 553  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -578,15 +578,16 @@
578 578  }
579 579  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
580 580  "users" - массив id пользователей, которых не удалось включить или отключить.
581 -
582 582  )))
583 583  
638 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
639 +
584 584  (% class="box errormessage" %)
585 585  (((
586 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
642 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
587 587  )))
588 588  
589 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
645 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
590 590  
591 591  (% style="color:#000000" %)Метод запроса: **DELETE**
592 592  
... ... @@ -599,20 +599,18 @@
599 599  (% style="text-align:left" %)
600 600  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
601 601  
658 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
602 602  
603 -(% class="box" style="text-align: center;" %)
604 -(((
605 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
606 -)))
660 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
607 607  
608 608  (% class="box infomessage" %)
609 609  (((
610 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
664 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
611 611  )))
612 612  
613 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
667 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
614 614  
615 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
669 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
616 616  
617 617  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
618 618  
... ... @@ -673,13 +673,14 @@
673 673  (% style="text-align:left" %)
674 674  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
675 675  
730 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
676 676  
677 677  (% class="box successmessage" %)
678 678  (((
679 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
734 +(% lang="en-US" %)**POST /api/v3/vehicles**
680 680  )))
681 681  
682 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
737 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
683 683  
684 684  (% style="color:#000000" %)Метод запроса: **POST**
685 685  
... ... @@ -792,15 +792,16 @@
792 792  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
793 793  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
794 794  
850 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
795 795  
796 796  (% class="box successmessage" %)
797 797  (((
798 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
854 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
799 799  )))
800 800  
801 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
857 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
802 802  
803 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
859 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
804 804  
805 805  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
806 806  
... ... @@ -837,7 +837,7 @@
837 837   "customFields": null ~/~/ значение любого из произвольных полей ТС
838 838  }
839 839  
840 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
896 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
841 841  
842 842  (% style="color:#000000" %)Ответ:
843 843  
... ... @@ -873,13 +873,14 @@
873 873  
874 874  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
875 875  
932 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
876 876  
877 877  (% class="box successmessage" %)
878 878  (((
879 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
936 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
880 880  )))
881 881  
882 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
939 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
883 883  
884 884  (% style="color:#000000" %)Метод запроса: **POST**
885 885  
... ... @@ -918,13 +918,14 @@
918 918  (% style="text-align:left" %)
919 919  (% style="color:#000000" %) }
920 920  
978 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
921 921  
922 922  (% class="box warningmessage" %)
923 923  (((
924 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
982 +(% lang="en-US" %)**PUT /api/v3/vehicles**
925 925  )))
926 926  
927 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
985 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
928 928  
929 929  (% style="color:#000000" %)Метод запроса: **PUT**
930 930  
... ... @@ -1046,13 +1046,14 @@
1046 1046  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1047 1047  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1048 1048  
1107 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1049 1049  
1050 1050  (% class="box errormessage" %)
1051 1051  (((
1052 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1111 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1053 1053  )))
1054 1054  
1055 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1114 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1056 1056  
1057 1057  (% style="color:#000000" %)Метод запроса: **DELETE**
1058 1058  
... ... @@ -1065,18 +1065,16 @@
1065 1065  (% style="text-align:left" %)
1066 1066  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1067 1067  
1127 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1068 1068  
1069 -(% class="box" lang="en-US" style="text-align: center;" %)
1070 -(((
1071 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1072 -)))
1129 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1073 1073  
1074 1074  (% class="box infomessage" %)
1075 1075  (((
1076 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1133 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1077 1077  )))
1078 1078  
1079 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1136 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1080 1080  
1081 1081  (% style="color:#000000" %)Метод запроса: **GET**
1082 1082  
... ... @@ -1094,24 +1094,22 @@
1094 1094  (% style="text-align:left" %)
1095 1095  (% style="color:#000000" %)}
1096 1096  
1154 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1097 1097  
1098 -(% class="box" style="text-align: center;" %)
1099 -(((
1100 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1101 -)))
1156 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1102 1102  
1103 1103  (% class="box infomessage" %)
1104 1104  (((
1105 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1160 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1106 1106  )))
1107 1107  
1108 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1163 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1109 1109  
1110 1110  (% style="color:#000000" %)Метод запроса: **GET**
1111 1111  
1112 1112  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1113 1113  
1114 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1169 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1115 1115  
1116 1116  (% style="color:#000000" %)Ответ:
1117 1117  
... ... @@ -1124,7 +1124,48 @@
1124 1124  (% style="text-align:left" %)
1125 1125  (% style="color:#000000" %)}
1126 1126  
1182 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1127 1127  
1184 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта (кол-во сообщений за период)**(%%) ==
1185 +
1186 +(% class="box infomessage" style="text-align: left;" %)
1187 +(((
1188 +**POST /api/v3/terminalMessages/count**
1189 +)))
1190 +
1191 +(% style="text-align: left;" %)
1192 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1193 +
1194 +(% style="text-align: left;" %)
1195 +Метод запроса **POST**
1196 +
1197 +(% style="text-align: left;" %)
1198 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1199 +
1200 +(% style="text-align: left;" %)
1201 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1202 +
1203 +(% style="text-align: left;" %)
1204 +{
1205 + "objectIds": [
1206 + id ~/~/ здесь передается список идентификаторов объектов
1207 + ],
1208 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1209 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1210 +}
1211 +
1212 +(% style="text-align: left;" %)
1213 +Ответ:
1214 +
1215 +(% style="text-align: left;" %)
1216 +[
1217 + {
1218 + "id": 0, ~/~/ идентификатор объекта
1219 + "count": 0 ~/~/ количество сообщений за период
1220 + }
1221 +]
1222 +
1223 +
1128 1128  (% class="box" lang="en-US" style="text-align: center;" %)
1129 1129  (((
1130 1130  (% 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 г.