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

Меню

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