Last modified by Андрей Калиновский on 2025/03/28 11:43
<
From version < 43.1 >
edited by Илья Крайнов
on 2022/11/18 17:47
To version < 18.1 >
edited by Артем Шемяков
on 2022/09/01 16:46
>
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,39 +20,22 @@
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 -
44 -(% style="color:#000000" %)**Ответ:**
45 -
46 46  (% lang="en-US" %)
47 -(% style="color:#000000" %){
37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
48 48  
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
52 -
53 -(% lang="en-US" %)
54 -}
55 -
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 58  
... ... @@ -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__»**).
47 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -83,32 +83,25 @@
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__»**):
69 +(% 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
75 +(% 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**__> - идентификатор клиента-родителя (опционально)
81 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
99 99  
100 100  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
101 101  
102 -(% style="color:#000000" %)Ответ:
85 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
103 103  
104 -(% style="color:#000000" %){
105 - "agentId": "", ~/~/ идентификатор клиента
106 - "parentId": "", ~/~/ идентификатор клиента-родителя
107 - "name": "", ~/~/ наименование клиента
108 - "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 -}
87 +(% 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" %)]
112 112  
113 113  
114 114  (% class="box" style="text-align: center;" %)
... ... @@ -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__»**).
100 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -129,57 +129,12 @@
129 129  
130 130  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
131 131  
132 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
108 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
133 133  
134 -(% style="color:#000000" %){ 
135 - "lastName": "", ~/~/ фамилия
136 - "firstName": "", ~/~/ имя
137 - "position": "", ~/~/ должность
138 - "phone": "", ~/~/ телефон
139 - "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин (обязателен)
141 - "password": "", ~/~/ пароль (обязателен)
142 - "email": "", ~/~/ email (обязателен)
143 - "description": "", ~/~/ описание
144 - "isEnabled": "", ~/~/ признак включения
145 - "parentId": "", ~/~/ Guid родительского агента
146 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 -}
153 -
154 154  (% style="text-align:left" %)
155 -(% style="color:#000000; font-weight:normal" %)Ответ:
111 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
156 156  
157 -(% style="text-align:left" %)
158 -(% style="color:#000000; font-weight:normal" %){    
159 159  
160 -(% style="text-align:left" %)
161 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
162 - "lastName": "" , ~/~/ Фамилия ,
163 - "firstName": "" , ~/~/ Имя
164 - "position": "" , ~/~/ Должность
165 - "phone": "" , ~/~/ Телефон
166 - "organization": "" , ~/~/ Организация
167 - "login": "" , ~/~/ Логин
168 - "password": "" , ~/~/ Пароль
169 - "email": "" , ~/~/ Email
170 - "description": "" , ~/~/ Описание
171 - "isEnabled": "" , ~/~/ Признак включения
172 - "parentId": "" , ~/~/ Guid родительского агента
173 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
174 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 - "kind": "" , ~/~/ тип аутентификации
176 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178 -
179 -(% style="text-align:left" %)
180 -(% style="color:#000000; font-weight:normal" %)}
181 -
182 -
183 183  (% class="box successmessage" %)
184 184  (((
185 185  (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
... ... @@ -187,230 +187,37 @@
187 187  
188 188  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
121 +(% 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" %)Условия фильтрации объектов задаются в теле запроса.
127 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
197 197  
198 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
129 +(% class="western" %)
130 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
131 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
132 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
133 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
199 199  
200 -(% style="color:#000000" %){
201 -
202 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
206 -
207 207  (% style="color:#000000" %)}
208 208  
209 -(% style="color:#000000" %)Ответ:
137 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
210 210  
211 -(% style="color:#000000" %){         (%%)
139 +(% class="western" style="margin-bottom:19px" %)
140 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
212 212  
213 - "id": "" , ~/~/ идентификатор пользователя
214 - "lastName": "" , ~/~/ фамилия
215 - "firstName": "" , ~/~/ имя
216 - "position": "" , ~/~/ должность
217 - "phone": "" , ~/~/ телефон
218 - "parentId": "" , ~/~/ идентификатор клиента-родителя
219 - "parentName": "" , ~/~/ наименование клиента-родителя
220 - "organization": "" , ~/~/ организация
221 - "login": "" , ~/~/ логин
222 - "email": "" , ~/~/ E-mail
223 - "sessionDuration":"", ~/~/ длительность сессии в минутах
224 - "status": "1",  ~/~/ статус пользователя
225 - "astLogged": "", ~/~/ дата/время последней авторизации
142 +(% lang="en-US" style="text-align:left" %)
143 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
226 226  
227 -(% style="color:#000000" %)}
228 228  
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 -)))
249 -)))
250 -
251 -(((
252 -(((
253 - "id": "", ~/~/ GUID пользователя
254 -)))
255 -)))
256 -
257 -(((
258 -(((
259 - "lastName": "", ~/~/ Фамилия
260 -)))
261 -)))
262 -
263 -(((
264 -(((
265 - "firstName": "", ~/~/ Имя
266 -)))
267 -)))
268 -
269 -(((
270 -(((
271 - "position": "", ~/~/ Должность
272 -)))
273 -)))
274 -
275 -(((
276 -(((
277 - "phone": "", ~/~/ Номер телефона
278 -)))
279 -)))
280 -
281 -(((
282 -(((
283 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
284 -)))
285 -)))
286 -
287 -(((
288 -(((
289 - "parentName": "", Наименование клиента, которому принадлежит пользователь
290 -)))
291 -)))
292 -
293 -(((
294 -(((
295 - "organization": "", ~/~/ Организация
296 -)))
297 -)))
298 -
299 -(((
300 -(((
301 - "login": "", ~/~/ Логин пользователя
302 -)))
303 -)))
304 -
305 -(((
306 -(((
307 - "email": "", ~/~/ Адрес электронной почты
308 -)))
309 -)))
310 -
311 -(((
312 -(((
313 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
314 -)))
315 -)))
316 -
317 -(((
318 -(((
319 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
320 -)))
321 -)))
322 -
323 -(((
324 -(((
325 - "description": "", ~/~/ Описание
326 -)))
327 -)))
328 -
329 -(((
330 -(((
331 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
332 -)))
333 -)))
334 -
335 -(((
336 -(((
337 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
338 -)))
339 -)))
340 -
341 -(((
342 -(((
343 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
344 -)))
345 -)))
346 -
347 -(((
348 -(((
349 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
350 -)))
351 -)))
352 -
353 -(((
354 -(((
355 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
356 -)))
357 -)))
358 -
359 -(((
360 -(((
361 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
362 -)))
363 -)))
364 -
365 -(((
366 -(((
367 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
368 -)))
369 -)))
370 -
371 -(((
372 -(((
373 - "groups": [], ~/~/ Список ролей пользователя
374 -)))
375 -)))
376 -
377 -(((
378 -(((
379 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
380 -)))
381 -)))
382 -
383 -(((
384 -(((
385 - "authDevices": [ ], ~/~/ Список авторизованных устройств
386 -)))
387 -)))
388 -
389 -(((
390 -(((
391 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
392 -)))
393 -)))
394 -
395 -(((
396 -(((
397 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
398 -)))
399 -)))
400 -
401 -(((
402 -(((
403 -}
404 -)))
405 -)))
406 -
407 -
408 408  (% class="box warningmessage" %)
409 409  (((
410 410  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
411 411  )))
412 412  
413 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
151 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
414 414  
415 415  (% style="color:#000000" %)Метод запроса: **PUT**
416 416  
... ... @@ -418,89 +418,27 @@
418 418  
419 419  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
420 420  
421 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
422 -
423 423  (% lang="en-US" style="text-align:left" %)
424 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
160 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
425 425  
426 -(% lang="en-US" style="text-align:left" %)
427 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
428 428  
429 -(% lang="en-US" style="text-align:left" %)
430 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
431 - "lastName": "" , ~/~/ фамилия
432 - "firstName": "" , ~/~/ имя
433 - "position": "" , ~/~/ должность
434 - "phone": "" , ~/~/ телефон
435 - "organization": "" , ~/~/ организация
436 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
437 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
438 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
439 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
440 - "isEnabled": "" , ~/~/ признак включения
441 - "parentId": "" , ~/~/ Guid родительского агента
442 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
443 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
444 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
445 - "kind": "" , ~/~/ тип аутентификации
446 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
447 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
448 -
449 -(% lang="en-US" style="text-align:left" %)
450 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
451 -
452 -(% lang="en-US" style="text-align:left" %)
453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
454 -
455 -(% lang="en-US" style="text-align:left" %)
456 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
457 -
458 -(% lang="en-US" style="text-align:left" %)
459 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
460 - "lastName": "" , ~/~/ фамилия
461 - "firstName": "" , ~/~/ имя
462 - "position": "" , ~/~/ должность
463 - "phone": "" , ~/~/ телефон
464 - "organization": "" , ~/~/ организация
465 - "login": "" , ~/~/ логин
466 - "password": "" , ~/~/ пароль 
467 - "email": "" , ~/~/ email
468 - "description": "" , ~/~/ описание
469 - "isEnabled": "" , ~/~/ признак включения
470 - "parentId": "" , ~/~/ Guid родительского агента
471 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
472 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
473 - "kind": "" , ~/~/ тип аутентификации
474 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
475 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
476 -
477 -(% lang="en-US" style="text-align:left" %)
478 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
479 -
480 -
481 481  (% class="box warningmessage" %)
482 482  (((
483 483  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
484 484  )))
485 485  
486 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
168 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
487 487  
488 488  (% style="color:#000000" %)Метод запроса: **PUT**
489 489  
490 -(% 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}
172 +(% 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} Параметр запроса:
491 491  
492 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
174 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
493 493  
494 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
176 +(% class="western" %)
177 +{{{ "description": "", // описание
178 + "data": "" // данные, связанные со сменой статуса}}}
495 495  
496 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
497 -
498 -(% style="color:#000000" %){
499 -
500 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
501 - "description": "" , ~/~/ описание
502 - "data": "" , ~/~/ данные, связанные со сменой статуса
503 -
504 504  (% style="color:#000000" %)}
505 505  
506 506  (% style="text-align:left" %)
... ... @@ -507,78 +507,19 @@
507 507  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
508 508  
509 509  
510 -(% class="box warningmessage" %)
511 -(((
512 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
513 -)))
514 -
515 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
516 -
517 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
518 -
519 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
520 -
521 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
522 -
523 - [ 
524 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
525 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
526 - ]
527 -
528 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
529 -
530 -
531 -(% class="box warningmessage" %)
532 -(((
533 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
534 -)))
535 -
536 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
537 -
538 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
539 -
540 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
541 -
542 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
543 -
544 - [ 
545 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
546 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
547 - ]
548 -
549 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
550 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
551 -
552 -(((
553 -В теле ответа:
554 -{
555 - "errorMessages": [
556 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
557 - ],
558 - "users": [
559 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
560 - ]
561 -}
562 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
563 -"users" - массив id пользователей, которых не удалось включить или отключить.
564 -
565 -)))
566 -
567 567  (% class="box errormessage" %)
568 568  (((
569 569  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
570 570  )))
571 571  
572 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
191 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
573 573  
574 574  (% style="color:#000000" %)Метод запроса: **DELETE**
575 575  
576 576  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
577 577  
578 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
197 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
579 579  
580 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
581 -
582 582  (% style="text-align:left" %)
583 583  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
584 584  
... ... @@ -595,166 +595,43 @@
595 595  
596 596  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
597 597  
598 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
215 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
599 599  
600 600  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
601 601  
602 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
219 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
603 603  
604 604  (% style="color:#000000" %)Метод запроса: **GET**
605 605  
606 606  (% 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>
607 607  
608 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
225 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
609 609  
610 610  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
611 611  
612 612  (% style="color:#000000" %)Ответ:
613 613  
614 -(((
615 -{
616 -)))
231 +(% style="color:#000000" %){
617 617  
618 -(((
619 - "vehicleId": "", ~/~/ ID объекта
620 -)))
233 +(% class="western" %)
234 +{{{ "vehicleId": “”, // идентификатор объекта
235 + "name": "", // имя объекта
236 + "imei": "", // IMEI объекта
237 + "deviceTypeId": “”, // идентификатор устройства объекта
238 + "deviceTypeName": "" // наименование устройства объекта
239 + "parentId": "", // идентификатор клиента-родителя
240 + "parentName": "" // наименование клиента-родителя,
241 + "modelId": "", // идентификатор модели объекта
242 + "modelName": "" // наименование модели объекта,
243 + "unitId": "", // идентификатор подразделения
244 + "unitName": "", // наименование подразделения
245 + "status": “”, // статус объекта
246 + ...
247 + },
248 + ...}}}
621 621  
622 -(((
623 - "name": "", ~/~/ Имя объекта
624 -)))
250 +(% style="color:#000000" %)}
625 625  
626 -(((
627 - "imei": "", ~/~/ IMEI объекта
628 -)))
629 -
630 -(((
631 - "deviceTypeId": , ~/~/ ID типа устройства
632 -)))
633 -
634 -(((
635 - "deviceTypeName": "", ~/~/ Название типа устройства
636 -)))
637 -
638 -(((
639 - "sim1": "", ~/~/ Номер SIM1
640 -)))
641 -
642 -(((
643 - "parentId": "", Номер SIM2
644 -)))
645 -
646 -(((
647 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
648 -)))
649 -
650 -(((
651 - "modelId": "", ID модели объекта
652 -)))
653 -
654 -(((
655 - "modelName": "", Имя модели объекта
656 -)))
657 -
658 -(((
659 - "createdAt": "", Дата создания объекта
660 -)))
661 -
662 -(((
663 - "mileageCalcMethod": "", Выбранный метод расчета пробега
664 -)))
665 -
666 -(((
667 - "counters": { ~/~/ Нормы
668 -)))
669 -
670 -(((
671 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
672 -)))
673 -
674 -(((
675 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
676 -)))
677 -
678 -(((
679 - "mileage": "", ~/~/ Пробег по нормам в метрах
680 -)))
681 -
682 -(((
683 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
684 -)))
685 -
686 -(((
687 - },
688 -)))
689 -
690 -(((
691 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
692 -)))
693 -
694 -(((
695 - {
696 -)))
697 -
698 -(((
699 - "id": "", ~/~/ ID  задания
700 -)))
701 -
702 -(((
703 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
704 -)))
705 -
706 -(((
707 - "name": "", ~/~/ Наименование задания
708 -)))
709 -
710 -(((
711 - "description": "", ~/~/ Описание задания
712 -)))
713 -
714 -(((
715 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
716 -)))
717 -
718 -(((
719 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
720 -)))
721 -
722 -(((
723 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
724 -)))
725 -
726 -(((
727 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
728 -)))
729 -
730 -(((
731 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
732 -)))
733 -
734 -(((
735 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
736 -)))
737 -
738 -(((
739 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
740 -)))
741 -
742 -(((
743 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
744 -)))
745 -
746 -(((
747 - }
748 -)))
749 -
750 -(((
751 - ]
752 -)))
753 -
754 -(((
755 -}
756 -)))
757 -
758 758  (% style="text-align:left" %)
759 759  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
760 760  
... ... @@ -767,7 +767,7 @@
767 767  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
768 768  )))
769 769  
770 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
264 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
771 771  
772 772  (% style="color:#000000" %)Метод запроса: **POST**
773 773  
... ... @@ -775,112 +775,100 @@
775 775  
776 776  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
777 777  
778 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
272 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
779 779  
780 -(% style="color:#000000" %){
781 -
782 - "parentId": "" , ~/~/ ID клиента
783 - "name": "" , ~/~/ имя ТС
784 - "imei": "" , ~/~/ IMEI
785 - "deviceTypeId": "" , ~/~/ ID типа устройства
786 - "modelId": "" , ~/~/ ID модели
787 - "unitId": "" , ~/~/ ID подразделения
788 - "sim1": "" , ~/~/ Номер SIM 1
789 - "sim2": "" , ~/~/ Номер SIM2
790 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
791 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
792 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
793 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
794 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
795 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
796 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
797 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
798 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
799 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
800 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
801 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
802 - "counters": ~/~/ счетчики
803 - {
804 - "mileage": "" , ~/~/ пробег
805 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
806 - "motohours": "" , ~/~/ моточасы
807 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
274 +(% class="western" %)
275 +{{{ "parentId": "", // ID клиента
276 + "name": "", // имя ТС
277 + "imei": "", // IMEI
278 + "deviceTypeId": "",// ID типа устройства
279 + "modelId": "",
280 + "unitId": "", // ID подразделения
281 + "sim1": "", // Номер SIM 1
282 + "sim2": "", // Номер SIM2
283 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
284 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
285 + "consumptionIdle": "",// Расход топлива на холостом ходу
286 + "counters": {
287 + "mileage": "", // пробег
288 + "mileageEnabled": true, // флаг активности счётчика "пробег"
289 + "motohours":"", // моточасы
290 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
291 + },
292 + "cmsv6Parameters": { // параметры CMSv6
293 + "enabled": true, // флаг включения
294 + //"id": "", // идентификатор
295 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
296 + "login": "", // имя учетной записи
297 + "password": "" // пароль учетной записи
808 808   },
809 - "cmsv6Parameters": { ~/~/ параметры CMSv6
810 - "enabled": true, ~/~/ флаг включения
811 - "id": "" , ~/~/ идентификатор
812 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
813 - "login": "" , ~/~/ имя учетной записи
814 - "password": "" ~/~/ пароль учетной записи
815 - },
816 - "inspectionTasks": ~/~/ задания на ТО
299 + "inspectionTasks": [ // задания на ТО
817 817   {
818 - "enabled": "" , ~/~/ Признак включения
819 - "name": "" , ~/~/ Имя задания
820 - "description": "" , ~/~/ Описание задания
821 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
822 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
823 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
824 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
825 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
826 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
827 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
828 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
829 - }
301 + "enabled": "", // Признак включения
302 + "name": "", // Имя задания
303 + "description": "", // Описание задания
304 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
305 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
306 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
307 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
308 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
309 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
310 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
311 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
312 + },
313 + ]}}}
830 830  
831 -(% style="color:#000000" %) }
315 +(% style="color:#000000" %)… }
832 832  
833 833  (% style="color:#000000" %)Ответ:
834 834  
835 835  (% style="color:#000000" %){
836 836  
837 - "vehicleId": "", ~/~/ID ТС 
838 - "parentId": "", ~/~/Guid владельца ТС
839 - "name": "", ~/~/Имя объекта
840 - "imei": "", ~/~/IMEI
841 - "deviceTypeId": "", ~/~/ID типа устройства
842 - "modelId": "", ~/~/ID модели
843 - "unitId": "", ~/~/ID подразделения
844 - "sim1": "", ~/~/SIM1
845 - "sim2": "", ~/~/SIM2
846 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
847 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
848 - "counters": { ~/~/Счётчики
849 - "mileageEnabled": true,
850 - "motohoursEnabled": true,
851 - "mileage": "",
852 - "motohours": 345.0
853 - },
854 - "cmsv6Parameters": { ~/~/Параметры CmsV6
855 - "id": null,
856 - "enabled": true, ~/~/флаг включения
857 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
858 - "login": "", ~/~/ имя учетной записи
859 - "password": "" ~/~/ пароль учетной записи
860 - },
861 - "inspectionTasks": { ~/~/ задания на ТО
862 - "id": "", ~/~/ ID задачи
863 - "enabled": false, ~/~/ Признак включения
864 - "name": "", ~/~/ Имя задания
865 - "description": "", ~/~/ Описание задания
866 - "mileageCondition": "", ~/~/ Условие по пробегу
867 - "lastMileage": "", ~/~/ Пробег (в метрах)
868 - "motohoursCondition": "", ~/~/ Условие по моточасам
869 - "lastMotohours": "", ~/~/ Моточасы
870 - "periodicCondition": "", ~/~/ Условие периодичности по времени
871 - "kind": "", ~/~/ Вид периодичности по времени 
872 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
873 - }
321 +(% class="western" %)
322 +{{{ "vehicleId": "", //ID ТС
323 + "parentId": "", //Guid владельца ТС
324 + "name": "", //Имя объекта
325 + "imei": "", //IMEI
326 + "deviceTypeId": "", //ID типа устройства
327 + "modelId": "", //ID модели
328 + "unitId": "", //ID подразделения
329 + "sim1": "", //SIM1
330 + "sim2": "", //SIM2
331 + "consumptionPer100Km": "", //Расход топлива на 100 км
332 + "consumptionIdle": "", //Расход топлива на холостом ходу
333 + "counters": { //Счётчики
334 + "mileageEnabled": true,
335 + "motohoursEnabled": true,
336 + "mileage": "",
337 + "motohours": 345.0
338 + },
339 + "cmsv6Parameters": { //Параметры CmsV6
340 + "id": null,
341 + "enabled": true, //флаг включения
342 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
343 + "login": "", // имя учетной записи
344 + "password": "" // пароль учетной записи
345 + },
346 + "inspectionTasks": [ // задания на ТО
347 + {
348 + "id": "", // ID задачи
349 + "enabled": false, // Признак включения
350 + "name": "", // Имя задания
351 + "description": "", // Описание задания
352 + "mileageCondition": "", // Условие по пробегу
353 + "lastMileage": "", // Пробег (в метрах)
354 + "motohoursCondition": "", // Условие по моточасам
355 + "lastMotohours": "", // Моточасы
356 + "periodicCondition": "", // Условие периодичности по времени
357 + "kind": "", // Вид периодичности по времени
358 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
359 + }
360 + ]}}}
874 874  
875 875  (% style="text-align:left" %)
876 876  (% style="color:#000000" %)}
877 877  
878 -**Валидация:**
879 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
880 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
881 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
882 882  
883 -
884 884  (% class="box successmessage" %)
885 885  (((
886 886  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -888,17 +888,17 @@
888 888  
889 889  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
890 890  
891 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
373 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
892 892  
893 893  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
894 894  
895 895  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
896 896  
897 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
379 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
898 898  
899 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
381 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
900 900  
901 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
383 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
902 902  
903 903  (% style="color:#000000" %)Метод запроса: **POST**
904 904  
... ... @@ -906,96 +906,95 @@
906 906  
907 907  (% style="color:#000000" %)В заголовках запроса:
908 908  
909 -(% style="color:#000000" %)− Content-Type: __**application/json**__
391 +(% style="color:#000000" %)− Content-Type: application/json
910 910  
911 911  (% style="color:#000000" %)− X-Auth: Токен авторизации
912 912  
913 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
395 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
914 914  
915 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
397 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
916 916  
917 -(% class="western" style="color:#000000" %)##{##
399 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
918 918  
919 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
920 - "name": null, ~/~/ Имя ТС (string, опционально) 
921 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
922 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
923 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
924 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
925 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
926 -(% style="color:#000000" %)}
401 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
927 927  
928 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
403 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
929 929  
930 -(% style="color:#000000" %)Ответ:
405 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
931 931  
932 -(% style="color:#000000" %){
407 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
933 933  
934 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
935 - "name": "" ~/~/ наименование объекта
936 - "imei": "" ~/~/ IMEI объекта
937 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
938 - "deviceTypeName": "" ~/~/ наименование типа устройства
939 - "sim1": "" ~/~/ первый номер телефона
940 - "sim2": "" ~/~/ второй номер телефона
941 - "parentId": "" ~/~/ идентификатор клиента-родителя
942 - "parentName": "" ~/~/ наименование клиента-родителя
943 - "modelId": "" ~/~/ идентификатор модели объекта
944 - "modelName": "" ~/~/ наименование модели объекта
945 - "unitId": "" ~/~/ идентификатор подразделения
946 - "unitName": "" ~/~/ наименование подразделения
947 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
948 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
949 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
950 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
951 -(% style="color:#000000" %)}
409 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
952 952  
953 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
411 +(% style="color:#000000" %)0 - «Блокировка»;
954 954  
413 +(% style="color:#000000" %)1 - «Активен»;
955 955  
415 +(% style="color:#000000" %)2 - «Отменен»;
416 +
417 +(% style="color:#000000" %)3 - «Оборудован»;
418 +
419 +(% style="color:#000000" %)4 - «Диагностика»;
420 +
421 +(% style="color:#000000" %)5 - «Сервис»;
422 +
423 +(% style="color:#000000" %)6 - «Демонтаж»;
424 +
425 +(% style="color:#000000" %)7 - «Монтаж»;
426 +
427 +(% style="color:#000000" %)8 - «Дозаказ»;
428 +
429 +(% style="color:#000000" %)9 - «Обслужен»;
430 +
431 +(% style="color:#000000" %)10 - «Списан»;
432 +
433 +(% style="color:#000000" %)11 - «Неисправен»;
434 +
435 +(% style="color:#000000" %)12 - «Проверен»;
436 +
437 +(% style="text-align:left" %)
438 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется».
439 +
440 +
956 956  (% class="box successmessage" %)
957 957  (((
958 958  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
959 959  )))
960 960  
961 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
446 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
962 962  
963 963  (% style="color:#000000" %)Метод запроса: **POST**
964 964  
965 965  (% 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}
966 966  
967 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
452 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
968 968  
969 969  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
970 970  
971 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
456 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
972 972  
973 -(% style="color:#000000" %){
458 +(% class="western" %)
459 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
460 + "date": "", // Дата смены статуса (null если сменить немедленно)
461 + "description": "", // Описание
462 + "data": "", // Данные
463 + "overwrite": false, // Флаг перезаписи
464 + "stage": "", // Состояние, может быть null}}}
974 974  
975 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
976 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
977 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
978 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
979 - "description": "", ~/~/ Описание
980 - "data": "", ~/~/ Данные
981 - "overwrite": false, ~/~/ Флаг перезаписи
982 - "stage": "", ~/~/ Состояние, может быть null
983 -
984 984  (% style="color:#000000" %)}
985 985  
986 -(% style="color:#000000" %)Ответ:
468 +(% style="color:#000000" %)Ответ: {
987 987  
988 -(% style="color:#000000" %){
470 +(% class="western" %)
471 +{{{ "status": "", // значение статуса
472 + "date": "", // Дата смены статуса
473 + "description": "", // Описание
474 + "data": "", // Данные
475 + "overwrite": false, // Флаг перезаписи
476 + "stage": "", // Состояние}}}
989 989  
990 - "status": "", ~/~/ значение статуса
991 - "date": "", ~/~/ Дата смены статуса 
992 - "description": "", ~/~/ Описание
993 - "data": "", ~/~/ Данные
994 - "overwrite": false, ~/~/ Флаг перезаписи
995 - "stage": "", ~/~/ Состояние
996 -
997 997  (% style="text-align:left" %)
998 -(% style="color:#000000" %) }
479 +(% style="color:#000000" %)}
999 999  
1000 1000  
1001 1001  (% class="box warningmessage" %)
... ... @@ -1003,7 +1003,7 @@
1003 1003  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1004 1004  )))
1005 1005  
1006 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
487 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1007 1007  
1008 1008  (% style="color:#000000" %)Метод запроса: **PUT**
1009 1009  
... ... @@ -1013,131 +1013,26 @@
1013 1013  
1014 1014  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1015 1015  
1016 -(% style="color:#000000" %){    
497 +(% 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»: «» //Сколько раз выполнить задание } ] }
1017 1017  
1018 -(((
1019 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1020 - "parentId": "", ~/~/ ID клиента
1021 - "name": "", ~/~/ имя ТС
1022 - "imei": "", ~/~/ IMEI
1023 - "deviceTypeId": "", ~/~/ ID типа устройства
1024 - "modelId": "", ~/~/ , ID модели    
1025 - "unitId": "", ~/~/ подразделения
1026 - "sim1": "", ~/~/ SIM 1
1027 - "sim2": "", ~/~/ SIM2     (%%)
1028 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1029 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1030 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1031 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1032 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1033 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1034 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1035 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1036 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1037 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1038 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1039 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1040 -(% style="color:#000000" %) "counters": 
1041 - {
1042 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1043 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1044 - "mileage": "", ~/~/ пробег, в метрах 
1045 - "motohours": "" ~/~/ моточасы, в секундах
1046 - }
1047 - "cmsv6Parameters": ~/~/ параметры CMSv6
1048 - {       
1049 - "id": "", ~/~/ идентификатор
1050 - "enabled": true, ~/~/ флаг включения
1051 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1052 - "login": "", ~/~/ имя учетной записи
1053 - "password": "", ~/~/ пароль учетной записи
1054 - }
1055 - "inspectionTasks": ~/~/ задания на ТО
1056 - {
1057 - "id": "", ~/~/ ID задания
1058 - "enabled": false, ~/~/ Признак включения
1059 - "name": "", ~/~/ Имя задания
1060 - "description": "", ~/~/ Описание задания
1061 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1062 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1063 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1064 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1065 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1066 - "kind": "", ~/~/ Вид периодичности по времени
1067 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1068 - } 
1069 -)))
1070 -
1071 -(% style="color:#000000" %)}
1072 -
1073 1073  (% style="color:#000000" %)Ответ:
1074 1074  
1075 1075  (% lang="en-US" style="text-align:left" %)
1076 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
502 +(% 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»: «» //Сколько раз выполнить задание } ] }
1077 1077  
1078 -(% lang="en-US" style="text-align:left" %)
1079 - "vehicleId": "", ~/~/ ID ТС
1080 - "parentId": "", ~/~/ ID клиента
1081 - "name": "", ~/~/ имя ТС
1082 - "imei": "", ~/~/ IMEI
1083 - "deviceTypeId": "", ~/~/ типа устройства
1084 - "modelId": "", ~/~/ ID модели
1085 - "unitId": "", ~/~/ ID подразделения
1086 - "sim1": "", ~/~/ SIM 1
1087 - "sim2": "", ~/~/ SIM2
1088 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1089 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1090 - "counters": 
1091 - {
1092 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1093 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1094 - "mileage": "", ~/~/ пробег
1095 - "motohours": "", ~/~/ моточасы
1096 - }
1097 - "cmsv6Parameters": ~/~/ параметры CMSv6
1098 - {
1099 - "id": ~/~/ идентификатор
1100 - "enabled": true, ~/~/ флаг включения
1101 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1102 - "login": "", ~/~/ имя учетной записи
1103 - "password": "", ~/~/ пароль учетной записи
1104 - }
1105 - "inspectionTasks": ~/~/ задания на ТО
1106 - {
1107 - "id": "", ~/~/ ID задания
1108 - "enabled": false, ~/~/ Признак включения
1109 - "name": "", ~/~/ Имя задания
1110 - "description": "", ~/~/ Описание задания
1111 - "mileageCondition": "", ~/~/ Условие по пробегу
1112 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1113 - "motohoursCondition": "", ~/~/ Условие по моточасам
1114 - "lastMotohours": "", ~/~/ Моточасы
1115 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1116 - "kind": "", ~/~/ Вид периодичности по времени
1117 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1118 - }
1119 1119  
1120 -(% lang="en-US" style="text-align:left" %)
1121 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1122 -
1123 -**валидация:**
1124 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1125 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1126 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1127 -
1128 -
1129 1129  (% class="box errormessage" %)
1130 1130  (((
1131 1131  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1132 1132  )))
1133 1133  
1134 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
510 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1135 1135  
1136 1136  (% style="color:#000000" %)Метод запроса: **DELETE**
1137 1137  
1138 1138  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1139 1139  
1140 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
516 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1141 1141  
1142 1142  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1143 1143  
... ... @@ -1155,7 +1155,7 @@
1155 1155  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1156 1156  )))
1157 1157  
1158 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
534 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1159 1159  
1160 1160  (% style="color:#000000" %)Метод запроса: **GET**
1161 1161  
... ... @@ -1163,15 +1163,16 @@
1163 1163  
1164 1164  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1165 1165  
1166 -(% style="color:#000000" %)Ответ:
542 +(% style="color:#000000" %)Ответ: [
1167 1167  
1168 -(% style="color:#000000" %){
544 +(% class="western" %)
545 +{{{ {
546 + "deviceTypeId" : "", // ID типа устройства
547 + "deviceTypeName" : "" // Название типа устройства
548 + },}}}
1169 1169  
1170 - "deviceTypeId" : "", ~/~/ ID типа устройства
1171 - "deviceTypeName" : "" ~/~/ Название типа устройства
1172 -
1173 1173  (% style="text-align:left" %)
1174 -(% style="color:#000000" %)}
551 +(% style="color:#000000" %)…** **]
1175 1175  
1176 1176  
1177 1177  (% class="box" style="text-align: center;" %)
... ... @@ -1184,7 +1184,7 @@
1184 1184  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1185 1185  )))
1186 1186  
1187 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
564 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1188 1188  
1189 1189  (% style="color:#000000" %)Метод запроса: **GET**
1190 1190  
... ... @@ -1192,16 +1192,19 @@
1192 1192  
1193 1193  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1194 1194  
1195 -(% style="color:#000000" %)Ответ:
572 +(% style="color:#000000" %)Ответ: [
1196 1196  
1197 -(% style="color:#000000" %){
574 +(% class="western" style="margin-bottom:19px" %)
575 +{{{ {}}}
1198 1198  
1199 - "id": "", ~/~/ ID типа датчика 
1200 - "name": "", ~/~/ Название
1201 - "description": "", ~/~/ Описание
577 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1202 1202  
579 +(% class="western" %)
580 +{{{ "description": "" // Описание
581 + },}}}
582 +
1203 1203  (% style="text-align:left" %)
1204 -(% style="color:#000000" %)}
584 +(% style="color:#000000" %)… ]
1205 1205  
1206 1206  
1207 1207  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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