Last modified by Андрей Калиновский on 2025/06/10 15:42
From version 1.1 >
edited by Андрей Калиновский
on 2022/05/16 11:15
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
... ... @@ -1,11 +1,16 @@
1 -== Описание ГЛОНАССSoft Public API
2 - ==
1 +== Описание ГЛОНАССSoft Public API ==
3 3  
3 +== ==
4 +
4 4   **Действующие ограничения**
6 +
5 5  
6 -Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
8 +- Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
7 7  
10 +- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
11 +
8 8  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
13 +\\
9 9  
10 10   **Авторизация**
11 11  
... ... @@ -18,6 +18,7 @@
18 18  В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
19 19  
20 20  Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
26 +
21 21  
22 22   **Получение списка объектов**
23 23  
... ... @@ -45,17 +45,11 @@
45 45  
46 46  Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
47 47  
48 -{{{ {"vehicleId": null,//84350, // ID ТС (int, опционально)
49 - "name": null, // Имя ТС (string, опционально)
50 - "imei": null,//"710179307", // IMEI (string, опционально)
51 - "sim": null,//"938112", // Номер телефона (string, опционально)
52 - "deviceTypeId": null,//5 // ID типа устройства (short, опционально)
53 - "parentId": null, // ID клиента (Guid, опционально)
54 - "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
54 +{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
55 55  
56 56  Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
57 57  
58 -Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «» // статус объекта }, … ]
58 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
59 59  
60 60  Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
61 61  
... ... @@ -86,6 +86,7 @@
86 86  12 - «Проверен»
87 87  
88 88  13 - «Не эксплуатируется»
89 +
89 89  
90 90   **Получение списка клиентов.**
91 91  
... ... @@ -108,6 +108,7 @@
108 108  Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
109 109  
110 110  Примечание. Возможные значение параметра agentInfoType:
112 +
111 111  
112 112   **Получение списка пользователей.**
113 113  
... ... @@ -133,6 +133,7 @@
133 133  {{{ "sessionDuration": "", // длительность сессии в минутах}}}
134 134  
135 135   «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
138 +
136 136  
137 137   **Получение списка типов устройств**
138 138  
... ... @@ -152,6 +152,7 @@
152 152   },}}}
153 153  
154 154  … ]
158 +
155 155  
156 156   **Получение списка типов датчиков**
157 157  
... ... @@ -173,6 +173,7 @@
173 173   },}}}
174 174  
175 175  … ]
180 +
176 176  
177 177   **Получение информации об объекте**
178 178  
... ... @@ -213,6 +213,7 @@
213 213  }
214 214  
215 215  Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
221 +
216 216  
217 217   **Добавление пользователя**
218 218  
... ... @@ -227,6 +227,7 @@
227 227  Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
228 228  
229 229  Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
236 +
230 230  
231 231   **Редактирование пользователя**
232 232  
... ... @@ -246,6 +246,7 @@
246 246  }
247 247  
248 248  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
256 +
249 249  
250 250   **Удаление пользователя**
251 251  
... ... @@ -258,6 +258,7 @@
258 258  Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
259 259  
260 260  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
269 +
261 261  
262 262   **Добавление объекта**
263 263  
... ... @@ -359,6 +359,7 @@
359 359   ]}}}
360 360  
361 361  }
371 +
362 362  
363 363   **Удаление объекта**
364 364  
... ... @@ -373,6 +373,7 @@
373 373  В заголовках запроса: X-Auth: Токен авторизации
374 374  
375 375  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
386 +
376 376  
377 377   **Редактирование объекта**
378 378  
... ... @@ -391,6 +391,7 @@
391 391  Ответ:
392 392  
393 393  { «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 +
394 394  
395 395   **Изменение статуса объекта**
396 396  
... ... @@ -425,6 +425,7 @@
425 425   "stage": "", // Состояние}}}
426 426  
427 427  }
440 +
428 428  
429 429   **Проверка авторизации**
430 430  

Меню

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