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

Меню

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