Version 21.12 by Артем Шемяков on 2022/09/02 10:00
Hide last authors
Артем Шемяков 9.1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
Артем Шемяков 16.2 2 == Описание ГЛОНАССSoft Public API 3.0 ==
Андрей Калиновский 1.1 3
Артем Шемяков 9.1 4 == ==
5
Артем Шемяков 11.1 6 (% class="box" style="text-align: center;" %)
Артем Шемяков 8.1 7 (((
Артем Шемяков 12.1 8 (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
Артем Шемяков 8.1 9 )))
Андрей Калиновский 2.1 10
Артем Шемяков 8.1 11 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12
13 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14
15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
Андрей Калиновский 3.1 16
Андрей Калиновский 1.1 17
Артем Шемяков 8.1 18 (% class="box" style="text-align: center;" %)
19 (((
Артем Шемяков 9.1 20 (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
Артем Шемяков 8.1 21 )))
Андрей Калиновский 1.1 22
Артем Шемяков 8.1 23 (% class="box infomessage" %)
24 (((
Артем Шемяков 16.1 25 (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
Артем Шемяков 8.1 26 )))
Андрей Калиновский 1.1 27
Артем Шемяков 16.1 28 (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
Андрей Калиновский 1.1 29
Артем Шемяков 8.1 30 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 31
Артем Шемяков 16.1 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]]
Андрей Калиновский 1.1 33
Артем Шемяков 16.1 34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
Андрей Калиновский 1.1 35
Артем Шемяков 8.1 36 (% lang="en-US" %)
Артем Шемяков 20.4 37 (% style="color:#000000" %)**Ответ:**
Андрей Калиновский 1.1 38
Артем Шемяков 20.4 39 (% lang="en-US" %)
40 (% style="color:#000000" %){
41
42 (% lang="en-US" %)
43 (% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 "User": "" , ~/~/ имя пользователя
45
46 (% lang="en-US" %)
Артем Шемяков 21.12 47 }
Артем Шемяков 20.4 48
Артем Шемяков 16.1 49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
Андрей Калиновский 1.1 50
Артем Шемяков 16.1 51
Артем Шемяков 8.1 52 (% class="box infomessage" %)
53 (((
Артем Шемяков 16.1 54 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
Артем Шемяков 8.1 55 )))
Андрей Калиновский 1.1 56
Артем Шемяков 16.1 57 (% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
Андрей Калиновский 1.1 58
Артем Шемяков 8.1 59 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 60
Артем Шемяков 16.1 61 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
Андрей Калиновский 1.1 62
Артем Шемяков 16.1 63 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 64
Артем Шемяков 8.1 65 (% lang="en-US" %)
Артем Шемяков 16.1 66 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
Андрей Калиновский 1.1 67
68
Артем Шемяков 16.2 69 (% class="box" style="text-align: center;" %)
70 (((
71 (% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
72 )))
73
74 (% class="box infomessage" %)
75 (((
76 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
77 )))
78
79 (% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
80
81 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82
83 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84
85 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
86
87 (% style="color:#000000" %)Метод запроса: **GET**
88
89 (% 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>
90
91 (% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
92
93 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94
Артем Шемяков 20.4 95 (% style="color:#000000" %)Ответ:
Артем Шемяков 16.2 96
Артем Шемяков 20.4 97 (% style="color:#000000" %){
98 "agentId": "", ~/~/ идентификатор клиента
99 "parentId": "", ~/~/ идентификатор клиента-родителя
100 "name": "", ~/~/ наименование клиента
101 "fullName": "", ~/~/ полное наименование клиента
102 "agentInfoType": "", ~/~/ тип клиента1
103 "status": "", ~/~/ статус клиента
Артем Шемяков 21.12 104 }
Артем Шемяков 20.2 105
Артем Шемяков 20.4 106
Артем Шемяков 18.1 107 (% 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" %)]
Артем Шемяков 16.2 108
109
Артем Шемяков 8.1 110 (% class="box" style="text-align: center;" %)
111 (((
Артем Шемяков 9.1 112 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
Артем Шемяков 8.1 113 )))
Андрей Калиновский 1.1 114
Артем Шемяков 8.1 115 (% class="box successmessage" %)
116 (((
Артем Шемяков 9.1 117 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
Артем Шемяков 8.1 118 )))
Андрей Калиновский 1.1 119
Артем Шемяков 8.1 120 (% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
Андрей Калиновский 1.1 121
Артем Шемяков 8.1 122 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 123
Артем Шемяков 8.1 124 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
Андрей Калиновский 1.1 125
Артем Шемяков 8.1 126 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 127
Артем Шемяков 20.3 128 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 129
Артем Шемяков 20.3 130 (% style="color:#000000" %){ 
Артем Шемяков 20.4 131 "lastName": "", ~/~/ фамилия
Артем Шемяков 20.3 132 "firstName": "", ~/~/ имя
133 "position": "", ~/~/ должность
134 "phone": "", ~/~/ телефон
135 "organization": "", ~/~/ организация
136 "login": "", ~/~/ логин
137 "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 "email": "", ~/~/ email
139 "description": "", ~/~/ описание
140 "isEnabled": "", ~/~/ признак включения
141 "parentId": "", ~/~/ Guid родительского агента
142 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
143 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
144 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
145 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 "groups": "" , ~/~/ группы пользователя, названия групп
Артем Шемяков 21.12 148 }
Артем Шемяков 20.3 149
Артем Шемяков 8.1 150 (% style="text-align:left" %)
Артем Шемяков 20.3 151 (% style="color:#000000; font-weight:normal" %)Ответ:
Андрей Калиновский 1.1 152
Артем Шемяков 20.3 153 (% style="text-align:left" %)
Артем Шемяков 21.2 154 (% style="color:#000000; font-weight:normal" %){    
Андрей Калиновский 1.1 155
Артем Шемяков 20.3 156 (% style="text-align:left" %)
Артем Шемяков 20.4 157 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
Артем Шемяков 20.3 158 "lastName": "" , ~/~/ Фамилия ,
159 "firstName": "" , ~/~/ Имя
160 "position": "" , ~/~/ Должность
161 "phone": "" , ~/~/ Телефон
162 "organization": "" , ~/~/ Организация
163 "login": "" , ~/~/ Логин
164 "password": "" , ~/~/ Пароль
165 "email": "" , ~/~/ Email
166 "description": "" , ~/~/ Описание
167 "isEnabled": "" , ~/~/ Признак включения
168 "parentId": "" , ~/~/ Guid родительского агента
169 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
170 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
171 "kind": "" , ~/~/ тип аутентификации
172 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
173 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
174
175 (% style="text-align:left" %)
Артем Шемяков 21.12 176 (% style="color:#000000; font-weight:normal" %)}
Артем Шемяков 20.3 177
178
Артем Шемяков 18.1 179 (% class="box successmessage" %)
180 (((
181 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
182 )))
183
184 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
185
186 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
187
188 (% style="color:#000000" %)Метод запроса: **POST**
189
190 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
191
Артем Шемяков 20.4 192 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
Артем Шемяков 18.1 193
Артем Шемяков 20.4 194 (% style="color:#000000" %){
Артем Шемяков 18.1 195
Артем Шемяков 20.4 196 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
197 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
198 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
200
Артем Шемяков 21.12 201 (% style="color:#000000" %)}
Артем Шемяков 18.1 202
Артем Шемяков 20.4 203 (% style="color:#000000" %)Ответ:
Артем Шемяков 18.1 204
Артем Шемяков 21.2 205 (% style="color:#000000" %){         (%%)
Артем Шемяков 20.4 206
Артем Шемяков 20.5 207 "id": "" , ~/~/ идентификатор пользователя
Артем Шемяков 20.4 208 "lastName": "" , ~/~/ фамилия
209 "firstName": "" , ~/~/ имя
210 "position": "" , ~/~/ должность
211 "phone": "" , ~/~/ телефон
212 "parentId": "" , ~/~/ идентификатор клиента-родителя
213 "parentName": "" , ~/~/ наименование клиента-родителя
214 "organization": "" , ~/~/ организация
215 "login": "" , ~/~/ логин
216 "email": "" , ~/~/ E-mail
Артем Шемяков 20.5 217 "sessionDuration":"", ~/~/ длительность сессии в минутах
218 "status": "1",  ~/~/ статус пользователя
219 "astLogged": "", ~/~/ дата/время последней авторизации
Артем Шемяков 20.4 220
Артем Шемяков 21.12 221 (% style="color:#000000" %)}
Артем Шемяков 20.4 222
Артем Шемяков 18.1 223
Артем Шемяков 8.1 224 (% class="box warningmessage" %)
225 (((
Артем Шемяков 9.1 226 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
Артем Шемяков 8.1 227 )))
Андрей Калиновский 1.1 228
Артем Шемяков 8.1 229 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
Андрей Калиновский 1.1 230
Артем Шемяков 8.1 231 (% style="color:#000000" %)Метод запроса: **PUT**
Андрей Калиновский 1.1 232
Артем Шемяков 8.1 233 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
Андрей Калиновский 1.1 234
Артем Шемяков 8.1 235 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 236
Артем Шемяков 8.1 237 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 20.6 238 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 239
Артем Шемяков 20.6 240 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.2 241 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
Андрей Калиновский 1.1 242
Артем Шемяков 20.6 243 (% lang="en-US" style="text-align:left" %)
244 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
245 "lastName": "" , ~/~/ фамилия
246 "firstName": "" , ~/~/ имя
247 "position": "" , ~/~/ должность
248 "phone": "" , ~/~/ телефон
249 "organization": "" , ~/~/ организация
250 "login": "" , ~/~/ логин
251 "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
252 "email": "" , ~/~/ email
253 "description": "" , ~/~/ описание
254 "isEnabled": "" , ~/~/ признак включения
255 "parentId": "" , ~/~/ Guid родительского агента
256 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
257 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
258 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
259 "kind": "" , ~/~/ тип аутентификации
260 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
261 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
262
263 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 264 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
Артем Шемяков 20.6 265
266 (% lang="en-US" style="text-align:left" %)
267 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
268
269 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 270 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 20.6 271
272 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 273 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
Артем Шемяков 20.6 274 "lastName": "" , ~/~/ фамилия
275 "firstName": "" , ~/~/ имя
276 "position": "" , ~/~/ должность
277 "phone": "" , ~/~/ телефон
278 "organization": "" , ~/~/ организация
279 "login": "" , ~/~/ логин
280 "password": "" , ~/~/ пароль 
281 "email": "" , ~/~/ email
282 "description": "" , ~/~/ описание
283 "isEnabled": "" , ~/~/ признак включения
284 "parentId": "" , ~/~/ Guid родительского агента
285 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
286 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
287 "kind": "" , ~/~/ тип аутентификации
288 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
Артем Шемяков 21.12 289 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
Артем Шемяков 20.6 290
291 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 292 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
Артем Шемяков 20.6 293
294
Артем Шемяков 8.1 295 (% class="box warningmessage" %)
296 (((
Артем Шемяков 18.1 297 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
Артем Шемяков 8.1 298 )))
Андрей Калиновский 1.1 299
Артем Шемяков 8.1 300 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
Андрей Калиновский 1.1 301
Артем Шемяков 8.1 302 (% style="color:#000000" %)Метод запроса: **PUT**
Андрей Калиновский 1.1 303
Артем Шемяков 20.7 304 (% 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}
Андрей Калиновский 1.1 305
Артем Шемяков 20.7 306 (% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
Андрей Калиновский 1.1 307
Артем Шемяков 20.7 308 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 309
Артем Шемяков 20.7 310 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 311
Артем Шемяков 20.7 312 (% style="color:#000000" %){
313
314 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
315 "description": "" , ~/~/ описание
316 "data": "" , ~/~/ данные, связанные со сменой статуса
317
Артем Шемяков 21.12 318 (% style="color:#000000" %)}
Артем Шемяков 20.7 319
Артем Шемяков 8.1 320 (% style="text-align:left" %)
321 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
Андрей Калиновский 1.1 322
323
Артем Шемяков 8.1 324 (% class="box errormessage" %)
325 (((
Артем Шемяков 9.1 326 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
Артем Шемяков 8.1 327 )))
Андрей Калиновский 1.1 328
Артем Шемяков 8.1 329 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
Андрей Калиновский 1.1 330
Артем Шемяков 8.1 331 (% style="color:#000000" %)Метод запроса: **DELETE**
Андрей Калиновский 1.1 332
Артем Шемяков 8.1 333 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
Андрей Калиновский 1.1 334
Артем Шемяков 20.8 335 (% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
Андрей Калиновский 1.1 336
Артем Шемяков 20.8 337 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
338
Артем Шемяков 8.1 339 (% style="text-align:left" %)
340 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
Андрей Калиновский 1.1 341
342
Артем Шемяков 8.1 343 (% class="box" style="text-align: center;" %)
344 (((
Артем Шемяков 9.1 345 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
Артем Шемяков 8.1 346 )))
Андрей Калиновский 1.1 347
Артем Шемяков 8.1 348 (% class="box infomessage" %)
349 (((
Артем Шемяков 9.1 350 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
Артем Шемяков 8.1 351 )))
Андрей Калиновский 1.1 352
Артем Шемяков 8.1 353 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
Андрей Калиновский 1.1 354
Артем Шемяков 8.1 355 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
Андрей Калиновский 1.1 356
Артем Шемяков 8.1 357 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
Андрей Калиновский 1.1 358
Артем Шемяков 8.1 359 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
Андрей Калиновский 1.1 360
Артем Шемяков 8.1 361 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 362
Артем Шемяков 8.1 363 (% 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>
Андрей Калиновский 1.1 364
Артем Шемяков 8.1 365 (% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
Андрей Калиновский 1.1 366
Артем Шемяков 8.1 367 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 368
Артем Шемяков 8.1 369 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 370
Артем Шемяков 8.1 371 (% style="color:#000000" %){
Андрей Калиновский 1.1 372
Артем Шемяков 20.9 373 "vehicleId": "" , ~/~/ идентификатор объекта
374 "name": "" , ~/~/ имя объекта
375 "imei": "" , ~/~/ IMEI объекта
376 "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
377 "deviceTypeName": "" , ~/~/ наименование устройства объекта
378 "parentId": "" , ~/~/ идентификатор клиента-родителя
379 "parentName": "" , ~/~/ наименование клиента-родителя,
380 "modelId": "" , ~/~/ идентификатор модели объекта
381 "modelName": "" , ~/~/ наименование модели объекта,
382 "unitId": "" , ~/~/ идентификатор подразделения
383 "unitName": "" , ~/~/ наименование подразделения
384 "status": "" , ~/~/ статус объекта
Андрей Калиновский 1.1 385
Артем Шемяков 21.12 386 }
Андрей Калиновский 1.1 387
Артем Шемяков 8.1 388 (% style="text-align:left" %)
389 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
Андрей Калиновский 1.1 390
Артем Шемяков 8.1 391 (% style="text-align:left" %)
392 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
Андрей Калиновский 1.1 393
394
Артем Шемяков 8.1 395 (% class="box successmessage" %)
396 (((
Артем Шемяков 9.1 397 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
Артем Шемяков 8.1 398 )))
Андрей Калиновский 1.1 399
Артем Шемяков 8.1 400 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
Андрей Калиновский 1.1 401
Артем Шемяков 8.1 402 (% style="color:#000000" %)Метод запроса: **POST**
403
404 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
405
406 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
407
Артем Шемяков 21.2 408 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
Артем Шемяков 8.1 409
Артем Шемяков 21.2 410 (% style="color:#000000" %){
411
412 "parentId": "" , ~/~/ ID клиента
413 "name": "" , ~/~/ имя ТС
414 "imei": "" , ~/~/ IMEI
415 "deviceTypeId": "" , ~/~/ ID типа устройства
416 "modelId": "" , ~/~/ ID модели
417 "unitId": "" , ~/~/ ID подразделения
418 "sim1": "" , ~/~/ Номер SIM 1
419 "sim2": "" , ~/~/ Номер SIM2
420 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
421 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
422 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
423 "counters": {
424 "mileage": "" , ~/~/ пробег
425 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
426 "motohours": "" , ~/~/ моточасы
427 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
Артем Шемяков 21.12 428 },
Артем Шемяков 21.2 429 "cmsv6Parameters": { ~/~/ параметры CMSv6
430 "enabled": true, ~/~/ флаг включения
431 "id": "" , ~/~/ идентификатор
432 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
433 "login": "" , ~/~/ имя учетной записи
434 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 435 },
Артем Шемяков 21.2 436 "inspectionTasks": ~/~/ задания на ТО
Андрей Калиновский 1.1 437 {
Артем Шемяков 21.2 438 "enabled": "" , ~/~/ Признак включения
439 "name": "" , ~/~/ Имя задания
440 "description": "" , ~/~/ Описание задания
441 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
442 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
443 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
444 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
445 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
446 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
447 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
448 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
449 }
Андрей Калиновский 1.1 450
Артем Шемяков 21.2 451 (% style="color:#000000" %) }
Андрей Калиновский 1.1 452
Артем Шемяков 8.1 453 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 454
Артем Шемяков 8.1 455 (% style="color:#000000" %){
Андрей Калиновский 1.1 456
Артем Шемяков 21.3 457 "vehicleId": "", ~/~/ID ТС 
458 "parentId": "", ~/~/Guid владельца ТС
459 "name": "", ~/~/Имя объекта
460 "imei": "", ~/~/IMEI
461 "deviceTypeId": "", ~/~/ID типа устройства
462 "modelId": "", ~/~/ID модели
463 "unitId": "", ~/~/ID подразделения
464 "sim1": "", ~/~/SIM1
465 "sim2": "", ~/~/SIM2
466 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
467 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
468 "counters": { ~/~/Счётчики
469 "mileageEnabled": true,
470 "motohoursEnabled": true,
471 "mileage": "",
472 "motohours": 345.0
Артем Шемяков 21.12 473 },
Артем Шемяков 21.3 474 "cmsv6Parameters": { ~/~/Параметры CmsV6
475 "id": null,
476 "enabled": true, ~/~/флаг включения
477 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
478 "login": "", ~/~/ имя учетной записи
479 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 480 },
Артем Шемяков 21.3 481 "inspectionTasks": { ~/~/ задания на ТО
482 "id": "", ~/~/ ID задачи
483 "enabled": false, ~/~/ Признак включения
484 "name": "", ~/~/ Имя задания
485 "description": "", ~/~/ Описание задания
486 "mileageCondition": "", ~/~/ Условие по пробегу
487 "lastMileage": "", ~/~/ Пробег (в метрах)
488 "motohoursCondition": "", ~/~/ Условие по моточасам
489 "lastMotohours": "", ~/~/ Моточасы
490 "periodicCondition": "", ~/~/ Условие периодичности по времени
491 "kind": "", ~/~/ Вид периодичности по времени 
492 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Артем Шемяков 21.12 493 }
Андрей Калиновский 1.1 494
Артем Шемяков 8.1 495 (% style="text-align:left" %)
496 (% style="color:#000000" %)}
Андрей Калиновский 1.1 497
498
Артем Шемяков 8.1 499 (% class="box successmessage" %)
500 (((
Артем Шемяков 18.1 501 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
Артем Шемяков 8.1 502 )))
Андрей Калиновский 1.1 503
Артем Шемяков 8.1 504 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
Андрей Калиновский 1.1 505
Артем Шемяков 8.1 506 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
Андрей Калиновский 1.1 507
Артем Шемяков 8.1 508 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
Андрей Калиновский 1.1 509
Артем Шемяков 8.1 510 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
Андрей Калиновский 1.1 511
Артем Шемяков 21.7 512 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
Андрей Калиновский 1.1 513
Артем Шемяков 21.7 514 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
Андрей Калиновский 1.1 515
Артем Шемяков 21.7 516 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
Андрей Калиновский 1.1 517
Артем Шемяков 8.1 518 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 519
Артем Шемяков 8.1 520 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
Андрей Калиновский 1.1 521
Артем Шемяков 8.1 522 (% style="color:#000000" %)В заголовках запроса:
Андрей Калиновский 1.1 523
Артем Шемяков 8.1 524 (% style="color:#000000" %)− Content-Type: application/json
Андрей Калиновский 1.1 525
Артем Шемяков 8.1 526 (% style="color:#000000" %)− X-Auth: Токен авторизации
527
528 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
529
Артем Шемяков 21.5 530 (% class="western" style="color:#000000" %)##{##
Артем Шемяков 8.1 531
Артем Шемяков 21.5 532 (% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
533 "name": null, ~/~/ Имя ТС (string, опционально) 
534 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
535 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
536 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
537 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
538 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
539 (% style="color:#000000" %)}
Артем Шемяков 14.1 540
Артем Шемяков 21.7 541 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
Артем Шемяков 8.1 542
Артем Шемяков 21.7 543 (% style="color:#000000" %)Ответ:
Артем Шемяков 8.1 544
Артем Шемяков 21.7 545 (% style="color:#000000" %){
Артем Шемяков 8.1 546
Артем Шемяков 21.7 547 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
548 "name": "" ~/~/ наименование объекта
549 "imei": "" ~/~/ IMEI объекта
550 "deviceTypeId": "" ~/~/ идентификатор типа устройства
551 "deviceTypeName": "" ~/~/ наименование типа устройства
552 "sim1": "" ~/~/ первый номер телефона
553 "sim2": "" ~/~/ второй номер телефона
554 "parentId": "" ~/~/ идентификатор клиента-родителя
555 "parentName": "" ~/~/ наименование клиента-родителя
556 "modelId": "" ~/~/ идентификатор модели объекта
557 "modelName": "" ~/~/ наименование модели объекта
558 "unitId": "" ~/~/ идентификатор подразделения
559 "unitName": "" ~/~/ наименование подразделения
560 "status": "" ~/~/ статус объекта         
561 "createdAt": "" ~/~/ дата создания объектов  (%%)
562 (% style="color:#000000" %)}
563
564 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
565
Артем Шемяков 18.2 566 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
Артем Шемяков 8.1 567
568
569 (% class="box successmessage" %)
570 (((
Артем Шемяков 9.1 571 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
Артем Шемяков 8.1 572 )))
573
574 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
575
576 (% style="color:#000000" %)Метод запроса: **POST**
577
578 (% 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}
579
580 (% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
581
582 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
583
Артем Шемяков 21.8 584 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Артем Шемяков 8.1 585
Артем Шемяков 21.8 586 (% style="color:#000000" %){
Артем Шемяков 21.7 587
Артем Шемяков 21.8 588 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
589 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
590 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
591 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
592 "description": "", ~/~/ Описание
593 "data": "", ~/~/ Данные
594 "overwrite": false, ~/~/ Флаг перезаписи
595 "stage": "", ~/~/ Состояние, может быть null
Андрей Калиновский 1.1 596
Артем Шемяков 21.12 597 (% style="color:#000000" %)}
Артем Шемяков 21.7 598
Артем Шемяков 21.8 599 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 600
Артем Шемяков 21.8 601 (% style="color:#000000" %){
Андрей Калиновский 1.1 602
Артем Шемяков 21.8 603 "status": "", ~/~/ значение статуса
604 "date": "", ~/~/ Дата смены статуса 
605 "description": "", ~/~/ Описание
606 "data": "", ~/~/ Данные
607 "overwrite": false, ~/~/ Флаг перезаписи
608 "stage": "", ~/~/ Состояние
Андрей Калиновский 1.1 609
Артем Шемяков 8.1 610 (% style="text-align:left" %)
Артем Шемяков 21.12 611 (% style="color:#000000" %) }
Андрей Калиновский 1.1 612
613
Артем Шемяков 18.1 614 (% class="box warningmessage" %)
615 (((
616 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
617 )))
618
619 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
620
621 (% style="color:#000000" %)Метод запроса: **PUT**
622
623 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
624
625 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
626
627 (% style="color:#000000" %)Параметры в теле запроса (JSON):
628
Артем Шемяков 21.12 629 (% style="color:#000000" %){
Артем Шемяков 18.1 630
Артем Шемяков 21.10 631 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
632 "parentId": "", ~/~/ ID клиента
633 "name": "", ~/~/ имя ТС
634 "imei": "", ~/~/ IMEI
635 "deviceTypeId": "", ~/~/ ID типа устройства
636 "modelId": "", ~/~/ , ID модели    
637 "unitId": "", ~/~/ подразделения
638 "sim1": "", ~/~/ SIM 1
639 "sim2": "", ~/~/ SIM2
640 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
641 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
642 "counters": 
643 {
644 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
645 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
646 "mileage": «», пробег
647 "motohours": «» моточасы
648 }
649 "cmsv6Parameters": ~/~/ параметры CMSv6
650 {       
651 "id": "", ~/~/ идентификатор
652 "enabled": true, ~/~/ флаг включения
653 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
654 "login": "", ~/~/ имя учетной записи
655 "password": "", ~/~/ пароль учетной записи
656 }
657 "inspectionTasks": ~/~/ задания на ТО
658 {
659 "id": "", ~/~/ ID задания
660 "enabled": false, ~/~/ Признак включения
661 "name": "", ~/~/ Имя задания
662 "description": "", ~/~/ Описание задания
663 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
664 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
665 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
666 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
667 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
668 "kind": "", ~/~/ Вид периодичности по времени
669 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
Артем Шемяков 21.12 670 }
Артем Шемяков 21.9 671
672 (% style="color:#000000" %)}
673
Артем Шемяков 18.1 674 (% style="color:#000000" %)Ответ:
675
676 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.11 677 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){
Артем Шемяков 18.1 678
Артем Шемяков 21.11 679 (% lang="en-US" style="text-align:left" %)
680 "vehicleId": "", ~/~/ ID ТС
681 "parentId": "", ~/~/ ID клиента
682 "name": "", ~/~/ имя ТС
683 "imei": "", ~/~/ IMEI
684 "deviceTypeId": "", ~/~/ типа устройства
685 "modelId": "", ~/~/ ID модели
686 "unitId": "", ~/~/ ID подразделения
687 "sim1": "", ~/~/ SIM 1
688 "sim2": "", ~/~/ SIM2
689 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
690 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
691 "counters": 
692 {
693 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
694 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
695 "mileage": "", ~/~/ пробег
696 "motohours": "", ~/~/ моточасы
697 }
698 "cmsv6Parameters": ~/~/ параметры CMSv6
699 {
700 "id": ~/~/ идентификатор
701 "enabled": true, ~/~/ флаг включения
702 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
703 "login": "", ~/~/ имя учетной записи
704 "password": "", ~/~/ пароль учетной записи
705 }
706 "inspectionTasks": ~/~/ задания на ТО
707 {
708 "id": "", ~/~/ ID задания
709 "enabled": false, ~/~/ Признак включения
710 "name": "", ~/~/ Имя задания
711 "description": "", ~/~/ Описание задания
712 "mileageCondition": "", ~/~/ Условие по пробегу
713 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
714 "motohoursCondition": "", ~/~/ Условие по моточасам
715 "lastMotohours": "", ~/~/ Моточасы
716 "periodicCondition": "", ~/~/ Условие периодичности по времени
717 "kind": "", ~/~/ Вид периодичности по времени
718 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
719 }
Артем Шемяков 18.1 720
Артем Шемяков 21.11 721 (% lang="en-US" style="text-align:left" %)
722 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
723
724
Артем Шемяков 18.1 725 (% class="box errormessage" %)
726 (((
727 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
728 )))
729
730 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
731
732 (% style="color:#000000" %)Метод запроса: **DELETE**
733
734 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
735
736 (% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
737
738 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
739
740 (% style="text-align:left" %)
741 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
742
743
Артем Шемяков 8.1 744 (% class="box" lang="en-US" style="text-align: center;" %)
745 (((
Артем Шемяков 17.1 746 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
747 )))
748
749 (% class="box infomessage" %)
750 (((
751 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
752 )))
753
754 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
755
756 (% style="color:#000000" %)Метод запроса: **GET**
757
758 (% 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]]
759
760 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
761
Артем Шемяков 21.12 762 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 763
Артем Шемяков 21.12 764 (% style="color:#000000" %){
Артем Шемяков 17.1 765
Артем Шемяков 21.12 766 "deviceTypeId" : "", ~/~/ ID типа устройства
767 "deviceTypeName" : "" ~/~/ Название типа устройства
768
Артем Шемяков 17.1 769 (% style="text-align:left" %)
Артем Шемяков 21.12 770 (% style="color:#000000" %)}
Артем Шемяков 17.1 771
772
773 (% class="box" style="text-align: center;" %)
774 (((
775 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
776 )))
777
778 (% class="box infomessage" %)
779 (((
780 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
781 )))
782
783 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
784
785 (% style="color:#000000" %)Метод запроса: **GET**
786
787 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
788
789 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
790
Артем Шемяков 21.12 791 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 792
Артем Шемяков 21.12 793 (% style="color:#000000" %){
Артем Шемяков 17.1 794
Артем Шемяков 21.12 795 "id": "", ~/~/ ID типа датчика 
796 "name": "", ~/~/ Название
797 "description": "", ~/~/ Описание
Артем Шемяков 17.1 798
799 (% style="text-align:left" %)
Артем Шемяков 21.12 800 (% style="color:#000000" %)}
Артем Шемяков 17.1 801
802
803 (% class="box" lang="en-US" style="text-align: center;" %)
804 (((
Артем Шемяков 14.1 805 (% 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]] **
Артем Шемяков 8.1 806 )))

Меню

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