Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 27.1 >
edited by Артем Шемяков
on 2022/09/20 09:17
To version < 21.8 >
edited by Артем Шемяков
on 2022/09/02 09:34
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -20,27 +20,20 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «(% style="color: rgb(0, 0, 0);" %)__**AuthId**__(% style="color:#000000" %)» содержит токен авторизации «(% style="color: rgb(0, 0, 0);" %)__**X-Auth**__(% style="color:#000000" %)».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 -
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}(%%)
42 -
43 -
36 +(% lang="en-US" %)
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -47,11 +47,11 @@
47 47  (% style="color:#000000" %){
48 48  
49 49  (% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
52 52  
53 53  (% lang="en-US" %)
54 -}
47 + }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
... ... @@ -61,7 +61,7 @@
61 61  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -83,19 +83,19 @@
83 83  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
90 90  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91 91  
92 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
93 93  
94 94  (% style="color:#000000" %)Метод запроса: **GET**
95 95  
96 96  (% 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>
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
91 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
99 99  
100 100  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
101 101  
... ... @@ -106,11 +106,14 @@
106 106   "parentId": "", ~/~/ идентификатор клиента-родителя
107 107   "name": "", ~/~/ наименование клиента
108 108   "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 -}
102 + "agentInfoType": "", ~/~/ тип клиента1
103 + "status": "", ~/~/ статус клиента
104 + }
112 112  
113 113  
107 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
108 +
109 +
114 114  (% class="box" style="text-align: center;" %)
115 115  (((
116 116  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -121,7 +121,7 @@
121 121  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
120 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -149,7 +149,7 @@
149 149   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 150   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 151   "groups": "" , ~/~/ группы пользователя, названия групп
152 -}
148 + }
153 153  
154 154  (% style="text-align:left" %)
155 155  (% style="color:#000000; font-weight:normal" %)Ответ:
... ... @@ -177,7 +177,7 @@
177 177   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
178 178  
179 179  (% style="text-align:left" %)
180 -(% style="color:#000000; font-weight:normal" %)}
176 +(% style="color:#000000; font-weight:normal" %) }
181 181  
182 182  
183 183  (% class="box successmessage" %)
... ... @@ -187,16 +187,14 @@
187 187  
188 188  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
186 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
191 191  
192 192  (% style="color:#000000" %)Метод запроса: **POST**
193 193  
194 194  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
195 195  
196 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
197 197  
198 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
199 -
200 200  (% style="color:#000000" %){
201 201  
202 202   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -204,7 +204,7 @@
204 204   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 205   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
206 206  
207 -(% style="color:#000000" %)}
201 +(% style="color:#000000" %) }
208 208  
209 209  (% style="color:#000000" %)Ответ:
210 210  
... ... @@ -224,7 +224,7 @@
224 224   "status": "1",  ~/~/ статус пользователя
225 225   "astLogged": "", ~/~/ дата/время последней авторизации
226 226  
227 -(% style="color:#000000" %)}
221 +(% style="color:#000000" %) }
228 228  
229 229  
230 230  (% class="box warningmessage" %)
... ... @@ -232,7 +232,7 @@
232 232  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
229 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -267,16 +267,16 @@
267 267   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
268 268  
269 269  (% lang="en-US" style="text-align:left" %)
270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
271 271  
272 272  (% lang="en-US" style="text-align:left" %)
273 273  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
274 274  
275 275  (% lang="en-US" style="text-align:left" %)
276 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{     //
277 277  
278 278  (% lang="en-US" style="text-align:left" %)
279 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
280 280   "lastName": "" , ~/~/ фамилия
281 281   "firstName": "" , ~/~/ имя
282 282   "position": "" , ~/~/ должность
... ... @@ -292,10 +292,10 @@
292 292   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 293   "kind": "" , ~/~/ тип аутентификации
294 294   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
296 296  
297 297  (% lang="en-US" style="text-align:left" %)
298 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
299 299  
300 300  
301 301  (% class="box warningmessage" %)
... ... @@ -303,13 +303,13 @@
303 303  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
300 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
310 310  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
311 311  
312 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
313 313  
314 314  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
315 315  
... ... @@ -321,7 +321,7 @@
321 321   "description": "" , ~/~/ описание
322 322   "data": "" , ~/~/ данные, связанные со сменой статуса
323 323  
324 -(% style="color:#000000" %)}
318 + (% style="color:#000000" %)}
325 325  
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
... ... @@ -332,13 +332,13 @@
332 332  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
333 333  )))
334 334  
335 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
329 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
336 336  
337 337  (% style="color:#000000" %)Метод запроса: **DELETE**
338 338  
339 339  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
340 340  
341 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
342 342  
343 343  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
344 344  
... ... @@ -358,17 +358,17 @@
358 358  
359 359  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
360 360  
361 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
355 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
362 362  
363 363  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
364 364  
365 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
359 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
366 366  
367 367  (% style="color:#000000" %)Метод запроса: **GET**
368 368  
369 369  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
370 370  
371 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
365 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
372 372  
373 373  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
374 374  
... ... @@ -389,7 +389,7 @@
389 389   "unitName": "" , ~/~/ наименование подразделения
390 390   "status": "" , ~/~/ статус объекта
391 391  
392 -}
386 + }
393 393  
394 394  (% style="text-align:left" %)
395 395  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -403,7 +403,7 @@
403 403  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
404 404  )))
405 405  
406 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
400 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
407 407  
408 408  (% style="color:#000000" %)Метод запроса: **POST**
409 409  
... ... @@ -431,7 +431,7 @@
431 431   "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
432 432   "motohours": "" , ~/~/ моточасы
433 433   "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
434 - },
428 + },
435 435   "cmsv6Parameters": { ~/~/ параметры CMSv6
436 436   "enabled": true, ~/~/ флаг включения
437 437   "id": "" , ~/~/ идентификатор
... ... @@ -438,7 +438,7 @@
438 438   "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
439 439   "login": "" , ~/~/ имя учетной записи
440 440   "password": "" ~/~/ пароль учетной записи
441 - },
435 + },
442 442   "inspectionTasks": ~/~/ задания на ТО
443 443   {
444 444   "enabled": "" , ~/~/ Признак включения
... ... @@ -476,7 +476,7 @@
476 476   "motohoursEnabled": true,
477 477   "mileage": "",
478 478   "motohours": 345.0
479 - },
473 + },
480 480   "cmsv6Parameters": { ~/~/Параметры CmsV6
481 481   "id": null,
482 482   "enabled": true, ~/~/флаг включения
... ... @@ -483,7 +483,7 @@
483 483   "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
484 484   "login": "", ~/~/ имя учетной записи
485 485   "password": "" ~/~/ пароль учетной записи
486 - },
480 + },
487 487   "inspectionTasks": { ~/~/ задания на ТО
488 488   "id": "", ~/~/ ID задачи
489 489   "enabled": false, ~/~/ Признак включения
... ... @@ -496,7 +496,7 @@
496 496   "periodicCondition": "", ~/~/ Условие периодичности по времени
497 497   "kind": "", ~/~/ Вид периодичности по времени 
498 498   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
499 - }
493 + }
500 500  
501 501  (% style="text-align:left" %)
502 502  (% style="color:#000000" %)}
... ... @@ -509,7 +509,7 @@
509 509  
510 510  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
511 511  
512 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
506 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
513 513  
514 514  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
515 515  
... ... @@ -527,26 +527,24 @@
527 527  
528 528  (% style="color:#000000" %)В заголовках запроса:
529 529  
530 -(% style="color:#000000" %)− Content-Type: __**application/json**__
524 +(% style="color:#000000" %)− Content-Type: application/json
531 531  
532 532  (% style="color:#000000" %)− X-Auth: Токен авторизации
533 533  
534 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
528 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
535 535  
536 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
537 -
538 538  (% class="western" style="color:#000000" %)##{##
539 539  
540 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
532 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
541 541   "name": null, ~/~/ Имя ТС (string, опционально) 
542 542   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
543 543   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
544 544   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
545 545   "parentId": null, ~/~/ ID клиента (Guid, опционально) 
546 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
538 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
547 547  (% style="color:#000000" %)}
548 548  
549 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
541 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
550 550  
551 551  (% style="color:#000000" %)Ответ:
552 552  
... ... @@ -565,27 +565,27 @@
565 565   "modelName": "" ~/~/ наименование модели объекта
566 566   "unitId": "" ~/~/ идентификатор подразделения
567 567   "unitName": "" ~/~/ наименование подразделения
568 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
569 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
570 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
571 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
560 + "status": "" ~/~/ статус объекта         
561 + "createdAt": "" ~/~/ дата создания объектов  (%%)
572 572  (% style="color:#000000" %)}
573 573  
574 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
564 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
575 575  
566 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
576 576  
568 +
577 577  (% class="box successmessage" %)
578 578  (((
579 579  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
580 580  )))
581 581  
582 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
574 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
583 583  
584 584  (% style="color:#000000" %)Метод запроса: **POST**
585 585  
586 586  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
587 587  
588 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
580 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
589 589  
590 590  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
591 591  
... ... @@ -602,7 +602,7 @@
602 602   "overwrite": false, ~/~/ Флаг перезаписи
603 603   "stage": "", ~/~/ Состояние, может быть null
604 604  
605 -(% style="color:#000000" %)}
597 + (% style="color:#000000" %)}
606 606  
607 607  (% style="color:#000000" %)Ответ:
608 608  
... ... @@ -616,7 +616,7 @@
616 616   "stage": "", ~/~/ Состояние
617 617  
618 618  (% style="text-align:left" %)
619 -(% style="color:#000000" %) }
611 +(% style="color:#000000" %)}
620 620  
621 621  
622 622  (% class="box warningmessage" %)
... ... @@ -624,7 +624,7 @@
624 624  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
625 625  )))
626 626  
627 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
619 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
628 628  
629 629  (% style="color:#000000" %)Метод запроса: **PUT**
630 630  
... ... @@ -634,114 +634,26 @@
634 634  
635 635  (% style="color:#000000" %)Параметры в теле запроса (JSON):
636 636  
637 -(% style="color:#000000" %){    
629 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
638 638  
639 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
640 - "parentId": "", ~/~/ ID клиента
641 - "name": "", ~/~/ имя ТС
642 - "imei": "", ~/~/ IMEI
643 - "deviceTypeId": "", ~/~/ ID типа устройства
644 - "modelId": "", ~/~/ , ID модели    
645 - "unitId": "", ~/~/ подразделения
646 - "sim1": "", ~/~/ SIM 1
647 - "sim2": "", ~/~/ SIM2
648 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
649 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
650 - "counters": 
651 - {
652 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
653 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
654 - "mileage": «», пробег
655 - "motohours": «» моточасы
656 - }
657 - "cmsv6Parameters": ~/~/ параметры CMSv6
658 - {       
659 - "id": "", ~/~/ идентификатор
660 - "enabled": true, ~/~/ флаг включения
661 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
662 - "login": "", ~/~/ имя учетной записи
663 - "password": "", ~/~/ пароль учетной записи
664 - }
665 - "inspectionTasks": ~/~/ задания на ТО
666 - {
667 - "id": "", ~/~/ ID задания
668 - "enabled": false, ~/~/ Признак включения
669 - "name": "", ~/~/ Имя задания
670 - "description": "", ~/~/ Описание задания
671 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
672 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
673 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
674 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
675 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
676 - "kind": "", ~/~/ Вид периодичности по времени
677 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
678 - } 
679 -
680 -(% style="color:#000000" %)}
681 -
682 682  (% style="color:#000000" %)Ответ:
683 683  
684 684  (% lang="en-US" style="text-align:left" %)
685 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
634 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
686 686  
687 -(% lang="en-US" style="text-align:left" %)
688 - "vehicleId": "", ~/~/ ID ТС
689 - "parentId": "", ~/~/ ID клиента
690 - "name": "", ~/~/ имя ТС
691 - "imei": "", ~/~/ IMEI
692 - "deviceTypeId": "", ~/~/ типа устройства
693 - "modelId": "", ~/~/ ID модели
694 - "unitId": "", ~/~/ ID подразделения
695 - "sim1": "", ~/~/ SIM 1
696 - "sim2": "", ~/~/ SIM2
697 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
698 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
699 - "counters": 
700 - {
701 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
702 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
703 - "mileage": "", ~/~/ пробег
704 - "motohours": "", ~/~/ моточасы
705 - }
706 - "cmsv6Parameters": ~/~/ параметры CMSv6
707 - {
708 - "id": ~/~/ идентификатор
709 - "enabled": true, ~/~/ флаг включения
710 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
711 - "login": "", ~/~/ имя учетной записи
712 - "password": "", ~/~/ пароль учетной записи
713 - }
714 - "inspectionTasks": ~/~/ задания на ТО
715 - {
716 - "id": "", ~/~/ ID задания
717 - "enabled": false, ~/~/ Признак включения
718 - "name": "", ~/~/ Имя задания
719 - "description": "", ~/~/ Описание задания
720 - "mileageCondition": "", ~/~/ Условие по пробегу
721 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
722 - "motohoursCondition": "", ~/~/ Условие по моточасам
723 - "lastMotohours": "", ~/~/ Моточасы
724 - "periodicCondition": "", ~/~/ Условие периодичности по времени
725 - "kind": "", ~/~/ Вид периодичности по времени
726 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
727 - }
728 728  
729 -(% lang="en-US" style="text-align:left" %)
730 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
731 -
732 -
733 733  (% class="box errormessage" %)
734 734  (((
735 735  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
736 736  )))
737 737  
738 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
642 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
739 739  
740 740  (% style="color:#000000" %)Метод запроса: **DELETE**
741 741  
742 742  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
743 743  
744 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
648 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
745 745  
746 746  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
747 747  
... ... @@ -759,7 +759,7 @@
759 759  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
760 760  )))
761 761  
762 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
666 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
763 763  
764 764  (% style="color:#000000" %)Метод запроса: **GET**
765 765  
... ... @@ -767,15 +767,16 @@
767 767  
768 768  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
769 769  
770 -(% style="color:#000000" %)Ответ:
674 +(% style="color:#000000" %)Ответ: [
771 771  
772 -(% style="color:#000000" %){
676 +(% class="western" %)
677 +{{{ {
678 + "deviceTypeId" : "", // ID типа устройства
679 + "deviceTypeName" : "" // Название типа устройства
680 + },}}}
773 773  
774 - "deviceTypeId" : "", ~/~/ ID типа устройства
775 - "deviceTypeName" : "" ~/~/ Название типа устройства
776 -
777 777  (% style="text-align:left" %)
778 -(% style="color:#000000" %)}
683 +(% style="color:#000000" %)…** **]
779 779  
780 780  
781 781  (% class="box" style="text-align: center;" %)
... ... @@ -788,7 +788,7 @@
788 788  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
789 789  )))
790 790  
791 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
696 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
792 792  
793 793  (% style="color:#000000" %)Метод запроса: **GET**
794 794  
... ... @@ -796,16 +796,19 @@
796 796  
797 797  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
798 798  
799 -(% style="color:#000000" %)Ответ:
704 +(% style="color:#000000" %)Ответ: [
800 800  
801 -(% style="color:#000000" %){
706 +(% class="western" style="margin-bottom:19px" %)
707 +{{{ {}}}
802 802  
803 - "id": "", ~/~/ ID типа датчика 
804 - "name": "", ~/~/ Название
805 - "description": "", ~/~/ Описание
709 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
806 806  
711 +(% class="western" %)
712 +{{{ "description": "" // Описание
713 + },}}}
714 +
807 807  (% style="text-align:left" %)
808 -(% style="color:#000000" %)}
716 +(% style="color:#000000" %)… ]
809 809  
810 810  
811 811  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

ГЛОНАССSoft wiki - 2024 г.