Версия 28.5 от Артем Шемяков на 2022/09/22 09:57
Последние авторы
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 successmessage" %)
24 (((
25 (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 )))
27
28 (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29
30 (% style="color:#000000" %)Метод запроса: **POST**
31
32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33
34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35
36 (% style="color:#000000" %)Параметры в теле запроса (JSON):
37
38 (% style="color:#000000" %){
39 "login": "testuser",
40 "password": "testuser"
41 }(%%)
42
43
44 (% style="color:#000000" %)**Ответ:**
45
46 (% lang="en-US" %)
47 (% style="color:#000000" %){
48
49 (% lang="en-US" %)
50 (% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 "User": "testuser" , ~/~/ имя пользователя
52
53 (% lang="en-US" %)
54 }
55
56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57
58
59 (% class="box infomessage" %)
60 (((
61 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 )))
63
64 (% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65
66 (% style="color:#000000" %)Метод запроса: **GET**
67
68 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
69
70 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
71
72 (% lang="en-US" %)
73 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74
75
76 (% class="box" style="text-align: center;" %)
77 (((
78 (% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 )))
80
81 (% class="box infomessage" %)
82 (((
83 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 )))
85
86 (% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87
88 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89
90 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91
92 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93
94 (% style="color:#000000" %)Метод запроса: **GET**
95
96 (% 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>
97
98 (% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
99
100 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
101
102 (% style="color:#000000" %)Ответ:
103
104 (% style="color:#000000" %){
105 "agentId": "", ~/~/ идентификатор клиента
106 "parentId": "", ~/~/ идентификатор клиента-родителя
107 "name": "", ~/~/ наименование клиента
108 "fullName": "", ~/~/ полное наименование клиента
109 "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 }
112
113
114 (% class="box" style="text-align: center;" %)
115 (((
116 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
117 )))
118
119 (% class="box successmessage" %)
120 (((
121 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 )))
123
124 (% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
125
126 (% style="color:#000000" %)Метод запроса: **POST**
127
128 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
129
130 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
131
132 (% style="color:#000000" %)Параметры в теле запроса (JSON):
133
134 (% style="color:#000000" %){ 
135 "lastName": "", ~/~/ фамилия
136 "firstName": "", ~/~/ имя
137 "position": "", ~/~/ должность
138 "phone": "", ~/~/ телефон
139 "organization": "", ~/~/ организация
140 "login": "", ~/~/ логин
141 "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 "email": "", ~/~/ email
143 "description": "", ~/~/ описание
144 "isEnabled": "", ~/~/ признак включения
145 "parentId": "", ~/~/ Guid родительского агента
146 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 "groups": "" , ~/~/ группы пользователя, названия групп
152 }
153
154 (% style="text-align:left" %)
155 (% style="color:#000000; font-weight:normal" %)Ответ:
156
157 (% style="text-align:left" %)
158 (% style="color:#000000; font-weight:normal" %){    
159
160 (% style="text-align:left" %)
161 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
162 "lastName": "" , ~/~/ Фамилия ,
163 "firstName": "" , ~/~/ Имя
164 "position": "" , ~/~/ Должность
165 "phone": "" , ~/~/ Телефон
166 "organization": "" , ~/~/ Организация
167 "login": "" , ~/~/ Логин
168 "password": "" , ~/~/ Пароль
169 "email": "" , ~/~/ Email
170 "description": "" , ~/~/ Описание
171 "isEnabled": "" , ~/~/ Признак включения
172 "parentId": "" , ~/~/ Guid родительского агента
173 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
174 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 "kind": "" , ~/~/ тип аутентификации
176 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
178
179 (% style="text-align:left" %)
180 (% style="color:#000000; font-weight:normal" %)}
181
182
183 (% class="box successmessage" %)
184 (((
185 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
186 )))
187
188 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189
190 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191
192 (% style="color:#000000" %)Метод запроса: **POST**
193
194 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
195
196 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
197
198 (% style="color:#000000" %)Параметры в теле запроса (JSON):
199
200 (% style="color:#000000" %){
201
202 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
206
207 (% style="color:#000000" %)}
208
209 (% style="color:#000000" %)Ответ:
210
211 (% style="color:#000000" %){         (%%)
212
213 "id": "" , ~/~/ идентификатор пользователя
214 "lastName": "" , ~/~/ фамилия
215 "firstName": "" , ~/~/ имя
216 "position": "" , ~/~/ должность
217 "phone": "" , ~/~/ телефон
218 "parentId": "" , ~/~/ идентификатор клиента-родителя
219 "parentName": "" , ~/~/ наименование клиента-родителя
220 "organization": "" , ~/~/ организация
221 "login": "" , ~/~/ логин
222 "email": "" , ~/~/ E-mail
223 "sessionDuration":"", ~/~/ длительность сессии в минутах
224 "status": "1",  ~/~/ статус пользователя
225 "astLogged": "", ~/~/ дата/время последней авторизации
226
227 (% style="color:#000000" %)}
228
229
230 (% class="box warningmessage" %)
231 (((
232 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
233 )))
234
235 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
236
237 (% style="color:#000000" %)Метод запроса: **PUT**
238
239 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
240
241 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242
243 (% lang="en-US" style="text-align:left" %)
244 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
245
246 (% lang="en-US" style="text-align:left" %)
247 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
248
249 (% lang="en-US" style="text-align:left" %)
250 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
251 "lastName": "" , ~/~/ фамилия
252 "firstName": "" , ~/~/ имя
253 "position": "" , ~/~/ должность
254 "phone": "" , ~/~/ телефон
255 "organization": "" , ~/~/ организация
256 "login": "" , ~/~/ логин
257 "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 "email": "" , ~/~/ email
259 "description": "" , ~/~/ описание
260 "isEnabled": "" , ~/~/ признак включения
261 "parentId": "" , ~/~/ Guid родительского агента
262 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 "kind": "" , ~/~/ тип аутентификации
266 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
267 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
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" %)//Ответ~://
274
275 (% lang="en-US" style="text-align:left" %)
276 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
277
278 (% lang="en-US" style="text-align:left" %)
279 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
280 "lastName": "" , ~/~/ фамилия
281 "firstName": "" , ~/~/ имя
282 "position": "" , ~/~/ должность
283 "phone": "" , ~/~/ телефон
284 "organization": "" , ~/~/ организация
285 "login": "" , ~/~/ логин
286 "password": "" , ~/~/ пароль 
287 "email": "" , ~/~/ email
288 "description": "" , ~/~/ описание
289 "isEnabled": "" , ~/~/ признак включения
290 "parentId": "" , ~/~/ Guid родительского агента
291 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 "kind": "" , ~/~/ тип аутентификации
294 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
296
297 (% lang="en-US" style="text-align:left" %)
298 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
299
300
301 (% class="box warningmessage" %)
302 (((
303 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 )))
305
306 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
307
308 (% style="color:#000000" %)Метод запроса: **PUT**
309
310 (% 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}
311
312 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
313
314 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
315
316 (% style="color:#000000" %)Параметры в теле запроса (JSON):
317
318 (% style="color:#000000" %){
319
320 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
321 "description": "" , ~/~/ описание
322 "data": "" , ~/~/ данные, связанные со сменой статуса
323
324 (% style="color:#000000" %)}
325
326 (% style="text-align:left" %)
327 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328
329
330 (% class="box errormessage" %)
331 (((
332 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
333 )))
334
335 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
336
337 (% style="color:#000000" %)Метод запроса: **DELETE**
338
339 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
340
341 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
342
343 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
344
345 (% style="text-align:left" %)
346 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
347
348
349 (% class="box" style="text-align: center;" %)
350 (((
351 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
352 )))
353
354 (% class="box infomessage" %)
355 (((
356 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
357 )))
358
359 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
360
361 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
362
363 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
364
365 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
366
367 (% style="color:#000000" %)Метод запроса: **GET**
368
369 (% 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>
370
371 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
372
373 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
374
375 (% style="color:#000000" %)Ответ:
376
377 (% style="color:#000000" %){
378
379 "vehicleId": "" , ~/~/ идентификатор объекта
380 "name": "" , ~/~/ имя объекта
381 "imei": "" , ~/~/ IMEI объекта
382 "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 "parentId": "" , ~/~/ идентификатор клиента-родителя
385 "parentName": "" , ~/~/ наименование клиента-родителя,
386 "modelId": "" , ~/~/ идентификатор модели объекта
387 "modelName": "" , ~/~/ наименование модели объекта,
388 "unitId": "" , ~/~/ идентификатор подразделения
389 "unitName": "" , ~/~/ наименование подразделения
390 "status": "" , ~/~/ статус объекта
391
392 }
393
394 (% style="text-align:left" %)
395 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
396
397 (% style="text-align:left" %)
398 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
399
400
401 (% class="box successmessage" %)
402 (((
403 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
404 )))
405
406 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
407
408 (% style="color:#000000" %)Метод запроса: **POST**
409
410 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
411
412 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
413
414 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
415
416 (% style="color:#000000" %){
417
418 "parentId": "" , ~/~/ ID клиента
419 "name": "" , ~/~/ имя ТС
420 "imei": "" , ~/~/ IMEI
421 "deviceTypeId": "" , ~/~/ ID типа устройства
422 "modelId": "" , ~/~/ ID модели
423 "unitId": "" , ~/~/ ID подразделения
424 "sim1": "" , ~/~/ Номер SIM 1
425 "sim2": "" , ~/~/ Номер SIM2
426 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
427 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
428 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
429 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
430 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
431 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
432 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
433 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
434 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
435 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
436 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
437 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
438 "counters": {
439 "mileage": "" , ~/~/ пробег
440 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
441 "motohours": "" , ~/~/ моточасы
442 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
443 },
444 "cmsv6Parameters": { ~/~/ параметры CMSv6
445 "enabled": true, ~/~/ флаг включения
446 "id": "" , ~/~/ идентификатор
447 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
448 "login": "" , ~/~/ имя учетной записи
449 "password": "" ~/~/ пароль учетной записи
450 },
451 "inspectionTasks": ~/~/ задания на ТО
452 {
453 "enabled": "" , ~/~/ Признак включения
454 "name": "" , ~/~/ Имя задания
455 "description": "" , ~/~/ Описание задания
456 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
457 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
458 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
459 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
460 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
461 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
462 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
463 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
464 }
465
466 (% style="color:#000000" %) }
467
468 (% style="color:#000000" %)Ответ:
469
470 (% style="color:#000000" %){
471
472 "vehicleId": "", ~/~/ID ТС 
473 "parentId": "", ~/~/Guid владельца ТС
474 "name": "", ~/~/Имя объекта
475 "imei": "", ~/~/IMEI
476 "deviceTypeId": "", ~/~/ID типа устройства
477 "modelId": "", ~/~/ID модели
478 "unitId": "", ~/~/ID подразделения
479 "sim1": "", ~/~/SIM1
480 "sim2": "", ~/~/SIM2
481 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
482 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
483 "counters": { ~/~/Счётчики
484 "mileageEnabled": true,
485 "motohoursEnabled": true,
486 "mileage": "",
487 "motohours": 345.0
488 },
489 "cmsv6Parameters": { ~/~/Параметры CmsV6
490 "id": null,
491 "enabled": true, ~/~/флаг включения
492 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
493 "login": "", ~/~/ имя учетной записи
494 "password": "" ~/~/ пароль учетной записи
495 },
496 "inspectionTasks": { ~/~/ задания на ТО
497 "id": "", ~/~/ ID задачи
498 "enabled": false, ~/~/ Признак включения
499 "name": "", ~/~/ Имя задания
500 "description": "", ~/~/ Описание задания
501 "mileageCondition": "", ~/~/ Условие по пробегу
502 "lastMileage": "", ~/~/ Пробег (в метрах)
503 "motohoursCondition": "", ~/~/ Условие по моточасам
504 "lastMotohours": "", ~/~/ Моточасы
505 "periodicCondition": "", ~/~/ Условие периодичности по времени
506 "kind": "", ~/~/ Вид периодичности по времени 
507 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
508 }
509
510 (% style="text-align:left" %)
511 (% style="color:#000000" %)}
512
513 **Валидация:**
514 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
515 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
516 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
517
518
519 (% class="box successmessage" %)
520 (((
521 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
522 )))
523
524 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
525
526 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
527
528 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
529
530 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
531
532 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
533
534 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
535
536 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
537
538 (% style="color:#000000" %)Метод запроса: **POST**
539
540 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
541
542 (% style="color:#000000" %)В заголовках запроса:
543
544 (% style="color:#000000" %)− Content-Type: __**application/json**__
545
546 (% style="color:#000000" %)− X-Auth: Токен авторизации
547
548 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
549
550 (% style="color:#000000" %)Параметры в теле запроса (JSON):
551
552 (% class="western" style="color:#000000" %)##{##
553
554 (% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
555 "name": null, ~/~/ Имя ТС (string, опционально) 
556 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
557 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
558 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
559 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
560 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
561 (% style="color:#000000" %)}
562
563 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
564
565 (% style="color:#000000" %)Ответ:
566
567 (% style="color:#000000" %){
568
569 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
570 "name": "" ~/~/ наименование объекта
571 "imei": "" ~/~/ IMEI объекта
572 "deviceTypeId": "" ~/~/ идентификатор типа устройства
573 "deviceTypeName": "" ~/~/ наименование типа устройства
574 "sim1": "" ~/~/ первый номер телефона
575 "sim2": "" ~/~/ второй номер телефона
576 "parentId": "" ~/~/ идентификатор клиента-родителя
577 "parentName": "" ~/~/ наименование клиента-родителя
578 "modelId": "" ~/~/ идентификатор модели объекта
579 "modelName": "" ~/~/ наименование модели объекта
580 "unitId": "" ~/~/ идентификатор подразделения
581 "unitName": "" ~/~/ наименование подразделения
582 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
583 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
584 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
585 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
586 (% style="color:#000000" %)}
587
588 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
589
590
591 (% class="box successmessage" %)
592 (((
593 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
594 )))
595
596 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
597
598 (% style="color:#000000" %)Метод запроса: **POST**
599
600 (% 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}
601
602 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
603
604 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
605
606 (% style="color:#000000" %)Параметры в теле запроса (JSON):
607
608 (% style="color:#000000" %){
609
610 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
611 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
612 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
613 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
614 "description": "", ~/~/ Описание
615 "data": "", ~/~/ Данные
616 "overwrite": false, ~/~/ Флаг перезаписи
617 "stage": "", ~/~/ Состояние, может быть null
618
619 (% style="color:#000000" %)}
620
621 (% style="color:#000000" %)Ответ:
622
623 (% style="color:#000000" %){
624
625 "status": "", ~/~/ значение статуса
626 "date": "", ~/~/ Дата смены статуса 
627 "description": "", ~/~/ Описание
628 "data": "", ~/~/ Данные
629 "overwrite": false, ~/~/ Флаг перезаписи
630 "stage": "", ~/~/ Состояние
631
632 (% style="text-align:left" %)
633 (% style="color:#000000" %) }
634
635
636 (% class="box warningmessage" %)
637 (((
638 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
639 )))
640
641 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
642
643 (% style="color:#000000" %)Метод запроса: **PUT**
644
645 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
646
647 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
648
649 (% style="color:#000000" %)Параметры в теле запроса (JSON):
650
651 (% style="color:#000000" %){    
652
653 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
654 "parentId": "", ~/~/ ID клиента
655 "name": "", ~/~/ имя ТС
656 "imei": "", ~/~/ IMEI
657 "deviceTypeId": "", ~/~/ ID типа устройства
658 "modelId": "", ~/~/ , ID модели    
659 "unitId": "", ~/~/ подразделения
660 "sim1": "", ~/~/ SIM 1
661 "sim2": "", ~/~/ SIM2
662 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
663 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
664 "counters": 
665 {
666 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
667 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
668 "mileage": «», пробег
669 "motohours": «» моточасы
670 }
671 "cmsv6Parameters": ~/~/ параметры CMSv6
672 {       
673 "id": "", ~/~/ идентификатор
674 "enabled": true, ~/~/ флаг включения
675 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
676 "login": "", ~/~/ имя учетной записи
677 "password": "", ~/~/ пароль учетной записи
678 }
679 "inspectionTasks": ~/~/ задания на ТО
680 {
681 "id": "", ~/~/ ID задания
682 "enabled": false, ~/~/ Признак включения
683 "name": "", ~/~/ Имя задания
684 "description": "", ~/~/ Описание задания
685 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
686 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
687 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
688 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
689 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
690 "kind": "", ~/~/ Вид периодичности по времени
691 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
692 } 
693
694 (% style="color:#000000" %)}
695
696 (% style="color:#000000" %)Ответ:
697
698 (% lang="en-US" style="text-align:left" %)
699 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
700
701 (% lang="en-US" style="text-align:left" %)
702 "vehicleId": "", ~/~/ ID ТС
703 "parentId": "", ~/~/ ID клиента
704 "name": "", ~/~/ имя ТС
705 "imei": "", ~/~/ IMEI
706 "deviceTypeId": "", ~/~/ типа устройства
707 "modelId": "", ~/~/ ID модели
708 "unitId": "", ~/~/ ID подразделения
709 "sim1": "", ~/~/ SIM 1
710 "sim2": "", ~/~/ SIM2
711 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
712 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
713 "counters": 
714 {
715 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
716 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
717 "mileage": "", ~/~/ пробег
718 "motohours": "", ~/~/ моточасы
719 }
720 "cmsv6Parameters": ~/~/ параметры CMSv6
721 {
722 "id": ~/~/ идентификатор
723 "enabled": true, ~/~/ флаг включения
724 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
725 "login": "", ~/~/ имя учетной записи
726 "password": "", ~/~/ пароль учетной записи
727 }
728 "inspectionTasks": ~/~/ задания на ТО
729 {
730 "id": "", ~/~/ ID задания
731 "enabled": false, ~/~/ Признак включения
732 "name": "", ~/~/ Имя задания
733 "description": "", ~/~/ Описание задания
734 "mileageCondition": "", ~/~/ Условие по пробегу
735 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
736 "motohoursCondition": "", ~/~/ Условие по моточасам
737 "lastMotohours": "", ~/~/ Моточасы
738 "periodicCondition": "", ~/~/ Условие периодичности по времени
739 "kind": "", ~/~/ Вид периодичности по времени
740 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
741 }
742
743 (% lang="en-US" style="text-align:left" %)
744 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
745
746
747 (% class="box errormessage" %)
748 (((
749 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
750 )))
751
752 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
753
754 (% style="color:#000000" %)Метод запроса: **DELETE**
755
756 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
757
758 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
759
760 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
761
762 (% style="text-align:left" %)
763 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
764
765
766 (% class="box" lang="en-US" style="text-align: center;" %)
767 (((
768 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
769 )))
770
771 (% class="box infomessage" %)
772 (((
773 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
774 )))
775
776 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
777
778 (% style="color:#000000" %)Метод запроса: **GET**
779
780 (% 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]]
781
782 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
783
784 (% style="color:#000000" %)Ответ:
785
786 (% style="color:#000000" %){
787
788 "deviceTypeId" : "", ~/~/ ID типа устройства
789 "deviceTypeName" : "" ~/~/ Название типа устройства
790
791 (% style="text-align:left" %)
792 (% style="color:#000000" %)}
793
794
795 (% class="box" style="text-align: center;" %)
796 (((
797 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
798 )))
799
800 (% class="box infomessage" %)
801 (((
802 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
803 )))
804
805 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
806
807 (% style="color:#000000" %)Метод запроса: **GET**
808
809 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
810
811 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
812
813 (% style="color:#000000" %)Ответ:
814
815 (% style="color:#000000" %){
816
817 "id": "", ~/~/ ID типа датчика 
818 "name": "", ~/~/ Название
819 "description": "", ~/~/ Описание
820
821 (% style="text-align:left" %)
822 (% style="color:#000000" %)}
823
824
825 (% class="box" lang="en-US" style="text-align: center;" %)
826 (((
827 (% 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]] **
828 )))

Меню

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