Version 20.4 by Артем Шемяков on 2022/09/01 17:28
Show last authors
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 (% style="color:#000000" %) "id": "" , ~/~/ идентификатор пользователя
208 "lastName": "" , ~/~/ фамилия
209 "firstName": "" , ~/~/ имя
210 "position": "" , ~/~/ должность
211 "phone": "" , ~/~/ телефон
212 "parentId": "" , ~/~/ идентификатор клиента-родителя
213 "parentName": "" , ~/~/ наименование клиента-родителя
214 "organization": "" , ~/~/ организация
215 "login": "" , ~/~/ логин
216 "email": "" , ~/~/ E-mail
217
218 (% style="color:#000000" %)}
219
220 (% class="western" style="margin-bottom:19px" %)
221 {{{ "sessionDuration":"", // длительность сессии в минутах}}}
222
223 (% lang="en-US" style="text-align:left" %)
224 (% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
225
226
227 (% class="box warningmessage" %)
228 (((
229 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
230 )))
231
232 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
233
234 (% style="color:#000000" %)Метод запроса: **PUT**
235
236 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
237
238 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
239
240 (% lang="en-US" style="text-align:left" %)
241 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (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» //названия групп ] }  //
242
243
244 (% class="box warningmessage" %)
245 (((
246 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
247 )))
248
249 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
250
251 (% style="color:#000000" %)Метод запроса: **PUT**
252
253 (% 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} Параметр запроса:
254
255 (% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
256
257 (% class="western" %)
258 {{{ "description": "", // описание
259 "data": "" // данные, связанные со сменой статуса}}}
260
261 (% style="color:#000000" %)}
262
263 (% style="text-align:left" %)
264 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
265
266
267 (% class="box errormessage" %)
268 (((
269 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
270 )))
271
272 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
273
274 (% style="color:#000000" %)Метод запроса: **DELETE**
275
276 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
277
278 (% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
279
280 (% style="text-align:left" %)
281 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
282
283
284 (% class="box" style="text-align: center;" %)
285 (((
286 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
287 )))
288
289 (% class="box infomessage" %)
290 (((
291 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
292 )))
293
294 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
295
296 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
297
298 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
299
300 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
301
302 (% style="color:#000000" %)Метод запроса: **GET**
303
304 (% 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>
305
306 (% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
307
308 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
309
310 (% style="color:#000000" %)Ответ:
311
312 (% style="color:#000000" %){
313
314 (% class="western" %)
315 {{{ "vehicleId": “”, // идентификатор объекта
316 "name": "", // имя объекта
317 "imei": "", // IMEI объекта
318 "deviceTypeId": “”, // идентификатор устройства объекта
319 "deviceTypeName": "" // наименование устройства объекта
320 "parentId": "", // идентификатор клиента-родителя
321 "parentName": "" // наименование клиента-родителя,
322 "modelId": "", // идентификатор модели объекта
323 "modelName": "" // наименование модели объекта,
324 "unitId": "", // идентификатор подразделения
325 "unitName": "", // наименование подразделения
326 "status": “”, // статус объекта
327 ...
328 },
329 ...}}}
330
331 (% style="color:#000000" %)}
332
333 (% style="text-align:left" %)
334 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
335
336 (% style="text-align:left" %)
337 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
338
339
340 (% class="box successmessage" %)
341 (((
342 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
343 )))
344
345 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
346
347 (% style="color:#000000" %)Метод запроса: **POST**
348
349 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
350
351 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
352
353 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
354
355 (% class="western" %)
356 {{{ "parentId": "", // ID клиента
357 "name": "", // имя ТС
358 "imei": "", // IMEI
359 "deviceTypeId": "",// ID типа устройства
360 "modelId": "",
361 "unitId": "", // ID подразделения
362 "sim1": "", // Номер SIM 1
363 "sim2": "", // Номер SIM2
364 "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
365 "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
366 "consumptionIdle": "",// Расход топлива на холостом ходу
367 "counters": {
368 "mileage": "", // пробег
369 "mileageEnabled": true, // флаг активности счётчика "пробег"
370 "motohours":"", // моточасы
371 "motohoursEnabled": true // флаг активности счётчика "моточасы"
372 },
373 "cmsv6Parameters": { // параметры CMSv6
374 "enabled": true, // флаг включения
375 //"id": "", // идентификатор
376 "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
377 "login": "", // имя учетной записи
378 "password": "" // пароль учетной записи
379 },
380 "inspectionTasks": [ // задания на ТО
381 {
382 "enabled": "", // Признак включения
383 "name": "", // Имя задания
384 "description": "", // Описание задания
385 "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
386 "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
387 "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
388 "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
389 "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
390 "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
391 "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
392 "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
393 },
394 ]}}}
395
396 (% style="color:#000000" %)… }
397
398 (% style="color:#000000" %)Ответ:
399
400 (% style="color:#000000" %){
401
402 (% class="western" %)
403 {{{ "vehicleId": "", //ID ТС
404 "parentId": "", //Guid владельца ТС
405 "name": "", //Имя объекта
406 "imei": "", //IMEI
407 "deviceTypeId": "", //ID типа устройства
408 "modelId": "", //ID модели
409 "unitId": "", //ID подразделения
410 "sim1": "", //SIM1
411 "sim2": "", //SIM2
412 "consumptionPer100Km": "", //Расход топлива на 100 км
413 "consumptionIdle": "", //Расход топлива на холостом ходу
414 "counters": { //Счётчики
415 "mileageEnabled": true,
416 "motohoursEnabled": true,
417 "mileage": "",
418 "motohours": 345.0
419 },
420 "cmsv6Parameters": { //Параметры CmsV6
421 "id": null,
422 "enabled": true, //флаг включения
423 "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
424 "login": "", // имя учетной записи
425 "password": "" // пароль учетной записи
426 },
427 "inspectionTasks": [ // задания на ТО
428 {
429 "id": "", // ID задачи
430 "enabled": false, // Признак включения
431 "name": "", // Имя задания
432 "description": "", // Описание задания
433 "mileageCondition": "", // Условие по пробегу
434 "lastMileage": "", // Пробег (в метрах)
435 "motohoursCondition": "", // Условие по моточасам
436 "lastMotohours": "", // Моточасы
437 "periodicCondition": "", // Условие периодичности по времени
438 "kind": "", // Вид периодичности по времени
439 "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
440 }
441 ]}}}
442
443 (% style="text-align:left" %)
444 (% style="color:#000000" %)}
445
446
447 (% class="box successmessage" %)
448 (((
449 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
450 )))
451
452 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
453
454 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
455
456 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
457
458 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
459
460 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
461
462 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
463
464 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
465
466 (% style="color:#000000" %)Метод запроса: **POST**
467
468 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
469
470 (% style="color:#000000" %)В заголовках запроса:
471
472 (% style="color:#000000" %)− Content-Type: application/json
473
474 (% style="color:#000000" %)− X-Auth: Токен авторизации
475
476 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
477
478 (% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
479
480 (% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
481
482 (% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
483
484 (% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
485
486 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
487
488 (% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
489
490 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
491
492 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
493
494
495 (% class="box successmessage" %)
496 (((
497 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
498 )))
499
500 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
501
502 (% style="color:#000000" %)Метод запроса: **POST**
503
504 (% 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}
505
506 (% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
507
508 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
509
510 (% style="color:#000000" %)Параметры в теле запроса (JSON): {
511
512 (% class="western" %)
513 {{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
514   // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
515   // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
516 "date": "", // Дата смены статуса (null если сменить немедленно)
517 "description": "", // Описание
518 "data": "", // Данные
519 "overwrite": false, // Флаг перезаписи
520 "stage": "", // Состояние, может быть null}}}
521
522 (% style="color:#000000" %)}
523
524 (% style="color:#000000" %)Ответ: {
525
526 (% class="western" %)
527 {{{ "status": "", // значение статуса
528 "date": "", // Дата смены статуса
529 "description": "", // Описание
530 "data": "", // Данные
531 "overwrite": false, // Флаг перезаписи
532 "stage": "", // Состояние}}}
533
534 (% style="text-align:left" %)
535 (% style="color:#000000" %)}
536
537
538 (% class="box warningmessage" %)
539 (((
540 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
541 )))
542
543 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
544
545 (% style="color:#000000" %)Метод запроса: **PUT**
546
547 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
548
549 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
550
551 (% style="color:#000000" %)Параметры в теле запроса (JSON):
552
553 (% 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»: «» //Сколько раз выполнить задание } ] }
554
555 (% style="color:#000000" %)Ответ:
556
557 (% lang="en-US" style="text-align:left" %)
558 (% 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»: «» //Сколько раз выполнить задание } ] }
559
560
561 (% class="box errormessage" %)
562 (((
563 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
564 )))
565
566 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
567
568 (% style="color:#000000" %)Метод запроса: **DELETE**
569
570 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
571
572 (% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
573
574 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
575
576 (% style="text-align:left" %)
577 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
578
579
580 (% class="box" lang="en-US" style="text-align: center;" %)
581 (((
582 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
583 )))
584
585 (% class="box infomessage" %)
586 (((
587 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
588 )))
589
590 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
591
592 (% style="color:#000000" %)Метод запроса: **GET**
593
594 (% 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]]
595
596 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
597
598 (% style="color:#000000" %)Ответ: [
599
600 (% class="western" %)
601 {{{ {
602 "deviceTypeId" : "", // ID типа устройства
603 "deviceTypeName" : "" // Название типа устройства
604 },}}}
605
606 (% style="text-align:left" %)
607 (% style="color:#000000" %)…** **]
608
609
610 (% class="box" style="text-align: center;" %)
611 (((
612 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
613 )))
614
615 (% class="box infomessage" %)
616 (((
617 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
618 )))
619
620 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
621
622 (% style="color:#000000" %)Метод запроса: **GET**
623
624 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
625
626 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
627
628 (% style="color:#000000" %)Ответ: [
629
630 (% class="western" style="margin-bottom:19px" %)
631 {{{ {}}}
632
633 (% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
634
635 (% class="western" %)
636 {{{ "description": "" // Описание
637 },}}}
638
639 (% style="text-align:left" %)
640 (% style="color:#000000" %)… ]
641
642
643 (% class="box" lang="en-US" style="text-align: center;" %)
644 (((
645 (% 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]] **
646 )))

Меню

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