Редактировал(а) Дмитрий Копотев 2023/12/20 20:31

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

Меню

© 2022 SMT-Hosting – Все права защищены (v.14.10)