Версия 20.6 от Артем Шемяков на 2022/09/01 17:41
Последние авторы
1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 == Описание ГЛОНАССSoft Public API 3.0 ==
3
4 == ==
5
6 (% class="box" style="text-align: center;" %)
7 (((
8 (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 )))
10
11 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12
13 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14
15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16
17
18 (% class="box" style="text-align: center;" %)
19 (((
20 (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 )))
22
23 (% class="box infomessage" %)
24 (((
25 (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 )))
27
28 (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29
30 (% style="color:#000000" %)Метод запроса: **GET**
31
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
34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35
36 (% lang="en-US" %)
37 (% style="color:#000000" %)**Ответ:**
38
39 (% lang="en-US" %)
40 (% style="color:#000000" %){
41
42 (% lang="en-US" %)
43 (% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 "User": "" , ~/~/ имя пользователя
45
46 (% lang="en-US" %)
47 }
48
49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50
51
52 (% class="box infomessage" %)
53 (((
54 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
55 )))
56
57 (% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
58
59 (% style="color:#000000" %)Метод запроса: **GET**
60
61 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
62
63 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
64
65 (% lang="en-US" %)
66 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
67
68
69 (% class="box" style="text-align: center;" %)
70 (((
71 (% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
72 )))
73
74 (% class="box infomessage" %)
75 (((
76 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
77 )))
78
79 (% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
80
81 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82
83 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84
85 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
86
87 (% style="color:#000000" %)Метод запроса: **GET**
88
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
91 (% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
92
93 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94
95 (% style="color:#000000" %)Ответ:
96
97 (% style="color:#000000" %){
98 "agentId": "", ~/~/ идентификатор клиента
99 "parentId": "", ~/~/ идентификатор клиента-родителя
100 "name": "", ~/~/ наименование клиента
101 "fullName": "", ~/~/ полное наименование клиента
102 "agentInfoType": "", ~/~/ тип клиента1
103 "status": "", ~/~/ статус клиента
104 }
105
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 (% class="box" style="text-align: center;" %)
111 (((
112 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
113 )))
114
115 (% class="box successmessage" %)
116 (((
117 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
118 )))
119
120 (% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
121
122 (% style="color:#000000" %)Метод запроса: **POST**
123
124 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
125
126 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
127
128 (% style="color:#000000" %)Параметры в теле запроса (JSON):
129
130 (% style="color:#000000" %){ 
131 "lastName": "", ~/~/ фамилия
132 "firstName": "", ~/~/ имя
133 "position": "", ~/~/ должность
134 "phone": "", ~/~/ телефон
135 "organization": "", ~/~/ организация
136 "login": "", ~/~/ логин
137 "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 "email": "", ~/~/ email
139 "description": "", ~/~/ описание
140 "isEnabled": "", ~/~/ признак включения
141 "parentId": "", ~/~/ Guid родительского агента
142 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
143 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
144 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
145 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 "groups": "" , ~/~/ группы пользователя, названия групп
148 }
149
150 (% style="text-align:left" %)
151 (% style="color:#000000; font-weight:normal" %)Ответ:
152
153 (% style="text-align:left" %)
154 (% style="color:#000000; font-weight:normal" %){
155
156 (% style="text-align:left" %)
157 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
158 "lastName": "" , ~/~/ Фамилия ,
159 "firstName": "" , ~/~/ Имя
160 "position": "" , ~/~/ Должность
161 "phone": "" , ~/~/ Телефон
162 "organization": "" , ~/~/ Организация
163 "login": "" , ~/~/ Логин
164 "password": "" , ~/~/ Пароль
165 "email": "" , ~/~/ Email
166 "description": "" , ~/~/ Описание
167 "isEnabled": "" , ~/~/ Признак включения
168 "parentId": "" , ~/~/ Guid родительского агента
169 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
170 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
171 "kind": "" , ~/~/ тип аутентификации
172 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
173 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
174
175 (% style="text-align:left" %)
176 (% style="color:#000000; font-weight:normal" %) }
177
178
179 (% class="box successmessage" %)
180 (((
181 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
182 )))
183
184 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
185
186 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
187
188 (% style="color:#000000" %)Метод запроса: **POST**
189
190 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
191
192 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
193
194 (% style="color:#000000" %){
195
196 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
197 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
198 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
200
201 (% style="color:#000000" %) }
202
203 (% style="color:#000000" %)Ответ:
204
205 (% style="color:#000000" %){ (%%)
206
207 "id": "" , ~/~/ идентификатор пользователя
208 "lastName": "" , ~/~/ фамилия
209 "firstName": "" , ~/~/ имя
210 "position": "" , ~/~/ должность
211 "phone": "" , ~/~/ телефон
212 "parentId": "" , ~/~/ идентификатор клиента-родителя
213 "parentName": "" , ~/~/ наименование клиента-родителя
214 "organization": "" , ~/~/ организация
215 "login": "" , ~/~/ логин
216 "email": "" , ~/~/ E-mail
217 "sessionDuration":"", ~/~/ длительность сессии в минутах
218 "status": "1",  ~/~/ статус пользователя
219 "astLogged": "", ~/~/ дата/время последней авторизации
220
221 (% style="color:#000000" %) }
222
223
224 (% class="box warningmessage" %)
225 (((
226 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
227 )))
228
229 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
230
231 (% style="color:#000000" %)Метод запроса: **PUT**
232
233 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
234
235 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
236
237 (% lang="en-US" style="text-align:left" %)
238 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
239
240 (% lang="en-US" style="text-align:left" %)
241 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){
242
243 (% lang="en-US" style="text-align:left" %)
244 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
245 "lastName": "" , ~/~/ фамилия
246 "firstName": "" , ~/~/ имя
247 "position": "" , ~/~/ должность
248 "phone": "" , ~/~/ телефон
249 "organization": "" , ~/~/ организация
250 "login": "" , ~/~/ логин
251 "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
252 "email": "" , ~/~/ email
253 "description": "" , ~/~/ описание
254 "isEnabled": "" , ~/~/ признак включения
255 "parentId": "" , ~/~/ Guid родительского агента
256 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
257 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
258 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
259 "kind": "" , ~/~/ тип аутентификации
260 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
261 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
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" %)//{ //
271
272 (% lang="en-US" style="text-align:left" %)
273 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
274 "lastName": "" , ~/~/ фамилия
275 "firstName": "" , ~/~/ имя
276 "position": "" , ~/~/ должность
277 "phone": "" , ~/~/ телефон
278 "organization": "" , ~/~/ организация
279 "login": "" , ~/~/ логин
280 "password": "" , ~/~/ пароль 
281 "email": "" , ~/~/ email
282 "description": "" , ~/~/ описание
283 "isEnabled": "" , ~/~/ признак включения
284 "parentId": "" , ~/~/ Guid родительского агента
285 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
286 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
287 "kind": "" , ~/~/ тип аутентификации
288 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
289 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
290
291 (% lang="en-US" style="text-align:left" %)
292 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
293
294
295 (% class="box warningmessage" %)
296 (((
297 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
298 )))
299
300 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
301
302 (% style="color:#000000" %)Метод запроса: **PUT**
303
304 (% 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} Параметр запроса:
305
306 (% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
307
308 (% class="western" %)
309 {{{ "description": "", // описание
310 "data": "" // данные, связанные со сменой статуса}}}
311
312 (% style="color:#000000" %)}
313
314 (% style="text-align:left" %)
315 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
316
317
318 (% class="box errormessage" %)
319 (((
320 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
321 )))
322
323 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
324
325 (% style="color:#000000" %)Метод запроса: **DELETE**
326
327 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
328
329 (% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
330
331 (% style="text-align:left" %)
332 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
333
334
335 (% class="box" style="text-align: center;" %)
336 (((
337 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
338 )))
339
340 (% class="box infomessage" %)
341 (((
342 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
343 )))
344
345 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
346
347 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
348
349 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
350
351 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
352
353 (% style="color:#000000" %)Метод запроса: **GET**
354
355 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
356
357 (% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
358
359 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
360
361 (% style="color:#000000" %)Ответ:
362
363 (% style="color:#000000" %){
364
365 (% class="western" %)
366 {{{ "vehicleId": “”, // идентификатор объекта
367 "name": "", // имя объекта
368 "imei": "", // IMEI объекта
369 "deviceTypeId": “”, // идентификатор устройства объекта
370 "deviceTypeName": "" // наименование устройства объекта
371 "parentId": "", // идентификатор клиента-родителя
372 "parentName": "" // наименование клиента-родителя,
373 "modelId": "", // идентификатор модели объекта
374 "modelName": "" // наименование модели объекта,
375 "unitId": "", // идентификатор подразделения
376 "unitName": "", // наименование подразделения
377 "status": “”, // статус объекта
378 ...
379 },
380 ...}}}
381
382 (% style="color:#000000" %)}
383
384 (% style="text-align:left" %)
385 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
386
387 (% style="text-align:left" %)
388 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
389
390
391 (% class="box successmessage" %)
392 (((
393 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
394 )))
395
396 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
397
398 (% style="color:#000000" %)Метод запроса: **POST**
399
400 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
401
402 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
403
404 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
405
406 (% class="western" %)
407 {{{ "parentId": "", // ID клиента
408 "name": "", // имя ТС
409 "imei": "", // IMEI
410 "deviceTypeId": "",// ID типа устройства
411 "modelId": "",
412 "unitId": "", // ID подразделения
413 "sim1": "", // Номер SIM 1
414 "sim2": "", // Номер SIM2
415 "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
416 "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
417 "consumptionIdle": "",// Расход топлива на холостом ходу
418 "counters": {
419 "mileage": "", // пробег
420 "mileageEnabled": true, // флаг активности счётчика "пробег"
421 "motohours":"", // моточасы
422 "motohoursEnabled": true // флаг активности счётчика "моточасы"
423 },
424 "cmsv6Parameters": { // параметры CMSv6
425 "enabled": true, // флаг включения
426 //"id": "", // идентификатор
427 "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
428 "login": "", // имя учетной записи
429 "password": "" // пароль учетной записи
430 },
431 "inspectionTasks": [ // задания на ТО
432 {
433 "enabled": "", // Признак включения
434 "name": "", // Имя задания
435 "description": "", // Описание задания
436 "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
437 "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
438 "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
439 "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
440 "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
441 "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
442 "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
443 "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
444 },
445 ]}}}
446
447 (% style="color:#000000" %)… }
448
449 (% style="color:#000000" %)Ответ:
450
451 (% style="color:#000000" %){
452
453 (% class="western" %)
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 {
480 "id": "", // ID задачи
481 "enabled": false, // Признак включения
482 "name": "", // Имя задания
483 "description": "", // Описание задания
484 "mileageCondition": "", // Условие по пробегу
485 "lastMileage": "", // Пробег (в метрах)
486 "motohoursCondition": "", // Условие по моточасам
487 "lastMotohours": "", // Моточасы
488 "periodicCondition": "", // Условие периодичности по времени
489 "kind": "", // Вид периодичности по времени
490 "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
491 }
492 ]}}}
493
494 (% style="text-align:left" %)
495 (% style="color:#000000" %)}
496
497
498 (% class="box successmessage" %)
499 (((
500 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
501 )))
502
503 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
504
505 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
506
507 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
508
509 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
510
511 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
512
513 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
514
515 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
516
517 (% style="color:#000000" %)Метод запроса: **POST**
518
519 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
520
521 (% style="color:#000000" %)В заголовках запроса:
522
523 (% style="color:#000000" %)− Content-Type: application/json
524
525 (% style="color:#000000" %)− X-Auth: Токен авторизации
526
527 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
528
529 (% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
530
531 (% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
532
533 (% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
534
535 (% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
536
537 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
538
539 (% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
540
541 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
542
543 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
544
545
546 (% class="box successmessage" %)
547 (((
548 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
549 )))
550
551 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
552
553 (% style="color:#000000" %)Метод запроса: **POST**
554
555 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
556
557 (% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
558
559 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
560
561 (% style="color:#000000" %)Параметры в теле запроса (JSON): {
562
563 (% class="western" %)
564 {{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
565   // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
566   // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
567 "date": "", // Дата смены статуса (null если сменить немедленно)
568 "description": "", // Описание
569 "data": "", // Данные
570 "overwrite": false, // Флаг перезаписи
571 "stage": "", // Состояние, может быть null}}}
572
573 (% style="color:#000000" %)}
574
575 (% style="color:#000000" %)Ответ: {
576
577 (% class="western" %)
578 {{{ "status": "", // значение статуса
579 "date": "", // Дата смены статуса
580 "description": "", // Описание
581 "data": "", // Данные
582 "overwrite": false, // Флаг перезаписи
583 "stage": "", // Состояние}}}
584
585 (% style="text-align:left" %)
586 (% style="color:#000000" %)}
587
588
589 (% class="box warningmessage" %)
590 (((
591 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
592 )))
593
594 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
595
596 (% style="color:#000000" %)Метод запроса: **PUT**
597
598 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
599
600 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
601
602 (% style="color:#000000" %)Параметры в теле запроса (JSON):
603
604 (% 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»: «» //Сколько раз выполнить задание } ] }
605
606 (% style="color:#000000" %)Ответ:
607
608 (% lang="en-US" style="text-align:left" %)
609 (% 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»: «» //Сколько раз выполнить задание } ] }
610
611
612 (% class="box errormessage" %)
613 (((
614 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
615 )))
616
617 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
618
619 (% style="color:#000000" %)Метод запроса: **DELETE**
620
621 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
622
623 (% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
624
625 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
626
627 (% style="text-align:left" %)
628 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
629
630
631 (% class="box" lang="en-US" style="text-align: center;" %)
632 (((
633 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
634 )))
635
636 (% class="box infomessage" %)
637 (((
638 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
639 )))
640
641 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
642
643 (% style="color:#000000" %)Метод запроса: **GET**
644
645 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
646
647 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
648
649 (% style="color:#000000" %)Ответ: [
650
651 (% class="western" %)
652 {{{ {
653 "deviceTypeId" : "", // ID типа устройства
654 "deviceTypeName" : "" // Название типа устройства
655 },}}}
656
657 (% style="text-align:left" %)
658 (% style="color:#000000" %)…** **]
659
660
661 (% class="box" style="text-align: center;" %)
662 (((
663 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
664 )))
665
666 (% class="box infomessage" %)
667 (((
668 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
669 )))
670
671 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
672
673 (% style="color:#000000" %)Метод запроса: **GET**
674
675 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
676
677 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
678
679 (% style="color:#000000" %)Ответ: [
680
681 (% class="western" style="margin-bottom:19px" %)
682 {{{ {}}}
683
684 (% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
685
686 (% class="western" %)
687 {{{ "description": "" // Описание
688 },}}}
689
690 (% style="text-align:left" %)
691 (% style="color:#000000" %)… ]
692
693
694 (% class="box" lang="en-US" style="text-align: center;" %)
695 (((
696 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
697 )))
ГЛОНАССSoft wiki - 2024 г.