Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 47.1 >
edited by Илья Крайнов
on 2022/11/21 10:32
To version < 21.11 >
edited by Артем Шемяков
on 2022/09/02 09:55
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
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" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
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  
... ... @@ -137,9 +137,9 @@
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин (обязателен)
141 - "password": "", ~/~/ пароль (обязателен)
142 - "email": "", ~/~/ email (обязателен)
136 + "login": "", ~/~/ логин
137 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 + "email": "", ~/~/ email
143 143   "description": "", ~/~/ описание
144 144   "isEnabled": "", ~/~/ признак включения
145 145   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -148,8 +148,8 @@
148 148   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 149   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 150   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 -}
147 + "groups": "" , ~/~/ группы пользователя, названия групп
148 + }
153 153  
154 154  (% style="text-align:left" %)
155 155  (% style="color:#000000; font-weight:normal" %)Ответ:
... ... @@ -174,10 +174,10 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
173 + "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,63 +224,15 @@
224 224   "status": "1",  ~/~/ статус пользователя
225 225   "astLogged": "", ~/~/ дата/время последней авторизации
226 226  
227 -(% style="color:#000000" %)}
221 +(% style="color:#000000" %) }
228 228  
229 229  
230 -(% class="box successmessage" %)
231 -(((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 -)))
234 -
235 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 -
237 -(% style="color:#000000" %)Метод запроса: **GET**
238 -
239 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240 -
241 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242 -
243 -(% style="color:#000000" %)Ответ:
244 -
245 -(((
246 -(((
247 -{
248 - "id": "", ~/~/ GUID пользователя
249 - "lastName": "", ~/~/ Фамилия 
250 - "firstName": "", ~/~/ Имя
251 - "position": "", ~/~/ Должность
252 - "phone": "", ~/~/ Номер телефона
253 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
254 - "parentName": "", Наименование клиента, которому принадлежит пользователь
255 - "organization": "", ~/~/ Организация
256 - "login": "", ~/~/ Логин пользователя
257 - "email": "", ~/~/ Адрес электронной почты
258 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
259 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
260 - "description": "", ~/~/ Описание
261 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
262 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
263 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
264 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
265 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
266 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
267 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
268 - "groups": [], ~/~/ Список ролей пользователя
269 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
270 - "authDevices": [ ], ~/~/ Список авторизованных устройств
271 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
272 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
273 -}
274 -)))
275 -)))
276 -
277 -
278 278  (% class="box warningmessage" %)
279 279  (((
280 280  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
281 281  )))
282 282  
283 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
229 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
284 284  
285 285  (% style="color:#000000" %)Метод запроса: **PUT**
286 286  
... ... @@ -288,8 +288,6 @@
288 288  
289 289  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
290 290  
291 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
292 -
293 293  (% lang="en-US" style="text-align:left" %)
294 294  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
295 295  
... ... @@ -303,10 +303,10 @@
303 303   "position": "" , ~/~/ должность
304 304   "phone": "" , ~/~/ телефон
305 305   "organization": "" , ~/~/ организация
306 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
307 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
308 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
309 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
250 + "login": "" , ~/~/ логин
251 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
252 + "email": "" , ~/~/ email
253 + "description": "" , ~/~/ описание
310 310   "isEnabled": "" , ~/~/ признак включения
311 311   "parentId": "" , ~/~/ Guid родительского агента
312 312   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -317,16 +317,16 @@
317 317   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
318 318  
319 319  (% lang="en-US" style="text-align:left" %)
320 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
321 321  
322 322  (% lang="en-US" style="text-align:left" %)
323 323  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
324 324  
325 325  (% lang="en-US" style="text-align:left" %)
326 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{     //
327 327  
328 328  (% lang="en-US" style="text-align:left" %)
329 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
330 330   "lastName": "" , ~/~/ фамилия
331 331   "firstName": "" , ~/~/ имя
332 332   "position": "" , ~/~/ должность
... ... @@ -342,10 +342,10 @@
342 342   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
343 343   "kind": "" , ~/~/ тип аутентификации
344 344   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
345 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
346 346  
347 347  (% lang="en-US" style="text-align:left" %)
348 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
349 349  
350 350  
351 351  (% class="box warningmessage" %)
... ... @@ -353,13 +353,13 @@
353 353  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
354 354  )))
355 355  
356 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
300 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
357 357  
358 358  (% style="color:#000000" %)Метод запроса: **PUT**
359 359  
360 360  (% 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}
361 361  
362 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
363 363  
364 364  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
365 365  
... ... @@ -371,81 +371,24 @@
371 371   "description": "" , ~/~/ описание
372 372   "data": "" , ~/~/ данные, связанные со сменой статуса
373 373  
374 -(% style="color:#000000" %)}
318 + (% style="color:#000000" %)}
375 375  
376 376  (% style="text-align:left" %)
377 377  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
378 378  
379 379  
380 -(% class="box warningmessage" %)
381 -(((
382 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
383 -)))
384 -
385 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
386 -
387 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
388 -
389 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
390 -
391 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
392 -
393 - [ 
394 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
395 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
396 - ]
397 -
398 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
399 -
400 -
401 -(% class="box warningmessage" %)
402 -(((
403 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
404 -)))
405 -
406 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
407 -
408 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
409 -
410 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
411 -
412 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
413 -
414 - [ 
415 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
416 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
417 - ]
418 -
419 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
420 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
421 -
422 -(((
423 -В теле ответа:
424 -{
425 - "errorMessages": [
426 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
427 - ],
428 - "users": [
429 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
430 - ]
431 -}
432 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
433 -"users" - массив id пользователей, которых не удалось включить или отключить.
434 -
435 -)))
436 -
437 437  (% class="box errormessage" %)
438 438  (((
439 439  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
440 440  )))
441 441  
442 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
329 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
443 443  
444 444  (% style="color:#000000" %)Метод запроса: **DELETE**
445 445  
446 446  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
447 447  
448 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
449 449  
450 450  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
451 451  
... ... @@ -465,61 +465,39 @@
465 465  
466 466  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
467 467  
468 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
355 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
469 469  
470 470  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
471 471  
472 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
359 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
473 473  
474 474  (% style="color:#000000" %)Метод запроса: **GET**
475 475  
476 476  (% 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>
477 477  
478 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
365 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
479 479  
480 480  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
481 481  
482 482  (% style="color:#000000" %)Ответ:
483 483  
484 -(((
485 -{
486 - "vehicleId": "", ~/~/ ID объекта
487 - "name": "", ~/~/ Имя объекта
488 - "imei": "", ~/~/ IMEI объекта
489 - "deviceTypeId": , ~/~/ ID типа устройства
490 - "deviceTypeName": "", ~/~/ Название типа устройства
491 - "sim1": "", ~/~/ Номер SIM1
492 - "parentId": "", Номер SIM2
493 - "parentName": "", Наименование клиента-родителя
494 - "modelId": "", ID модели объекта
495 - "modelName": "", Имя модели объекта
496 - "createdAt": "", Дата создания объекта
497 - "mileageCalcMethod": "", Выбранный метод расчета пробега
498 - "counters": { ~/~/ Нормы
499 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
500 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
501 - "mileage": "", ~/~/ Пробег по нормам в метрах
502 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
503 - },
504 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
505 - {
506 - "id": "", ~/~/ ID  задания
507 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
508 - "name": "", ~/~/ Наименование задания
509 - "description": "", ~/~/ Описание задания
510 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
511 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
512 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
513 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
514 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
515 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
516 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
517 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
518 - }
519 - ]
520 -}
521 -)))
371 +(% style="color:#000000" %){
522 522  
373 + "vehicleId": "" , ~/~/ идентификатор объекта
374 + "name": "" , ~/~/ имя объекта
375 + "imei": "" , ~/~/ IMEI объекта
376 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
377 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
378 + "parentId": "" , ~/~/ идентификатор клиента-родителя
379 + "parentName": "" , ~/~/ наименование клиента-родителя,
380 + "modelId": "" , ~/~/ идентификатор модели объекта
381 + "modelName": "" , ~/~/ наименование модели объекта,
382 + "unitId": "" , ~/~/ идентификатор подразделения
383 + "unitName": "" , ~/~/ наименование подразделения
384 + "status": "" , ~/~/ статус объекта
385 +
386 + }
387 +
523 523  (% style="text-align:left" %)
524 524  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
525 525  
... ... @@ -532,7 +532,7 @@
532 532  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
533 533  )))
534 534  
535 -(% 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**).
536 536  
537 537  (% style="color:#000000" %)Метод запроса: **POST**
538 538  
... ... @@ -554,23 +554,13 @@
554 554   "sim2": "" , ~/~/ Номер SIM2
555 555   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
556 556   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
557 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
558 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
559 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
560 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
561 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
562 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
563 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
564 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
565 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
566 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
567 - "counters": ~/~/ счетчики
568 - {
569 - "mileage": "" , ~/~/ пробег
570 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
571 - "motohours": "" , ~/~/ моточасы
572 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
573 - },
422 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
423 + "counters": {
424 + "mileage": "" , ~/~/ пробег
425 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
426 + "motohours": "" , ~/~/ моточасы
427 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
428 + },
574 574   "cmsv6Parameters": { ~/~/ параметры CMSv6
575 575   "enabled": true, ~/~/ флаг включения
576 576   "id": "" , ~/~/ идентификатор
... ... @@ -577,7 +577,7 @@
577 577   "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
578 578   "login": "" , ~/~/ имя учетной записи
579 579   "password": "" ~/~/ пароль учетной записи
580 - },
435 + },
581 581   "inspectionTasks": ~/~/ задания на ТО
582 582   {
583 583   "enabled": "" , ~/~/ Признак включения
... ... @@ -615,7 +615,7 @@
615 615   "motohoursEnabled": true,
616 616   "mileage": "",
617 617   "motohours": 345.0
618 - },
473 + },
619 619   "cmsv6Parameters": { ~/~/Параметры CmsV6
620 620   "id": null,
621 621   "enabled": true, ~/~/флаг включения
... ... @@ -622,7 +622,7 @@
622 622   "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
623 623   "login": "", ~/~/ имя учетной записи
624 624   "password": "" ~/~/ пароль учетной записи
625 - },
480 + },
626 626   "inspectionTasks": { ~/~/ задания на ТО
627 627   "id": "", ~/~/ ID задачи
628 628   "enabled": false, ~/~/ Признак включения
... ... @@ -635,17 +635,12 @@
635 635   "periodicCondition": "", ~/~/ Условие периодичности по времени
636 636   "kind": "", ~/~/ Вид периодичности по времени 
637 637   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
638 - }
493 + }
639 639  
640 640  (% style="text-align:left" %)
641 641  (% style="color:#000000" %)}
642 642  
643 -**Валидация:**
644 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
645 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
646 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
647 647  
648 -
649 649  (% class="box successmessage" %)
650 650  (((
651 651  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -653,7 +653,7 @@
653 653  
654 654  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
655 655  
656 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
506 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
657 657  
658 658  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
659 659  
... ... @@ -671,26 +671,24 @@
671 671  
672 672  (% style="color:#000000" %)В заголовках запроса:
673 673  
674 -(% style="color:#000000" %)− Content-Type: __**application/json**__
524 +(% style="color:#000000" %)− Content-Type: application/json
675 675  
676 676  (% style="color:#000000" %)− X-Auth: Токен авторизации
677 677  
678 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
528 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
679 679  
680 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
530 +(% class="western" style="color:#000000" %)##{##
681 681  
682 -{
683 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
684 - "name": null, ~/~/ Имя ТС (string, опционально)
685 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
686 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
687 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
688 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
689 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
690 - "customFields": null ~/~/ значение любого из произвольных полей ТС
691 -}
532 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
533 + "name": null, ~/~/ Имя ТС (string, опционально) 
534 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
535 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
536 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
537 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
538 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
539 +(% style="color:#000000" %)}
692 692  
693 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
541 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
694 694  
695 695  (% style="color:#000000" %)Ответ:
696 696  
... ... @@ -709,27 +709,27 @@
709 709   "modelName": "" ~/~/ наименование модели объекта
710 710   "unitId": "" ~/~/ идентификатор подразделения
711 711   "unitName": "" ~/~/ наименование подразделения
712 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
713 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
714 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
715 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
560 + "status": "" ~/~/ статус объекта         
561 + "createdAt": "" ~/~/ дата создания объектов  (%%)
716 716  (% style="color:#000000" %)}
717 717  
718 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
564 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
719 719  
566 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
720 720  
568 +
721 721  (% class="box successmessage" %)
722 722  (((
723 723  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
724 724  )))
725 725  
726 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
574 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
727 727  
728 728  (% style="color:#000000" %)Метод запроса: **POST**
729 729  
730 730  (% 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}
731 731  
732 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
580 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
733 733  
734 734  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
735 735  
... ... @@ -746,7 +746,7 @@
746 746   "overwrite": false, ~/~/ Флаг перезаписи
747 747   "stage": "", ~/~/ Состояние, может быть null
748 748  
749 -(% style="color:#000000" %)}
597 + (% style="color:#000000" %)}
750 750  
751 751  (% style="color:#000000" %)Ответ:
752 752  
... ... @@ -760,7 +760,7 @@
760 760   "stage": "", ~/~/ Состояние
761 761  
762 762  (% style="text-align:left" %)
763 -(% style="color:#000000" %) }
611 +(% style="color:#000000" %)}
764 764  
765 765  
766 766  (% class="box warningmessage" %)
... ... @@ -768,7 +768,7 @@
768 768  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
769 769  )))
770 770  
771 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
619 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
772 772  
773 773  (% style="color:#000000" %)Метод запроса: **PUT**
774 774  
... ... @@ -778,9 +778,8 @@
778 778  
779 779  (% style="color:#000000" %)Параметры в теле запроса (JSON):
780 780  
781 -(% style="color:#000000" %){    
629 +(% style="color:#000000" %) {
782 782  
783 -(((
784 784  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
785 785   "parentId": "", ~/~/ ID клиента
786 786   "name": "", ~/~/ имя ТС
... ... @@ -789,25 +789,15 @@
789 789   "modelId": "", ~/~/ , ID модели    
790 790   "unitId": "", ~/~/ подразделения
791 791   "sim1": "", ~/~/ SIM 1
792 - "sim2": "", ~/~/ SIM2     (%%)
793 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
794 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
795 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
796 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
797 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
798 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
799 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
800 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
801 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
802 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
803 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
804 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
805 -(% style="color:#000000" %) "counters": 
639 + "sim2": "", ~/~/ SIM2
640 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
641 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
642 + "counters": 
806 806   {
807 807   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
808 808   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
809 - "mileage": "", ~/~/ пробег, в метрах 
810 - "motohours": "" ~/~/ моточасы, в секундах
646 + "mileage": «», пробег
647 + "motohours": «» моточасы
811 811   }
812 812   "cmsv6Parameters": ~/~/ параметры CMSv6
813 813   {       
... ... @@ -830,8 +830,7 @@
830 830   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
831 831   "kind": "", ~/~/ Вид периодичности по времени
832 832   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
833 - } 
834 -)))
670 + }
835 835  
836 836  (% style="color:#000000" %)}
837 837  
... ... @@ -838,7 +838,7 @@
838 838  (% style="color:#000000" %)Ответ:
839 839  
840 840  (% lang="en-US" style="text-align:left" %)
841 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
677 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
842 842  
843 843  (% lang="en-US" style="text-align:left" %)
844 844   "vehicleId": "", ~/~/ ID ТС
... ... @@ -885,24 +885,19 @@
885 885  (% lang="en-US" style="text-align:left" %)
886 886  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
887 887  
888 -**валидация:**
889 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
890 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
891 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
892 892  
893 -
894 894  (% class="box errormessage" %)
895 895  (((
896 896  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
897 897  )))
898 898  
899 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
730 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
900 900  
901 901  (% style="color:#000000" %)Метод запроса: **DELETE**
902 902  
903 903  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
904 904  
905 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
736 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
906 906  
907 907  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
908 908  
... ... @@ -920,7 +920,7 @@
920 920  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
921 921  )))
922 922  
923 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
754 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
924 924  
925 925  (% style="color:#000000" %)Метод запроса: **GET**
926 926  
... ... @@ -928,15 +928,16 @@
928 928  
929 929  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
930 930  
931 -(% style="color:#000000" %)Ответ:
762 +(% style="color:#000000" %)Ответ: [
932 932  
933 -(% style="color:#000000" %){
764 +(% class="western" %)
765 +{{{ {
766 + "deviceTypeId" : "", // ID типа устройства
767 + "deviceTypeName" : "" // Название типа устройства
768 + },}}}
934 934  
935 - "deviceTypeId" : "", ~/~/ ID типа устройства
936 - "deviceTypeName" : "" ~/~/ Название типа устройства
937 -
938 938  (% style="text-align:left" %)
939 -(% style="color:#000000" %)}
771 +(% style="color:#000000" %)…** **]
940 940  
941 941  
942 942  (% class="box" style="text-align: center;" %)
... ... @@ -949,7 +949,7 @@
949 949  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
950 950  )))
951 951  
952 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
784 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
953 953  
954 954  (% style="color:#000000" %)Метод запроса: **GET**
955 955  
... ... @@ -957,16 +957,19 @@
957 957  
958 958  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
959 959  
960 -(% style="color:#000000" %)Ответ:
792 +(% style="color:#000000" %)Ответ: [
961 961  
962 -(% style="color:#000000" %){
794 +(% class="western" style="margin-bottom:19px" %)
795 +{{{ {}}}
963 963  
964 - "id": "", ~/~/ ID типа датчика 
965 - "name": "", ~/~/ Название
966 - "description": "", ~/~/ Описание
797 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
967 967  
799 +(% class="western" %)
800 +{{{ "description": "" // Описание
801 + },}}}
802 +
968 968  (% style="text-align:left" %)
969 -(% style="color:#000000" %)}
804 +(% style="color:#000000" %)… ]
970 970  
971 971  
972 972  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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