Исходный код вики API

Версия 4.1 от Андрей Калиновский на 2022/08/31 14:11
Последние авторы
1 == Описание ГЛОНАССSoft Public API ==
2
3 == ==
4
5 **Действующие ограничения**
6
7
8 - Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
9
10 - Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
11
12 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
13 \\
14
15 **Авторизация**
16
17 Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
18
19 Метод запроса: GET
20
21 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]]
22
23 В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
24
25 Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
26
27 **Получение списка объектов**
28
29 Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
30
31 −возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
32
33 −возвращает информацию об объектах с учетом заданных настроек видимости объектов;
34
35 −информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
36
37 −информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
38
39 −информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
40
41 Метод запроса: POST
42
43 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
44
45 В заголовках запроса:
46
47 −Content-Type: application/json
48
49 −X-Auth: Токен авторизации
50
51 Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
52
53 {{{{"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, опционально)}}}}
54
55 Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
56
57 Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
58
59 Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
60
61 0 - «Блокировка»
62
63 1 - «Активен»,
64
65 2 - «Отменен»
66
67 3 - «Оборудован»
68
69 4 - «Диагностика»
70
71 5 - «Сервис»
72
73 6 - «Демонтаж»
74
75 7 - «Монтаж»
76
77 8 - «Дозаказ»
78
79 9 - «Обслужен»
80
81 10 - «Списан»
82
83 11 - «Неисправен»
84
85 12 - «Проверен»
86
87 13 - «Не эксплуатируется»
88
89 **Получение списка клиентов.**
90
91 Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
92
93 −информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
94
95 −возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
96
97 −информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
98
99 Метод запроса: GET
100
101 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
102
103 Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
104
105 В заголовках запроса: X-Auth: Токен авторизации
106
107 Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
108
109 Примечание. Возможные значение параметра agentInfoType:
110
111 **Получение списка пользователей.**
112
113 Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
114
115 Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
116
117 Метод запроса: POST
118
119 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
120
121 Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
122
123 {{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
124 //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
125 "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
126 //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
127
128 }
129
130 Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
131
132 {{{ "sessionDuration": "", // длительность сессии в минутах}}}
133
134 «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
135
136 **Получение списка типов устройств**
137
138 Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
139
140 Метод запроса: GET
141
142 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
143
144 В заголовках запроса:X-Auth: Токен авторизации
145
146 Ответ: [
147
148 {{{ {
149 "deviceTypeId" : "", // ID типа устройства
150 "deviceTypeName" : "" // Название типа устройства
151 },}}}
152
153 … ]
154
155 **Получение списка типов датчиков**
156
157 Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
158
159 Метод запроса: GET
160
161 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
162
163 В заголовках запроса:X-Auth: Токен авторизации
164
165 Ответ: [
166
167 {{{ {}}}
168
169 «id»: «», //ID типа датчика «name»: «», //Название
170
171 {{{ "description": "" // Описание
172 },}}}
173
174 … ]
175
176 **Получение информации об объекте**
177
178 Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
179
180 Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
181
182 −возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
183
184 Метод запроса: GET
185
186 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
187
188 Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
189
190 В заголовках запроса: X-Auth: Токен авторизации
191
192 Ответ:
193
194 {
195
196 {{{ "vehicleId": “”, // идентификатор объекта
197 "name": "", // имя объекта
198 "imei": "", // IMEI объекта
199 "deviceTypeId": “”, // идентификатор устройства объекта
200 "deviceTypeName": "" // наименование устройства объекта
201 "parentId": "", // идентификатор клиента-родителя
202 "parentName": "" // наименование клиента-родителя,
203 "modelId": "", // идентификатор модели объекта
204 "modelName": "" // наименование модели объекта,
205 "unitId": "", // идентификатор подразделения
206 "unitName": "", // наименование подразделения
207 "status": “”, // статус объекта
208 ...
209 },
210 ...}}}
211
212 }
213
214 Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
215
216 **Добавление пользователя**
217
218 Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
219
220 Метод запроса: POST
221
222 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
223
224 В заголовках запроса: X-Auth: Токен авторизации
225
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
228 Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
229
230 **Редактирование пользователя**
231
232 Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
233
234 Метод запроса: PUT
235
236 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
237
238 В заголовках запроса: X-Auth: Токен авторизации
239
240 Параметры в теле запроса (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» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
241
242 {{{ "description": "", // описание
243 "data": "" // данные, связанные со сменой статуса}}}
244
245 }
246
247 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
248
249 **Удаление пользователя**
250
251 Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
252
253 Метод запроса: DELETE
254
255 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
256
257 Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
258
259 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
260
261 **Добавление объекта**
262
263 Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
264
265 Метод запроса: POST
266
267 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
268
269 В заголовках запроса: X-Auth: Токен авторизации
270
271 Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
272
273 {{{ "parentId": "", // ID клиента
274 "name": "", // имя ТС
275 "imei": "", // IMEI
276 "deviceTypeId": "",// ID типа устройства
277 "modelId": "",
278 "unitId": "", // ID подразделения
279 "sim1": "", // Номер SIM 1
280 "sim2": "", // Номер SIM2
281 "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
282 "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
283 "consumptionIdle": "",// Расход топлива на холостом ходу
284 "counters": {
285 "mileage": "", // пробег
286 "mileageEnabled": true, // флаг активности счётчика "пробег"
287 "motohours":"", // моточасы
288 "motohoursEnabled": true // флаг активности счётчика "моточасы"
289 },
290 "cmsv6Parameters": { // параметры CMSv6
291 "enabled": true, // флаг включения
292 //"id": "", // идентификатор
293 "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
294 "login": "", // имя учетной записи
295 "password": "" // пароль учетной записи
296 },
297 "inspectionTasks": [ // задания на ТО
298 {
299 "enabled": "", // Признак включения
300 "name": "", // Имя задания
301 "description": "", // Описание задания
302 "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
303 "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
304 "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
305 "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
306 "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
307 "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
308 "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
309 "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
310 },
311 ]}}}
312
313 … }
314
315 Ответ:
316
317 {
318
319 {{{ "vehicleId": "", //ID ТС
320 "parentId": "", //Guid владельца ТС
321 "name": "", //Имя объекта
322 "imei": "", //IMEI
323 "deviceTypeId": "", //ID типа устройства
324 "modelId": "", //ID модели
325 "unitId": "", //ID подразделения
326 "sim1": "", //SIM1
327 "sim2": "", //SIM2
328 "consumptionPer100Km": "", //Расход топлива на 100 км
329 "consumptionIdle": "", //Расход топлива на холостом ходу
330 "counters": { //Счётчики
331 "mileageEnabled": true,
332 "motohoursEnabled": true,
333 "mileage": "",
334 "motohours": 345.0
335 },
336 "cmsv6Parameters": { //Параметры CmsV6
337 "id": null,
338 "enabled": true, //флаг включения
339 "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
340 "login": "", // имя учетной записи
341 "password": "" // пароль учетной записи
342 },
343 "inspectionTasks": [ // задания на ТО
344 {
345 "id": "", // ID задачи
346 "enabled": false, // Признак включения
347 "name": "", // Имя задания
348 "description": "", // Описание задания
349 "mileageCondition": "", // Условие по пробегу
350 "lastMileage": "", // Пробег (в метрах)
351 "motohoursCondition": "", // Условие по моточасам
352 "lastMotohours": "", // Моточасы
353 "periodicCondition": "", // Условие периодичности по времени}}}
354
355 {{{ "kind": "", // Вид периодичности по времени
356 "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
357 }
358 ]}}}
359
360 }
361
362 **Удаление объекта**
363
364 Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
365
366 Метод запроса: DELETE
367
368 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
369
370 Параметр запроса: {id} - Guid объекта
371
372 В заголовках запроса: X-Auth: Токен авторизации
373
374 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
375
376 **Редактирование объекта**
377
378 Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
379
380 Метод запроса: PUT
381
382 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
383
384 В заголовках запроса: X-Auth: Токен авторизации
385
386 Параметры в теле запроса (JSON):
387
388 //Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
389
390 Ответ:
391
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»: «» //Сколько раз выполнить задание } ] }
393
394 **Изменение статуса объекта**
395
396 Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
397
398 Метод запроса: POST
399
400 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
401
402 Параметр запроса: {vehicleId} - ID ТС
403
404 В заголовках запроса: X-Auth: Токен авторизации
405
406 Параметры в теле запроса (JSON): {
407
408 {{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
409 "date": "", // Дата смены статуса (null если сменить немедленно)
410 "description": "", // Описание
411 "data": "", // Данные
412 "overwrite": false, // Флаг перезаписи
413 "stage": "", // Состояние, может быть null}}}
414
415 }
416
417 Ответ: {
418
419 {{{ "status": "", // значение статуса
420 "date": "", // Дата смены статуса
421 "description": "", // Описание
422 "data": "", // Данные
423 "overwrite": false, // Флаг перезаписи
424 "stage": "", // Состояние}}}
425
426 }
427
428 **Проверка авторизации**
429
430 Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
431
432 Метод запроса: GET
433
434 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
435
436 В заголовках запроса: X-Auth: Токен авторизации
437
438 Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
439
440 **Расширенное описание API доступно по запросу на support@glonasssoft.ru**

Меню

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