Версия 76.3 от Илья Крайнов на 2023/03/14 14:20
Скрыть последних авторов
Артем Шемяков 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 - отключен
452 "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
453 "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
454 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
455 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
456 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
457 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
458 "groups": [], ~/~/ Список ролей пользователя
459 "customGroups": [], ~/~/ Список клиентских ролей пользователя
460 "authDevices": [ ], ~/~/ Список авторизованных устройств
461 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
462 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
463 }
464 )))
Илья Крайнов 41.2 465 )))
Илья Крайнов 41.1 466
Илья Крайнов 66.12 467 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
Илья Крайнов 41.1 468
Артем Шемяков 8.1 469 (% class="box warningmessage" %)
470 (((
Илья Крайнов 60.1 471 (% lang="en-US" %)**PUT /api/v3/users**
Артем Шемяков 8.1 472 )))
Андрей Калиновский 1.1 473
Илья Крайнов 60.1 474 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 475
Артем Шемяков 8.1 476 (% style="color:#000000" %)Метод запроса: **PUT**
Андрей Калиновский 1.1 477
Артем Шемяков 8.1 478 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
Андрей Калиновский 1.1 479
Артем Шемяков 8.1 480 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 481
Артем Шемяков 8.1 482 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 20.6 483 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 484
Артем Шемяков 20.6 485 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.2 486 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
Андрей Калиновский 1.1 487
Артем Шемяков 20.6 488 (% lang="en-US" style="text-align:left" %)
489 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
490 "lastName": "" , ~/~/ фамилия
491 "firstName": "" , ~/~/ имя
492 "position": "" , ~/~/ должность
493 "phone": "" , ~/~/ телефон
494 "organization": "" , ~/~/ организация
Илья Крайнов 41.1 495 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
Илья Крайнов 40.1 496 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
Илья Крайнов 41.1 497 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
Илья Крайнов 40.1 498 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
Артем Шемяков 20.6 499 "isEnabled": "" , ~/~/ признак включения
500 "parentId": "" , ~/~/ Guid родительского агента
501 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
502 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
503 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
504 "kind": "" , ~/~/ тип аутентификации
505 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
506 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
507
508 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 509 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
Артем Шемяков 20.6 510
511 (% lang="en-US" style="text-align:left" %)
512 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
513
514 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 515 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 20.6 516
517 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 518 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
Артем Шемяков 20.6 519 "lastName": "" , ~/~/ фамилия
520 "firstName": "" , ~/~/ имя
521 "position": "" , ~/~/ должность
522 "phone": "" , ~/~/ телефон
523 "organization": "" , ~/~/ организация
524 "login": "" , ~/~/ логин
525 "password": "" , ~/~/ пароль 
526 "email": "" , ~/~/ email
527 "description": "" , ~/~/ описание
528 "isEnabled": "" , ~/~/ признак включения
529 "parentId": "" , ~/~/ Guid родительского агента
530 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
531 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
532 "kind": "" , ~/~/ тип аутентификации
533 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
Артем Шемяков 21.12 534 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
Артем Шемяков 20.6 535
536 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 21.12 537 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
Артем Шемяков 20.6 538
Илья Крайнов 66.12 539 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
Артем Шемяков 20.6 540
Артем Шемяков 8.1 541 (% class="box warningmessage" %)
542 (((
Илья Крайнов 60.1 543 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
Артем Шемяков 8.1 544 )))
Андрей Калиновский 1.1 545
Илья Крайнов 60.1 546 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 547
Артем Шемяков 8.1 548 (% style="color:#000000" %)Метод запроса: **PUT**
Андрей Калиновский 1.1 549
Артем Шемяков 20.7 550 (% 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 551
Артем Шемяков 22.4 552 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
Андрей Калиновский 1.1 553
Артем Шемяков 20.7 554 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 555
Артем Шемяков 20.7 556 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Андрей Калиновский 1.1 557
Артем Шемяков 20.7 558 (% style="color:#000000" %){
559
560 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
561 "description": "" , ~/~/ описание
562 "data": "" , ~/~/ данные, связанные со сменой статуса
563
Артем Шемяков 21.12 564 (% style="color:#000000" %)}
Артем Шемяков 20.7 565
Артем Шемяков 8.1 566 (% style="text-align:left" %)
567 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
Андрей Калиновский 1.1 568
Илья Крайнов 66.12 569 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
Андрей Калиновский 1.1 570
Илья Крайнов 30.1 571 (% class="box warningmessage" %)
572 (((
Илья Крайнов 60.1 573 **POST /api/v3/users/disable**
Илья Крайнов 30.1 574 )))
575
576 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
577
578 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
579
580 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
581
582 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
583
584 [ 
585 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
586 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
587 ]
588
Илья Крайнов 31.1 589 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
Илья Крайнов 30.1 590
Илья Крайнов 66.12 591 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
Илья Крайнов 60.1 592
Илья Крайнов 30.1 593 (% class="box warningmessage" %)
594 (((
Илья Крайнов 60.1 595 **POST /api/v3/users/enable**
Илья Крайнов 30.1 596 )))
597
598 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
599
600 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
601
602 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
603
604 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
605
606 [ 
607 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
608 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
609 ]
610
Андрей Калиновский 33.1 611 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
612 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
Илья Крайнов 30.1 613
Илья Крайнов 41.1 614 (((
Андрей Калиновский 33.1 615 В теле ответа:
616 {
617 "errorMessages": [
618 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
619 ],
620 "users": [
621 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
622 ]
623 }
624 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
625 "users" - массив id пользователей, которых не удалось включить или отключить.
Илья Крайнов 41.1 626 )))
Илья Крайнов 31.1 627
Илья Крайнов 66.12 628 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
629
Артем Шемяков 8.1 630 (% class="box errormessage" %)
631 (((
Илья Крайнов 60.1 632 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
Артем Шемяков 8.1 633 )))
Андрей Калиновский 1.1 634
Илья Крайнов 60.1 635 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Андрей Калиновский 1.1 636
Артем Шемяков 8.1 637 (% style="color:#000000" %)Метод запроса: **DELETE**
Андрей Калиновский 1.1 638
Артем Шемяков 8.1 639 (% 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 640
Артем Шемяков 22.5 641 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
Андрей Калиновский 1.1 642
Артем Шемяков 20.8 643 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
644
Артем Шемяков 8.1 645 (% style="text-align:left" %)
646 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
Андрей Калиновский 1.1 647
Илья Крайнов 65.1 648 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
Андрей Калиновский 1.1 649
Илья Крайнов 66.14 650 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
Илья Крайнов 60.1 651
Артем Шемяков 8.1 652 (% class="box infomessage" %)
653 (((
Илья Крайнов 60.1 654 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
Артем Шемяков 8.1 655 )))
Андрей Калиновский 1.1 656
Илья Крайнов 60.1 657 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
Андрей Калиновский 1.1 658
Илья Крайнов 60.1 659 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 660
Артем Шемяков 8.1 661 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
Андрей Калиновский 1.1 662
Артем Шемяков 22.5 663 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
Андрей Калиновский 1.1 664
Артем Шемяков 8.1 665 (% style="color:#000000" %)Метод запроса: **GET**
Андрей Калиновский 1.1 666
Артем Шемяков 8.1 667 (% 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 668
Артем Шемяков 22.5 669 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
Андрей Калиновский 1.1 670
Артем Шемяков 8.1 671 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Андрей Калиновский 1.1 672
Артем Шемяков 8.1 673 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 674
Илья Крайнов 41.1 675 (((
Илья Крайнов 35.1 676 {
Илья Крайнов 36.1 677 "vehicleId": "", ~/~/ ID объекта
678 "name": "", ~/~/ Имя объекта
679 "imei": "", ~/~/ IMEI объекта
680 "deviceTypeId": , ~/~/ ID типа устройства
681 "deviceTypeName": "", ~/~/ Название типа устройства
682 "sim1": "", ~/~/ Номер SIM1
683 "parentId": "", Номер SIM2
Илья Крайнов 47.1 684 "parentName": "", Наименование клиента-родителя
Илья Крайнов 36.1 685 "modelId": "", ID модели объекта
686 "modelName": "", Имя модели объекта
687 "createdAt": "", Дата создания объекта
688 "mileageCalcMethod": "", Выбранный метод расчета пробега
689 "counters": { ~/~/ Нормы
690 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
691 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
692 "mileage": "", ~/~/ Пробег по нормам в метрах
693 "motohours": "" ~/~/ Моточасы по нормам, в секундах
Илья Крайнов 76.3 694 "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
695 "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
Илья Крайнов 35.1 696 },
Илья Крайнов 36.1 697 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
Илья Крайнов 35.1 698 {
Илья Крайнов 47.1 699 "id": "", ~/~/ ID  задания
Илья Крайнов 37.1 700 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
Илья Крайнов 36.1 701 "name": "", ~/~/ Наименование задания
702 "description": "", ~/~/ Описание задания
703 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
704 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
705 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
706 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
707 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
708 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
709 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
710 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Илья Крайнов 35.1 711 }
712 ]
Артем Шемяков 21.12 713 }
Илья Крайнов 41.1 714 )))
Андрей Калиновский 1.1 715
Артем Шемяков 8.1 716 (% style="text-align:left" %)
717 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
Андрей Калиновский 1.1 718
Артем Шемяков 8.1 719 (% style="text-align:left" %)
720 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
Андрей Калиновский 1.1 721
Илья Крайнов 66.14 722 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
Андрей Калиновский 1.1 723
Артем Шемяков 8.1 724 (% class="box successmessage" %)
725 (((
Илья Крайнов 60.1 726 (% lang="en-US" %)**POST /api/v3/vehicles**
Артем Шемяков 8.1 727 )))
Андрей Калиновский 1.1 728
Илья Крайнов 60.1 729 (% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
Андрей Калиновский 1.1 730
Артем Шемяков 8.1 731 (% style="color:#000000" %)Метод запроса: **POST**
732
733 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
734
735 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
736
Артем Шемяков 21.2 737 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
Артем Шемяков 8.1 738
Артем Шемяков 21.2 739 (% style="color:#000000" %){
740
741 "parentId": "" , ~/~/ ID клиента
742 "name": "" , ~/~/ имя ТС
743 "imei": "" , ~/~/ IMEI
744 "deviceTypeId": "" , ~/~/ ID типа устройства
745 "modelId": "" , ~/~/ ID модели
746 "unitId": "" , ~/~/ ID подразделения
747 "sim1": "" , ~/~/ Номер SIM 1
748 "sim2": "" , ~/~/ Номер SIM2
749 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
750 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
Артем Шемяков 28.1 751 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
Артем Шемяков 28.5 752 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
753 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
754 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
755 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
756 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
757 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
758 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
759 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
760 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
Артем Шемяков 28.6 761 "counters": ~/~/ счетчики
762 {
Артем Шемяков 28.2 763 "mileage": "" , ~/~/ пробег
764 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
765 "motohours": "" , ~/~/ моточасы
766 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
Артем Шемяков 21.12 767 },
Артем Шемяков 21.2 768 "cmsv6Parameters": { ~/~/ параметры CMSv6
769 "enabled": true, ~/~/ флаг включения
770 "id": "" , ~/~/ идентификатор
771 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
772 "login": "" , ~/~/ имя учетной записи
773 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 774 },
Артем Шемяков 21.2 775 "inspectionTasks": ~/~/ задания на ТО
Андрей Калиновский 1.1 776 {
Артем Шемяков 21.2 777 "enabled": "" , ~/~/ Признак включения
778 "name": "" , ~/~/ Имя задания
779 "description": "" , ~/~/ Описание задания
780 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
781 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
782 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
783 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
784 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
785 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
786 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
787 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
788 }
Андрей Калиновский 1.1 789
Артем Шемяков 21.2 790 (% style="color:#000000" %) }
Андрей Калиновский 1.1 791
Артем Шемяков 8.1 792 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 793
Артем Шемяков 8.1 794 (% style="color:#000000" %){
Андрей Калиновский 1.1 795
Артем Шемяков 21.3 796 "vehicleId": "", ~/~/ID ТС 
797 "parentId": "", ~/~/Guid владельца ТС
798 "name": "", ~/~/Имя объекта
799 "imei": "", ~/~/IMEI
800 "deviceTypeId": "", ~/~/ID типа устройства
801 "modelId": "", ~/~/ID модели
802 "unitId": "", ~/~/ID подразделения
803 "sim1": "", ~/~/SIM1
804 "sim2": "", ~/~/SIM2
805 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
806 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
807 "counters": { ~/~/Счётчики
808 "mileageEnabled": true,
809 "motohoursEnabled": true,
810 "mileage": "",
811 "motohours": 345.0
Артем Шемяков 21.12 812 },
Артем Шемяков 21.3 813 "cmsv6Parameters": { ~/~/Параметры CmsV6
814 "id": null,
815 "enabled": true, ~/~/флаг включения
816 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
817 "login": "", ~/~/ имя учетной записи
818 "password": "" ~/~/ пароль учетной записи
Артем Шемяков 21.12 819 },
Артем Шемяков 21.3 820 "inspectionTasks": { ~/~/ задания на ТО
821 "id": "", ~/~/ ID задачи
822 "enabled": false, ~/~/ Признак включения
823 "name": "", ~/~/ Имя задания
824 "description": "", ~/~/ Описание задания
825 "mileageCondition": "", ~/~/ Условие по пробегу
826 "lastMileage": "", ~/~/ Пробег (в метрах)
827 "motohoursCondition": "", ~/~/ Условие по моточасам
828 "lastMotohours": "", ~/~/ Моточасы
829 "periodicCondition": "", ~/~/ Условие периодичности по времени
830 "kind": "", ~/~/ Вид периодичности по времени 
831 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
Артем Шемяков 21.12 832 }
Андрей Калиновский 1.1 833
Артем Шемяков 8.1 834 (% style="text-align:left" %)
835 (% style="color:#000000" %)}
Андрей Калиновский 1.1 836
Артем Шемяков 28.3 837 **Валидация:**
838 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
839 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
840 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Андрей Калиновский 1.1 841
Илья Крайнов 66.14 842 == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
Артем Шемяков 28.4 843
Илья Крайнов 76.1 844 (% class="box infomessage" %)
Артем Шемяков 8.1 845 (((
Илья Крайнов 60.1 846 (% lang="en-US" %)**POST /api/v3/vehicles/find**
Артем Шемяков 8.1 847 )))
Андрей Калиновский 1.1 848
Илья Крайнов 60.1 849 (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
Андрей Калиновский 1.1 850
Илья Крайнов 60.1 851 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
Андрей Калиновский 1.1 852
Артем Шемяков 8.1 853 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
Андрей Калиновский 1.1 854
Артем Шемяков 8.1 855 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
Андрей Калиновский 1.1 856
Артем Шемяков 21.7 857 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
Андрей Калиновский 1.1 858
Артем Шемяков 21.7 859 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
Андрей Калиновский 1.1 860
Артем Шемяков 21.7 861 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
Андрей Калиновский 1.1 862
Артем Шемяков 8.1 863 (% style="color:#000000" %)Метод запроса: **POST**
Андрей Калиновский 1.1 864
Артем Шемяков 8.1 865 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
Андрей Калиновский 1.1 866
Артем Шемяков 8.1 867 (% style="color:#000000" %)В заголовках запроса:
Андрей Калиновский 1.1 868
Артем Шемяков 22.6 869 (% style="color:#000000" %)− Content-Type: __**application/json**__
Андрей Калиновский 1.1 870
Артем Шемяков 8.1 871 (% style="color:#000000" %)− X-Auth: Токен авторизации
872
Артем Шемяков 22.7 873 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
Артем Шемяков 8.1 874
Артем Шемяков 22.7 875 (% style="color:#000000" %)Параметры в теле запроса (JSON):
876
Илья Крайнов 45.1 877 {
878 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
Илья Крайнов 44.1 879 "name": null, ~/~/ Имя ТС (string, опционально)
880 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
881 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
882 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
883 "parentId": null, ~/~/ ID клиента (Guid, опционально)
Илья Крайнов 47.1 884 "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
Илья Крайнов 46.1 885 "customFields": null ~/~/ значение любого из произвольных полей ТС
Илья Крайнов 45.1 886 }
Илья Крайнов 44.1 887
Илья Крайнов 60.1 888 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
Артем Шемяков 8.1 889
Артем Шемяков 21.7 890 (% style="color:#000000" %)Ответ:
Артем Шемяков 8.1 891
Артем Шемяков 21.7 892 (% style="color:#000000" %){
Артем Шемяков 8.1 893
Артем Шемяков 21.7 894 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
895 "name": "" ~/~/ наименование объекта
896 "imei": "" ~/~/ IMEI объекта
897 "deviceTypeId": "" ~/~/ идентификатор типа устройства
898 "deviceTypeName": "" ~/~/ наименование типа устройства
899 "sim1": "" ~/~/ первый номер телефона
900 "sim2": "" ~/~/ второй номер телефона
901 "parentId": "" ~/~/ идентификатор клиента-родителя
902 "parentName": "" ~/~/ наименование клиента-родителя
903 "modelId": "" ~/~/ идентификатор модели объекта
904 "modelName": "" ~/~/ наименование модели объекта
905 "unitId": "" ~/~/ идентификатор подразделения
906 "unitName": "" ~/~/ наименование подразделения
Артем Шемяков 25.1 907 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
908 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
909 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
Илья Крайнов 49.1 910 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
911 "customFields": [ 
912 {
913 "id": "", ~/~/ идентификатор произвольного поля
914 "name": "", ~/~/ имя произвольного поля
915 "value": "", ~/~/ значение произвольного поля
916 "forClient": true, ~/~/ право на отображение у клиента
917 "forTooltip": false, ~/~/ право на отображение в подсказке
918 "forReport": false ~/~/ право на отображение в отчетах
919 }(%%)
Артем Шемяков 21.7 920 (% style="color:#000000" %)}
921
Артем Шемяков 22.7 922 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
Артем Шемяков 21.7 923
Илья Крайнов 66.14 924 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
Артем Шемяков 22.7 925
Артем Шемяков 8.1 926 (% class="box successmessage" %)
927 (((
Илья Крайнов 60.1 928 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
Артем Шемяков 8.1 929 )))
930
Илья Крайнов 60.1 931 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 8.1 932
933 (% style="color:#000000" %)Метод запроса: **POST**
934
935 (% 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}
936
Артем Шемяков 22.8 937 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
Артем Шемяков 8.1 938
939 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
940
Артем Шемяков 21.8 941 (% style="color:#000000" %)Параметры в теле запроса (JSON):
Артем Шемяков 8.1 942
Артем Шемяков 21.8 943 (% style="color:#000000" %){
Артем Шемяков 21.7 944
Артем Шемяков 21.8 945 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
946 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
947 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
948 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
949 "description": "", ~/~/ Описание
950 "data": "", ~/~/ Данные
951 "overwrite": false, ~/~/ Флаг перезаписи
952 "stage": "", ~/~/ Состояние, может быть null
Андрей Калиновский 1.1 953
Артем Шемяков 21.12 954 (% style="color:#000000" %)}
Артем Шемяков 21.7 955
Артем Шемяков 21.8 956 (% style="color:#000000" %)Ответ:
Андрей Калиновский 1.1 957
Артем Шемяков 21.8 958 (% style="color:#000000" %){
Андрей Калиновский 1.1 959
Артем Шемяков 21.8 960 "status": "", ~/~/ значение статуса
961 "date": "", ~/~/ Дата смены статуса 
962 "description": "", ~/~/ Описание
963 "data": "", ~/~/ Данные
964 "overwrite": false, ~/~/ Флаг перезаписи
965 "stage": "", ~/~/ Состояние
Андрей Калиновский 1.1 966
Артем Шемяков 8.1 967 (% style="text-align:left" %)
Артем Шемяков 21.12 968 (% style="color:#000000" %) }
Андрей Калиновский 1.1 969
Илья Крайнов 66.14 970 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
Андрей Калиновский 1.1 971
Артем Шемяков 18.1 972 (% class="box warningmessage" %)
973 (((
Илья Крайнов 60.1 974 (% lang="en-US" %)**PUT /api/v3/vehicles**
Артем Шемяков 18.1 975 )))
976
Илья Крайнов 60.1 977 (% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 978
979 (% style="color:#000000" %)Метод запроса: **PUT**
980
981 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
982
983 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
984
985 (% style="color:#000000" %)Параметры в теле запроса (JSON):
986
Артем Шемяков 22.2 987 (% style="color:#000000" %){    
Артем Шемяков 18.1 988
Артем Шемяков 28.8 989 (((
Артем Шемяков 21.10 990 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
991 "parentId": "", ~/~/ ID клиента
992 "name": "", ~/~/ имя ТС
993 "imei": "", ~/~/ IMEI
994 "deviceTypeId": "", ~/~/ ID типа устройства
995 "modelId": "", ~/~/ , ID модели    
996 "unitId": "", ~/~/ подразделения
997 "sim1": "", ~/~/ SIM 1
Илья Крайнов 30.1 998 "sim2": "", ~/~/ SIM2     (%%)
Артем Шемяков 28.6 999 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1000 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1001 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1002 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1003 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1004 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1005 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1006 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1007 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1008 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1009 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1010 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1011 (% style="color:#000000" %) "counters": 
Артем Шемяков 21.10 1012 {
1013 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1014 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
Илья Крайнов 34.1 1015 "mileage": "", ~/~/ пробег, в метрах 
1016 "motohours": "" ~/~/ моточасы, в секундах
Артем Шемяков 21.10 1017 }
1018 "cmsv6Parameters": ~/~/ параметры CMSv6
1019 {       
1020 "id": "", ~/~/ идентификатор
1021 "enabled": true, ~/~/ флаг включения
1022 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1023 "login": "", ~/~/ имя учетной записи
1024 "password": "", ~/~/ пароль учетной записи
1025 }
1026 "inspectionTasks": ~/~/ задания на ТО
1027 {
1028 "id": "", ~/~/ ID задания
1029 "enabled": false, ~/~/ Признак включения
1030 "name": "", ~/~/ Имя задания
1031 "description": "", ~/~/ Описание задания
1032 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1033 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1034 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1035 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1036 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1037 "kind": "", ~/~/ Вид периодичности по времени
1038 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
Артем Шемяков 22.2 1039 } 
Артем Шемяков 28.8 1040 )))
Артем Шемяков 21.9 1041
1042 (% style="color:#000000" %)}
1043
Артем Шемяков 18.1 1044 (% style="color:#000000" %)Ответ:
1045
1046 (% lang="en-US" style="text-align:left" %)
Артем Шемяков 22.2 1047 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
Артем Шемяков 18.1 1048
Артем Шемяков 21.11 1049 (% lang="en-US" style="text-align:left" %)
1050 "vehicleId": "", ~/~/ ID ТС
1051 "parentId": "", ~/~/ ID клиента
1052 "name": "", ~/~/ имя ТС
1053 "imei": "", ~/~/ IMEI
1054 "deviceTypeId": "", ~/~/ типа устройства
1055 "modelId": "", ~/~/ ID модели
1056 "unitId": "", ~/~/ ID подразделения
1057 "sim1": "", ~/~/ SIM 1
1058 "sim2": "", ~/~/ SIM2
1059 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1060 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1061 "counters": 
1062 {
1063 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1064 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1065 "mileage": "", ~/~/ пробег
1066 "motohours": "", ~/~/ моточасы
1067 }
1068 "cmsv6Parameters": ~/~/ параметры CMSv6
1069 {
1070 "id": ~/~/ идентификатор
1071 "enabled": true, ~/~/ флаг включения
1072 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1073 "login": "", ~/~/ имя учетной записи
1074 "password": "", ~/~/ пароль учетной записи
1075 }
1076 "inspectionTasks": ~/~/ задания на ТО
1077 {
1078 "id": "", ~/~/ ID задания
1079 "enabled": false, ~/~/ Признак включения
1080 "name": "", ~/~/ Имя задания
1081 "description": "", ~/~/ Описание задания
1082 "mileageCondition": "", ~/~/ Условие по пробегу
1083 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1084 "motohoursCondition": "", ~/~/ Условие по моточасам
1085 "lastMotohours": "", ~/~/ Моточасы
1086 "periodicCondition": "", ~/~/ Условие периодичности по времени
1087 "kind": "", ~/~/ Вид периодичности по времени
1088 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1089 }
Артем Шемяков 18.1 1090
Артем Шемяков 21.11 1091 (% lang="en-US" style="text-align:left" %)
1092 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1093
Артем Шемяков 28.7 1094 **валидация:**
1095 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1096 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1097 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
Артем Шемяков 21.11 1098
Илья Крайнов 66.14 1099 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
Артем Шемяков 28.7 1100
Артем Шемяков 18.1 1101 (% class="box errormessage" %)
1102 (((
Илья Крайнов 60.1 1103 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
Артем Шемяков 18.1 1104 )))
1105
Илья Крайнов 60.1 1106 (% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 18.1 1107
1108 (% style="color:#000000" %)Метод запроса: **DELETE**
1109
1110 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1111
Артем Шемяков 22.8 1112 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
Артем Шемяков 18.1 1113
1114 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1115
1116 (% style="text-align:left" %)
1117 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1118
Илья Крайнов 66.14 1119 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
Артем Шемяков 18.1 1120
Илья Крайнов 66.14 1121 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
Артем Шемяков 17.1 1122
1123 (% class="box infomessage" %)
1124 (((
Илья Крайнов 60.1 1125 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
Артем Шемяков 17.1 1126 )))
1127
Илья Крайнов 60.1 1128 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 1129
1130 (% style="color:#000000" %)Метод запроса: **GET**
1131
1132 (% 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]]
1133
1134 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1135
Артем Шемяков 21.12 1136 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 1137
Артем Шемяков 21.12 1138 (% style="color:#000000" %){
Артем Шемяков 17.1 1139
Артем Шемяков 21.12 1140 "deviceTypeId" : "", ~/~/ ID типа устройства
1141 "deviceTypeName" : "" ~/~/ Название типа устройства
1142
Артем Шемяков 17.1 1143 (% style="text-align:left" %)
Артем Шемяков 21.12 1144 (% style="color:#000000" %)}
Артем Шемяков 17.1 1145
Илья Крайнов 66.15 1146 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
Артем Шемяков 17.1 1147
Илья Крайнов 66.15 1148 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
Артем Шемяков 17.1 1149
1150 (% class="box infomessage" %)
1151 (((
Илья Крайнов 60.1 1152 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
Артем Шемяков 17.1 1153 )))
1154
Илья Крайнов 60.1 1155 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
Артем Шемяков 17.1 1156
1157 (% style="color:#000000" %)Метод запроса: **GET**
1158
1159 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1160
Илья Крайнов 71.1 1161 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
Артем Шемяков 17.1 1162
Артем Шемяков 21.12 1163 (% style="color:#000000" %)Ответ:
Артем Шемяков 17.1 1164
Артем Шемяков 21.12 1165 (% style="color:#000000" %){
Артем Шемяков 17.1 1166
Артем Шемяков 21.12 1167 "id": "", ~/~/ ID типа датчика 
1168 "name": "", ~/~/ Название
1169 "description": "", ~/~/ Описание
Артем Шемяков 17.1 1170
1171 (% style="text-align:left" %)
Артем Шемяков 21.12 1172 (% style="color:#000000" %)}
Артем Шемяков 17.1 1173
Илья Крайнов 71.1 1174 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
Артем Шемяков 17.1 1175
Илья Крайнов 74.1 1176 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
Илья Крайнов 71.1 1177
1178 (% class="box infomessage" style="text-align: left;" %)
1179 (((
1180 **POST /api/v3/terminalMessages/count**
1181 )))
1182
1183 (% style="text-align: left;" %)
1184 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1185
1186 (% style="text-align: left;" %)
1187 Метод запроса **POST**
1188
1189 (% style="text-align: left;" %)
1190 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1191
1192 (% style="text-align: left;" %)
1193 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1194
1195 (% style="text-align: left;" %)
1196 {
Илья Крайнов 76.2 1197 "vehicleIds": [
Илья Крайнов 71.1 1198 id ~/~/ здесь передается список идентификаторов объектов
1199 ],
1200 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1201 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1202 }
1203
1204 (% style="text-align: left;" %)
1205 Ответ:
1206
1207 (% style="text-align: left;" %)
1208 [
1209 {
Илья Крайнов 76.2 1210 "vehicleId": 0, ~/~/ идентификатор объекта
Илья Крайнов 71.1 1211 "count": 0 ~/~/ количество сообщений за период
1212 }
1213 ]
1214
1215
Артем Шемяков 17.1 1216 (% class="box" lang="en-US" style="text-align: center;" %)
1217 (((
Артем Шемяков 14.1 1218 (% 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 1219 )))

Меню

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