Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 20.4 >
edited by Артем Шемяков
on 2022/09/01 17:28
To version < 22.3 >
edited by Артем Шемяков
on 2022/09/02 10:04
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
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  
... ... @@ -31,7 +31,7 @@
31 31  
32 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 36  (% lang="en-US" %)
37 37  (% style="color:#000000" %)**Ответ:**
... ... @@ -82,13 +82,13 @@
82 82  
83 83  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 84  
85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
86 86  
87 87  (% style="color:#000000" %)Метод запроса: **GET**
88 88  
89 89  (% 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>
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
91 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
92 92  
93 93  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94 94  
... ... @@ -99,14 +99,11 @@
99 99   "parentId": "", ~/~/ идентификатор клиента-родителя
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента1
102 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 103   "status": "", ~/~/ статус клиента
104 - }
104 +}
105 105  
106 106  
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 -
110 110  (% class="box" style="text-align: center;" %)
111 111  (((
112 112  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -145,13 +145,13 @@
145 145   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 146   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 147   "groups": "" , ~/~/ группы пользователя, названия групп
148 - }
145 +}
149 149  
150 150  (% style="text-align:left" %)
151 151  (% style="color:#000000; font-weight:normal" %)Ответ:
152 152  
153 153  (% style="text-align:left" %)
154 -(% style="color:#000000; font-weight:normal" %){
151 +(% style="color:#000000; font-weight:normal" %){    
155 155  
156 156  (% style="text-align:left" %)
157 157  (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
... ... @@ -202,9 +202,9 @@
202 202  
203 203  (% style="color:#000000" %)Ответ:
204 204  
205 -(% style="color:#000000" %){
202 +(% style="color:#000000" %){         (%%)
206 206  
207 -(% style="color:#000000" %) "id": "" , ~/~/ идентификатор пользователя
204 + "id": "" , ~/~/ идентификатор пользователя
208 208   "lastName": "" , ~/~/ фамилия
209 209   "firstName": "" , ~/~/ имя
210 210   "position": "" , ~/~/ должность
... ... @@ -214,16 +214,13 @@
214 214   "organization": "" , ~/~/ организация
215 215   "login": "" , ~/~/ логин
216 216   "email": "" , ~/~/ E-mail
214 + "sessionDuration":"", ~/~/ длительность сессии в минутах
215 + "status": "1",  ~/~/ статус пользователя
216 + "astLogged": "", ~/~/ дата/время последней авторизации
217 217  
218 218  (% style="color:#000000" %)}
219 219  
220 -(% class="western" style="margin-bottom:19px" %)
221 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
222 222  
223 -(% lang="en-US" style="text-align:left" %)
224 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
225 -
226 -
227 227  (% class="box warningmessage" %)
228 228  (((
229 229  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -238,9 +238,63 @@
238 238  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
239 239  
240 240  (% lang="en-US" style="text-align:left" %)
241 -(% 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» //названия групп ] }  //
235 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
242 242  
237 +(% lang="en-US" style="text-align:left" %)
238 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
243 243  
240 +(% lang="en-US" style="text-align:left" %)
241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
242 + "lastName": "" , ~/~/ фамилия
243 + "firstName": "" , ~/~/ имя
244 + "position": "" , ~/~/ должность
245 + "phone": "" , ~/~/ телефон
246 + "organization": "" , ~/~/ организация
247 + "login": "" , ~/~/ логин
248 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
249 + "email": "" , ~/~/ email
250 + "description": "" , ~/~/ описание
251 + "isEnabled": "" , ~/~/ признак включения
252 + "parentId": "" , ~/~/ Guid родительского агента
253 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
254 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
255 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
256 + "kind": "" , ~/~/ тип аутентификации
257 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
258 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
259 +
260 +(% lang="en-US" style="text-align:left" %)
261 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
262 +
263 +(% lang="en-US" style="text-align:left" %)
264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
265 +
266 +(% lang="en-US" style="text-align:left" %)
267 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
268 +
269 +(% lang="en-US" style="text-align:left" %)
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
271 + "lastName": "" , ~/~/ фамилия
272 + "firstName": "" , ~/~/ имя
273 + "position": "" , ~/~/ должность
274 + "phone": "" , ~/~/ телефон
275 + "organization": "" , ~/~/ организация
276 + "login": "" , ~/~/ логин
277 + "password": "" , ~/~/ пароль 
278 + "email": "" , ~/~/ email
279 + "description": "" , ~/~/ описание
280 + "isEnabled": "" , ~/~/ признак включения
281 + "parentId": "" , ~/~/ Guid родительского агента
282 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
283 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
284 + "kind": "" , ~/~/ тип аутентификации
285 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
286 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
287 +
288 +(% lang="en-US" style="text-align:left" %)
289 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
290 +
291 +
244 244  (% class="box warningmessage" %)
245 245  (((
246 246  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
... ... @@ -250,14 +250,20 @@
250 250  
251 251  (% style="color:#000000" %)Метод запроса: **PUT**
252 252  
253 -(% 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} Параметр запроса:
301 +(% 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}
254 254  
255 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
303 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
256 256  
257 -(% class="western" %)
258 -{{{ "description": "", // описание
259 - "data": "" // данные, связанные со сменой статуса}}}
305 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
260 260  
307 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
308 +
309 +(% style="color:#000000" %){
310 +
311 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
312 + "description": "" , ~/~/ описание
313 + "data": "" , ~/~/ данные, связанные со сменой статуса
314 +
261 261  (% style="color:#000000" %)}
262 262  
263 263  (% style="text-align:left" %)
... ... @@ -275,8 +275,10 @@
275 275  
276 276  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
277 277  
278 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
332 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
279 279  
334 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
335 +
280 280  (% style="text-align:left" %)
281 281  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
282 282  
... ... @@ -311,24 +311,20 @@
311 311  
312 312  (% style="color:#000000" %){
313 313  
314 -(% class="western" %)
315 -{{{ "vehicleId": “”, // идентификатор объекта
316 - "name": "", // имя объекта
317 - "imei": "", // IMEI объекта
318 - "deviceTypeId": “”, // идентификатор устройства объекта
319 - "deviceTypeName": "" // наименование устройства объекта
320 - "parentId": "", // идентификатор клиента-родителя
321 - "parentName": "" // наименование клиента-родителя,
322 - "modelId": "", // идентификатор модели объекта
323 - "modelName": "" // наименование модели объекта,
324 - "unitId": "", // идентификатор подразделения
325 - "unitName": "", // наименование подразделения
326 - "status": “”, // статус объекта
327 - ...
328 - },
329 - ...}}}
370 + "vehicleId": "" , ~/~/ идентификатор объекта
371 + "name": "" , ~/~/ имя объекта
372 + "imei": "" , ~/~/ IMEI объекта
373 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
374 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
375 + "parentId": "" , ~/~/ идентификатор клиента-родителя
376 + "parentName": "" , ~/~/ наименование клиента-родителя,
377 + "modelId": "" , ~/~/ идентификатор модели объекта
378 + "modelName": "" , ~/~/ наименование модели объекта,
379 + "unitId": "" , ~/~/ идентификатор подразделения
380 + "unitName": "" , ~/~/ наименование подразделения
381 + "status": "" , ~/~/ статус объекта
330 330  
331 -(% style="color:#000000" %)}
383 +}
332 332  
333 333  (% style="text-align:left" %)
334 334  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -350,95 +350,92 @@
350 350  
351 351  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
352 352  
353 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
405 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
354 354  
355 -(% class="western" %)
356 -{{{ "parentId": "", // ID клиента
357 - "name": "", // имя ТС
358 - "imei": "", // IMEI
359 - "deviceTypeId": "",// ID типа устройства
360 - "modelId": "",
361 - "unitId": "", // ID подразделения
362 - "sim1": "", // Номер SIM 1
363 - "sim2": "", // Номер SIM2
364 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
365 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
366 - "consumptionIdle": "",// Расход топлива на холостом ходу
367 - "counters": {
368 - "mileage": "", // пробег
369 - "mileageEnabled": true, // флаг активности счётчика "пробег"
370 - "motohours":"", // моточасы
371 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
372 - },
373 - "cmsv6Parameters": { // параметры CMSv6
374 - "enabled": true, // флаг включения
375 - //"id": "", // идентификатор
376 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
377 - "login": "", // имя учетной записи
378 - "password": "" // пароль учетной записи
407 +(% style="color:#000000" %){
408 +
409 + "parentId": "" , ~/~/ ID клиента
410 + "name": "" , ~/~/ имя ТС
411 + "imei": "" , ~/~/ IMEI
412 + "deviceTypeId": "" , ~/~/ ID типа устройства
413 + "modelId": "" , ~/~/ ID модели
414 + "unitId": "" , ~/~/ ID подразделения
415 + "sim1": "" , ~/~/ Номер SIM 1
416 + "sim2": "" , ~/~/ Номер SIM2
417 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
418 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
419 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
420 + "counters": {
421 + "mileage": "" , ~/~/ пробег
422 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
423 + "motohours": "" , ~/~/ моточасы
424 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
379 379   },
380 - "inspectionTasks": [ // задания на ТО
381 - {
382 - "enabled": "", // Признак включения
383 - "name": "", // Имя задания
384 - "description": "", // Описание задания
385 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
386 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
387 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
388 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
389 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
390 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
391 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
392 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
426 + "cmsv6Parameters": { ~/~/ параметры CMSv6
427 + "enabled": true, ~/~/ флаг включения
428 + "id": "" , ~/~/ идентификатор
429 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
430 + "login": "" , ~/~/ имя учетной записи
431 + "password": "" ~/~/ пароль учетной записи
393 393   },
394 - ]}}}
433 + "inspectionTasks": ~/~/ задания на ТО
434 + {
435 + "enabled": "" , ~/~/ Признак включения
436 + "name": "" , ~/~/ Имя задания
437 + "description": "" , ~/~/ Описание задания
438 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
439 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
440 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
441 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
442 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
443 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
444 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
445 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
446 + }
395 395  
396 -(% style="color:#000000" %)… }
448 +(% style="color:#000000" %) }
397 397  
398 398  (% style="color:#000000" %)Ответ:
399 399  
400 400  (% style="color:#000000" %){
401 401  
402 -(% class="western" %)
403 -{{{ "vehicleId": "", //ID ТС
404 - "parentId": "", //Guid владельца ТС
405 - "name": "", //Имя объекта
406 - "imei": "", //IMEI
407 - "deviceTypeId": "", //ID типа устройства
408 - "modelId": "", //ID модели
409 - "unitId": "", //ID подразделения
410 - "sim1": "", //SIM1
411 - "sim2": "", //SIM2
412 - "consumptionPer100Km": "", //Расход топлива на 100 км
413 - "consumptionIdle": "", //Расход топлива на холостом ходу
414 - "counters": { //Счётчики
415 - "mileageEnabled": true,
416 - "motohoursEnabled": true,
417 - "mileage": "",
418 - "motohours": 345.0
419 - },
420 - "cmsv6Parameters": { //Параметры CmsV6
421 - "id": null,
422 - "enabled": true, //флаг включения
423 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
424 - "login": "", // имя учетной записи
425 - "password": "" // пароль учетной записи
426 - },
427 - "inspectionTasks": [ // задания на ТО
428 - {
429 - "id": "", // ID задачи
430 - "enabled": false, // Признак включения
431 - "name": "", // Имя задания
432 - "description": "", // Описание задания
433 - "mileageCondition": "", // Условие по пробегу
434 - "lastMileage": "", // Пробег (в метрах)
435 - "motohoursCondition": "", // Условие по моточасам
436 - "lastMotohours": "", // Моточасы
437 - "periodicCondition": "", // Условие периодичности по времени
438 - "kind": "", // Вид периодичности по времени
439 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
440 - }
441 - ]}}}
454 + "vehicleId": "", ~/~/ID ТС 
455 + "parentId": "", ~/~/Guid владельца ТС
456 + "name": "", ~/~/Имя объекта
457 + "imei": "", ~/~/IMEI
458 + "deviceTypeId": "", ~/~/ID типа устройства
459 + "modelId": "", ~/~/ID модели
460 + "unitId": "", ~/~/ID подразделения
461 + "sim1": "", ~/~/SIM1
462 + "sim2": "", ~/~/SIM2
463 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
464 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
465 + "counters": { ~/~/Счётчики
466 + "mileageEnabled": true,
467 + "motohoursEnabled": true,
468 + "mileage": "",
469 + "motohours": 345.0
470 + },
471 + "cmsv6Parameters": { ~/~/Параметры CmsV6
472 + "id": null,
473 + "enabled": true, ~/~/флаг включения
474 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
475 + "login": "", ~/~/ имя учетной записи
476 + "password": "" ~/~/ пароль учетной записи
477 + },
478 + "inspectionTasks": { ~/~/ задания на ТО
479 + "id": "", ~/~/ ID задачи
480 + "enabled": false, ~/~/ Признак включения
481 + "name": "", ~/~/ Имя задания
482 + "description": "", ~/~/ Описание задания
483 + "mileageCondition": "", ~/~/ Условие по пробегу
484 + "lastMileage": "", ~/~/ Пробег (в метрах)
485 + "motohoursCondition": "", ~/~/ Условие по моточасам
486 + "lastMotohours": "", ~/~/ Моточасы
487 + "periodicCondition": "", ~/~/ Условие периодичности по времени
488 + "kind": "", ~/~/ Вид периодичности по времени 
489 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
490 + }
442 442  
443 443  (% style="text-align:left" %)
444 444  (% style="color:#000000" %)}
... ... @@ -457,11 +457,11 @@
457 457  
458 458  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
459 459  
460 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
509 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
461 461  
462 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
511 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
463 463  
464 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
513 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
465 465  
466 466  (% style="color:#000000" %)Метод запроса: **POST**
467 467  
... ... @@ -475,19 +475,41 @@
475 475  
476 476  (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
477 477  
478 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
527 +(% class="western" style="color:#000000" %)##{##
479 479  
480 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
529 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
530 + "name": null, ~/~/ Имя ТС (string, опционально) 
531 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
532 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
533 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
534 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
535 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
536 +(% style="color:#000000" %)}
481 481  
482 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
538 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
483 483  
484 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
540 +(% style="color:#000000" %)Ответ:
485 485  
486 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
542 +(% style="color:#000000" %){
487 487  
488 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
544 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
545 + "name": "" ~/~/ наименование объекта
546 + "imei": "" ~/~/ IMEI объекта
547 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
548 + "deviceTypeName": "" ~/~/ наименование типа устройства
549 + "sim1": "" ~/~/ первый номер телефона
550 + "sim2": "" ~/~/ второй номер телефона
551 + "parentId": "" ~/~/ идентификатор клиента-родителя
552 + "parentName": "" ~/~/ наименование клиента-родителя
553 + "modelId": "" ~/~/ идентификатор модели объекта
554 + "modelName": "" ~/~/ наименование модели объекта
555 + "unitId": "" ~/~/ идентификатор подразделения
556 + "unitName": "" ~/~/ наименование подразделения
557 + "status": "" ~/~/ статус объекта         
558 + "createdAt": "" ~/~/ дата создания объектов  (%%)
559 +(% style="color:#000000" %)}
489 489  
490 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
561 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
491 491  
492 492  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
493 493  
... ... @@ -507,32 +507,34 @@
507 507  
508 508  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
509 509  
510 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
581 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
511 511  
512 -(% class="western" %)
513 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
514 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
515 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
516 - "date": "", // Дата смены статуса (null если сменить немедленно)
517 - "description": "", // Описание
518 - "data": "", // Данные
519 - "overwrite": false, // Флаг перезаписи
520 - "stage": "", // Состояние, может быть null}}}
583 +(% style="color:#000000" %){
521 521  
585 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
586 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
587 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
588 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
589 + "description": "", ~/~/ Описание
590 + "data": "", ~/~/ Данные
591 + "overwrite": false, ~/~/ Флаг перезаписи
592 + "stage": "", ~/~/ Состояние, может быть null
593 +
522 522  (% style="color:#000000" %)}
523 523  
524 -(% style="color:#000000" %)Ответ: {
596 +(% style="color:#000000" %)Ответ:
525 525  
526 -(% class="western" %)
527 -{{{ "status": "", // значение статуса
528 - "date": "", // Дата смены статуса
529 - "description": "", // Описание
530 - "data": "", // Данные
531 - "overwrite": false, // Флаг перезаписи
532 - "stage": "", // Состояние}}}
598 +(% style="color:#000000" %){
533 533  
600 + "status": "", ~/~/ значение статуса
601 + "date": "", ~/~/ Дата смены статуса 
602 + "description": "", ~/~/ Описание
603 + "data": "", ~/~/ Данные
604 + "overwrite": false, ~/~/ Флаг перезаписи
605 + "stage": "", ~/~/ Состояние
606 +
534 534  (% style="text-align:left" %)
535 -(% style="color:#000000" %)}
608 +(% style="color:#000000" %) }
536 536  
537 537  
538 538  (% class="box warningmessage" %)
... ... @@ -550,14 +550,102 @@
550 550  
551 551  (% style="color:#000000" %)Параметры в теле запроса (JSON):
552 552  
553 -(% 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»: «» //Сколько раз выполнить задание } ] }
626 +(% style="color:#000000" %){    
554 554  
628 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
629 + "parentId": "", ~/~/ ID клиента
630 + "name": "", ~/~/ имя ТС
631 + "imei": "", ~/~/ IMEI
632 + "deviceTypeId": "", ~/~/ ID типа устройства
633 + "modelId": "", ~/~/ , ID модели    
634 + "unitId": "", ~/~/ подразделения
635 + "sim1": "", ~/~/ SIM 1
636 + "sim2": "", ~/~/ SIM2
637 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
638 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
639 + "counters": 
640 + {
641 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
642 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
643 + "mileage": «», пробег
644 + "motohours": «» моточасы
645 + }
646 + "cmsv6Parameters": ~/~/ параметры CMSv6
647 + {       
648 + "id": "", ~/~/ идентификатор
649 + "enabled": true, ~/~/ флаг включения
650 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
651 + "login": "", ~/~/ имя учетной записи
652 + "password": "", ~/~/ пароль учетной записи
653 + }
654 + "inspectionTasks": ~/~/ задания на ТО
655 + {
656 + "id": "", ~/~/ ID задания
657 + "enabled": false, ~/~/ Признак включения
658 + "name": "", ~/~/ Имя задания
659 + "description": "", ~/~/ Описание задания
660 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
661 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
663 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
664 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
665 + "kind": "", ~/~/ Вид периодичности по времени
666 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
667 + } 
668 +
669 +(% style="color:#000000" %)}
670 +
555 555  (% style="color:#000000" %)Ответ:
556 556  
557 557  (% lang="en-US" style="text-align:left" %)
558 -(% 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»: «» //Сколько раз выполнить задание } ] }
674 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
559 559  
676 +(% lang="en-US" style="text-align:left" %)
677 + "vehicleId": "", ~/~/ ID ТС
678 + "parentId": "", ~/~/ ID клиента
679 + "name": "", ~/~/ имя ТС
680 + "imei": "", ~/~/ IMEI
681 + "deviceTypeId": "", ~/~/ типа устройства
682 + "modelId": "", ~/~/ ID модели
683 + "unitId": "", ~/~/ ID подразделения
684 + "sim1": "", ~/~/ SIM 1
685 + "sim2": "", ~/~/ SIM2
686 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
687 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
688 + "counters": 
689 + {
690 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
691 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
692 + "mileage": "", ~/~/ пробег
693 + "motohours": "", ~/~/ моточасы
694 + }
695 + "cmsv6Parameters": ~/~/ параметры CMSv6
696 + {
697 + "id": ~/~/ идентификатор
698 + "enabled": true, ~/~/ флаг включения
699 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
700 + "login": "", ~/~/ имя учетной записи
701 + "password": "", ~/~/ пароль учетной записи
702 + }
703 + "inspectionTasks": ~/~/ задания на ТО
704 + {
705 + "id": "", ~/~/ ID задания
706 + "enabled": false, ~/~/ Признак включения
707 + "name": "", ~/~/ Имя задания
708 + "description": "", ~/~/ Описание задания
709 + "mileageCondition": "", ~/~/ Условие по пробегу
710 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
711 + "motohoursCondition": "", ~/~/ Условие по моточасам
712 + "lastMotohours": "", ~/~/ Моточасы
713 + "periodicCondition": "", ~/~/ Условие периодичности по времени
714 + "kind": "", ~/~/ Вид периодичности по времени
715 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
716 + }
560 560  
718 +(% lang="en-US" style="text-align:left" %)
719 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
720 +
721 +
561 561  (% class="box errormessage" %)
562 562  (((
563 563  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -595,16 +595,15 @@
595 595  
596 596  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
597 597  
598 -(% style="color:#000000" %)Ответ: [
759 +(% style="color:#000000" %)Ответ:
599 599  
600 -(% class="western" %)
601 -{{{ {
602 - "deviceTypeId" : "", // ID типа устройства
603 - "deviceTypeName" : "" // Название типа устройства
604 - },}}}
761 +(% style="color:#000000" %){
605 605  
763 + "deviceTypeId" : "", ~/~/ ID типа устройства
764 + "deviceTypeName" : "" ~/~/ Название типа устройства
765 +
606 606  (% style="text-align:left" %)
607 -(% style="color:#000000" %)…** **]
767 +(% style="color:#000000" %)}
608 608  
609 609  
610 610  (% class="box" style="text-align: center;" %)
... ... @@ -625,19 +625,16 @@
625 625  
626 626  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
627 627  
628 -(% style="color:#000000" %)Ответ: [
788 +(% style="color:#000000" %)Ответ:
629 629  
630 -(% class="western" style="margin-bottom:19px" %)
631 -{{{ {}}}
790 +(% style="color:#000000" %){
632 632  
633 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
792 + "id": "", ~/~/ ID типа датчика 
793 + "name": "", ~/~/ Название
794 + "description": "", ~/~/ Описание
634 634  
635 -(% class="western" %)
636 -{{{ "description": "" // Описание
637 - },}}}
638 -
639 639  (% style="text-align:left" %)
640 -(% style="color:#000000" %)… ]
797 +(% style="color:#000000" %)}
641 641  
642 642  
643 643  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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