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

Summary

Details

Icon Page properties
Content
... ... @@ -1,28 +1,25 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -**Содержание страницы:**
4 -)))
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
5 5  
4 +
6 6  {{toc/}}
7 7  
8 8  
9 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
8 +=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) ===
10 10  
11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
10 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
15 +
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ====
18 18  
19 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 -
23 -(% class="box infomessage" %)
20 +(% class="box successmessage" %)
24 24  (((
25 -(% lang="en-US" %)**POST /api/v3/auth/login**
22 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
... ... @@ -38,9 +38,9 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}
38 +}(%%)
39 +
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,14 +55,13 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
61 61  (((
62 -(% lang="en-US" %)**GET /api/v3/auth/check**
58 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
63 63  )))
64 64  
65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
61 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
66 66  
67 67  (% style="color:#000000" %)Метод запроса: **GET**
68 68  
... ... @@ -73,58 +73,18 @@
73 73  (% lang="en-US" %)
74 74  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
75 75  
76 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 -
80 -(% class="box infomessage" %)
73 +(% class="box" style="text-align: center;" %)
81 81  (((
82 -**GET api/v3/agents/{id}**
75 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
83 83  )))
84 84  
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 -
122 122  (% class="box infomessage" %)
123 123  (((
124 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
80 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
125 125  )))
126 126  
127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
83 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
128 128  
129 129  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
130 130  
... ... @@ -132,33 +132,29 @@
132 132  
133 133  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 -(% style="color:#000000" %)Метод запроса: **POST**
91 +(% style="color:#000000" %)Метод запроса: **GET**
136 136  
137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
93 +(% 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>
138 138  
139 -(% style="color:#000000" %)Параметр запроса:
95 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
140 140  
141 -(% style="color:#000000" %){
142 - "parentId": "string"
143 -}
97 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
144 144  
145 145  (% style="color:#000000" %)Ответ:
146 146  
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 - Отказ)
101 +(% style="color:#000000" %){
102 + "agentId": "", ~/~/ идентификатор клиента
103 + "parentId": "", ~/~/ идентификатор клиента-родителя
104 + "name": "", ~/~/ наименование клиента
105 + "fullName": "", ~/~/ полное наименование клиента
106 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
107 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
155 155  }
156 156  
157 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
160 160  (((
161 -**POST /api/v3/agents **
113 +**Добавление клиента — POST /api/v3/agents **
162 162  )))
163 163  
164 164  Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -175,7 +175,6 @@
175 175   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
179 179   "isForeign": true, ~/~/ иностранный контрагент
180 180   "district": "string", ~/~/ округ
181 181   "region": "string", ~/~/ регион
... ... @@ -200,7 +200,6 @@
200 200   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
201 201   "name": "string", ~/~/ имя
202 202   "fullName": "string", ~/~/ полное наименование
203 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
204 204   "isForeign": true, ~/~/ иностранный контрагент
205 205   "district": "string", ~/~/ округ
206 206   "region": "string", ~/~/ регион
... ... @@ -217,11 +217,10 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
220 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 221  
222 222  (% class="box warningmessage" %)
223 223  (((
224 -**PUT /api/v3/agents**
173 +**Редактирование клиента — PUT /api/v3/agents**
225 225  )))
226 226  
227 227  Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -240,7 +240,6 @@
240 240   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
241 241   "name": "string", ~/~/ имя
242 242   "fullName": "string", ~/~/ полное наименование
243 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
244 244   "isForeign": true, ~/~/ иностранный контрагент
245 245   "district": "string", ~/~/ округ
246 246   "region": "string", ~/~/ регион
... ... @@ -281,13 +281,13 @@
281 281   "bankKS": "string" ~/~/ корр. счёт
282 282  }
283 283  
284 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
285 285  
286 286  (% class="box errormessage" %)
287 287  (((
288 -**DELETE /api/v3/agents/{clientId}**
235 +**Удаление клиента — DELETE /api/v3/agents/{clientId}**
289 289  )))
290 290  
238 +
291 291  Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
292 292  
293 293  Метод запроса: **DELETE**
... ... @@ -300,16 +300,19 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
303 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
306 306  
253 +(% class="box" style="text-align: center;" %)
254 +(((
255 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
256 +)))
257 +
307 307  (% class="box successmessage" %)
308 308  (((
309 -(% lang="en-US" %)**POST /api/v3/users**
260 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
310 310  )))
311 311  
312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
263 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
313 313  
314 314  (% style="color:#000000" %)Метод запроса: **POST**
315 315  
... ... @@ -367,14 +367,13 @@
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)}
369 369  
370 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
371 371  
372 -(% class="box infomessage" %)
322 +(% class="box successmessage" %)
373 373  (((
374 -(% lang="en-US" %)**POST /api/v3/users/find**
324 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
375 375  )))
376 376  
377 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
327 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
378 378  
379 379  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
380 380  
... ... @@ -415,14 +415,13 @@
415 415  
416 416  (% style="color:#000000" %)}
417 417  
418 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
419 419  
420 -(% class="box infomessage" %)
369 +(% class="box successmessage" %)
421 421  (((
422 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
371 +(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
423 423  )))
424 424  
425 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
374 +(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
426 426  
427 427  (% style="color:#000000" %)Метод запроса: **GET**
428 428  
... ... @@ -464,14 +464,13 @@
464 464  )))
465 465  )))
466 466  
467 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
468 468  
469 469  (% class="box warningmessage" %)
470 470  (((
471 -(% lang="en-US" %)**PUT /api/v3/users**
419 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
472 472  )))
473 473  
474 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
422 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
475 475  
476 476  (% style="color:#000000" %)Метод запроса: **PUT**
477 477  
... ... @@ -479,6 +479,8 @@
479 479  
480 480  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
481 481  
430 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
431 +
482 482  (% lang="en-US" style="text-align:left" %)
483 483  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
484 484  
... ... @@ -536,14 +536,13 @@
536 536  (% lang="en-US" style="text-align:left" %)
537 537  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
538 538  
539 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
540 540  
541 541  (% class="box warningmessage" %)
542 542  (((
543 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
492 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
544 544  )))
545 545  
546 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
495 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
547 547  
548 548  (% style="color:#000000" %)Метод запроса: **PUT**
549 549  
... ... @@ -566,11 +566,10 @@
566 566  (% style="text-align:left" %)
567 567  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
568 568  
569 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
570 570  
571 571  (% class="box warningmessage" %)
572 572  (((
573 -**POST /api/v3/users/disable**
521 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
574 574  )))
575 575  
576 576  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -588,11 +588,10 @@
588 588  
589 589  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
590 590  
591 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
592 592  
593 593  (% class="box warningmessage" %)
594 594  (((
595 -**POST /api/v3/users/enable**
542 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
596 596  )))
597 597  
598 598  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -623,16 +623,15 @@
623 623  }
624 624  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
625 625  "users" - массив id пользователей, которых не удалось включить или отключить.
573 +
626 626  )))
627 627  
628 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
629 -
630 630  (% class="box errormessage" %)
631 631  (((
632 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
578 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
633 633  )))
634 634  
635 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
581 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
636 636  
637 637  (% style="color:#000000" %)Метод запроса: **DELETE**
638 638  
... ... @@ -645,18 +645,20 @@
645 645  (% style="text-align:left" %)
646 646  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
647 647  
648 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
649 649  
650 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
595 +(% class="box" style="text-align: center;" %)
596 +(((
597 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
598 +)))
651 651  
652 652  (% class="box infomessage" %)
653 653  (((
654 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
602 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
655 655  )))
656 656  
657 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
605 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
658 658  
659 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
607 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
660 660  
661 661  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
662 662  
... ... @@ -691,8 +691,6 @@
691 691   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
692 692   "mileage": "", ~/~/ Пробег по нормам в метрах
693 693   "motohours": "" ~/~/ Моточасы по нормам, в секундах
694 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
695 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
696 696   },
697 697   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
698 698   {
... ... @@ -719,14 +719,13 @@
719 719  (% style="text-align:left" %)
720 720  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
721 721  
722 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
723 723  
724 724  (% class="box successmessage" %)
725 725  (((
726 -(% lang="en-US" %)**POST /api/v3/vehicles**
671 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
727 727  )))
728 728  
729 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
674 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
730 730  
731 731  (% style="color:#000000" %)Метод запроса: **POST**
732 732  
... ... @@ -839,16 +839,15 @@
839 839  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
840 840  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
841 841  
842 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
843 843  
844 -(% class="box infomessage" %)
788 +(% class="box successmessage" %)
845 845  (((
846 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
790 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
847 847  )))
848 848  
849 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
793 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
850 850  
851 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
795 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
852 852  
853 853  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
854 854  
... ... @@ -885,7 +885,7 @@
885 885   "customFields": null ~/~/ значение любого из произвольных полей ТС
886 886  }
887 887  
888 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
832 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
889 889  
890 890  (% style="color:#000000" %)Ответ:
891 891  
... ... @@ -921,14 +921,13 @@
921 921  
922 922  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
923 923  
924 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
925 925  
926 926  (% class="box successmessage" %)
927 927  (((
928 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
871 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
929 929  )))
930 930  
931 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
874 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
932 932  
933 933  (% style="color:#000000" %)Метод запроса: **POST**
934 934  
... ... @@ -967,14 +967,13 @@
967 967  (% style="text-align:left" %)
968 968  (% style="color:#000000" %) }
969 969  
970 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
971 971  
972 972  (% class="box warningmessage" %)
973 973  (((
974 -(% lang="en-US" %)**PUT /api/v3/vehicles**
916 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
975 975  )))
976 976  
977 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
919 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
978 978  
979 979  (% style="color:#000000" %)Метод запроса: **PUT**
980 980  
... ... @@ -1096,14 +1096,13 @@
1096 1096  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1097 1097  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1098 1098  
1099 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1100 1100  
1101 1101  (% class="box errormessage" %)
1102 1102  (((
1103 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1044 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1104 1104  )))
1105 1105  
1106 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1047 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1107 1107  
1108 1108  (% style="color:#000000" %)Метод запроса: **DELETE**
1109 1109  
... ... @@ -1116,16 +1116,18 @@
1116 1116  (% style="text-align:left" %)
1117 1117  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1118 1118  
1119 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1120 1120  
1121 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1061 +(% class="box" lang="en-US" style="text-align: center;" %)
1062 +(((
1063 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1064 +)))
1122 1122  
1123 1123  (% class="box infomessage" %)
1124 1124  (((
1125 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1068 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1126 1126  )))
1127 1127  
1128 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1071 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1129 1129  
1130 1130  (% style="color:#000000" %)Метод запроса: **GET**
1131 1131  
... ... @@ -1143,22 +1143,24 @@
1143 1143  (% style="text-align:left" %)
1144 1144  (% style="color:#000000" %)}
1145 1145  
1146 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1147 1147  
1148 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1090 +(% class="box" style="text-align: center;" %)
1091 +(((
1092 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1093 +)))
1149 1149  
1150 1150  (% class="box infomessage" %)
1151 1151  (((
1152 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1097 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1153 1153  )))
1154 1154  
1155 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1100 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1156 1156  
1157 1157  (% style="color:#000000" %)Метод запроса: **GET**
1158 1158  
1159 1159  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1160 1160  
1161 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1106 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1162 1162  
1163 1163  (% style="color:#000000" %)Ответ:
1164 1164  
... ... @@ -1171,48 +1171,7 @@
1171 1171  (% style="text-align:left" %)
1172 1172  (% style="color:#000000" %)}
1173 1173  
1174 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1175 1175  
1176 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1177 -
1178 -(% class="box infomessage" style="text-align: left;" %)
1179 -(((
1180 -**POST /api/v3/terminalMessages/count**
1181 -)))
1182 -
1183 -(% style="text-align: left;" %)
1184 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1185 -
1186 -(% style="text-align: left;" %)
1187 -Метод запроса **POST**
1188 -
1189 -(% style="text-align: left;" %)
1190 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1191 -
1192 -(% style="text-align: left;" %)
1193 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1194 -
1195 -(% style="text-align: left;" %)
1196 -{
1197 - "vehicleIds": [
1198 - id ~/~/ здесь передается список идентификаторов объектов
1199 - ],
1200 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1201 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1202 -}
1203 -
1204 -(% style="text-align: left;" %)
1205 -Ответ:
1206 -
1207 -(% style="text-align: left;" %)
1208 -[
1209 - {
1210 - "vehicleId": 0, ~/~/ идентификатор объекта
1211 - "count": 0 ~/~/ количество сообщений за период
1212 - }
1213 -]
1214 -
1215 -
1216 1216  (% class="box" lang="en-US" style="text-align: center;" %)
1217 1217  (((
1218 1218  (% 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 г.