Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 4.1 >
edited by Андрей Калиновский
on 2022/08/31 14:11
To version < 7.1 >
edited by Андрей Калиновский
on 2022/08/31 14:14
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -API
1 +Методы API для работы с ГЛОНАССSoft
Content
... ... @@ -5,7 +5,7 @@
5 5   **Действующие ограничения**
6 6  
7 7  
8 -- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
8 +- Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
9 9  
10 10  - Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
11 11  
... ... @@ -23,6 +23,7 @@
23 23  В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
24 24  
25 25  Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
26 +
26 26  
27 27   **Получение списка объектов**
28 28  
... ... @@ -85,6 +85,7 @@
85 85  12 - «Проверен»
86 86  
87 87  13 - «Не эксплуатируется»
89 +
88 88  
89 89   **Получение списка клиентов.**
90 90  
... ... @@ -107,6 +107,7 @@
107 107  Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
108 108  
109 109  Примечание. Возможные значение параметра agentInfoType:
112 +
110 110  
111 111   **Получение списка пользователей.**
112 112  
... ... @@ -132,6 +132,7 @@
132 132  {{{ "sessionDuration": "", // длительность сессии в минутах}}}
133 133  
134 134   «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
138 +
135 135  
136 136   **Получение списка типов устройств**
137 137  
... ... @@ -151,6 +151,7 @@
151 151   },}}}
152 152  
153 153  … ]
158 +
154 154  
155 155   **Получение списка типов датчиков**
156 156  
... ... @@ -172,6 +172,7 @@
172 172   },}}}
173 173  
174 174  … ]
180 +
175 175  
176 176   **Получение информации об объекте**
177 177  
... ... @@ -212,6 +212,7 @@
212 212  }
213 213  
214 214  Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
221 +
215 215  
216 216   **Добавление пользователя**
217 217  
... ... @@ -226,6 +226,7 @@
226 226  Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
227 227  
228 228  Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
236 +
229 229  
230 230   **Редактирование пользователя**
231 231  
... ... @@ -245,6 +245,7 @@
245 245  }
246 246  
247 247  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
256 +
248 248  
249 249   **Удаление пользователя**
250 250  
... ... @@ -257,6 +257,7 @@
257 257  Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
258 258  
259 259  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
269 +
260 260  
261 261   **Добавление объекта**
262 262  
... ... @@ -358,6 +358,7 @@
358 358   ]}}}
359 359  
360 360  }
371 +
361 361  
362 362   **Удаление объекта**
363 363  
... ... @@ -372,6 +372,7 @@
372 372  В заголовках запроса: X-Auth: Токен авторизации
373 373  
374 374  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
386 +
375 375  
376 376   **Редактирование объекта**
377 377  
... ... @@ -390,6 +390,7 @@
390 390  Ответ:
391 391  
392 392  { «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»: «» //Сколько раз выполнить задание } ] }
405 +
393 393  
394 394   **Изменение статуса объекта**
395 395  
... ... @@ -424,6 +424,7 @@
424 424   "stage": "", // Состояние}}}
425 425  
426 426  }
440 +
427 427  
428 428   **Проверка авторизации**
429 429  

Меню

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