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

Меню

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