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