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

Меню

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