Show last authors
1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 (((
3 **Содержание страницы:**
4 )))
5
6 {{toc/}}
7
8
9 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10
11 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12
13 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14
15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16
17 (% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18
19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20
21 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22
23 (% class="box successmessage" %)
24 (((
25 (% lang="en-US" %)**POST /api/v3/auth/login**
26 )))
27
28 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29
30 (% style="color:#000000" %)Метод запроса: **POST**
31
32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33
34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35
36 (% style="color:#000000" %)Параметры в теле запроса (JSON):
37
38 (% style="color:#000000" %){
39 "login": "testuser",
40 "password": "testuser"
41 }
42
43 (% style="color:#000000" %)**Ответ:**
44
45 (% lang="en-US" %)
46 (% style="color:#000000" %){
47
48 (% lang="en-US" %)
49 (% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
50 "User": "testuser" , ~/~/ имя пользователя
51
52 (% lang="en-US" %)
53 }
54
55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56
57 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 |(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 |(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62
63 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64
65 (% class="box infomessage" %)
66 (((
67 (% lang="en-US" %)**GET /api/v3/auth/check**
68 )))
69
70 (% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
71
72 (% style="color:#000000" %)Метод запроса: **GET**
73
74 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
75
76 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
77
78 (% lang="en-US" %)
79 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
80
81 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
82
83 == (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
84
85 (% class="box infomessage" %)
86 (((
87 **GET api/v3/agents/{id}**
88 )))
89
90 Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
91
92 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
93
94 (% style="color:#000000" %)Метод запроса: **GET**
95
96 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
97
98 Запрос должен содержать данные параметра "**agentId**"
99
100 (% style="color:#000000" %)Ответ:
101 {
102 "agentId": "",  (%%)
103 "parentId": "",
104 "parentName": "string",
105 "name": "string",
106 "fullName": "string",
107 "agentInfoType": 0,
108 "isForeign": true/false,
109 "district": "string", 
110 "region": "string",
111 "city": "string",
112 "inn": "string",
113 "kpp": "string",
114 "address": "string",
115 "addressFact": "string",
116 "email": "string",
117 "director": "string",
118 "bankName": "string",
119 "bankBIK": "string",
120 "bankRS": "string",
121 "bankKS": "string"
122 }
123
124 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 |(% style="width:215px" %)city|(% style="width:861px" %)Город
135 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145
146 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147
148 (% class="box infomessage" %)
149 (((
150 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
151 )))
152
153 (% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
154
155 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
156
157 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
158
159 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
160
161 (% style="color:#000000" %)Метод запроса: **POST**
162
163 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
164
165 (% style="color:#000000" %)Параметр запроса:
166
167 (% style="color:#000000" %){
168 "parentId": "string"
169 }
170
171 (% style="color:#000000" %)Ответ:
172
173 {
174 "agentId": "",(% style="color:#000000" %)   (%%)
175 "parentId": "",
176 "name": "string",
177 "fullName": "string",
178 "agentInfoType": 0,
179 (% style="color:#000000" %) "status": "",
180 }
181
182
183 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
186 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
189 |(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
190
191 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
192
193 (% class="box successmessage" %)
194 (((
195 **POST /api/v3/agents **
196 )))
197
198 Метод позволяет добавить клиента, указанного в запросе.
199
200 Метод запроса: **POST**
201
202 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
203
204 В заголовках запроса: X-Auth: Токен авторизации
205
206 Параметры в теле запроса (JSON):
207
208 {
209 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
210 "name": "string", ~/~/ имя
211 "fullName": "string", ~/~/ полное наименование
212 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
213 "isForeign": true, ~/~/ иностранный контрагент
214 "district": "string", ~/~/ округ
215 "region": "string", ~/~/ регион
216 "city": "string", ~/~/ город
217 "inn": "string", ~/~/ ИНН
218 "kpp": "string", ~/~/ КПП
219 "address": "string", ~/~/ юридический адрес
220 "addressFact": "string", ~/~/ фактический адрес
221 "email": "string", ~/~/ email
222 "director": "string", ~/~/ ФИО руководителя
223 "bankName": "string", ~/~/ банк
224 "bankBIK": "string", ~/~/ БИК
225 "bankRS": "string", ~/~/ номер счёта
226 "bankKS": "string" ~/~/ корр. счёт
227 }
228
229
230 Ответ:
231
232 {
233 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
234 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
235 "name": "string", ~/~/ имя
236 "fullName": "string", ~/~/ полное наименование
237 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
238 "isForeign": true, ~/~/ иностранный контрагент
239 "district": "string", ~/~/ округ
240 "region": "string", ~/~/ регион
241 "city": "string", ~/~/ город
242 "inn": "string", ~/~/ ИНН
243 "kpp": "string", ~/~/ КПП
244 "address": "string", ~/~/ юридический адрес
245 "addressFact": "string", ~/~/ фактический адрес
246 "email": "string", ~/~/ email
247 "director": "string", ~/~/ ФИО руководителя
248 "bankName": "string", ~/~/ банк
249 "bankBIK": "string", ~/~/ БИК
250 "bankRS": "string", ~/~/ номер счёта
251 "bankKS": "string" ~/~/ корр. счёт
252 }
253
254 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
255 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
256 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
257 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
258 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
259 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
260 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
261 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
262 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
263 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
264 |(% style="width:215px" %)city|(% style="width:861px" %)Город
265 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
266 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
267 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
268 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
269 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
270 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
271 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
272 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
273 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
274 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
275
276 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
277
278 (% class="box warningmessage" %)
279 (((
280 **PUT /api/v3/agents**
281 )))
282
283 Метод позволяет отредактировать клиента, указанного в запросе.
284
285 Метод запроса: **PUT**
286
287 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
288
289 В заголовках запроса: X-Auth: Токен авторизации
290
291 Параметры в теле запроса (JSON):
292
293 {
294 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
295 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
296 "name": "string", ~/~/ имя
297 "fullName": "string", ~/~/ полное наименование
298 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
299 "isForeign": true, ~/~/ иностранный контрагент
300 "district": "string", ~/~/ округ
301 "region": "string", ~/~/ регион
302 "city": "string", ~/~/ город
303 "inn": "string", ~/~/ ИНН
304 "kpp": "string", ~/~/ КПП
305 "address": "string", ~/~/ юридический адрес
306 "addressFact": "string", ~/~/ фактический адрес
307 "email": "string", ~/~/ email
308 "director": "string", ~/~/ ФИО руководителя
309 "bankName": "string", ~/~/ банк
310 "bankBIK": "string", ~/~/ БИК
311 "bankRS": "string", ~/~/ номер счёта
312 "bankKS": "string" ~/~/ корр. счёт
313 }
314
315 Ответ:
316
317 {
318 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
319 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
320 "name": "string", ~/~/ имя
321 "fullName": "string", ~/~/ полное наименование
322 "isForeign": true, ~/~/ иностранный контрагент
323 "district": "string", ~/~/ округ
324 "region": "string", ~/~/ регион
325 "city": "string", ~/~/ город
326 "inn": "string", ~/~/ ИНН
327 "kpp": "string", ~/~/ КПП
328 "address": "string", ~/~/ юридический адрес
329 "addressFact": "string", ~/~/ фактический адрес
330 "email": "string", ~/~/ email
331 "director": "string", ~/~/ ФИО руководителя
332 "bankName": "string", ~/~/ банк
333 "bankBIK": "string", ~/~/ БИК
334 "bankRS": "string", ~/~/ номер счёта
335 "bankKS": "string" ~/~/ корр. счёт
336 }
337
338 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
339
340 (% class="box errormessage" %)
341 (((
342 **DELETE /api/v3/agents/{clientId}**
343 )))
344
345 Метод позволяет удалить клиента, указанного в строке запроса.
346
347 Метод запроса: **DELETE**
348
349 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
350
351 Параметр запроса: **{clientId}** - Guid пользователя
352
353 В заголовках запроса: X-Auth: Токен авторизации
354
355 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
356
357 == (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
358
359 (% class="box warningmessage" %)
360 (((
361 **PUT /api/v3/agents/{id}/changeStatus/{status}**
362 )))
363
364 Метод позволяет изменить статус клиента, указанного в запросе.
365
366 В пути указывается GUID клиента и статус клиента.
367
368 **status **- значение 0 - заблокирован, 1 - активен.
369
370 Ответ: Code 204
371
372 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
373
374 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
375
376 (% class="box successmessage" %)
377 (((
378 (% lang="en-US" %)**POST /api/v3/users**
379 )))
380
381 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
382
383 (% style="color:#000000" %)Метод запроса: **POST**
384
385 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
386
387 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
388
389 (% style="color:#000000" %)Параметры в теле запроса (JSON):
390
391 (% style="color:#000000" %)
392
393 "lastName": "", ~/~/ фамилия
394 "firstName": "", ~/~/ имя
395 "position": "", ~/~/ должность
396 "phone": "", ~/~/ телефон
397 "organization": "", ~/~/ организация
398 "login": "", ~/~/ логин (обязателен)
399 "password": "", ~/~/ пароль (обязателен)
400 "email": "", ~/~/ email (обязателен)
401 "description": "string", ~/~/ Описание
402 "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
403 "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
404 "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
405 "parentId": "", ~/~/ Guid родительского агента
406 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
407 "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
408 "doubleAuth":
409 {
410 "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
411 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
412 },
413 "groups":
414 [
415 "string" ~/~/ группы пользователя, перечисление названия системных ролей
416 ],
417 "customGroups":
418 [
419 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
420 ],
421 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
422 }
423
424 {
425 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
426 "lastName": "string",
427 "firstName": "string",
428 "position": "string",
429 "phone": "string",
430 "organization": "string",
431 "login": "string",
432 "password": "string",
433 "email": "string",
434
435 (% style="text-align:left" %)
436 (% style="color:#000000; font-weight:normal" %)Ответ:
437
438 (% style="text-align:left" %)
439 (% style="color:#000000; font-weight:normal" %){    
440
441 (% style="text-align:left" %)
442 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
443 "lastName": "" , ~/~/ Фамилия ,
444 "firstName": "" , ~/~/ Имя
445 "position": "" , ~/~/ Должность
446 "phone": "" , ~/~/ Телефон
447 "organization": "" , ~/~/ Организация
448 "login": "" , ~/~/ Логин
449 "password": "" , ~/~/ Пароль
450 "email": "" , ~/~/ Email
451 "description": "" , ~/~/ Описание
452 "isEnabled": "" , ~/~/ Признак включения
453 "parentId": "" , ~/~/ Guid родительского агента
454 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
455 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
456 "kind": "" , ~/~/ тип аутентификации
457 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
458 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
459
460 (% style="text-align:left" %)
461 (% style="color:#000000; font-weight:normal" %)}
462
463
464 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465
466 (% class="box infomessage" %)
467 (((
468 (% lang="en-US" %)**POST /api/v3/users/find**
469 )))
470
471 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
472
473 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
474
475 (% style="color:#000000" %)Метод запроса: **POST**
476
477 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
478
479 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
480
481 (% style="color:#000000" %)Параметры в теле запроса (JSON):
482
483 (% style="color:#000000" %){
484
485 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
486 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
487 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
488 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
489
490 (% style="color:#000000" %)}
491
492 (% style="color:#000000" %)Ответ:
493
494 (% style="color:#000000" %){         (%%)
495
496 "id": "" , ~/~/ идентификатор пользователя
497 "lastName": "" , ~/~/ фамилия
498 "firstName": "" , ~/~/ имя
499 "position": "" , ~/~/ должность
500 "phone": "" , ~/~/ телефон
501 "parentId": "" , ~/~/ идентификатор клиента-родителя
502 "parentName": "" , ~/~/ наименование клиента-родителя
503 "organization": "" , ~/~/ организация
504 "login": "" , ~/~/ логин
505 "email": "" , ~/~/ E-mail
506 "sessionDuration":"", ~/~/ длительность сессии в минутах
507 "status": "1",  ~/~/ статус пользователя
508 "lastLogged": "", ~/~/ дата/время последней авторизации
509
510 (% style="color:#000000" %)}
511
512 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
513
514 (% class="box infomessage" %)
515 (((
516 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
517 )))
518
519 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
520
521 (% style="color:#000000" %)Метод запроса: **GET**
522
523 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
524
525 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
526
527 (% style="color:#000000" %)Ответ:
528
529 (((
530 (((
531 {
532 "id": "", ~/~/ GUID пользователя
533 "lastName": "", ~/~/ Фамилия 
534 "firstName": "", ~/~/ Имя
535 "position": "", ~/~/ Должность
536 "phone": "", ~/~/ Номер телефона
537 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
538 "parentName": "", Наименование клиента, которому принадлежит пользователь
539 "organization": "", ~/~/ Организация
540 "login": "", ~/~/ Логин пользователя
541 "email": "", ~/~/ Адрес электронной почты
542 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
543 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
544 "description": "", ~/~/ Описание
545 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
546 "doubleAuth":
547 {
548 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
549 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
550 },
551 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
552 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
553 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
554 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
555 "groups": [], ~/~/ Список ролей пользователя
556 "customGroups": [], ~/~/ Список клиентских ролей пользователя
557 "authDevices": [ ], ~/~/ Список авторизованных устройств
558 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
559 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
560 }
561 )))
562 )))
563
564 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
565
566 (% class="box warningmessage" %)
567 (((
568 (% lang="en-US" %)**PUT /api/v3/users**
569 )))
570
571 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
572
573 (% style="color:#000000" %)Метод запроса: **PUT**
574
575 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
576
577 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
578
579 (% lang="en-US" style="text-align:left" %)
580 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
581
582 (% lang="en-US" style="text-align:left" %)
583 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
584
585 (% lang="en-US" style="text-align:left" %)
586 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
587 "lastName": "" , ~/~/ фамилия
588 "firstName": "" , ~/~/ имя
589 "position": "" , ~/~/ должность
590 "phone": "" , ~/~/ телефон
591 "organization": "" , ~/~/ организация
592 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
593 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
594 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
595 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
596 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
597 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
598 "isEnabled": "" , ~/~/ признак включения
599 "parentId": "" , ~/~/ Guid родительского агента
600 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
601 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
602 "doubleAuth":
603 {
604 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
605 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
606 },
607 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
608 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
609
610 (% lang="en-US" style="text-align:left" %)
611 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
612
613 (% lang="en-US" style="text-align:left" %)
614 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
615
616 (% lang="en-US" style="text-align:left" %)
617 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
618
619 (% lang="en-US" style="text-align:left" %)
620 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
621 "lastName": "" , ~/~/ фамилия
622 "firstName": "" , ~/~/ имя
623 "position": "" , ~/~/ должность
624 "phone": "" , ~/~/ телефон
625 "organization": "" , ~/~/ организация
626 "login": "" , ~/~/ логин
627 "password": "" , ~/~/ пароль 
628 "email": "" , ~/~/ email
629 "description": "" , ~/~/ описание
630 "isEnabled": "" , ~/~/ признак включения
631 "parentId": "" , ~/~/ Guid родительского агента
632 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
633 "doubleAuth":
634 {
635 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
636 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
637 },
638 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
639 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
640 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
641
642 (% lang="en-US" style="text-align:left" %)
643 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
644
645 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
646
647 (% class="box warningmessage" %)
648 (((
649 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
650 )))
651
652 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
653
654 (% style="color:#000000" %)Метод запроса: **PUT**
655
656 (% 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}
657
658 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
659
660 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
661
662 (% style="color:#000000" %)Параметры в теле запроса (JSON):
663
664 (% style="color:#000000" %){
665
666 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
667 "description": "" , ~/~/ описание
668 "data": "" , ~/~/ данные, связанные со сменой статуса
669
670 (% style="color:#000000" %)}
671
672 (% style="text-align:left" %)
673 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
674
675 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
676
677 (% class="box warningmessage" %)
678 (((
679 **POST /api/v3/users/disable**
680 )))
681
682 Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
683
684 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
685
686 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
687
688 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
689
690
691 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
692 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
693 ]
694
695 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
696
697 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
698
699 (% class="box warningmessage" %)
700 (((
701 **POST /api/v3/users/enable**
702 )))
703
704 Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
705
706 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
707
708 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
709
710 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
711
712
713 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
714 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
715 ]
716
717 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
718 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
719
720 (((
721 В теле ответа:
722 {
723 "errorMessages": [
724 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
725 ],
726 "users": [
727 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
728 ]
729 }
730 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
731 "users" - массив id пользователей, которых не удалось включить или отключить.
732 )))
733
734 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
735
736 (% class="box errormessage" %)
737 (((
738 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
739 )))
740
741 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
742
743 (% style="color:#000000" %)Метод запроса: **DELETE**
744
745 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
746
747 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
748
749 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
750
751 (% style="text-align:left" %)
752 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
753
754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
755
756 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
757
758 (% class="box infomessage" %)
759 (((
760 (% lang="en-US" %)**GET /api/v3/models/{Id}**
761 )))
762
763 Метод возвращает полную информацию о модели объекта.
764
765 (% style="color:#000000" %)Метод запроса: **GET**
766
767 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
768
769 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
770
771 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
772
773 (% style="color:#000000" %)Ответ:
774
775 (% style="color:#000000" %){
776 "parentName": "string",
777 "name": "string",
778 "picture": "string",
779 "minspeed": 0,
780 "maxspeed": 0,
781 "width": 0,
782 "imbeddedtrailer": true,
783 "hoppercapacity": 0,
784 "hopperdischargespeed": 0,
785 "modelType": 0,
786 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
787 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
788 "deleted": true
789 }
790
791 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
792 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
793 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
794 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
795 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
796 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
797 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
798 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
799 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
800 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
801 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
802 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
803 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
804 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
805
806 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
807
808 (% class="box successmessage" %)
809 (((
810 (% lang="en-US" %)**POST /api/v3/models/find**
811 )))
812
813 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
814
815 (% style="color:#000000" %)Метод запроса: **POST**
816
817 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
818
819 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
820
821 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
822
823 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
824 }
825
826 (% style="color:#000000" %)Ответ:
827
828 (% style="color:#000000" %)[
829 {
830 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
831 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 "parentName": "string",
833 "name": "string",
834 "modelType": 0
835 }
836 ]
837
838 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
839 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
840 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
841 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
842 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
843 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
844
845 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
846
847 (% class="box successmessage" %)
848 (((
849 (% lang="en-US" %)**POST /api/v3/models**
850 )))
851
852 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
853
854 (% style="color:#000000" %)Метод запроса: **POST**
855
856 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
857
858 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
859
860 (% style="color:#000000" %)Параметры в теле запроса (JSON):
861
862 {
863 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
864 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
865 "deleted": true,
866 "extId": "string",
867 "name": "string",
868 "picture": "string",
869 "minspeed": 0,
870 "maxspeed": 0,
871 "width": 0,
872 "imbeddedtrailer": true,
873 "fueloutlay": 0,
874 "hoppercapacity": 0,
875 "hopperdischargespeed": 0,
876 "modelType": 0
877 }
878
879 Ответ:
880
881 {
882 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
883 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
884 "deleted": true,
885 "extId": "string",
886 "name": "string",
887 "picture": "string",
888 "minspeed": 0,
889 "maxspeed": 0,
890 "width": 0,
891 "imbeddedtrailer": true,
892 "hoppercapacity": 0,
893 "hopperdischargespeed": 0,
894 "modelType": 0
895 }
896
897 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
898 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
899 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
900 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
901 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
902 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
903 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
904 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
905 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
906 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
907 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
908 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
909 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
910
911 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
912
913 (% class="box warningmessage" %)
914 (((
915 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
916 )))
917
918 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
919
920 (% style="color:#000000" %)Метод запроса: **PUT**
921
922 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
923
924 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
925
926 (% style="color:#000000" %)Параметры в теле запроса (JSON):
927
928 {
929 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
930 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
931 "deleted": true,
932 "extId": "string",
933 "name": "string",
934 "picture": "string",
935 "minspeed": 0,
936 "maxspeed": 0,
937 "width": 0,
938 "imbeddedtrailer": true,
939 "fueloutlay": 0,
940 "hoppercapacity": 0,
941 "hopperdischargespeed": 0,
942 "modelType": 0
943 }
944
945 Ответ:
946
947 {
948 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
950 "deleted": true,
951 "extId": "string",
952 "name": "string",
953 "picture": "string",
954 "minspeed": 0,
955 "maxspeed": 0,
956 "width": 0,
957 "imbeddedtrailer": true,
958 "fueloutlay": 0,
959 "hoppercapacity": 0,
960 "hopperdischargespeed": 0,
961 "modelType": 0
962 }
963
964 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
965 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
966 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
967 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
968 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
969 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
970 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
971 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
972 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
973 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
974 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
975 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
976 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
977
978 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
979
980 (% class="box errormessage" %)
981 (((
982 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
983 )))
984
985 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
986
987 (% style="color:#000000" %)Метод запроса: **DELETE**
988
989 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
990
991 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
992
993 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
994
995 Ответ: В случае успеха **Success 200**
996
997 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
998
999 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1000
1001 (% class="box infomessage" %)
1002 (((
1003 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1004 )))
1005
1006 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1007
1008 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1009
1010 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1011
1012 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1013
1014 (% style="color:#000000" %)Метод запроса: **GET**
1015
1016 (% 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}
1017
1018 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1019
1020 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1021
1022 (% style="color:#000000" %)Ответ:
1023
1024 (((
1025 {
1026 "vehicleId": "", ~/~/ ID объекта
1027 "name": "", ~/~/ Имя объекта
1028 "imei": "", ~/~/ IMEI объекта
1029 "deviceTypeId": , ~/~/ ID типа устройства
1030 "deviceTypeName": "", ~/~/ Название типа устройства
1031 "sim1": "", ~/~/ Номер SIM1
1032 "sim2": "", ~/~/ Номер SIM2
1033
1034 "parentId": "", ~/~/ ID клиента-родителя
1035 "parentName": "", ~/~/ Наименование клиента-родителя
1036 "modelId": "", ~/~/ ID модели объекта
1037 "modelName": "", ~/~/ Имя модели объекта
1038
1039 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1040 "unitName": "string", ~/~/ Наименование подразделения
1041 "status": 0, ~/~/ Статус объекта
1042
1043 "createdAt": "", ~/~/ Дата создания объекта
1044 },
1045
1046 "customFields": [ ~/~/ Произвольные поля
1047 {
1048 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1049 "name": "string", ~/~/ Имя поля
1050 "value": "string", ~/~/ Значение поля
1051 "forClient": true, ~/~/ Не используемая функция
1052 "forTooltip": true, ~/~/ Отображать в подсказке
1053 "forReport": true ~/~/ Отображать в отчете
1054 }
1055
1056 ], ~/~/ Данные с вкладки нормы
1057 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1058 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1059 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1060 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1061 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1062 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1063 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1064 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1065 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1066 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1067 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1068 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
1069
1070 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1071 "mileageCoeff": 0, ~/~/ коэффициент пробега
1072 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1073 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1074 "counters": { ~/~/ Счетчики
1075 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1076 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1077 "mileage": 0, ~/~/ Текущий пробег
1078 "motohours": 0, ~/~/ Текущие моточасы
1079 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1080 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1081 },
1082
1083 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1084 "id": "string", ~/~/ ID объекта
1085 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1086 "host": "string", ~/~/ CMSV6 Web Host
1087 "login": "string", ~/~/ CMSV6 Account
1088 "password": "string" ~/~/ CMSV6 Password
1089 },
1090
1091 "commandTemplates": [ ~/~/ Шаблоны команд
1092 {
1093 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1094 "name": "string", ~/~/ Наименование команды
1095 "command": "string", ~/~/ Текст команды
1096 "retries": 0 ~/~/ Количество попыток
1097 }
1098 ],
1099
1100 "sensors": [ ~/~/ Датчики
1101 {
1102 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1103 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1104 "type": 0, ~/~/ Тип датчика
1105 "name": "string", ~/~/ Имя датчика
1106 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1107 "inputNumber": 0, ~/~/ Номер входа
1108 "pseudonym": "string", ~/~/ Псевдоним
1109 "medianDegree": 0, ~/~/ Медианная фильтрация
1110 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1111 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1112 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1113 "gradesTables": [ ~/~/ Массив таблиц тарировки
1114 {
1115 "grades": [ ~/~/ Таблица тарировки 1
1116 {
1117 "input": 0, ~/~/ Входящее значение
1118 "output": 0 ~/~/ Выходящее значение
1119 }
1120 ],
1121 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1122 }
1123 ],
1124 "showInTooltip": true, ~/~/ Отображать в подсказке
1125 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1126 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1127 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1128 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1129 "expr": "string", ~/~/ Формула
1130 "children": [ ~/~/ массив дочерних датчиков
1131 "string"
1132 ],
1133 "customParams": { ~/~/ прочие произвольные параметры
1134 "additionalProp1": "string",
1135 "additionalProp2": "string",
1136 "additionalProp3": "string"
1137 },
1138
1139 ~/~/ Характерные для произвольного:
1140
1141 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1142
1143 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1144
1145 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1146
1147 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148
1149 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1150
1151 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1152
1153 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1154
1155 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1156
1157 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1158
1159 ~/~/ "ValueOn": "Вкл.",
1160
1161 ~/~/ "ValueOff": "Выкл."
1162 "summaryMaxValue": 0 ~/~/ Макс. значение
1163 }
1164
1165 "drivers": [ ~/~/ Водители
1166 {
1167 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1168 "name": "string", ~/~/ Наименование
1169 "description": "string",
1170 "isDefault": true ~/~/ По умолчанию
1171 }
1172 ],
1173
1174 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1175 {
1176 "id": "", ~/~/ ID  задания
1177 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1178 "name": "", ~/~/ Наименование задания
1179 "description": "", ~/~/ Описание задания
1180 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1181 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1182 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1183 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1184 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1185 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1186 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1187 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1188 }
1189 ],
1190
1191 "statusHistory": [ ~/~/ История статусов
1192 {
1193 "status": 0,
1194 "date": "2023-05-22T09:57:39.562Z",
1195 "description": "string",
1196 "additionalInfo": "string"
1197 }
1198 ]
1199
1200 }
1201 )))
1202
1203 (% style="text-align:left" %)
1204 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1205
1206 (% style="text-align:left" %)
1207 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1208
1209 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1210
1211 (% class="box successmessage" %)
1212 (((
1213 (% lang="en-US" %)**POST /api/v3/vehicles**
1214 )))
1215
1216 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1217
1218 (% style="color:#000000" %)Метод запроса: **POST**
1219
1220 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1221
1222 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1223
1224 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1225
1226 (% style="color:#000000" %){
1227
1228 "parentId": "" , ~/~/ ID клиента
1229 "name": "" , ~/~/ имя ТС
1230 "imei": "" , ~/~/ IMEI
1231 "deviceTypeId": "" , ~/~/ ID типа устройства
1232 "modelId": "" , ~/~/ ID модели
1233 "unitId": "" , ~/~/ ID подразделения
1234 "sim1": "" , ~/~/ Номер SIM 1
1235 "sim2": "" , ~/~/ Номер SIM2
1236 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1237 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1238 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1239 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1240 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1241 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1242 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1243 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1244 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1245 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1246 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1247 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1248
1249 "mileageCalcMethod": 0,
1250 "mileageCoeff": 0,
1251 "locationByCellId": true,
1252 "dottedLineTrackWhenNoCoords": true,
1253 "counters": ~/~/ счетчики
1254 {
1255 "mileage": "" , ~/~/ пробег
1256 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1257 "motohours": "" , ~/~/ моточасы
1258 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1259 },
1260 "cmsv6Parameters": { ~/~/ параметры CMSv6
1261 "enabled": true, ~/~/ флаг включения
1262 "id": "" , ~/~/ идентификатор
1263 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1264 "login": "" , ~/~/ имя учетной записи
1265 "password": "" ~/~/ пароль учетной записи
1266 },
1267 "inspectionTasks": ~/~/ задания на ТО
1268 {
1269 "enabled": "" , ~/~/ Признак включения
1270 "name": "" , ~/~/ Имя задания
1271 "description": "" , ~/~/ Описание задания
1272 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1273 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1274 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1275 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1276 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1277 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1278 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1279 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1280 }
1281
1282 "drivers": [ ~/~/ Водители
1283 {
1284 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1285 "isDefault": true
1286 }
1287 ],
1288 "commandTemplates": [ ~/~/ Шаблон команды
1289 {
1290 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1291 "name": "string",
1292 "command": "string",
1293 "retries": 0
1294 }
1295 ],
1296
1297 "sensors": [ ~/~/ Датчики
1298 {
1299 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1300 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1301 "type": 0, ~/~/ Тип датчика
1302 "name": "string", ~/~/ Имя датчика
1303 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1304 "inputNumber": 0, ~/~/ Номер входа
1305 "pseudonym": "string", ~/~/ Псевдоним
1306 "medianDegree": 0, ~/~/ Медианная фильтрация
1307 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1308 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1309 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1310 "gradesTables": [ ~/~/ Массив таблиц тарировки
1311 {
1312 "grades": [ ~/~/ Таблица тарировки 1
1313 {
1314 "input": 0, ~/~/ Входящее значение
1315 "output": 0 ~/~/ Выходящее значение
1316 }
1317 ],
1318 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1319 }
1320 ],
1321 "showInTooltip": true, ~/~/ Отображать в подсказке
1322 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1323 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1324 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1325 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1326 "expr": "string", ~/~/ Формула
1327 "children": [ ~/~/ массив дочерних датчиков
1328 "string"
1329 ],
1330 "customParams": { ~/~/ прочие произвольные параметры
1331 "additionalProp1": "string",
1332 "additionalProp2": "string",
1333 "additionalProp3": "string"
1334 },
1335
1336 ~/~/ Характерные для произвольного:
1337
1338 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1339
1340 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1341
1342 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1343
1344 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1345
1346 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1347
1348 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1349
1350 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1351
1352 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1353
1354 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1355
1356 ~/~/ "ValueOn": "Вкл.",
1357
1358 ~/~/ "ValueOff": "Выкл."
1359 "summaryMaxValue": 0 ~/~/ Макс. значение
1360 }
1361 ],
1362 "customFields": [ ~/~/ Произвольные поля
1363 {
1364 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1365 "name": "string",
1366 "value": "string",
1367 "forClient": true,
1368 "forTooltip": true,
1369 "forReport": true
1370 }
1371 ]
1372 }
1373
1374 (% style="color:#000000" %)Ответ:
1375
1376 (% style="color:#000000" %){
1377
1378 "vehicleId": "", ~/~/ID ТС 
1379 "parentId": "", ~/~/Guid владельца ТС
1380 "name": "", ~/~/Имя объекта
1381 "imei": "", ~/~/IMEI
1382 "deviceTypeId": "", ~/~/ID типа устройства
1383 "modelId": "", ~/~/ID модели
1384 "unitId": "", ~/~/ID подразделения
1385 "sim1": "", ~/~/SIM1
1386 "sim2": "", ~/~/SIM2
1387 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1388 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1389 "counters": { ~/~/Счётчики
1390 "mileageEnabled": true,
1391 "motohoursEnabled": true,
1392 "mileage": "",
1393 "motohours": 345.0
1394 },
1395 "cmsv6Parameters": { ~/~/Параметры CmsV6
1396 "id": null,
1397 "enabled": true, ~/~/флаг включения
1398 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1399 "login": "", ~/~/ имя учетной записи
1400 "password": "" ~/~/ пароль учетной записи
1401 },
1402 "inspectionTasks": { ~/~/ задания на ТО
1403 "id": "", ~/~/ ID задачи
1404 "enabled": false, ~/~/ Признак включения
1405 "name": "", ~/~/ Имя задания
1406 "description": "", ~/~/ Описание задания
1407 "mileageCondition": "", ~/~/ Условие по пробегу
1408 "lastMileage": "", ~/~/ Пробег (в метрах)
1409 "motohoursCondition": "", ~/~/ Условие по моточасам
1410 "lastMotohours": "", ~/~/ Моточасы
1411 "periodicCondition": "", ~/~/ Условие периодичности по времени
1412 "kind": "", ~/~/ Вид периодичности по времени 
1413 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1414 }
1415
1416 (% style="text-align:left" %)
1417 (% style="color:#000000" %)}
1418
1419 **Валидация:**
1420 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1421 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1422 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1423
1424 == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1425
1426 (% class="box infomessage" %)
1427 (((
1428 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1429 )))
1430
1431 (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1432
1433 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1434
1435 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1436
1437 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1438
1439 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1440
1441 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1442
1443 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1444
1445 (% style="color:#000000" %)Метод запроса: **POST**
1446
1447 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1448
1449 (% style="color:#000000" %)В заголовках запроса:
1450
1451 (% style="color:#000000" %)− Content-Type: __**application/json**__
1452
1453 (% style="color:#000000" %)− X-Auth: Токен авторизации
1454
1455 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1456
1457 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1458
1459 {
1460 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1461 "name": null, ~/~/ Имя ТС (string, опционально)
1462 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1463 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1464 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1465 "parentId": null, ~/~/ ID клиента (Guid, опционально)
1466 "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1467 "customFields": null ~/~/ значение любого из произвольных полей ТС
1468 }
1469
1470 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1471
1472 (% style="color:#000000" %)Ответ:
1473
1474 (% style="color:#000000" %){
1475
1476 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1477 "name": "" ~/~/ наименование объекта
1478 "imei": "" ~/~/ IMEI объекта
1479 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1480 "deviceTypeName": "" ~/~/ наименование типа устройства
1481 "sim1": "" ~/~/ первый номер телефона
1482 "sim2": "" ~/~/ второй номер телефона
1483 "parentId": "" ~/~/ идентификатор клиента-родителя
1484 "parentName": "" ~/~/ наименование клиента-родителя
1485 "modelId": "" ~/~/ идентификатор модели объекта
1486 "modelName": "" ~/~/ наименование модели объекта
1487 "unitId": "" ~/~/ идентификатор подразделения
1488 "unitName": "" ~/~/ наименование подразделения
1489 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1490 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1491 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1492 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1493 "customFields": [ 
1494 {
1495 "id": "", ~/~/ идентификатор произвольного поля
1496 "name": "", ~/~/ имя произвольного поля
1497 "value": "", ~/~/ значение произвольного поля
1498 "forClient": true, ~/~/ право на отображение у клиента
1499 "forTooltip": false, ~/~/ право на отображение в подсказке
1500 "forReport": false ~/~/ право на отображение в отчетах
1501 }(%%)
1502 (% style="color:#000000" %)}
1503
1504 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1505
1506 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1507
1508 (% class="box successmessage" %)
1509 (((
1510 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1511 )))
1512
1513 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1514
1515 (% style="color:#000000" %)Метод запроса: **POST**
1516
1517 (% 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}
1518
1519 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1520
1521 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1522
1523 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1524
1525 (% style="color:#000000" %){
1526
1527 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1528 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1529 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1530 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1531 "description": "", ~/~/ Описание
1532 "data": "", ~/~/ Данные
1533 "overwrite": false, ~/~/ Флаг перезаписи
1534 "stage": "", ~/~/ Состояние, может быть null
1535
1536 (% style="color:#000000" %)}
1537
1538 (% style="color:#000000" %)Ответ:
1539
1540 (% style="color:#000000" %){
1541
1542 "status": "", ~/~/ значение статуса
1543 "date": "", ~/~/ Дата смены статуса 
1544 "description": "", ~/~/ Описание
1545 "data": "", ~/~/ Данные
1546 "overwrite": false, ~/~/ Флаг перезаписи
1547 "stage": "", ~/~/ Состояние
1548
1549 (% style="text-align:left" %)
1550 (% style="color:#000000" %) }
1551
1552 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1553
1554 (% class="box warningmessage" %)
1555 (((
1556 (% lang="en-US" %)**PUT /api/v3/vehicles**
1557 )))
1558
1559 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1560
1561 (% style="color:#000000" %)Метод запроса: **PUT**
1562
1563 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1564
1565 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1566
1567 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1568
1569 (% style="color:#000000" %){
1570 "vehicleId": , ~/~/ ID объекта
1571 "parentId": "" , ~/~/ ID клиента
1572 "name": "" , ~/~/ имя ТС
1573 "imei": "" , ~/~/ IMEI
1574 "deviceTypeId": "" , ~/~/ ID типа устройства
1575 "modelId": "" , ~/~/ ID модели
1576 "unitId": "" , ~/~/ ID подразделения
1577 "sim1": "" , ~/~/ Номер SIM 1
1578 "sim2": "" , ~/~/ Номер SIM2
1579 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1580 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1581 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1582 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1583 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1584 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1585 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1586 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1587 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1588 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1589 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1590 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1591
1592 "mileageCalcMethod": 0,
1593 "mileageCoeff": 0,
1594 "locationByCellId": true,
1595 "dottedLineTrackWhenNoCoords": true,
1596 "counters": ~/~/ счетчики
1597 {
1598 "mileage": "" , ~/~/ пробег
1599 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1600 "motohours": "" , ~/~/ моточасы
1601 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1602 },
1603 "cmsv6Parameters": { ~/~/ параметры CMSv6
1604 "enabled": true, ~/~/ флаг включения
1605 "id": "" , ~/~/ идентификатор
1606 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1607 "login": "" , ~/~/ имя учетной записи
1608 "password": "" ~/~/ пароль учетной записи
1609 },
1610 "inspectionTasks": ~/~/ задания на ТО
1611 {
1612 "enabled": "" , ~/~/ Признак включения
1613 "name": "" , ~/~/ Имя задания
1614 "description": "" , ~/~/ Описание задания
1615 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1616 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1617 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1618 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1619 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1620 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1621 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1622 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1623 }
1624
1625 "drivers": [ ~/~/ Водители
1626 {
1627 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1628 "isDefault": true
1629 }
1630 ],
1631 "commandTemplates": [ ~/~/ Шаблон команды
1632 {
1633 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1634 "name": "string",
1635 "command": "string",
1636 "retries": 0
1637 }
1638 ],
1639
1640 "sensors": [ ~/~/ Датчики
1641 {
1642 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1643 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1644 "type": 0, ~/~/ Тип датчика
1645 "name": "string", ~/~/ Имя датчика
1646 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1647 "inputNumber": 0, ~/~/ Номер входа
1648 "pseudonym": "string", ~/~/ Псевдоним
1649 "medianDegree": 0, ~/~/ Медианная фильтрация
1650 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1651 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1652 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1653 "gradesTables": [ ~/~/ Массив таблиц тарировки
1654 {
1655 "grades": [ ~/~/ Таблица тарировки 1
1656 {
1657 "input": 0, ~/~/ Входящее значение
1658 "output": 0 ~/~/ Выходящее значение
1659 }
1660 ],
1661 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1662 }
1663 ],
1664 "showInTooltip": true, ~/~/ Отображать в подсказке
1665 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1666 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1667 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1668 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1669 "expr": "string", ~/~/ Формула
1670 "children": [ ~/~/ массив дочерних датчиков
1671 "string"
1672 ],
1673 "customParams": { ~/~/ прочие произвольные параметры
1674 "additionalProp1": "string",
1675 "additionalProp2": "string",
1676 "additionalProp3": "string"
1677 },
1678
1679 ~/~/ Характерные для произвольного:
1680
1681 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1682
1683 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1684
1685 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1686
1687 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1688
1689 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1690
1691 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1692
1693 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1694
1695 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1696
1697 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1698
1699 ~/~/ "ValueOn": "Вкл.",
1700
1701 ~/~/ "ValueOff": "Выкл."
1702 "summaryMaxValue": 0 ~/~/ Макс. значение
1703 }
1704 ],
1705 "customFields": [ ~/~/ Произвольные поля
1706 {
1707 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1708 "name": "string",
1709 "value": "string",
1710 "forClient": true,
1711 "forTooltip": true,
1712 "forReport": true
1713 }
1714 ]
1715 }
1716
1717 (% style="color:#000000" %)Ответ:
1718
1719 (% lang="en-US" style="text-align:left" %)
1720 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1721
1722 (% lang="en-US" style="text-align:left" %)
1723 "vehicleId": "", ~/~/ ID ТС
1724 "parentId": "", ~/~/ ID клиента
1725 "name": "", ~/~/ имя ТС
1726 "imei": "", ~/~/ IMEI
1727 "deviceTypeId": "", ~/~/ типа устройства
1728 "modelId": "", ~/~/ ID модели
1729 "unitId": "", ~/~/ ID подразделения
1730 "sim1": "", ~/~/ SIM 1
1731 "sim2": "", ~/~/ SIM2
1732 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1733 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1734 "counters": 
1735 {
1736 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1737 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1738 "mileage": "", ~/~/ пробег
1739 "motohours": "", ~/~/ моточасы
1740 }
1741 "cmsv6Parameters": ~/~/ параметры CMSv6
1742 {
1743 "id": ~/~/ идентификатор
1744 "enabled": true, ~/~/ флаг включения
1745 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1746 "login": "", ~/~/ имя учетной записи
1747 "password": "", ~/~/ пароль учетной записи
1748 }
1749 "inspectionTasks": ~/~/ задания на ТО
1750 {
1751 "id": "", ~/~/ ID задания
1752 "enabled": false, ~/~/ Признак включения
1753 "name": "", ~/~/ Имя задания
1754 "description": "", ~/~/ Описание задания
1755 "mileageCondition": "", ~/~/ Условие по пробегу
1756 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1757 "motohoursCondition": "", ~/~/ Условие по моточасам
1758 "lastMotohours": "", ~/~/ Моточасы
1759 "periodicCondition": "", ~/~/ Условие периодичности по времени
1760 "kind": "", ~/~/ Вид периодичности по времени
1761 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1762 }
1763
1764 (% lang="en-US" style="text-align:left" %)
1765 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1766
1767 **Валидация:**
1768 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1769 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1770 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1771
1772 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1773
1774 (% class="box errormessage" %)
1775 (((
1776 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1777 )))
1778
1779 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1780
1781 (% style="color:#000000" %)Метод запроса: **DELETE**
1782
1783 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1784
1785 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1786
1787 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1788
1789 (% style="text-align:left" %)
1790 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1791
1792 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1793
1794 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1795
1796 (% class="box infomessage" %)
1797 (((
1798 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1799 )))
1800
1801 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1802
1803 (% style="color:#000000" %)Метод запроса: **GET**
1804
1805 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1806
1807 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1808
1809 (% style="color:#000000" %)Ответ:
1810
1811 (% style="color:#000000" %){
1812
1813 "deviceTypeId" : "", ~/~/ ID типа устройства
1814 "deviceTypeName" : "" ~/~/ Название типа устройства
1815
1816 (% style="text-align:left" %)
1817 (% style="color:#000000" %)}
1818
1819 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1820
1821 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1822
1823 (% class="box infomessage" %)
1824 (((
1825 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1826 )))
1827
1828 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1829
1830 (% style="color:#000000" %)Метод запроса: **GET**
1831
1832 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1833
1834 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1835
1836 (% style="color:#000000" %)Ответ:
1837
1838 (% style="color:#000000" %){
1839
1840 "id": "", ~/~/ ID типа датчика 
1841 "name": "", ~/~/ Название
1842 "description": "", ~/~/ Описание
1843
1844 (% style="text-align:left" %)
1845 (% style="color:#000000" %)}
1846
1847 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1848
1849 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1850
1851 (% class="box infomessage" style="text-align: left;" %)
1852 (((
1853 **POST /api/v3/terminalMessages/count**
1854 )))
1855
1856 (% style="text-align: left;" %)
1857 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1858
1859 (% style="text-align: left;" %)
1860 Метод запроса **POST**
1861
1862 (% style="text-align: left;" %)
1863 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1864
1865 (% style="text-align: left;" %)
1866 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1867
1868 (% style="text-align: left;" %)
1869 {
1870 "vehicleIds": [
1871 id ~/~/ здесь передается список идентификаторов объектов
1872 ],
1873 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1874 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1875 }
1876
1877 (% style="text-align: left;" %)
1878 Ответ:
1879
1880 (% style="text-align: left;" %)
1881 [
1882 {
1883 "vehicleId": 0, ~/~/ идентификатор объекта
1884 "count": 0 ~/~/ количество сообщений за период
1885 }
1886 ]
1887
1888 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889
1890 (% class="box infomessage" style="text-align: left;" %)
1891 (((
1892 **POST /api/v3/terminalMessages/mapping**
1893 )))
1894
1895 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896
1897 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898
1899 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900
1901 {
1902 "protocolType": 0,
1903 "params": ["string"]
1904 }
1905
1906 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 |protocolType|ID типа протокола
1908 |params|(((
1909 Массив наименований параметров в сообщении
1910 )))
1911
1912 Ответ:
1913
1914 {
1915 "protocolType": 0,
1916 "mapping": {
1917 "additionalProp1": {
1918 "inputType": 0,
1919 "inputNumber": 0
1920 },
1921 "additionalProp2": {
1922 "inputType": 0,
1923 "inputNumber": 0
1924 }
1925 }
1926 }
1927
1928 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 |protocolType|Тип протокола
1930 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 |inputNumber|Номер входа
1932
1933 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1934
1935 (% class="box infomessage" %)
1936 (((
1937 **POST /api/v3/terminalMessages**
1938 )))
1939
1940 Метод возвращает список сообщений терминала объекта за выбранный период.
1941
1942 (% style="text-align: left;" %)
1943 Метод запроса **POST**
1944
1945 (% style="text-align: left;" %)
1946 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1947
1948 (% style="text-align: left;" %)
1949 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1950
1951 {
1952 "vehicleId": 0, ~/~/ id объекта
1953 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1954 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1955 }
1956
1957 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 |vehicleId|ID объекта
1959 |from|Дата и время начала периода запроса
1960 |to|Дата и время окончания периода запроса
1961
1962 Ответ:
1963
1964 [
1965 {
1966 "messages": [
1967 {
1968 "deviceTime": "2023-11-29T07:40:44.052Z",
1969 "serverTime": "2023-11-29T07:40:44.052Z",
1970 "speed": 0,
1971 "altitude": 0,
1972 "latitude": 0,
1973 "longitude": 0,
1974 "satellites": 0,
1975 "course": 0,
1976 "voltage": 0,
1977 "parameters": {
1978 "additionalProp1": "string",
1979 "additionalProp2": "string",
1980 "additionalProp3": "string"
1981 },
1982 "photoCount": 0,
1983 "lbsCorrectedCoords": true,
1984 "protocolType": 0
1985 }
1986 ]
1987 }
1988 ]
1989
1990 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 |deviceTime|Время сообщения терминала
1992 |serverTime|Время когда сообщение поступило на сервер
1993 |speed|Скорость
1994 |altitude|Высота над уровнем моря
1995 |latitude|Широта
1996 |longitude|Долгота
1997 |satellites|Кол-во спутников
1998 |course|Курс
1999 |voltage|Бортовое напряжение
2000 |parameters|Список параметров и их значений
2001 |photoCount|Количество фото
2002 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 |protocolType|ID типа протокола
2004
2005 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006
2007 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2008
2009 (% class="box infomessage" %)
2010 (((
2011 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2012 )))
2013
2014 (% style="color:#000000" %)Метод запроса: **POST**
2015
2016 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2017
2018 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2019
2020 (% style="text-align:left" %)
2021 Тело запроса:
2022
2023 {
2024 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2025 "vehicleIds": [0], ~/~/ Список ID объектов
2026 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2027 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2028 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2029 }
2030
2031 Ответ:
2032
2033 [
2034 {
2035 "vehicleId": 0, ~/~/ ID объекта
2036 "name": "string", ~/~/ Имя ТС
2037 "periods": [ ~/~/ Периоды
2038 {
2039 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2040 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2041 "mileageBegin": 0, ~/~/ Пробег на начало периода
2042 "mileageEnd": 0, ~/~/ Пробег на окончание периода
2043 "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2044 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2045 }
2046 ]
2047 }
2048 ]
2049
2050 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2051
2052 (% class="box infomessage" %)
2053 (((
2054 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2055 )))
2056
2057 (% style="color:#000000" %)Метод запроса: **POST**
2058
2059 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2060
2061 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2062
2063 (% style="text-align:left" %)
2064 Тело запроса:
2065
2066 {
2067 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2068 "vehicleIds": [0], ~/~/ Список ID объектов
2069 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2070 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2071 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2072 }
2073
2074 Ответ:
2075
2076 [
2077 {
2078 "vehicleId": 0, ~/~/ ID объекта
2079 "name": "string", ~/~/ Имя ТС
2080 "periods": [ ~/~/ Периоды
2081 {
2082 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2083 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2084 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2085 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2086 "fuelConsumption": 0, ~/~/ Расход топлива
2087 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2088 }
2089 ]
2090 }
2091 ]
2092
2093 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2094
2095 (% class="box infomessage" %)
2096 (((
2097 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2098 )))
2099
2100 (% style="color:#000000" %)Метод запроса: **POST**
2101
2102 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2103
2104 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2105
2106 (% style="text-align:left" %)
2107 Тело запроса:
2108
2109 {
2110 "vehicleIds": [0], ~/~/ Список ID объектов
2111 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2112 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2113 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2114 }
2115
2116 Ответ:
2117
2118 [
2119 {
2120 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2121 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2122 "vehicleId": 0, ~/~/ ID объекта
2123 "name": "string", ~/~/ Имя объекта
2124 "model": "string", ~/~/ Модель объекта
2125 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2126 {
2127 "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2128 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2129 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2130 "valueFuel": 0, ~/~/ Количество
2131 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2132 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2133 }
2134 ]
2135 }
2136 ]
2137
2138
2139 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2140
2141 (% class="box infomessage" %)
2142 (((
2143 **POST /api/v3/vehicles/moveStop**
2144 )))
2145
2146 Метод запроса: **POST**
2147
2148 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2149
2150 В заголовках запроса: X-Auth: Токен авторизации
2151
2152
2153 Тело запроса:
2154
2155 {
2156
2157 "vehicleIds": [ ], ~/~/ Список ID объектов
2158
2159 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2160
2161 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2162
2163 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2164
2165 }
2166
2167 Ответ:
2168
2169 [
2170
2171 {
2172
2173 "vehicleId": 0, ~/~/ ID объекта
2174
2175 "vehicleName": "string", ~/~/ Имя объекта
2176
2177 "moves": [ ~/~/ Событие движения
2178
2179 {
2180
2181 "mileage": 0, ~/~/ Пробег, км
2182
2183 "eventId": 0, ~/~/ Идентификатор события
2184
2185 "eventName": "string", ~/~/ Название события
2186
2187 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2188
2189 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2190
2191 "duration": 0 ~/~/ Продолжительность события, секунд
2192
2193 }
2194
2195 ],
2196
2197 "stops": [ ~/~/ События стоянок
2198
2199 {
2200
2201 "address": "string", ~/~/ Адрес события
2202
2203 "eventId": 0, ~/~/ Идентификатор события
2204
2205 "eventName": "string", ~/~/ Название события
2206
2207 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2208
2209 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2210
2211 "duration": 0 ~/~/ Продолжительность события, секунд
2212
2213
2214 }
2215
2216 ]
2217
2218 }
2219
2220 ]
2221
2222
2223
2224 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2225
2226 (% class="box infomessage" %)
2227 (((
2228 **POST /api/v3/vehicles/getlastdata**
2229 )))
2230
2231 Метод запроса: **POST**
2232
2233 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2234
2235 В заголовках запроса: X-Auth: Токен авторизации
2236
2237
2238 Тело запроса:
2239
2240 {
2241
2242 "vehicleIds": [ ], ~/~/ Список ID машины
2243
2244 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2245
2246 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2247
2248 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2249
2250 }
2251
2252
2253 Ответ:
2254 {
2255 "vehicleId": 0, ~/~/Идентификатор объекта.
2256 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2257 "vehicleNumber": "string",~/~/Номер объекта.
2258 "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2259 "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2260 "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных.
2261 "speed": 0,~/~/Скорость объекта.
2262 "course": 0,~/~/Курс движения [0;360]
2263 "latitude": 0,~/~/Широта [-90°;90°].
2264 "longitude": 0,~/~/Долгота [-180°;180°].
2265 "address": "string",~/~/Адрес.
2266 "geozones": [ ~/~/Сведения по геозонам.
2267 {
2268 "id": 0,
2269 "name": "string"
2270 }
2271
2272
2273
2274 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2275
2276 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2277
2278 (% class="box infomessage" %)
2279 (((
2280 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2281 )))
2282
2283 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2284
2285 (% style="color:#000000" %)Метод запроса: **POST**
2286
2287 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2288
2289 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2290
2291 (% style="text-align:left" %)
2292 Тело запроса:
2293
2294 (% style="text-align:left" %)
2295 {
2296 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2297 }
2298
2299 (% style="text-align:left" %)
2300 Ответ:
2301
2302 [
2303 {
2304 "id": 0, ~/~/ Идентификатор объекта геозоны
2305 "name": "string", ~/~/ Название объекта геозоны
2306 "type": 0, ~/~/ Тип объекта геозоны
2307 "fname": "string", ~/~/ Имя файла
2308 "parentId": "string", ~/~/ Идентификатор клиента
2309 "radius": 0, ~/~/ Радиус геообъекта
2310 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2311 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2312 "description": "string", ~/~/ Описание
2313 "area": 0, ~/~/ Площадь, м^^2^^
2314 "perimetr": 0, ~/~/ Периметр, м
2315 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2316 }
2317 ]
2318
2319 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2320
2321 (% class="box infomessage" %)
2322 (((
2323 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2324 )))
2325
2326 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2327
2328 (% style="color:#000000" %)Метод запроса: **POST**
2329
2330 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2331
2332 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2333
2334 (% style="text-align:left" %)
2335 Тело запроса:
2336
2337 {
2338 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2339 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2340 "ids": [ ], ~/~/ Массив id объектов
2341 "byTime": 0, ~/~/ Объединение событий по времени 
2342 "byDist": 0, ~/~/ Объединение событий по расстоянию
2343 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2344 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2345 }
2346
2347 Ответ:
2348 [
2349 {
2350 "geozoneId": 0, ~/~/ ID геообъекта
2351 "geozoneName": "string", ~/~/ Название геообъекта
2352 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2353 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2354 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2355 "vehicleId": 0, ~/~/ ID объекта
2356 "vehicleName": "string" ~/~/ Имя объекта
2357 }
2358 ]
2359
2360 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2361
2362 (% class="box infomessage" %)
2363 (((
2364 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2365 )))
2366
2367 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2368
2369 (% style="color:#000000" %)Метод запроса: **POST**
2370
2371 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2372
2373 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2374
2375 (% style="text-align:left" %)
2376 Тело запроса:
2377
2378 {
2379 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2380 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2381 "ids": [ ], ~/~/ Массив id геообъектов
2382 "byTime": 0, ~/~/ Объединение событий по времени 
2383 "byDist": 0, ~/~/ Объединение событий по расстоянию
2384 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2385 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2386 }
2387
2388 Ответ:
2389
2390 [
2391 {
2392 "geozoneId": 0, ~/~/ ID геообъекта
2393 "geozoneName": "string", ~/~/ Название геообъекта
2394 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2395 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2396 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2397 "vehicleId": 0, ~/~/ ID объекта
2398 "vehicleName": "string" ~/~/ Имя объекта
2399 }
2400 ]
2401
2402 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2403
2404 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2405
2406 (% class="box infomessage" %)
2407 (((
2408 **POST /api/v3/notifications/find**
2409 )))
2410
2411 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2412
2413 (% style="text-align: left;" %)
2414 Метод запроса **POST**
2415
2416 (% style="text-align: left;" %)
2417 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2418
2419 (% style="text-align: left;" %)
2420 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2421
2422 {
2423 "parentId": "" ~/~/ id клиента
2424 }
2425
2426 Ответ:
2427
2428 [
2429 {
2430 "id": 0, ~/~/ ID уведомления
2431 "name": "string", ~/~/ Название уведомления
2432 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2433 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2434 "userId": "", ~/~/ Пользователь, создавший уведомление
2435 "parentId": "", ~/~/ Идентификатор клиента
2436 "parentName": "string" ~/~/ Имя клиента
2437 }
2438 ]
2439
2440 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2441
2442 (% class="box infomessage" %)
2443 (((
2444 **GET /api/v3/notifications/{id}**
2445 )))
2446
2447 Метод возвращает данные правил формирования выбранного уведомления.
2448
2449 (% style="text-align: left;" %)
2450 Метод запроса **GET**
2451
2452 (% style="text-align: left;" %)
2453 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2454
2455 (% style="text-align: left;" %)
2456 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2457
2458 (% style="text-align: left;" %)
2459 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2460
2461 (% style="text-align: left;" %)
2462 (% style="color:#000000" %)Ответ:
2463
2464 (% style="text-align: left;" %)
2465 (% style="color:#000000" %){
2466 "id": 0, ~/~/ (%%)id уведомления
2467 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2468 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2469 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2470 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2471 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2472 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2473 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2474 (% style="color:#000000" %) 0
2475 ],
2476 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2477 (% style="color:#000000" %) 0
2478 ],
2479 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2480 (% style="color:#000000" %) 0
2481 ],
2482 "settings": { ~/~/ Список параметров уведомления
2483 "additionalProp1": "string",
2484 "additionalProp2": "string",
2485 "additionalProp3": "string"
2486 },
2487 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2488 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2489 (% style="color:#000000" %) ""
2490 ],
2491 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2492 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2493 (% style="color:#000000" %) "string"
2494 ],
2495 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2496 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2497 (% style="color:#000000" %) {
2498 "id": 0, ~/~/ (%%)Идентификатор участника чата
2499 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2500 (% style="color:#000000" %) }
2501 ],
2502 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2503 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2504 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2505 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2506 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2507 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2508 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2509 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2510 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2511 (% style="color:#000000" %)}
2512
2513 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2514
2515 (% class="box warningmessage" %)
2516 (((
2517 **PUT /api/v3/notifications/**
2518 )))
2519
2520 Метод позволяет отредактировать уведомление.
2521
2522 Метод запроса **PUT**
2523
2524 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2525
2526 В заголовках запроса: X-Auth: Токен авторизации
2527
2528 Тело запроса:
2529 {
2530 "id": 0, ~/~/ id уведомления
2531 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2532 "userId": "", ~/~/ Пользователь, создавший уведомление
2533 "parentId": "", ~/~/ Идентификатор клиента
2534 "parentName": "string", ~/~/ Имя клиента
2535 "name": "string", ~/~/ Название уведомления
2536 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2537 "vehicleIds": [ ~/~/ Список id объектов для анализа
2538 0
2539 ],
2540 "geoids": [ ~/~/ Список id геообъектов для анализа
2541 0
2542 ],
2543 "fieldids": [ ~/~/ Список id полей для анализа
2544 0
2545 ],
2546 "settings": { ~/~/ Список параметров уведомления
2547 "additionalProp1": "string",
2548 "additionalProp2": "string",
2549 "additionalProp3": "string"
2550 },
2551 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2552 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2553 ""
2554 ],
2555 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2556 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2557 "string"
2558 ],
2559 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2560 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2561 {
2562 "id": 0, ~/~/ Идентификатор участника чата
2563 "info": "string" ~/~/ Дополнительные сведения
2564 }
2565 ],
2566 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2567 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2568 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2569 "kind": 0, ~/~/ Определяет вид уведомления
2570 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2571 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2572 "timezone": 0, ~/~/ Сдвиг часового пояса
2573 "validity": 0, ~/~/ Срок действия в днях (1-90)
2574 "autoProlongation": true ~/~/ Автопродление срока действия
2575 }
2576
2577 Ответ:
2578
2579 Success
2580
2581 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2582
2583 (% class="box errormessage" %)
2584 (((
2585 **DELETE /api/v3/notifications/{id}**
2586 )))
2587
2588 Метод позволяет удалить выбранное уведомление.
2589
2590 Метод запроса **DELETE**
2591
2592 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2593
2594 Передаваемый параметр: {id} - id уведомления
2595
2596 В заголовках запроса: X-Auth: Токен авторизации
2597
2598 Ответ:
2599
2600 Success
2601
2602
2603 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2604
2605 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2606
2607 (% class="box infomessage" %)
2608 (((
2609 **POST /api/v3/Drivers/find**
2610 )))
2611
2612 Передается параметр: parentId - ID клиента-родителя
2613
2614 Ответ:
2615
2616 [
2617 {
2618 "name": "string", ~/~/ Определяет наименование
2619 "description": "string", ~/~/ Определяет описание
2620 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2621 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2622 "exclusive": true, ~/~/ Определяет признак "Исключительный"
2623 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2624 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2625 "deleted": true ~/~/ Признак удаления
2626 }
2627 ]
2628
2629 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2630
2631 (% class="box infomessage" %)
2632 (((
2633 **GET /api/v3/Drivers/{driverGuid}**
2634 )))
2635
2636 Передается параметр: ID водителя
2637
2638 Ответ:
2639
2640 {
2641 "name": "string", ~/~/ Определяет наименование
2642 "description": "string", ~/~/ Определяет описание
2643 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2644 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2645 "exclusive": true, ~/~/ Определяет признак "Исключительный"
2646 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2647 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2648 "deleted": true ~/~/ Признак удаления
2649 }
2650
2651 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2652
2653 (% class="box successmessage" %)
2654 (((
2655 **POST /api/v3/Drivers**
2656 )))
2657
2658 Запрос:
2659
2660 {
2661 "name": "string",
2662 "description": "string",
2663 "hiredate": "2023-06-30T12:50:54.020Z",
2664 "chopdate": "2023-06-30T12:50:54.020Z",
2665 "exclusive": true,
2666 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2667 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2668 "deleted": true
2669 }
2670
2671 Ответ:
2672
2673 {
2674 "name": "string",
2675 "description": "string",
2676 "hiredate": "2023-06-30T12:50:54.051Z",
2677 "chopdate": "2023-06-30T12:50:54.051Z",
2678 "exclusive": true,
2679 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2681 "deleted": true
2682 }
2683
2684
2685 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2686
2687 (% class="box warningmessage" %)
2688 (((
2689 **PUT /api/v3/Drivers**
2690 )))
2691
2692 Запрос:
2693
2694 {
2695 "name": "string",
2696 "description": "string",
2697 "hiredate": "2023-06-30T12:50:27.910Z",
2698 "chopdate": "2023-06-30T12:50:27.910Z",
2699 "exclusive": true,
2700 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2701 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2702 "deleted": true
2703 }
2704
2705 Ответ:
2706
2707 {
2708 "name": "string",
2709 "description": "string",
2710 "hiredate": "2023-06-30T12:50:27.929Z",
2711 "chopdate": "2023-06-30T12:50:27.929Z",
2712 "exclusive": true,
2713 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2714 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2715 "deleted": true
2716 }
2717
2718
2719 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2720
2721 (% class="box errormessage" %)
2722 (((
2723 **DELETE /api/v3/Drivers/{driverGuid}**
2724 )))
2725
2726 Передается параметр: ID водителя
2727
2728 Ответ:
2729
2730 Success
2731
2732
2733 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2734
2735 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2736
2737 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2738
2739 (% class="box infomessage" %)
2740 (((
2741 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2742 )))
2743
2744 Запрос:
2745
2746 {
2747 "Ids": [
2748 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2749 ],
2750 "BeginTime": "2023-06-30T12:49:04.365Z",
2751 "EndTime": "2023-06-30T12:49:04.365Z"
2752 }
2753
2754 Ответ:
2755
2756 [
2757 {
2758 "VehicleId": 0,
2759 "CreateTime": "2023-06-30T09:52:31.240Z",
2760 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2761 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2762 "BeginTime": "2023-06-30T09:52:31.240Z",
2763 "EndTime": "2023-06-30T09:52:31.240Z"
2764 }
2765 ]
2766
2767
2768 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2769
2770 (% class="box infomessage" %)
2771 (((
2772 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2773 )))
2774
2775 Запрос:
2776
2777 {
2778 "Ids": [
2779 0
2780 ],
2781 "BeginTime": "2023-06-30T12:48:39.419Z",
2782 "EndTime": "2023-06-30T12:48:39.419Z"
2783 }
2784
2785 Ответ:
2786
2787 [
2788 {
2789 "VehicleId": 0,
2790 "CreateTime": "2023-06-30T09:54:01.631Z",
2791 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2792 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2793 "BeginTime": "2023-06-30T09:54:01.631Z",
2794 "EndTime": "2023-06-30T09:54:01.631Z"
2795 }
2796 ]
2797
2798
2799 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2800
2801 (% class="box successmessage" %)
2802 (((
2803 **POST /api/v3/DriversVehiclesAssignments**
2804 )))
2805
2806 Передается массив назначений
2807
2808 Запрос:
2809
2810 [
2811 {
2812 "VehicleId": 0, ~/~/ Идентификатор объекта
2813 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2814 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2815 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2816 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2817 }
2818 ]
2819
2820 Ответ:
2821
2822 [
2823 {
2824 "VehicleId": 0,
2825 "CreateTime": "2023-06-30T11:04:46.903Z",
2826 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2827 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2828 "BeginTime": "2023-06-30T11:04:46.903Z",
2829 "EndTime": "2023-06-30T11:04:46.903Z"
2830 }
2831 ]
2832
2833
2834 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2835
2836 (% class="box warningmessage" %)
2837 (((
2838 **PUT /api/v3/DriversVehiclesAssignments**
2839 )))
2840
2841 Запрос:
2842
2843 [
2844 {
2845 "VehicleId": 0,
2846 "CreateTime": "2023-06-30T11:14:08.117Z",
2847 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2848 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2849 "BeginTime": "2023-06-30T11:14:08.117Z",
2850 "EndTime": "2023-06-30T11:14:08.117Z"
2851 }
2852 ]
2853
2854 Ответ:
2855
2856 [
2857 {
2858 "VehicleId": 0,
2859 "CreateTime": "2023-06-30T11:14:53.349Z",
2860 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2861 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2862 "BeginTime": "2023-06-30T11:14:53.349Z",
2863 "EndTime": "2023-06-30T11:14:53.349Z"
2864 }
2865 ]
2866
2867
2868 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2869
2870 (% class="box errormessage" %)
2871 (((
2872 **DELETE /api/v3/DriversVehiclesAssignments**
2873 )))
2874
2875 Запрос:
2876
2877 [
2878 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2879 ]
2880
2881 Ответ:
2882
2883 Success
2884
2885
2886 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2887
2888 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2889
2890 (% class="box infomessage" %)
2891 (((
2892 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2893 )))
2894
2895 Запрос:
2896
2897 {
2898 "Ids": [
2899 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2900 ],
2901 "BeginTime": "2023-06-30T12:47:12.162Z",
2902 "EndTime": "2023-06-30T12:47:12.162Z"
2903 }
2904
2905 Ответ:
2906
2907 [
2908 {
2909 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2910 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2911 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2912 "BeginTime": "2023-06-30T11:19:40.703Z",
2913 "EndTime": "2023-06-30T11:19:40.703Z"
2914 }
2915 ]
2916
2917
2918 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2919
2920 (% class="box infomessage" %)
2921 (((
2922 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
2923 )))
2924
2925 Запрос:
2926
2927 {
2928 "Ids": [
2929 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2930 ],
2931 "BeginTime": "2023-06-30T12:47:12.162Z",
2932 "EndTime": "2023-06-30T12:47:12.162Z"
2933 }
2934
2935 Ответ:
2936
2937 [
2938 {
2939 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2940 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2941 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2942 "BeginTime": "2023-06-30T11:19:40.703Z",
2943 "EndTime": "2023-06-30T11:19:40.703Z"
2944 }
2945 ]
2946
2947
2948 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2949
2950 (% class="box successmessage" %)
2951 (((
2952 **POST /api/v3/DriversRfidsAssignments**
2953 )))
2954
2955 Запрос:
2956
2957 [
2958 {
2959 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2960 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2961 "BeginTime": "2023-06-30T11:27:08.635Z",
2962 "EndTime": "2023-06-30T11:27:08.635Z"
2963 }
2964 ]
2965
2966 Ответ:
2967
2968 [
2969 {
2970 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2971 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2972 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2973 "BeginTime": "2023-06-30T11:27:08.677Z",
2974 "EndTime": "2023-06-30T11:27:08.677Z"
2975 }
2976 ]
2977
2978
2979 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2980
2981 (% class="box warningmessage" %)
2982 (((
2983 **PUT /api/v3/DriversRfidsAssignments**
2984 )))
2985
2986 Запрос:
2987
2988 [
2989 {
2990 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2991 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2992 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2993 "BeginTime": "2023-06-30T11:28:43.330Z",
2994 "EndTime": "2023-06-30T11:28:43.330Z"
2995 }
2996 ]
2997
2998 Ответ:
2999
3000 [
3001 {
3002 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3003 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3004 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3005 "BeginTime": "2023-06-30T11:28:43.331Z",
3006 "EndTime": "2023-06-30T11:28:43.331Z"
3007 }
3008 ]
3009
3010
3011 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3012
3013 (% class="box errormessage" %)
3014 (((
3015 **DELETE /api/v3/DriversRfidsAssignments**
3016 )))
3017
3018 Запрос:
3019
3020 [
3021 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3022 ]
3023
3024 Ответ:
3025
3026 Success
3027
3028
3029 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3030
3031 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3032
3033 (% class="box infomessage" %)
3034 (((
3035 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3036 )))
3037
3038 Запрос:
3039
3040 {
3041 "Ids": [
3042 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3043 ],
3044 "BeginTime": "2023-06-30T12:45:10.852Z",
3045 "EndTime": "2023-06-30T12:45:10.852Z"
3046 }
3047
3048 Ответ:
3049
3050 [
3051 {
3052 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3053 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3054 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3055 "BeginTime": "2023-06-30T11:58:04.695Z",
3056 "EndTime": "2023-06-30T11:58:04.695Z"
3057 }
3058 ]
3059
3060
3061 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3062
3063 (% class="box infomessage" %)
3064 (((
3065 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3066 )))
3067
3068 Запрос:
3069
3070 {
3071 "Ids": [
3072 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3073 ],
3074 "BeginTime": "2023-06-30T12:45:10.852Z",
3075 "EndTime": "2023-06-30T12:45:10.852Z"
3076 }
3077
3078 Ответ:
3079
3080 [
3081 {
3082 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3084 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 "BeginTime": "2023-06-30T11:58:04.695Z",
3086 "EndTime": "2023-06-30T11:58:04.695Z"
3087 }
3088 ]
3089
3090
3091 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3092
3093 (% class="box successmessage" %)
3094 (((
3095 **POST /api/v3/DriversFuelCardsAssignments**
3096 )))
3097
3098 Запрос:
3099
3100 [
3101 {
3102 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3103 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3104 "BeginTime": "2023-06-30T12:09:53.175Z",
3105 "EndTime": "2023-06-30T12:09:53.175Z"
3106 }
3107 ]
3108
3109 Ответ:
3110
3111 [
3112 {
3113 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3114 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3115 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3116 "BeginTime": "2023-06-30T12:09:53.201Z",
3117 "EndTime": "2023-06-30T12:09:53.201Z"
3118 }
3119 ]
3120
3121
3122 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3123
3124 (% class="box warningmessage" %)
3125 (((
3126 **PUT /api/v3/DriversFuelCardsAssignments**
3127 )))
3128
3129 Запрос:
3130
3131 [
3132 {
3133 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3134 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3135 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3136 "BeginTime": "2023-06-30T12:09:53.201Z",
3137 "EndTime": "2023-06-30T12:09:53.201Z"
3138 }
3139 ]
3140
3141 Ответ:
3142
3143 [
3144 {
3145 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3146 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3147 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3148 "BeginTime": "2023-06-30T12:09:53.201Z",
3149 "EndTime": "2023-06-30T12:09:53.201Z"
3150 }
3151 ]
3152
3153
3154 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3155
3156 (% class="box errormessage" %)
3157 (((
3158 **DELETE /api/v3/DriversFuelCardsAssignments**
3159 )))
3160
3161 Запрос:
3162
3163 [
3164 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3165 ]
3166
3167 Ответ:
3168
3169 Success
3170
3171
3172 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3173
3174 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3175
3176 (% class="box infomessage" %)
3177 (((
3178 **POST /api/v3/Trailers**
3179 )))
3180
3181 Пример запроса:
3182
3183 {
3184 "startDate": "2023-11-14T10:48:03.671Z",
3185 "endDate": "2023-11-14T10:48:03.671Z",
3186 "ids": [ 0 ],
3187 "timezone": 0
3188 }
3189
3190 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3191 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3192 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3193 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3194 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3195
3196 Пример ответа:
3197
3198 [
3199 {
3200 "SD": "2023-11-14T10:48:03.717Z",
3201 "ED": "2023-11-14T10:48:03.717Z", 
3202 "id": 0,
3203 "SLat": 0,
3204 "SLon": 0,
3205 "ELat": 0,
3206 "ELon": 0,
3207 "mileage": 0
3208 "Duration": 0
3209 "Address": "string",
3210 "Address2": "string",
3211 "name": "string",
3212 "rid": "string",
3213 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3214 "trailer": {
3215 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3216 "Number": "string",
3217 "Description": "string",
3218 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3219 "ExternalID": "string",
3220 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3221 "CreateTime": "2023-11-14T10:48:03.717Z",
3222 "UpdateTime": "2023-11-14T10:48:03.717Z",
3223 "IsDeleted": true
3224 },
3225 "filesCount": 0,
3226 }
3227 ]
3228
3229 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3230 |SD|Дата и время начала события
3231 |ED|Дата и время окончания события
3232 |id|ID объекта
3233 |SLat|Широта начальной координаты
3234 |SLon|Долгота начальной координаты
3235 |ELat|Широта конечной координаты
3236 |ELon|Долгота конечной координаты
3237 |mileage|Пробег
3238 |Duration|Продолжительность
3239 |Address|Адрес начального местоположения
3240 |Address2|Адрес конечного местоположения
3241 |name|Имя радиометки
3242 |rid|Номер радиометки
3243 |rguid|ID радиометки
3244 |trailer|Информация об агрегате
3245 |ModelGuid|ID агрегата
3246 |Number|Название/номер агрегата
3247 |Description|Текст примечания агрегата
3248
3249 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3250
3251 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3252
3253 (% class="box infomessage" %)
3254 (((
3255 **POST /api/v3/Rfids/find**
3256 )))
3257
3258 Запрос:
3259
3260 {
3261 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3262 }
3263
3264 Ответ:
3265
3266 [
3267 {
3268 "name": "string",
3269 "number": 0,
3270 "period": 0,
3271 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3272 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3273 }
3274 ]
3275
3276 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3277 |parentId|ID клиента
3278 |name|Название карты-метки
3279 |number|Номер
3280 |period|Период запросов в секундах (работает только для агрегатов)
3281 |id|ID карты-метки
3282
3283 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3284
3285 (% class="box infomessage" %)
3286 (((
3287 **GET /api/v3/Rfids/{rfidGuid}**
3288 )))
3289
3290 Передаем параметр rfidGuid - идентификатор карты-метки
3291
3292 Ответ:
3293
3294 [
3295 {
3296 "name": "string",
3297 "number": 0,
3298 "period": 0,
3299 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3300 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3301 }
3302 ]
3303
3304 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3305 |name|Название карты-метки
3306 |number|Номер
3307 |period|Период запросов в секундах (работает только для агрегатов)
3308 |id|ID карты-метки
3309 |parentId|ID клиента
3310
3311 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3312
3313 (% class="box successmessage" %)
3314 (((
3315 **POST /api/v3/Rfids**
3316 )))
3317
3318 Запрос:
3319
3320 {
3321 "name": "string",
3322 "number": 0,
3323 "period": 0,
3324 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3325 }
3326
3327 Ответ:
3328
3329 {
3330 "name": "string",
3331 "number": 0,
3332 "period": 0,
3333 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3334 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3335 }
3336
3337 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3338 |name|Название карты-метки
3339 |number|Номер
3340 |period|Период запросов в секундах (работает только для агрегатов)
3341 |id|ID карты-метки
3342 |parentId|ID клиента
3343
3344 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3345
3346 (% class="box warningmessage" %)
3347 (((
3348 **PUT /api/v3/Rfids**
3349 )))
3350
3351 Запрос:
3352
3353 {
3354 "name": "string",
3355 "number": 0,
3356 "period": 0,
3357 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3358 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3359 }
3360
3361 Ответ:
3362
3363 {
3364 "name": "string",
3365 "number": 0,
3366 "period": 0,
3367 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3368 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3369 }
3370
3371 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3372 |name|Название карты-метки
3373 |number|Номер
3374 |period|Период запросов в секундах (работает только для агрегатов)
3375 |id|ID карты-метки
3376 |parentId|ID клиента
3377
3378 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3379
3380 (% class="box errormessage" %)
3381 (((
3382 **DELETE /api/v3/Rfids/{rfidGuid}**
3383 )))
3384
3385 Передаем параметр **rfidGuid** - идентификатор карты-метки
3386
3387 Ответ:
3388
3389 Success
3390
3391
3392 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3393
3394 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3395
3396 (% class="box infomessage" %)
3397 (((
3398 **GET /api/v3/Billing/client/balance/{clientId}**
3399 )))
3400
3401 Параметр запроса: **clientId **- идентификатор клиента.
3402
3403 Ответ:
3404
3405 {
3406 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3407 "Balance": 0
3408 }
3409
3410 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3411 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3412 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3413
3414 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3415
3416 (% class="box infomessage" %)
3417 (((
3418 **GET /api/v3/Billing/client/constraint/{clientId}**
3419 )))
3420
3421 Параметр запроса: **clientId **- идентификатор клиента.
3422
3423 Ответ:
3424
3425 {
3426 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3427 "CalculationType": 0,
3428 "PermissibleBalance": 0,
3429 "DefermentDays": 0,
3430 "SendUiNotifications": true,
3431 "SendEmailNotifications": true,
3432 "IsPrivate": true,
3433 }
3434
3435 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3436 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3437 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3438 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3439 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3440 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3441 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3442 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3443
3444 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3445
3446 (% class="box infomessage" %)
3447 (((
3448 **GET /api/v3/Billing/client/plan/{clientId}**
3449 )))
3450
3451 Параметры запроса:
3452
3453 **clientId **- идентификатор клиента.
3454
3455 **planId **- идентификатор тарифного плана.
3456
3457 Ответ:
3458
3459 {
3460 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3461 "Plan": { **~/~/ Описание тарифного плана**
3462 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3463 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3464 "Name": "string",
3465 "IsArchived": true,
3466 "Constraint": {
3467 "CalculationType": 0,
3468 "PermissibleBalance": 0,
3469 "DefermentDays": 0
3470 },
3471 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3472 {
3473 "Feature": "string",
3474 "IsFactual": true,
3475 "Limit": 0,
3476 "Price": 0,
3477 "PeriodValue": 0,
3478 "PeriodType": 0
3479 }
3480 ]
3481 },
3482 "DebitDate": "2023-10-18T12:46:24.213Z",
3483 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3484 {
3485 "Feature": "string",
3486 "IsEnabled": true,
3487 "IsPrivate": true,
3488 "IsFactual": true,
3489 "Limit": 0,
3490 "Price": 0,
3491 "DebitDate": "2023-10-18T12:46:24.213Z",
3492 "PeriodValue": 0,
3493 "PeriodType": 0
3494 }
3495 ]
3496 }
3497
3498 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3499 |ClientId|Идентификатор клиента
3500 |Id|Идентификатор тарифного плана
3501 |OwnerId|Идентификатор клиента-владельца
3502 |Name|Наименование тарифного плана
3503 |IsArchived|Признак, определяющий архивный тарифный план
3504 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3505 |PermissibleBalance|Допустимый баланс
3506 |DefermentDays|Отсрочка, количество дней
3507 |Feature|Код услуги
3508 |IsEnabled|Признак, определяющий активирована ли услуга
3509 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3510 |IsFactual|Признак, определяющий расчёт по факту
3511 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3512 |Price|Цена за единицу.
3513 |DebitDate|Следующий момент времени списания с баланса за услугу.
3514 |PeriodValue|Значение периода.
3515 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3516
3517 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3518
3519 (% class="box infomessage" %)
3520 (((
3521 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3522 )))
3523
3524 Параметр запроса: **clientId **- идентификатор клиента.
3525
3526 Ответ:
3527
3528 [
3529 {
3530 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3531 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3532 "Name": "string",
3533 "IsArchived": true,
3534 "Constraint": {
3535 "CalculationType": 0,
3536 "PermissibleBalance": 0,
3537 "DefermentDays": 0
3538 },
3539 "Features": [
3540 {
3541 "Feature": "string",
3542 "IsFactual": true,
3543 "Limit": 0,
3544 "Price": 0,
3545 "PeriodValue": 0,
3546 "PeriodType": 0
3547 }
3548 ]
3549 }
3550 ]
3551
3552 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3553 |ClientId|Идентификатор клиента
3554 |Id|Идентификатор тарифного плана
3555 |OwnerId|Идентификатор клиента-владельца
3556 |Name|Наименование тарифного плана
3557 |IsArchived|Признак, определяющий архивный тарифный план
3558 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3559 |PermissibleBalance|Допустимый баланс
3560 |DefermentDays|Отсрочка, количество дней
3561 |Feature|Код услуги
3562 |IsFactual|Признак, определяющий расчёт по факту
3563 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3564 |Price|Цена за единицу.
3565 |PeriodValue|Значение периода.
3566 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3567
3568 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3569
3570 (% class="box infomessage" %)
3571 (((
3572 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3573 )))
3574
3575 Параметр запроса: **clientId **- идентификатор клиента.
3576
3577 Ответ:
3578
3579 [
3580 {
3581 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3582 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3583 "Name": "string",
3584 "IsArchived": true,
3585 "Constraint": {
3586 "CalculationType": 0,
3587 "PermissibleBalance": 0,
3588 "DefermentDays": 0
3589 },
3590 "Features": [
3591 {
3592 "Feature": "string",
3593 "IsFactual": true,
3594 "Limit": 0,
3595 "Price": 0,
3596 "PeriodValue": 0,
3597 "PeriodType": 0
3598 }
3599 ]
3600 }
3601 ]
3602
3603 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3604 |ClientId|Идентификатор клиента
3605 |Id|Идентификатор тарифного плана
3606 |OwnerId|Идентификатор клиента-владельца
3607 |Name|Наименование тарифного плана
3608 |IsArchived|Признак, определяющий архивный тарифный план
3609 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3610 |PermissibleBalance|Допустимый баланс
3611 |DefermentDays|Отсрочка, количество дней
3612 |Feature|Код услуги
3613 |IsFactual|Признак, определяющий расчёт по факту
3614 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3615 |Price|Цена за единицу.
3616 |PeriodValue|Значение периода.
3617 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3618
3619 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3620
3621 (% class="box warningmessage" %)
3622 (((
3623 **PUT /api/v3/Billing/client/balance**
3624 )))
3625
3626 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3627
3628 Тело запроса:
3629
3630 {
3631 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3632 "Balance": 0
3633 }
3634
3635 Ответ: Success
3636
3637 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3638 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3639 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3640
3641 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3642
3643 (% class="box warningmessage" %)
3644 (((
3645 **PUT /api/v3/billing/client/balance/deposit**
3646 )))
3647
3648 Создает операцию **Пополнение **с указанной суммой
3649
3650 Тело запроса:
3651
3652 {
3653 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3654 "Balance": 0
3655 }
3656
3657 Ответ: Success
3658
3659 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3660 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3661 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3662
3663 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3664
3665 Создает операцию **Списание **с указанной суммой
3666
3667 (% class="box warningmessage" %)
3668 (((
3669 **PUT /api/v3/billing/client/balance/withdraw**
3670 )))
3671
3672 Тело запроса:
3673
3674 {
3675 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3676 "Balance": 0
3677 }
3678
3679 Ответ: Success
3680
3681 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3682 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3683 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3684
3685 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3686
3687 (% class="box warningmessage" %)
3688 (((
3689 **PUT /api/v3/Billing/client/constraint**
3690 )))
3691
3692 Тело запроса:
3693
3694 {
3695 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3696 "CalculationType": 0,
3697 "PermissibleBalance": 0,
3698 "DefermentDays": 0,
3699 "SendUiNotifications": true,
3700 "SendEmailNotifications": true,
3701 "IsPrivate": true,
3702 }
3703
3704 Ответ: Success
3705
3706 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3707 |ClientId|Идентификатор клиента
3708 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3709 |PermissibleBalance|Допустимый баланс
3710 |DefermentDays|(((
3711 Отсрочка, количество дней
3712 )))
3713 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3714 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3715 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3716
3717 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3718
3719 (% class="box warningmessage" %)
3720 (((
3721 **PUT /api/v3/Billing/client/plan**
3722 )))
3723
3724 Тело запроса:
3725
3726 {
3727 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3728 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3729 "Features": [
3730 {
3731 "Feature": "string",
3732 "IsEnabled": true,
3733 "IsFactual": true,
3734 "Limit": 0,
3735 "Price": 0,
3736 "DebitDate": "2023-10-18T13:26:58.987Z",
3737 "PeriodValue": 0,
3738 "PeriodType": 0
3739 }
3740 ]
3741 }
3742
3743 Ответ: Success
3744
3745 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3746 |ClientId|Идентификатор клиента
3747 |PlanId|Идентификатор тарифного плана
3748 |Feature|Код услуги
3749 |IsEnabled|Признак, определяющий активирована ли услуга
3750 |IsFactual|Признак, определяющий расчёт по факту
3751 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3752 |Price|Цена за единицу.
3753 |DebitDate|Следующий момент времени списания с баланса за услугу.
3754 |PeriodValue|Значение периода.
3755 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3756
3757 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3758
3759 (% class="box warningmessage" %)
3760 (((
3761 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3762 )))
3763
3764 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3765
3766 (% class="box infomessage" %)
3767 (((
3768 **POST /api/v3/vehicles/import/{agentId}**
3769 )))
3770
3771 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3772
3773 В пути указывается **agentId** - id клиента.
3774
3775 **Заголовок**
3776
3777 **X-Auth: [токен авторизации]**
3778
3779 **Параметры**
3780
3781 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3782 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3783 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3784
3785 В теле использовать тип **form-data,** тип значения** file**
3786
3787 **Ключи**
3788
3789 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3790 |data|В значении передаем файл объекта, формат **xml** или **wlp **
3791 |csv|В значении передаем файл датчиков, формат **csv**
3792
3793 Ответ:
3794
3795 {
3796 "vehicleId": 0,
3797 "name": "string",
3798 "errors": ["string"]
3799 }
3800
3801 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3802 |vehicleId|ID созданного объекта
3803 |name|Имя созданного объекта
3804 |errors|Ошибки и их описание
3805
3806 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3807
3808 (% class="box infomessage" %)
3809 (((
3810 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
3811 )))
3812
3813 (% class="wikigeneratedid" %)
3814 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3815
3816 (% class="wikigeneratedid" %)
3817 В пути указывается **vehicleId **- id объекта.
3818
3819 **Заголовок**
3820
3821 **X-Auth: [токен авторизации]**
3822
3823 В теле использовать тип **form-data.**
3824
3825 Ключи:
3826
3827 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3828 |**history**|В значении передавать файл с историей
3829
3830 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3831
3832 Ответ:
3833
3834 {
3835 "results": [
3836 {
3837 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3838 "vehicleId": 0,
3839 "errors": [
3840 "string"
3841 ],
3842 "firstMessageDate": "2023-11-28T09:27:58.949Z",
3843 "lastMessageDate": "2023-11-28T09:27:58.949Z",
3844 "producedCount": 0,
3845 "msgCount": 0
3846 }
3847 ]
3848 }
3849
3850 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3851 |results|Результаты импорта в разрезе ТС
3852 |vehicleGuid|Guid ТС
3853 |vehicleId|ID ТС
3854 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
3855 |firstMessageDate|Дата первого импортированного сообщения (UTC)
3856 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
3857 |producedCount|Кол-во успешно отправленных в шину данных сообщений
3858 |msgCount|Кол-во обработанных сообщений всего
3859
3860 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3861
3862 (% class="box infomessage" %)
3863 (((
3864 **GET /api/v3/vehicles/import/history/status**
3865 )))
3866
3867 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3868
3869 Ответ:
3870
3871 {
3872 "activity": true,
3873 "progress": 0,
3874 "message": "string"
3875 }
3876
3877 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3878 |activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3879 |progress|Guid ТС
3880
3881 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3882
3883 (% class="box infomessage" %)
3884 (((
3885 **POST /api/v3/vehicles/export**
3886 )))
3887
3888 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3889
3890 Тело запроса:
3891
3892 [
3893 id
3894 ]
3895
3896 Ответ: Success 200, получаете файлы с настройками.
3897
3898 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3899
3900 (% class="box infomessage" %)
3901 (((
3902 **POST /api/v3/vehicles/export/history**
3903 )))
3904
3905 Метод возвращает список сообщений терминала объекта за выбранный период.
3906
3907 Тело запроса:
3908
3909 {
3910 "vehicleId": 0,
3911 "asArchive": true,
3912 "from": "2023-09-27T12:17:45.973Z",
3913 "to": "2023-09-27T12:17:45.973Z"
3914 }
3915
3916 Ответ:
3917
3918 Получаете файл. Сообщение: Code 200/Success
3919
3920 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3921 |vehicleId|ID объекта
3922 |asArchive|true - Архивировать файл, False - не архивировать
3923 |from|Дата и время начала запроса
3924 |to|Дата и время окончания запроса
3925
3926 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3927
3928 (% class="box infomessage" %)
3929 (((
3930 **GET /api/v3/vehicles/export/history/status**
3931 )))
3932
3933 Метод возвращает список сообщений терминала объекта за выбранный период.
3934
3935 Ответ:
3936
3937 {
3938 "activity": true,
3939 "progress": 0,
3940 "message": "string"
3941 }
3942
3943 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3944 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3945 |progress|Прогресс экспорта, от 0 до 100%
3946 |message|Текст описывающий статус
3947
3948 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3949
3950 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3951
3952 (% class="box infomessage" %)
3953 (((
3954 **POST /api/v3/EcoDriving/rating**
3955 )))
3956
3957 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3958
3959 Тело запроса:
3960
3961 {
3962 "vehicleIds": [vehicleId],
3963 "from": "2023-11-22T09:29:48.051Z",
3964 "to": "2023-11-22T09:29:48.051Z"
3965 }
3966
3967 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3968 |vehicleIds|Массив ID объектов
3969 |from|Дата начала запроса
3970 |to|Дата окончания запроса
3971
3972 Ответ:
3973
3974 {
3975 "items": [
3976 {
3977 "from": "2023-11-22T09:29:48.052Z",
3978 "to": "2023-11-22T09:29:48.052Z",
3979 "vehicleId": 0,
3980 "vehicleName": "string",
3981 "vehicleModel": "string",
3982 "penalty": 0,
3983 "score": 0,
3984 "totalViolations": 0,
3985 "violationsByType": {
3986 "overspeedingViolations": 0,
3987 "accelerationViolations": 0,
3988 "brakingViolations": 0,
3989 "turningViolations": 0,
3990 "dangerousDrivingViolations": 0,
3991 "sensorViolations": 0
3992 },
3993 "moveTime": 0,
3994 "mileage": 0,
3995 "tripsCount": 0,
3996 "trips": [
3997 {
3998 "penalty": 0,
3999 "score": 0,
4000 "violationsCount": 0,
4001 "violationsByType": {
4002 "overspeedingViolations": 0,
4003 "accelerationViolations": 0,
4004 "brakingViolations": 0,
4005 "turningViolations": 0,
4006 "dangerousDrivingViolations": 0,
4007 "sensorViolations": 0
4008 },
4009 "moveTime": 0,
4010 "mileage": 0,
4011 "motohours": 0,
4012 "maxSpeed": 0,
4013 "startAddress": "string",
4014 "endAddress": "string",
4015 "drivers": [
4016 {
4017 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4018 "driverName": "string",
4019 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4020 }
4021 ]
4022 }
4023 ]
4024 }
4025 ]
4026 }
4027
4028 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4029 |from|Дата начала запроса
4030 |to|Дата  окончания
4031 |vehicleId|ID объекта
4032 |vehicleName|Имя объекта
4033 |vehicleModel|Модель объекта
4034 |penalty|Сумма штрафных баллов
4035 |score|Оценка
4036 |totalViolations|Суммарное количество нарушений
4037 |violationsByType|Список типов нарушений и количество нарушений для каждого типа
4038 |overspeedingViolations|Превышение скорости
4039 |accelerationViolations|Ускорение
4040 |brakingViolations|Торможение
4041 |turningViolations|Резкий поворот
4042 |dangerousDrivingViolations|Резкое вождение
4043 |sensorViolations|Нарушение по датчику
4044 |moveTime|Время в движении
4045 |mileage|Пробег
4046 |tripsCount|Количество рейсов
4047 |motohours|Моточасы
4048 |maxSpeed|Максимальная скорость
4049 |startAddress|Адрес начала рейса
4050 |endAddress|Адрес окончания рейса
4051 |drivers|Список водителей, которые были на объекте в течениии рейса
4052 |driverGuid|Guid водителя
4053 |driverName|Имя водителя
4054 |driverRfid|Номер Карты-метки
4055
4056 (% class="box" lang="en-US" style="text-align: center;" %)
4057 (((
4058 (% 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]] **
4059 )))

Меню

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