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

Меню

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