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

Меню

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