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

Меню

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