Версия 67.1 от Илья Крайнов на 2022/11/24 13:52
Скрыть последних авторов
Артем Шемяков 9.1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
Илья Крайнов 64.1 2 = Описание ГЛОНАССSoft Public API 3.0 =
Андрей Калиновский 1.1 3
Артем Шемяков 9.1 4
Илья Крайнов 67.1 5 **Содержание страницы:**
6
Илья Крайнов 56.1 7 {{toc/}}
8
9
Илья Крайнов 66.4 10 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
Андрей Калиновский 2.1 11
Артем Шемяков 8.1 12 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
13
Артем Шемяков 23.2 14 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
Артем Шемяков 8.1 15
16 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
Андрей Калиновский 1.1 17
Илья Крайнов 60.1 18 (% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
Андрей Калиновский 1.1 19
Илья Крайнов 65.1 20 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
Андрей Калиновский 1.1 21
Илья Крайнов 66.3 22 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
Илья Крайнов 60.1 23
24 (% class="box infomessage" %)
25 (((
26 (% lang="en-US" %)**POST /api/v3/auth/login**
27 )))
28
Илья Крайнов 58.1 29 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
Андрей Калиновский 1.1 30
Артем Шемяков 27.1 31 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 32
Артем Шемяков 27.1 33 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
Андрей Калиновский 1.1 34
Артем Шемяков 28.1 35 (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
Андрей Калиновский 1.1 36
Артем Шемяков 27.1 37 (% style="color:#000000" %)Параметры в теле запроса (JSON):
38
39 (% style="color:#000000" %){
40 "login": "testuser",
41 "password": "testuser"
Илья Крайнов 67.1 42 }
Артем Шемяков 27.1 43
Илья Крайнов 66.9 44
Артем Шемяков 20.4 45 (% style="color:#000000" %)**Ответ:**
Андрей Калиновский 1.1 46
Артем Шемяков 20.4 47 (% lang="en-US" %)
48 (% style="color:#000000" %){
49
50 (% lang="en-US" %)
Артем Шемяков 27.1 51 (% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
52 "User": "testuser" , ~/~/ имя пользователя
Артем Шемяков 20.4 53
54 (% lang="en-US" %)
Артем Шемяков 21.12 55 }
Артем Шемяков 20.4 56
Артем Шемяков 16.1 57 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
Андрей Калиновский 1.1 58
Илья Крайнов 66.5 59 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
Илья Крайнов 60.1 60
Артем Шемяков 8.1 61 (% class="box infomessage" %)
62 (((
Илья Крайнов 60.1 63 (% lang="en-US" %)**GET /api/v3/auth/check**
Артем Шемяков 8.1 64 )))
Андрей Калиновский 1.1 65
Илья Крайнов 60.1 66 (% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 67
Артем Шемяков 8.1 68 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 69
Артем Шемяков 16.1 70 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
Андрей Калиновский 1.1 71
Артем Шемяков 16.1 72 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 73
Артем Шемяков 8.1 74 (% lang="en-US" %)
Артем Шемяков 16.1 75 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
Андрей Калиновский 1.1 76
Илья Крайнов 66.1 77 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
Артем Шемяков 16.2 78
Илья Крайнов 66.7 79 == (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
Илья Крайнов 60.1 80
Артем Шемяков 16.2 81 (% class="box infomessage" %)
82 (((
Илья Крайнов 60.1 83 (% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
Артем Шемяков 16.2 84 )))
85
Илья Крайнов 60.1 86 (% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Артем Шемяков 16.2 87
88 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89
90 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91
Артем Шемяков 22.3 92 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
Артем Шемяков 16.2 93
94 (% style="color:#000000" %)Метод запроса: **GET**
95
96 (% 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>
97
Артем Шемяков 22.3 98 (% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
Артем Шемяков 16.2 99
100 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
101
Артем Шемяков 20.4 102 (% style="color:#000000" %)Ответ:
Артем Шемяков 16.2 103
Артем Шемяков 20.4 104 (% style="color:#000000" %){
105 "agentId": "", ~/~/ идентификатор клиента
106 "parentId": "", ~/~/ идентификатор клиента-родителя
107 "name": "", ~/~/ наименование клиента
108 "fullName": "", ~/~/ полное наименование клиента
Артем Шемяков 22.3 109 "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
Артем Шемяков 25.7 110 "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
Артем Шемяков 21.12 111 }
Артем Шемяков 20.2 112
Илья Крайнов 66.10 113 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
Артем Шемяков 20.4 114
Илья Крайнов 50.1 115 (% class="box successmessage" %)
116 (((
Илья Крайнов 60.1 117 **POST /api/v3/agents **
Илья Крайнов 50.1 118 )))
119
120 Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
121
122 Метод запроса: **POST**
123
124 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
125
126 В заголовках запроса: X-Auth: Токен авторизации
127
128 Параметры в теле запроса (JSON):
129
130 {
131 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
132 "name": "string", ~/~/ имя
133 "fullName": "string", ~/~/ полное наименование
134 "isForeign": true, ~/~/ иностранный контрагент
135 "district": "string", ~/~/ округ
136 "region": "string", ~/~/ регион
137 "city": "string", ~/~/ город
138 "inn": "string", ~/~/ ИНН
139 "kpp": "string", ~/~/ КПП
140 "address": "string", ~/~/ юридический адрес
141 "addressFact": "string", ~/~/ фактический адрес
142 "email": "string", ~/~/ email
143 "director": "string", ~/~/ ФИО руководителя
144 "bankName": "string", ~/~/ банк
145 "bankBIK": "string", ~/~/ БИК
146 "bankRS": "string", ~/~/ номер счёта
147 "bankKS": "string" ~/~/ корр. счёт
148 }
149
150
151 Ответ:
152
153 {
154 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
155 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
156 "name": "string", ~/~/ имя
157 "fullName": "string", ~/~/ полное наименование
158 "isForeign": true, ~/~/ иностранный контрагент
159 "district": "string", ~/~/ округ
160 "region": "string", ~/~/ регион
161 "city": "string", ~/~/ город
162 "inn": "string", ~/~/ ИНН
163 "kpp": "string", ~/~/ КПП
164 "address": "string", ~/~/ юридический адрес
165 "addressFact": "string", ~/~/ фактический адрес
166 "email": "string", ~/~/ email
167 "director": "string", ~/~/ ФИО руководителя
168 "bankName": "string", ~/~/ банк
169 "bankBIK": "string", ~/~/ БИК
170 "bankRS": "string", ~/~/ номер счёта
171 "bankKS": "string" ~/~/ корр. счёт
172 }
173
Илья Крайнов 66.10 174 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
Илья Крайнов 60.1 175
Илья Крайнов 50.1 176 (% class="box warningmessage" %)
177 (((
Илья Крайнов 60.1 178 **PUT /api/v3/agents**
Илья Крайнов 50.1 179 )))
180
181 Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
182
183 Метод запроса: **PUT**
184
185 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
186
187 В заголовках запроса: X-Auth: Токен авторизации
188
189
190 Параметры в теле запроса (JSON):
191
192 {
193 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
194 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
195 "name": "string", ~/~/ имя
196 "fullName": "string", ~/~/ полное наименование
197 "isForeign": true, ~/~/ иностранный контрагент
198 "district": "string", ~/~/ округ
199 "region": "string", ~/~/ регион
200 "city": "string", ~/~/ город
201 "inn": "string", ~/~/ ИНН
202 "kpp": "string", ~/~/ КПП
203 "address": "string", ~/~/ юридический адрес
204 "addressFact": "string", ~/~/ фактический адрес
205 "email": "string", ~/~/ email
206 "director": "string", ~/~/ ФИО руководителя
207 "bankName": "string", ~/~/ банк
208 "bankBIK": "string", ~/~/ БИК
209 "bankRS": "string", ~/~/ номер счёта
210 "bankKS": "string" ~/~/ корр. счёт
211 }
212
213
214 Ответ:
215
216 {
217 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
218 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
219 "name": "string", ~/~/ имя
220 "fullName": "string", ~/~/ полное наименование
221 "isForeign": true, ~/~/ иностранный контрагент
222 "district": "string", ~/~/ округ
223 "region": "string", ~/~/ регион
224 "city": "string", ~/~/ город
225 "inn": "string", ~/~/ ИНН
226 "kpp": "string", ~/~/ КПП
227 "address": "string", ~/~/ юридический адрес
228 "addressFact": "string", ~/~/ фактический адрес
229 "email": "string", ~/~/ email
230 "director": "string", ~/~/ ФИО руководителя
231 "bankName": "string", ~/~/ банк
232 "bankBIK": "string", ~/~/ БИК
233 "bankRS": "string", ~/~/ номер счёта
234 "bankKS": "string" ~/~/ корр. счёт
235 }
236
Илья Крайнов 66.11 237 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
Илья Крайнов 50.1 238
239 (% class="box errormessage" %)
240 (((
Илья Крайнов 60.1 241 **DELETE /api/v3/agents/{clientId}**
Илья Крайнов 50.1 242 )))
243
244 Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
245
246 Метод запроса: **DELETE**
247
248 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
249
250 Параметр запроса: **{clientId}** - Guid пользователя
251
252 В заголовках запроса: X-Auth: Токен авторизации
253
254 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
255
Илья Крайнов 65.1 256 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
Илья Крайнов 50.1 257
Илья Крайнов 66.11 258 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
Андрей Калиновский 1.1 259
Артем Шемяков 8.1 260 (% class="box successmessage" %)
261 (((
Илья Крайнов 60.1 262 (% lang="en-US" %)**POST /api/v3/users**
Артем Шемяков 8.1 263 )))
Андрей Калиновский 1.1 264
Илья Крайнов 60.1 265 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 266
Артем Шемяков 8.1 267 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 268
Артем Шемяков 8.1 269 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
Андрей Калиновский 1.1 270
Артем Шемяков 8.1 271 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 272
Артем Шемяков 20.3 273 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 274
Артем Шемяков 20.3 275 (% style="color:#000000" %){ 
Артем Шемяков 20.4 276 "lastName": "", ~/~/ фамилия
Артем Шемяков 20.3 277 "firstName": "", ~/~/ имя
278 "position": "", ~/~/ должность
279 "phone": "", ~/~/ телефон
280 "organization": "", ~/~/ организация
Илья Крайнов 40.1 281 "login": "", ~/~/ логин (обязателен)
282 "password": "", ~/~/ пароль (обязателен)
283 "email": "", ~/~/ email (обязателен)
Артем Шемяков 20.3 284 "description": "", ~/~/ описание
285 "isEnabled": "", ~/~/ признак включения
286 "parentId": "", ~/~/ Guid родительского агента
287 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
288 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
289 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
290 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
291 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
Илья Крайнов 38.1 292 "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
Артем Шемяков 21.12 293 }
Артем Шемяков 20.3 294
Артем Шемяков 8.1 295 (% style="text-align:left" %)
Артем Шемяков 20.3 296 (% style="color:#000000; font-weight:normal" %)Ответ:
Андрей Калиновский 1.1 297
Артем Шемяков 20.3 298 (% style="text-align:left" %)
Артем Шемяков 21.2 299 (% style="color:#000000; font-weight:normal" %){    
Андрей Калиновский 1.1 300
Артем Шемяков 20.3 301 (% style="text-align:left" %)
Артем Шемяков 20.4 302 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
Артем Шемяков 20.3 303 "lastName": "" , ~/~/ Фамилия ,
304 "firstName": "" , ~/~/ Имя
305 "position": "" , ~/~/ Должность
306 "phone": "" , ~/~/ Телефон
307 "organization": "" , ~/~/ Организация
308 "login": "" , ~/~/ Логин
309 "password": "" , ~/~/ Пароль
310 "email": "" , ~/~/ Email
311 "description": "" , ~/~/ Описание
312 "isEnabled": "" , ~/~/ Признак включения
313 "parentId": "" , ~/~/ Guid родительского агента
314 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
315 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
316 "kind": "" , ~/~/ тип аутентификации
317 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
Илья Крайнов 39.1 318 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
Артем Шемяков 20.3 319
320 (% style="text-align:left" %)
Артем Шемяков 21.12 321 (% style="color:#000000; font-weight:normal" %)}
Артем Шемяков 20.3 322
Илья Крайнов 66.12 323 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
Артем Шемяков 20.3 324
Артем Шемяков 18.1 325 (% class="box successmessage" %)
326 (((
Илья Крайнов 60.1 327 (% lang="en-US" %)**POST /api/v3/users/find**
Артем Шемяков 18.1 328 )))
329
Илья Крайнов 60.1 330 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
Артем Шемяков 18.1 331
Артем Шемяков 23.2 332 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
Артем Шемяков 18.1 333
334 (% style="color:#000000" %)Метод запроса: **POST**
335
336 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
337
Артем Шемяков 22.5 338 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
Артем Шемяков 18.1 339
Артем Шемяков 22.5 340 (% style="color:#000000" %)Параметры в теле запроса (JSON):
341
Артем Шемяков 20.4 342 (% style="color:#000000" %){
Артем Шемяков 18.1 343
Артем Шемяков 20.4 344 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
345 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
346 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
347 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
348
Артем Шемяков 21.12 349 (% style="color:#000000" %)}
Артем Шемяков 18.1 350
Артем Шемяков 20.4 351 (% style="color:#000000" %)Ответ:
Артем Шемяков 18.1 352
Артем Шемяков 21.2 353 (% style="color:#000000" %){         (%%)
Артем Шемяков 20.4 354
Артем Шемяков 20.5 355 "id": "" , ~/~/ идентификатор пользователя
Артем Шемяков 20.4 356 "lastName": "" , ~/~/ фамилия
357 "firstName": "" , ~/~/ имя
358 "position": "" , ~/~/ должность
359 "phone": "" , ~/~/ телефон
360 "parentId": "" , ~/~/ идентификатор клиента-родителя
361 "parentName": "" , ~/~/ наименование клиента-родителя
362 "organization": "" , ~/~/ организация
363 "login": "" , ~/~/ логин
364 "email": "" , ~/~/ E-mail
Артем Шемяков 20.5 365 "sessionDuration":"", ~/~/ длительность сессии в минутах
366 "status": "1",  ~/~/ статус пользователя
367 "astLogged": "", ~/~/ дата/время последней авторизации
Артем Шемяков 20.4 368
Артем Шемяков 21.12 369 (% style="color:#000000" %)}
Артем Шемяков 20.4 370
Илья Крайнов 66.12 371 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
Артем Шемяков 18.1 372
Илья Крайнов 41.1 373 (% class="box successmessage" %)
374 (((
Илья Крайнов 60.1 375 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
Илья Крайнов 41.1 376 )))
377
Илья Крайнов 60.1 378 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
Илья Крайнов 41.1 379
380 (% style="color:#000000" %)Метод запроса: **GET**
381
382 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
383
Илья Крайнов 43.1 384 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
385
Илья Крайнов 41.1 386 (% style="color:#000000" %)Ответ:
387
388 (((
Илья Крайнов 41.2 389 (((
Илья Крайнов 41.1 390 {
391 "id": "", ~/~/ GUID пользователя
Илья Крайнов 47.1 392 "lastName": "", ~/~/ Фамилия 
Илья Крайнов 41.1 393 "firstName": "", ~/~/ Имя
394 "position": "", ~/~/ Должность
395 "phone": "", ~/~/ Номер телефона
396 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
397 "parentName": "", Наименование клиента, которому принадлежит пользователь
398 "organization": "", ~/~/ Организация
399 "login": "", ~/~/ Логин пользователя
400 "email": "", ~/~/ Адрес электронной почты
401 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
402 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
403 "description": "", ~/~/ Описание
404 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
405 "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
406 "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
407 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
408 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
409 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
410 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
411 "groups": [], ~/~/ Список ролей пользователя
412 "customGroups": [], ~/~/ Список клиентских ролей пользователя
413 "authDevices": [ ], ~/~/ Список авторизованных устройств
414 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
415 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
416 }
417 )))
Илья Крайнов 41.2 418 )))
Илья Крайнов 41.1 419
Илья Крайнов 66.12 420 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
Илья Крайнов 41.1 421
Артем Шемяков 8.1 422 (% class="box warningmessage" %)
423 (((
Илья Крайнов 60.1 424 (% lang="en-US" %)**PUT /api/v3/users**
Артем Шемяков 8.1 425 )))
Андрей Калиновский 1.1 426
Илья Крайнов 60.1 427 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 428
Артем Шемяков 8.1 429 (% style="color:#000000" %)Метод запроса: **PUT**
Андрей Калиновский 1.1 430
Артем Шемяков 8.1 431 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
Андрей Калиновский 1.1 432
Артем Шемяков 8.1 433 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 434
Артем Шемяков 8.1 435 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 20.6 436 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 437
Артем Шемяков 20.6 438 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.2 439 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
Андрей Калиновский 1.1 440
Артем Шемяков 20.6 441 (% lang="en-US" style="text-align:left" %)
442 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
443 "lastName": "" , ~/~/ фамилия
444 "firstName": "" , ~/~/ имя
445 "position": "" , ~/~/ должность
446 "phone": "" , ~/~/ телефон
447 "organization": "" , ~/~/ организация
Илья Крайнов 41.1 448 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
Илья Крайнов 40.1 449 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
Илья Крайнов 41.1 450 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
Илья Крайнов 40.1 451 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
Артем Шемяков 20.6 452 "isEnabled": "" , ~/~/ признак включения
453 "parentId": "" , ~/~/ Guid родительского агента
454 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
455 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
456 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
457 "kind": "" , ~/~/ тип аутентификации
458 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
459 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
460
461 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 462 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
Артем Шемяков 20.6 463
464 (% lang="en-US" style="text-align:left" %)
465 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
466
467 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 468 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 20.6 469
470 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 471 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
Артем Шемяков 20.6 472 "lastName": "" , ~/~/ фамилия
473 "firstName": "" , ~/~/ имя
474 "position": "" , ~/~/ должность
475 "phone": "" , ~/~/ телефон
476 "organization": "" , ~/~/ организация
477 "login": "" , ~/~/ логин
478 "password": "" , ~/~/ пароль 
479 "email": "" , ~/~/ email
480 "description": "" , ~/~/ описание
481 "isEnabled": "" , ~/~/ признак включения
482 "parentId": "" , ~/~/ Guid родительского агента
483 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
484 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
485 "kind": "" , ~/~/ тип аутентификации
486 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
Артем Шемяков 21.12 487 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
Артем Шемяков 20.6 488
489 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 490 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
Артем Шемяков 20.6 491
Илья Крайнов 66.12 492 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
Артем Шемяков 20.6 493
Артем Шемяков 8.1 494 (% class="box warningmessage" %)
495 (((
Илья Крайнов 60.1 496 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
Артем Шемяков 8.1 497 )))
Андрей Калиновский 1.1 498
Илья Крайнов 60.1 499 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 500
Артем Шемяков 8.1 501 (% style="color:#000000" %)Метод запроса: **PUT**
Андрей Калиновский 1.1 502
Артем Шемяков 20.7 503 (% 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 504
Артем Шемяков 22.4 505 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
Андрей Калиновский 1.1 506
Артем Шемяков 20.7 507 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 508
Артем Шемяков 20.7 509 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 510
Артем Шемяков 20.7 511 (% style="color:#000000" %){
512
513 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
514 "description": "" , ~/~/ описание
515 "data": "" , ~/~/ данные, связанные со сменой статуса
516
Артем Шемяков 21.12 517 (% style="color:#000000" %)}
Артем Шемяков 20.7 518
Артем Шемяков 8.1 519 (% style="text-align:left" %)
520 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
Андрей Калиновский 1.1 521
Илья Крайнов 66.12 522 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
Андрей Калиновский 1.1 523
Илья Крайнов 30.1 524 (% class="box warningmessage" %)
525 (((
Илья Крайнов 60.1 526 **POST /api/v3/users/disable**
Илья Крайнов 30.1 527 )))
528
529 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
530
531 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
532
533 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
534
535 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
536
537 [ 
538 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
539 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
540 ]
541
Илья Крайнов 31.1 542 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
Илья Крайнов 30.1 543
Илья Крайнов 66.12 544 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
Илья Крайнов 60.1 545
Илья Крайнов 30.1 546 (% class="box warningmessage" %)
547 (((
Илья Крайнов 60.1 548 **POST /api/v3/users/enable**
Илья Крайнов 30.1 549 )))
550
551 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
552
553 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
554
555 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
556
557 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
558
559 [ 
560 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
561 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
562 ]
563
Андрей Калиновский 33.1 564 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
565 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
Илья Крайнов 30.1 566
Илья Крайнов 41.1 567 (((
Андрей Калиновский 33.1 568 В теле ответа:
569 {
570 "errorMessages": [
571 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
572 ],
573 "users": [
574 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
575 ]
576 }
577 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
578 "users" - массив id пользователей, которых не удалось включить или отключить.
Илья Крайнов 41.1 579 )))
Илья Крайнов 31.1 580
Илья Крайнов 66.12 581 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
582
Артем Шемяков 8.1 583 (% class="box errormessage" %)
584 (((
Илья Крайнов 60.1 585 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
Артем Шемяков 8.1 586 )))
Андрей Калиновский 1.1 587
Илья Крайнов 60.1 588 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 589
Артем Шемяков 8.1 590 (% style="color:#000000" %)Метод запроса: **DELETE**
Андрей Калиновский 1.1 591
Артем Шемяков 8.1 592 (% 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 593
Артем Шемяков 22.5 594 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
Андрей Калиновский 1.1 595
Артем Шемяков 20.8 596 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
597
Артем Шемяков 8.1 598 (% style="text-align:left" %)
599 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
Андрей Калиновский 1.1 600
Илья Крайнов 65.1 601 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
Андрей Калиновский 1.1 602
Илья Крайнов 66.14 603 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
Илья Крайнов 60.1 604
Артем Шемяков 8.1 605 (% class="box infomessage" %)
606 (((
Илья Крайнов 60.1 607 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
Артем Шемяков 8.1 608 )))
Андрей Калиновский 1.1 609
Илья Крайнов 60.1 610 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
Андрей Калиновский 1.1 611
Илья Крайнов 60.1 612 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 613
Артем Шемяков 8.1 614 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
Андрей Калиновский 1.1 615
Артем Шемяков 22.5 616 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
Андрей Калиновский 1.1 617
Артем Шемяков 8.1 618 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 619
Артем Шемяков 8.1 620 (% 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 621
Артем Шемяков 22.5 622 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
Андрей Калиновский 1.1 623
Артем Шемяков 8.1 624 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 625
Артем Шемяков 8.1 626 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 627
Илья Крайнов 41.1 628 (((
Илья Крайнов 35.1 629 {
Илья Крайнов 36.1 630 "vehicleId": "", ~/~/ ID объекта
631 "name": "", ~/~/ Имя объекта
632 "imei": "", ~/~/ IMEI объекта
633 "deviceTypeId": , ~/~/ ID типа устройства
634 "deviceTypeName": "", ~/~/ Название типа устройства
635 "sim1": "", ~/~/ Номер SIM1
636 "parentId": "", Номер SIM2
Илья Крайнов 47.1 637 "parentName": "", Наименование клиента-родителя
Илья Крайнов 36.1 638 "modelId": "", ID модели объекта
639 "modelName": "", Имя модели объекта
640 "createdAt": "", Дата создания объекта
641 "mileageCalcMethod": "", Выбранный метод расчета пробега
642 "counters": { ~/~/ Нормы
643 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
644 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
645 "mileage": "", ~/~/ Пробег по нормам в метрах
646 "motohours": "" ~/~/ Моточасы по нормам, в секундах
Илья Крайнов 35.1 647 },
Илья Крайнов 36.1 648 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
Илья Крайнов 35.1 649 {
Илья Крайнов 47.1 650 "id": "", ~/~/ ID  задания
Илья Крайнов 37.1 651 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
Илья Крайнов 36.1 652 "name": "", ~/~/ Наименование задания
653 "description": "", ~/~/ Описание задания
654 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
655 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
656 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
657 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
658 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
659 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
660 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
661 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Илья Крайнов 35.1 662 }
663 ]
Артем Шемяков 21.12 664 }
Илья Крайнов 41.1 665 )))
Андрей Калиновский 1.1 666
Артем Шемяков 8.1 667 (% style="text-align:left" %)
668 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
Андрей Калиновский 1.1 669
Артем Шемяков 8.1 670 (% style="text-align:left" %)
671 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
Андрей Калиновский 1.1 672
Илья Крайнов 66.14 673 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
Андрей Калиновский 1.1 674
Артем Шемяков 8.1 675 (% class="box successmessage" %)
676 (((
Илья Крайнов 60.1 677 (% lang="en-US" %)**POST /api/v3/vehicles**
Артем Шемяков 8.1 678 )))
Андрей Калиновский 1.1 679
Илья Крайнов 60.1 680 (% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
Андрей Калиновский 1.1 681
Артем Шемяков 8.1 682 (% style="color:#000000" %)Метод запроса: **POST**
683
684 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
685
686 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
687
Артем Шемяков 21.2 688 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
Артем Шемяков 8.1 689
Артем Шемяков 21.2 690 (% style="color:#000000" %){
691
692 "parentId": "" , ~/~/ ID клиента
693 "name": "" , ~/~/ имя ТС
694 "imei": "" , ~/~/ IMEI
695 "deviceTypeId": "" , ~/~/ ID типа устройства
696 "modelId": "" , ~/~/ ID модели
697 "unitId": "" , ~/~/ ID подразделения
698 "sim1": "" , ~/~/ Номер SIM 1
699 "sim2": "" , ~/~/ Номер SIM2
700 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
701 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
Артем Шемяков 28.1 702 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
Артем Шемяков 28.5 703 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
704 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
705 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
706 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
707 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
708 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
709 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
710 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
711 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
Артем Шемяков 28.6 712 "counters": ~/~/ счетчики
713 {
Артем Шемяков 28.2 714 "mileage": "" , ~/~/ пробег
715 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
716 "motohours": "" , ~/~/ моточасы
717 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
Артем Шемяков 21.12 718 },
Артем Шемяков 21.2 719 "cmsv6Parameters": { ~/~/ параметры CMSv6
720 "enabled": true, ~/~/ флаг включения
721 "id": "" , ~/~/ идентификатор
722 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
723 "login": "" , ~/~/ имя учетной записи
724 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 725 },
Артем Шемяков 21.2 726 "inspectionTasks": ~/~/ задания на ТО
Андрей Калиновский 1.1 727 {
Артем Шемяков 21.2 728 "enabled": "" , ~/~/ Признак включения
729 "name": "" , ~/~/ Имя задания
730 "description": "" , ~/~/ Описание задания
731 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
732 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
733 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
734 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
735 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
736 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
737 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
738 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
739 }
Андрей Калиновский 1.1 740
Артем Шемяков 21.2 741 (% style="color:#000000" %) }
Андрей Калиновский 1.1 742
Артем Шемяков 8.1 743 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 744
Артем Шемяков 8.1 745 (% style="color:#000000" %){
Андрей Калиновский 1.1 746
Артем Шемяков 21.3 747 "vehicleId": "", ~/~/ID ТС 
748 "parentId": "", ~/~/Guid владельца ТС
749 "name": "", ~/~/Имя объекта
750 "imei": "", ~/~/IMEI
751 "deviceTypeId": "", ~/~/ID типа устройства
752 "modelId": "", ~/~/ID модели
753 "unitId": "", ~/~/ID подразделения
754 "sim1": "", ~/~/SIM1
755 "sim2": "", ~/~/SIM2
756 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
757 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
758 "counters": { ~/~/Счётчики
759 "mileageEnabled": true,
760 "motohoursEnabled": true,
761 "mileage": "",
762 "motohours": 345.0
Артем Шемяков 21.12 763 },
Артем Шемяков 21.3 764 "cmsv6Parameters": { ~/~/Параметры CmsV6
765 "id": null,
766 "enabled": true, ~/~/флаг включения
767 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
768 "login": "", ~/~/ имя учетной записи
769 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 770 },
Артем Шемяков 21.3 771 "inspectionTasks": { ~/~/ задания на ТО
772 "id": "", ~/~/ ID задачи
773 "enabled": false, ~/~/ Признак включения
774 "name": "", ~/~/ Имя задания
775 "description": "", ~/~/ Описание задания
776 "mileageCondition": "", ~/~/ Условие по пробегу
777 "lastMileage": "", ~/~/ Пробег (в метрах)
778 "motohoursCondition": "", ~/~/ Условие по моточасам
779 "lastMotohours": "", ~/~/ Моточасы
780 "periodicCondition": "", ~/~/ Условие периодичности по времени
781 "kind": "", ~/~/ Вид периодичности по времени 
782 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Артем Шемяков 21.12 783 }
Андрей Калиновский 1.1 784
Артем Шемяков 8.1 785 (% style="text-align:left" %)
786 (% style="color:#000000" %)}
Андрей Калиновский 1.1 787
Артем Шемяков 28.3 788 **Валидация:**
789 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
790 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
791 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Андрей Калиновский 1.1 792
Илья Крайнов 66.14 793 == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
Артем Шемяков 28.4 794
Артем Шемяков 8.1 795 (% class="box successmessage" %)
796 (((
Илья Крайнов 60.1 797 (% lang="en-US" %)**POST /api/v3/vehicles/find**
Артем Шемяков 8.1 798 )))
Андрей Калиновский 1.1 799
Илья Крайнов 60.1 800 (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
Андрей Калиновский 1.1 801
Илья Крайнов 60.1 802 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 803
Артем Шемяков 8.1 804 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
Андрей Калиновский 1.1 805
Артем Шемяков 8.1 806 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
Андрей Калиновский 1.1 807
Артем Шемяков 21.7 808 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
Андрей Калиновский 1.1 809
Артем Шемяков 21.7 810 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
Андрей Калиновский 1.1 811
Артем Шемяков 21.7 812 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
Андрей Калиновский 1.1 813
Артем Шемяков 8.1 814 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 815
Артем Шемяков 8.1 816 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
Андрей Калиновский 1.1 817
Артем Шемяков 8.1 818 (% style="color:#000000" %)В заголовках запроса:
Андрей Калиновский 1.1 819
Артем Шемяков 22.6 820 (% style="color:#000000" %)− Content-Type: __**application/json**__
Андрей Калиновский 1.1 821
Артем Шемяков 8.1 822 (% style="color:#000000" %)− X-Auth: Токен авторизации
823
Артем Шемяков 22.7 824 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
Артем Шемяков 8.1 825
Артем Шемяков 22.7 826 (% style="color:#000000" %)Параметры в теле запроса (JSON):
827
Илья Крайнов 45.1 828 {
829 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
Илья Крайнов 44.1 830 "name": null, ~/~/ Имя ТС (string, опционально)
831 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
832 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
833 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
834 "parentId": null, ~/~/ ID клиента (Guid, опционально)
Илья Крайнов 47.1 835 "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
Илья Крайнов 46.1 836 "customFields": null ~/~/ значение любого из произвольных полей ТС
Илья Крайнов 45.1 837 }
Илья Крайнов 44.1 838
Илья Крайнов 60.1 839 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
Артем Шемяков 8.1 840
Артем Шемяков 21.7 841 (% style="color:#000000" %)Ответ:
Артем Шемяков 8.1 842
Артем Шемяков 21.7 843 (% style="color:#000000" %){
Артем Шемяков 8.1 844
Артем Шемяков 21.7 845 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
846 "name": "" ~/~/ наименование объекта
847 "imei": "" ~/~/ IMEI объекта
848 "deviceTypeId": "" ~/~/ идентификатор типа устройства
849 "deviceTypeName": "" ~/~/ наименование типа устройства
850 "sim1": "" ~/~/ первый номер телефона
851 "sim2": "" ~/~/ второй номер телефона
852 "parentId": "" ~/~/ идентификатор клиента-родителя
853 "parentName": "" ~/~/ наименование клиента-родителя
854 "modelId": "" ~/~/ идентификатор модели объекта
855 "modelName": "" ~/~/ наименование модели объекта
856 "unitId": "" ~/~/ идентификатор подразделения
857 "unitName": "" ~/~/ наименование подразделения
Артем Шемяков 25.1 858 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
859 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
860 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
Илья Крайнов 49.1 861 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
862 "customFields": [ 
863 {
864 "id": "", ~/~/ идентификатор произвольного поля
865 "name": "", ~/~/ имя произвольного поля
866 "value": "", ~/~/ значение произвольного поля
867 "forClient": true, ~/~/ право на отображение у клиента
868 "forTooltip": false, ~/~/ право на отображение в подсказке
869 "forReport": false ~/~/ право на отображение в отчетах
870 }(%%)
Артем Шемяков 21.7 871 (% style="color:#000000" %)}
872
Артем Шемяков 22.7 873 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
Артем Шемяков 21.7 874
Илья Крайнов 66.14 875 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
Артем Шемяков 22.7 876
Артем Шемяков 8.1 877 (% class="box successmessage" %)
878 (((
Илья Крайнов 60.1 879 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
Артем Шемяков 8.1 880 )))
881
Илья Крайнов 60.1 882 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 8.1 883
884 (% style="color:#000000" %)Метод запроса: **POST**
885
886 (% 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}
887
Артем Шемяков 22.8 888 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
Артем Шемяков 8.1 889
890 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
891
Артем Шемяков 21.8 892 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Артем Шемяков 8.1 893
Артем Шемяков 21.8 894 (% style="color:#000000" %){
Артем Шемяков 21.7 895
Артем Шемяков 21.8 896 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
897 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
898 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
899 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
900 "description": "", ~/~/ Описание
901 "data": "", ~/~/ Данные
902 "overwrite": false, ~/~/ Флаг перезаписи
903 "stage": "", ~/~/ Состояние, может быть null
Андрей Калиновский 1.1 904
Артем Шемяков 21.12 905 (% style="color:#000000" %)}
Артем Шемяков 21.7 906
Артем Шемяков 21.8 907 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 908
Артем Шемяков 21.8 909 (% style="color:#000000" %){
Андрей Калиновский 1.1 910
Артем Шемяков 21.8 911 "status": "", ~/~/ значение статуса
912 "date": "", ~/~/ Дата смены статуса 
913 "description": "", ~/~/ Описание
914 "data": "", ~/~/ Данные
915 "overwrite": false, ~/~/ Флаг перезаписи
916 "stage": "", ~/~/ Состояние
Андрей Калиновский 1.1 917
Артем Шемяков 8.1 918 (% style="text-align:left" %)
Артем Шемяков 21.12 919 (% style="color:#000000" %) }
Андрей Калиновский 1.1 920
Илья Крайнов 66.14 921 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
Андрей Калиновский 1.1 922
Артем Шемяков 18.1 923 (% class="box warningmessage" %)
924 (((
Илья Крайнов 60.1 925 (% lang="en-US" %)**PUT /api/v3/vehicles**
Артем Шемяков 18.1 926 )))
927
Илья Крайнов 60.1 928 (% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 929
930 (% style="color:#000000" %)Метод запроса: **PUT**
931
932 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
933
934 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
935
936 (% style="color:#000000" %)Параметры в теле запроса (JSON):
937
Артем Шемяков 22.2 938 (% style="color:#000000" %){    
Артем Шемяков 18.1 939
Артем Шемяков 28.8 940 (((
Артем Шемяков 21.10 941 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
942 "parentId": "", ~/~/ ID клиента
943 "name": "", ~/~/ имя ТС
944 "imei": "", ~/~/ IMEI
945 "deviceTypeId": "", ~/~/ ID типа устройства
946 "modelId": "", ~/~/ , ID модели    
947 "unitId": "", ~/~/ подразделения
948 "sim1": "", ~/~/ SIM 1
Илья Крайнов 30.1 949 "sim2": "", ~/~/ SIM2     (%%)
Артем Шемяков 28.6 950 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
951 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
952 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
953 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
954 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
955 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
956 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
957 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
958 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
959 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
960 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
961 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
962 (% style="color:#000000" %) "counters": 
Артем Шемяков 21.10 963 {
964 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
965 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
Илья Крайнов 34.1 966 "mileage": "", ~/~/ пробег, в метрах 
967 "motohours": "" ~/~/ моточасы, в секундах
Артем Шемяков 21.10 968 }
969 "cmsv6Parameters": ~/~/ параметры CMSv6
970 {       
971 "id": "", ~/~/ идентификатор
972 "enabled": true, ~/~/ флаг включения
973 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
974 "login": "", ~/~/ имя учетной записи
975 "password": "", ~/~/ пароль учетной записи
976 }
977 "inspectionTasks": ~/~/ задания на ТО
978 {
979 "id": "", ~/~/ ID задания
980 "enabled": false, ~/~/ Признак включения
981 "name": "", ~/~/ Имя задания
982 "description": "", ~/~/ Описание задания
983 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
984 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
985 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
986 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
987 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
988 "kind": "", ~/~/ Вид периодичности по времени
989 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
Артем Шемяков 22.2 990 } 
Артем Шемяков 28.8 991 )))
Артем Шемяков 21.9 992
993 (% style="color:#000000" %)}
994
Артем Шемяков 18.1 995 (% style="color:#000000" %)Ответ:
996
997 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 22.2 998 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 18.1 999
Артем Шемяков 21.11 1000 (% lang="en-US" style="text-align:left" %)
1001 "vehicleId": "", ~/~/ ID ТС
1002 "parentId": "", ~/~/ ID клиента
1003 "name": "", ~/~/ имя ТС
1004 "imei": "", ~/~/ IMEI
1005 "deviceTypeId": "", ~/~/ типа устройства
1006 "modelId": "", ~/~/ ID модели
1007 "unitId": "", ~/~/ ID подразделения
1008 "sim1": "", ~/~/ SIM 1
1009 "sim2": "", ~/~/ SIM2
1010 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1011 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1012 "counters": 
1013 {
1014 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1015 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1016 "mileage": "", ~/~/ пробег
1017 "motohours": "", ~/~/ моточасы
1018 }
1019 "cmsv6Parameters": ~/~/ параметры CMSv6
1020 {
1021 "id": ~/~/ идентификатор
1022 "enabled": true, ~/~/ флаг включения
1023 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1024 "login": "", ~/~/ имя учетной записи
1025 "password": "", ~/~/ пароль учетной записи
1026 }
1027 "inspectionTasks": ~/~/ задания на ТО
1028 {
1029 "id": "", ~/~/ ID задания
1030 "enabled": false, ~/~/ Признак включения
1031 "name": "", ~/~/ Имя задания
1032 "description": "", ~/~/ Описание задания
1033 "mileageCondition": "", ~/~/ Условие по пробегу
1034 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1035 "motohoursCondition": "", ~/~/ Условие по моточасам
1036 "lastMotohours": "", ~/~/ Моточасы
1037 "periodicCondition": "", ~/~/ Условие периодичности по времени
1038 "kind": "", ~/~/ Вид периодичности по времени
1039 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1040 }
Артем Шемяков 18.1 1041
Артем Шемяков 21.11 1042 (% lang="en-US" style="text-align:left" %)
1043 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1044
Артем Шемяков 28.7 1045 **валидация:**
1046 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1047 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1048 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Артем Шемяков 21.11 1049
Илья Крайнов 66.14 1050 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
Артем Шемяков 28.7 1051
Артем Шемяков 18.1 1052 (% class="box errormessage" %)
1053 (((
Илья Крайнов 60.1 1054 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
Артем Шемяков 18.1 1055 )))
1056
Илья Крайнов 60.1 1057 (% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 1058
1059 (% style="color:#000000" %)Метод запроса: **DELETE**
1060
1061 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1062
Артем Шемяков 22.8 1063 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
Артем Шемяков 18.1 1064
1065 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1066
1067 (% style="text-align:left" %)
1068 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1069
Илья Крайнов 66.14 1070 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
Артем Шемяков 18.1 1071
Илья Крайнов 66.14 1072 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
Артем Шемяков 17.1 1073
1074 (% class="box infomessage" %)
1075 (((
Илья Крайнов 60.1 1076 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
Артем Шемяков 17.1 1077 )))
1078
Илья Крайнов 60.1 1079 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 1080
1081 (% style="color:#000000" %)Метод запроса: **GET**
1082
1083 (% 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]]
1084
1085 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1086
Артем Шемяков 21.12 1087 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 1088
Артем Шемяков 21.12 1089 (% style="color:#000000" %){
Артем Шемяков 17.1 1090
Артем Шемяков 21.12 1091 "deviceTypeId" : "", ~/~/ ID типа устройства
1092 "deviceTypeName" : "" ~/~/ Название типа устройства
1093
Артем Шемяков 17.1 1094 (% style="text-align:left" %)
Артем Шемяков 21.12 1095 (% style="color:#000000" %)}
Артем Шемяков 17.1 1096
Илья Крайнов 66.15 1097 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
Артем Шемяков 17.1 1098
Илья Крайнов 66.15 1099 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
Артем Шемяков 17.1 1100
1101 (% class="box infomessage" %)
1102 (((
Илья Крайнов 60.1 1103 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
Артем Шемяков 17.1 1104 )))
1105
Илья Крайнов 60.1 1106 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 1107
1108 (% style="color:#000000" %)Метод запроса: **GET**
1109
1110 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1111
1112 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1113
Артем Шемяков 21.12 1114 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 1115
Артем Шемяков 21.12 1116 (% style="color:#000000" %){
Артем Шемяков 17.1 1117
Артем Шемяков 21.12 1118 "id": "", ~/~/ ID типа датчика 
1119 "name": "", ~/~/ Название
1120 "description": "", ~/~/ Описание
Артем Шемяков 17.1 1121
1122 (% style="text-align:left" %)
Артем Шемяков 21.12 1123 (% style="color:#000000" %)}
Артем Шемяков 17.1 1124
1125
1126 (% class="box" lang="en-US" style="text-align: center;" %)
1127 (((
Артем Шемяков 14.1 1128 (% 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 1129 )))

Меню

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