Версия 188.1 от Андрей Калиновский на 2024/11/22 14:38
Последние авторы
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
20 (% style="color:#000000; font-size:16px" %)**Рекомендации**
21
22 - Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
23
24 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
25
26 (% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
27 (((
28 (% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
29 (% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
30 )))
31
32 (% class="box successmessage" %)
33 (((
34 (% lang="en-US" %)**POST /api/v3/auth/login**
35 )))
36
37 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
38
39 (% style="color:#000000" %)Метод запроса: **POST**
40
41 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
42
43 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
44
45 (% style="color:#000000" %)Параметры в теле запроса (JSON):
46
47 (% style="color:#000000" %){
48 "login": "testuser",
49 "password": "testuser"
50 }
51
52 (% style="color:#000000" %)**Ответ:**
53
54 (% lang="en-US" %)
55 (% style="color:#000000" %){
56 "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
57 "User": "testuser" , ~/~/ имя пользователя(%%)
58 }
59
60 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
61
62 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
63 |(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
64 |(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
65 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
66 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
67
68 (% class="wikigeneratedid" %)
69 Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
70
71 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
72
73 (% class="box infomessage" %)
74 (((
75 (% lang="en-US" %)**GET /api/v3/auth/check**
76 )))
77
78 (% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
79
80 (% style="color:#000000" %)Метод запроса: **GET**
81
82 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
83
84 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
85
86 (% lang="en-US" %)
87 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
88
89 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
90
91 == (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
92
93 (% class="box infomessage" %)
94 (((
95 **GET api/v3/agents/{id}**
96 )))
97
98 Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
99
100 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
101
102 (% style="color:#000000" %)Метод запроса: **GET**
103
104 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
105
106 Запрос должен содержать данные параметра "**agentId**"
107
108 (% style="color:#000000" %)Ответ:
109 {
110 "agentId": "",  (%%)
111 "parentId": "",
112 "parentName": "string",
113 "name": "string",
114 "fullName": "string",
115 "agentInfoType": 0,
116 "isForeign": true/false,
117 "district": "string", 
118 "region": "string",
119 "city": "string",
120 "inn": "string",
121 "kpp": "string",
122 "address": "string",
123 "addressFact": "string",
124 "email": "string",
125 "director": "string",
126 "bankName": "string",
127 "bankBIK": "string",
128 "bankRS": "string",
129 "bankKS": "string"
130 }
131
132 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
133 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
134 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
135 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
136 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
137 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
138 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
139 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
140 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
141 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
142 |(% style="width:215px" %)city|(% style="width:861px" %)Город
143 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
144 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
145 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
146 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
147 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
148 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
149 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
150 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
151 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
152 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
153
154 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
155
156 (% class="box infomessage" %)
157 (((
158 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
159 )))
160
161 (% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
162
163 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
164
165 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
166
167 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
168
169 (% style="color:#000000" %)Метод запроса: **POST**
170
171 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
172
173 (% style="color:#000000" %)Параметр запроса:
174
175 (% style="color:#000000" %){
176 "parentId": "string"
177 }
178
179 (% style="color:#000000" %)Ответ:
180
181 {
182 "agentId": "",(% style="color:#000000" %)   (%%)
183 "parentId": "",
184 "name": "string",
185 "fullName": "string",
186 "agentInfoType": 0,
187 (% style="color:#000000" %) "status": "",
188 }
189
190
191 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
192 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
193 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
194 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
195 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
196 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
197 |(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
198
199 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
200
201 (% class="box successmessage" %)
202 (((
203 **POST /api/v3/agents **
204 )))
205
206 Метод позволяет добавить клиента, указанного в запросе.
207
208 Метод запроса: **POST**
209
210 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
211
212 В заголовках запроса: X-Auth: Токен авторизации
213
214 Параметры в теле запроса (JSON):
215
216 {
217 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
218 "name": "string", ~/~/ имя
219 "fullName": "string", ~/~/ полное наименование
220 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
221 "isForeign": true, ~/~/ иностранный контрагент
222 "district": "string", ~/~/ округ
223 "region": "string", ~/~/ регион
224 "city": "string", ~/~/ город
225 "inn": "string", ~/~/ ИНН
226 "kpp": "string", ~/~/ КПП
227 "address": "string", ~/~/ юридический адрес
228 "addressFact": "string", ~/~/ фактический адрес
229 "email": "string", ~/~/ email
230 "director": "string", ~/~/ ФИО руководителя
231 "bankName": "string", ~/~/ банк
232 "bankBIK": "string", ~/~/ БИК
233 "bankRS": "string", ~/~/ номер счёта
234 "bankKS": "string" ~/~/ корр. счёт
235 }
236
237 Ответ:
238
239 {
240 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
241 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
242 "name": "string", ~/~/ имя
243 "fullName": "string", ~/~/ полное наименование
244 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
245 "isForeign": true, ~/~/ иностранный контрагент
246 "district": "string", ~/~/ округ
247 "region": "string", ~/~/ регион
248 "city": "string", ~/~/ город
249 "inn": "string", ~/~/ ИНН
250 "kpp": "string", ~/~/ КПП
251 "address": "string", ~/~/ юридический адрес
252 "addressFact": "string", ~/~/ фактический адрес
253 "email": "string", ~/~/ email
254 "director": "string", ~/~/ ФИО руководителя
255 "bankName": "string", ~/~/ банк
256 "bankBIK": "string", ~/~/ БИК
257 "bankRS": "string", ~/~/ номер счёта
258 "bankKS": "string" ~/~/ корр. счёт
259 }
260
261 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
262 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
263 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
264 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
265 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
266 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
267 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
268 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
269 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
270 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
271 |(% style="width:215px" %)city|(% style="width:861px" %)Город
272 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
273 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
274 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
275 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
276 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
277 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
278 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
279 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
280 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
281 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
282
283 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
284
285 (% class="box warningmessage" %)
286 (((
287 **PUT /api/v3/agents**
288 )))
289
290 Метод позволяет отредактировать клиента, указанного в запросе.
291
292 Метод запроса: **PUT**
293
294 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
295
296 В заголовках запроса: X-Auth: Токен авторизации
297
298 Параметры в теле запроса (JSON):
299
300 {
301 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
302 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
303 "name": "string", ~/~/ имя
304 "fullName": "string", ~/~/ полное наименование
305 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
306 "isForeign": true, ~/~/ иностранный контрагент
307 "district": "string", ~/~/ округ
308 "region": "string", ~/~/ регион
309 "city": "string", ~/~/ город
310 "inn": "string", ~/~/ ИНН
311 "kpp": "string", ~/~/ КПП
312 "address": "string", ~/~/ юридический адрес
313 "addressFact": "string", ~/~/ фактический адрес
314 "email": "string", ~/~/ email
315 "director": "string", ~/~/ ФИО руководителя
316 "bankName": "string", ~/~/ банк
317 "bankBIK": "string", ~/~/ БИК
318 "bankRS": "string", ~/~/ номер счёта
319 "bankKS": "string" ~/~/ корр. счёт
320 }
321
322 Ответ:
323
324 {
325 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
326 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
327 "name": "string", ~/~/ имя
328 "fullName": "string", ~/~/ полное наименование
329 "isForeign": true, ~/~/ иностранный контрагент
330 "district": "string", ~/~/ округ
331 "region": "string", ~/~/ регион
332 "city": "string", ~/~/ город
333 "inn": "string", ~/~/ ИНН
334 "kpp": "string", ~/~/ КПП
335 "address": "string", ~/~/ юридический адрес
336 "addressFact": "string", ~/~/ фактический адрес
337 "email": "string", ~/~/ email
338 "director": "string", ~/~/ ФИО руководителя
339 "bankName": "string", ~/~/ банк
340 "bankBIK": "string", ~/~/ БИК
341 "bankRS": "string", ~/~/ номер счёта
342 "bankKS": "string" ~/~/ корр. счёт
343 }
344
345 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
346
347 (% class="box errormessage" %)
348 (((
349 **DELETE /api/v3/agents/{clientId}**
350 )))
351
352 Метод позволяет удалить клиента, указанного в строке запроса.
353
354 Метод запроса: **DELETE**
355
356 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
357
358 Параметр запроса: **{clientId}** - Guid пользователя
359
360 В заголовках запроса: X-Auth: Токен авторизации
361
362 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
363
364 == (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
365
366 (% class="box warningmessage" %)
367 (((
368 **PUT /api/v3/agents/{id}/changeStatus/{status}**
369 )))
370
371 Метод позволяет изменить статус клиента, указанного в запросе.
372
373 В пути указывается GUID клиента и статус клиента.
374
375 **status **- значение 0 - заблокирован, 1 - активен.
376
377 Ответ: Code 204
378
379 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
380
381 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
382
383 (% class="box successmessage" %)
384 (((
385 (% lang="en-US" %)**POST /api/v3/users**
386 )))
387
388 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
389
390 (% style="color:#000000" %)Метод запроса: **POST**
391
392 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
393
394 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
395
396 (% style="color:#000000" %)Параметры в теле запроса (JSON):
397
398 (% style="color:#000000" %)
399 { 
400 "lastName": "", ~/~/ фамилия
401 "firstName": "", ~/~/ имя
402 "position": "", ~/~/ должность
403 "phone": "", ~/~/ телефон
404 "organization": "", ~/~/ организация
405 "login": "", ~/~/ логин (обязателен)
406 "password": "", ~/~/ пароль (обязателен)
407 "email": "", ~/~/ email (обязателен)
408 "description": "string", ~/~/ Описание
409 "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
410 "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
411 "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
412 "parentId": "", ~/~/ Guid родительского агента
413 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
414 "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
415 "doubleAuth":
416 {
417 "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
418 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
419 },
420 "groups":
421 [
422 "string" ~/~/ группы пользователя, перечисление названия системных ролей
423 ],
424 "customGroups":
425 [
426 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
427 ],
428 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
429 }
430 {
431 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
432 "lastName": "string",
433 "firstName": "string",
434 "position": "string",
435 "phone": "string",
436 "organization": "string",
437 "login": "string",
438 "password": "string",
439 "email": "string",
440
441 (% style="text-align:left" %)
442 (% style="color:#000000; font-weight:normal" %)Ответ:
443 {     
444 "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
463
464 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465
466 (% class="box infomessage" %)
467 (((
468 (% lang="en-US" %)**POST /api/v3/users/find**
469 )))
470
471 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
472
473 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
474
475 (% style="color:#000000" %)Метод запроса: **POST**
476
477 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
478
479 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
480
481 (% style="color:#000000" %)Параметры в теле запроса (JSON):
482
483 (% style="color:#000000" %){(%%)
484 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
485 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
486 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
487 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
488 (% style="color:#000000" %)}
489
490 (% style="color:#000000" %)Ответ:
491
492 (% style="color:#000000" %){         (%%)
493 "id": "" , ~/~/ идентификатор пользователя
494 "lastName": "" , ~/~/ фамилия
495 "firstName": "" , ~/~/ имя
496 "position": "" , ~/~/ должность
497 "phone": "" , ~/~/ телефон
498 "parentId": "" , ~/~/ идентификатор клиента-родителя
499 "parentName": "" , ~/~/ наименование клиента-родителя
500 "organization": "" , ~/~/ организация
501 "login": "" , ~/~/ логин
502 "email": "" , ~/~/ E-mail
503 "sessionDuration":"", ~/~/ длительность сессии в минутах
504 "status": "1",  ~/~/ статус пользователя
505 "lastLogged": "", ~/~/ дата/время последней авторизации
506 (% style="color:#000000" %)}
507
508 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
509
510 (% class="box infomessage" %)
511 (((
512 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
513 )))
514
515 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
516
517 (% style="color:#000000" %)Метод запроса: **GET**
518
519 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
520
521 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
522
523 (% style="color:#000000" %)Ответ:
524
525 (((
526 (((
527 {
528 "id": "", ~/~/ GUID пользователя
529 "lastName": "", ~/~/ Фамилия 
530 "firstName": "", ~/~/ Имя
531 "position": "", ~/~/ Должность
532 "phone": "", ~/~/ Номер телефона
533 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
534 "parentName": "", Наименование клиента, которому принадлежит пользователь
535 "organization": "", ~/~/ Организация
536 "login": "", ~/~/ Логин пользователя
537 "email": "", ~/~/ Адрес электронной почты
538 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
539 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
540 "description": "", ~/~/ Описание
541 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
542 "doubleAuth":
543 {
544 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
545 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
546 },
547 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
548 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
549 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
550 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
551 "groups": [], ~/~/ Список ролей пользователя
552 "customGroups": [], ~/~/ Список клиентских ролей пользователя
553 "authDevices": [ ], ~/~/ Список авторизованных устройств
554 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
555 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
556 }
557 )))
558 )))
559
560 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
561
562 (% class="box warningmessage" %)
563 (((
564 (% lang="en-US" %)**PUT /api/v3/users**
565 )))
566
567 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
568
569 (% style="color:#000000" %)Метод запроса: **PUT**
570
571 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
572
573 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
574
575 (% lang="en-US" style="text-align:left" %)
576 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
577
578 (% lang="en-US" style="text-align:left" %)
579 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
580 "id": "" , ~/~/ ID пользователя 
581 "lastName": "" , ~/~/ фамилия
582 "firstName": "" , ~/~/ имя
583 "position": "" , ~/~/ должность
584 "phone": "" , ~/~/ телефон
585 "organization": "" , ~/~/ организация
586 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
587 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
588 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
589 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
590 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
591 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
592 "isEnabled": "" , ~/~/ признак включения
593 "parentId": "" , ~/~/ Guid родительского агента
594 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
595 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
596 "doubleAuth":
597 {
598 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
599 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
600 },
601 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
602 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
603 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
604
605 (% lang="en-US" style="text-align:left" %)
606 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
607
608 (% lang="en-US" style="text-align:left" %)
609 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
610 "id": "" , ~/~/ идентификатор пользователя
611 "lastName": "" , ~/~/ фамилия
612 "firstName": "" , ~/~/ имя
613 "position": "" , ~/~/ должность
614 "phone": "" , ~/~/ телефон
615 "organization": "" , ~/~/ организация
616 "login": "" , ~/~/ логин
617 "password": "" , ~/~/ пароль 
618 "email": "" , ~/~/ email
619 "description": "" , ~/~/ описание
620 "isEnabled": "" , ~/~/ признак включения
621 "parentId": "" , ~/~/ Guid родительского агента
622 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
623 "doubleAuth":
624 {
625 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
626 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
627 },
628 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
629 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
630 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
631 }
632
633 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
634
635 (% class="box warningmessage" %)
636 (((
637 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
638 )))
639
640 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
641
642 (% style="color:#000000" %)Метод запроса: **PUT**
643
644 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
645
646 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
647
648 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
649
650 (% style="color:#000000" %)Параметры в теле запроса (JSON):
651
652 (% style="color:#000000" %){(%%)
653 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
654 "description": "" , ~/~/ описание
655 "data": "" , ~/~/ данные, связанные со сменой статуса
656 (% style="color:#000000" %)}
657
658 (% style="text-align:left" %)
659 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
660
661 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
662
663 (% class="box warningmessage" %)
664 (((
665 **POST /api/v3/users/disable**
666 )))
667
668 Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
669
670 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
671
672 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
673
674 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
675
676 [ 
677 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
678 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
679 ]
680
681 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
682
683 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
684
685 (% class="box warningmessage" %)
686 (((
687 **POST /api/v3/users/enable**
688 )))
689
690 Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
691
692 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
693
694 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
695
696 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
697
698 [ 
699 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
700 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
701 ]
702
703 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
704 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
705
706 (((
707 В теле ответа:
708 {
709 "errorMessages": [
710 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
711 ],
712 "users": [
713 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
714 ]
715 }
716 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
717 "users" - массив id пользователей, которых не удалось включить или отключить.
718 )))
719
720 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
721
722 (% class="box errormessage" %)
723 (((
724 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
725 )))
726
727 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
728
729 (% style="color:#000000" %)Метод запроса: **DELETE**
730
731 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
732
733 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
734
735 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
736
737 (% style="text-align:left" %)
738 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
739
740 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
741
742 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
743
744 (% class="box infomessage" %)
745 (((
746 (% lang="en-US" %)**GET /api/v3/models/{Id}**
747 )))
748
749 Метод возвращает полную информацию о модели объекта.
750
751 (% style="color:#000000" %)Метод запроса: **GET**
752
753 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
754
755 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
756
757 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
758
759 (% style="color:#000000" %)Ответ:
760
761 (% style="color:#000000" %){
762 "parentName": "string",
763 "name": "string",
764 "picture": "string",
765 "minspeed": 0,
766 "maxspeed": 0,
767 "width": 0,
768 "imbeddedtrailer": true,
769 "hoppercapacity": 0,
770 "hopperdischargespeed": 0,
771 "modelType": 0,
772 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
773 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
774 "deleted": true
775 }
776
777 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
778 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
779 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
780 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
781 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
782 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
783 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
784 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
785 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
786 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
787 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
788 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
789 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
790 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
791
792 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
793
794 (% class="box successmessage" %)
795 (((
796 (% lang="en-US" %)**POST /api/v3/models/find**
797 )))
798
799 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
800
801 (% style="color:#000000" %)Метод запроса: **POST**
802
803 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
804
805 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
806
807 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
808
809 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
810 }
811
812 (% style="color:#000000" %)Ответ:
813
814 (% style="color:#000000" %)[
815 {
816 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
817 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
818 "parentName": "string",
819 "name": "string",
820 "modelType": 0
821 }
822 ]
823
824 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
825 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
826 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
827 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
828 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
829 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
830
831 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
832
833 (% class="box successmessage" %)
834 (((
835 (% lang="en-US" %)**POST /api/v3/models**
836 )))
837
838 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
839
840 (% style="color:#000000" %)Метод запроса: **POST**
841
842 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
843
844 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
845
846 (% style="color:#000000" %)Параметры в теле запроса (JSON):
847
848 {
849 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
850 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
851 "deleted": true,
852 "extId": "string",
853 "name": "string",
854 "picture": "string",
855 "minspeed": 0,
856 "maxspeed": 0,
857 "width": 0,
858 "imbeddedtrailer": true,
859 "fueloutlay": 0,
860 "hoppercapacity": 0,
861 "hopperdischargespeed": 0,
862 "modelType": 0
863 }
864
865 Ответ:
866
867 {
868 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
869 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
870 "deleted": true,
871 "extId": "string",
872 "name": "string",
873 "picture": "string",
874 "minspeed": 0,
875 "maxspeed": 0,
876 "width": 0,
877 "imbeddedtrailer": true,
878 "hoppercapacity": 0,
879 "hopperdischargespeed": 0,
880 "modelType": 0
881 }
882
883 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
884 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
885 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
886 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
887 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
888 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
889 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
890 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
891 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
892 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
893 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
894 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
895 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
896
897 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
898
899 (% class="box warningmessage" %)
900 (((
901 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
902 )))
903
904 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
905
906 (% style="color:#000000" %)Метод запроса: **PUT**
907
908 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
909
910 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911
912 (% style="color:#000000" %)Параметры в теле запроса (JSON):
913
914 {
915 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
916 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
917 "deleted": true,
918 "extId": "string",
919 "name": "string",
920 "picture": "string",
921 "minspeed": 0,
922 "maxspeed": 0,
923 "width": 0,
924 "imbeddedtrailer": true,
925 "fueloutlay": 0,
926 "hoppercapacity": 0,
927 "hopperdischargespeed": 0,
928 "modelType": 0
929 }
930
931 Ответ:
932
933 {
934 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
935 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
936 "deleted": true,
937 "extId": "string",
938 "name": "string",
939 "picture": "string",
940 "minspeed": 0,
941 "maxspeed": 0,
942 "width": 0,
943 "imbeddedtrailer": true,
944 "fueloutlay": 0,
945 "hoppercapacity": 0,
946 "hopperdischargespeed": 0,
947 "modelType": 0
948 }
949
950 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
951 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
952 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
953 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
954 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
955 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
956 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
957 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
958 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
959 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
960 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
961 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
962 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
963
964 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
965
966 (% class="box errormessage" %)
967 (((
968 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
969 )))
970
971 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
972
973 (% style="color:#000000" %)Метод запроса: **DELETE**
974
975 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
976
977 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
978
979 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
980
981 Ответ: В случае успеха **Success 200**
982
983 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
984
985 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
986
987 (% class="box infomessage" %)
988 (((
989 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
990 )))
991
992 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
993
994 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
995
996 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
997
998 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
999
1000 (% style="color:#000000" %)Метод запроса: **GET**
1001
1002 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
1003
1004 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1005
1006 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1007
1008 (% style="color:#000000" %)Ответ:
1009
1010 (((
1011 {
1012 "vehicleId": "", ~/~/ ID объекта
1013 "name": "", ~/~/ Имя объекта
1014 "imei": "", ~/~/ IMEI объекта
1015 "deviceTypeId": , ~/~/ ID типа устройства
1016 "deviceTypeName": "", ~/~/ Название типа устройства
1017 "sim1": "", ~/~/ Номер SIM1
1018 "sim2": "", ~/~/ Номер SIM2
1019 "parentId": "", ~/~/ ID клиента-родителя
1020 "parentName": "", ~/~/ Наименование клиента-родителя
1021 "modelId": "", ~/~/ ID модели объекта
1022 "modelName": "", ~/~/ Имя модели объекта
1023 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1024 "unitName": "string", ~/~/ Наименование подразделения
1025 "status": 0, ~/~/ Статус объекта
1026 "createdAt": "", ~/~/ Дата создания объекта
1027 },
1028 "customFields": [ ~/~/ Произвольные поля
1029 {
1030 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1031 "name": "string", ~/~/ Имя поля
1032 "value": "string", ~/~/ Значение поля
1033 "forClient": true, ~/~/ Не используемая функция
1034 "forTooltip": true, ~/~/ Отображать в подсказке
1035 "forReport": true ~/~/ Отображать в отчете
1036 }
1037
1038 ], ~/~/ Данные с вкладки нормы
1039 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1040 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1041 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1042 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1043 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1044 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1045 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1046 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1047 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1048 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1049 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1050 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1051 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1052 "mileageCoeff": 0, ~/~/ коэффициент пробега
1053 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1054 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1055 "counters": { ~/~/ Счетчики
1056 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1057 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1058 "mileage": 0, ~/~/ Текущий пробег
1059 "motohours": 0, ~/~/ Текущие моточасы
1060 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1061 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1062 },
1063
1064 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1065 "id": "string", ~/~/ ID объекта
1066 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1067 "host": "string", ~/~/ CMSV6 Web Host
1068 "login": "string", ~/~/ CMSV6 Account
1069 "password": "string" ~/~/ CMSV6 Password
1070 },
1071
1072 "commandTemplates": [ ~/~/ Шаблоны команд
1073 {
1074 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1075 "name": "string", ~/~/ Наименование команды
1076 "command": "string", ~/~/ Текст команды
1077 "retries": 0 ~/~/ Количество попыток
1078 }
1079 ],
1080 "sensors": [ ~/~/ Датчики
1081 {
1082 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1083 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1084 "type": 0, ~/~/ Тип датчика
1085 "name": "string", ~/~/ Имя датчика
1086 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1087 "inputNumber": 0, ~/~/ Номер входа
1088 "pseudonym": "string", ~/~/ Псевдоним
1089 "medianDegree": 0, ~/~/ Медианная фильтрация
1090 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1091 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1092 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1093 "gradesTables": [ ~/~/ Массив таблиц тарировки
1094 {
1095 "grades": [ ~/~/ Таблица тарировки 1
1096 {
1097 "input": 0, ~/~/ Входящее значение
1098 "output": 0 ~/~/ Выходящее значение
1099 }
1100 ],
1101 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1102 }
1103 ],
1104 "showInTooltip": true, ~/~/ Отображать в подсказке
1105 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1106 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1107 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1108 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1109 "expr": "string", ~/~/ Формула
1110 "children": [ ~/~/ массив дочерних датчиков
1111 "string"
1112 ],
1113 "customParams": { ~/~/ прочие произвольные параметры
1114 "additionalProp1": "string",
1115 "additionalProp2": "string",
1116 "additionalProp3": "string"
1117 },
1118
1119 ~/~/ Характерные для произвольного:
1120 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1121 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1122 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1123 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1124 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1125 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1126 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1127 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1128 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1129 ~/~/ "ValueOn": "Вкл.",
1130 ~/~/ "ValueOff": "Выкл."
1131 "summaryMaxValue": 0 ~/~/ Макс. значение
1132 }
1133 "drivers": [ ~/~/ Водители
1134 {
1135 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1136 "name": "string", ~/~/ Наименование
1137 "description": "string",
1138 "isDefault": true ~/~/ По умолчанию
1139 }
1140 ],
1141 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1142 {
1143 "id": "", ~/~/ ID  задания
1144 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1145 "name": "", ~/~/ Наименование задания
1146 "description": "", ~/~/ Описание задания
1147 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1148 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1149 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1150 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1151 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1152 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1153 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1154 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1155 }
1156 ],
1157 "statusHistory": [ ~/~/ История статусов
1158 {
1159 "status": 0,
1160 "date": "2023-05-22T09:57:39.562Z",
1161 "description": "string",
1162 "additionalInfo": "string"
1163 }
1164 ]
1165 }
1166 )))
1167
1168 (% style="text-align:left" %)
1169 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1170
1171 (% style="text-align:left" %)
1172 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1173
1174
1175 == **Отправить команду на терминал** ==
1176
1177 (% class="box successmessage" %)
1178 (((
1179 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1180 )))
1181
1182 Команда для отправки на тс.
1183
1184 {  
1185 "id": "", ~/~/идентификатор произвольного поля
1186 "command": "", ~/~/ Текст команды
1187 "retries": "", ~/~/ Количество попыток
1188 "idTemplate": "" ~/~/ ID шаблона команды
1189 }
1190
1191
1192 == **Получить ответ на отправленную на ТС команду** ==
1193
1194 (% class="box infomessage" %)
1195 (((
1196 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1197 )))
1198
1199 Идентификатор команды: cmdid
1200
1201 Запрос от терминала на ответ команды
1202
1203 Пример ответ от терминала:
1204
1205 ID= "" ~/~/ идентификатор произвольного поля
1206 Soft="" ~/~/ версия софта
1207 GPS=4 ~/~/ тип трекера
1208 Time=11:05:43 28.06.24 ~/~/ время запроса
1209 Lat=45.056221 ~/~/ широта
1210 Lon=39.035938 ~/~/ долгота
1211 Speed=0.0 ~/~/ скорость
1212 Course=181.4 ~/~/направление
1213
1214 (((
1215 == **Список отправленных объекту команд с ответами** ==
1216
1217 (% class="box infomessage" %)
1218 (((
1219 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1220 )))
1221
1222 Идентификатор ТС: vehicleId
1223
1224 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1225
1226 Пример ответа терминала
1227
1228 [ 
1229 {    
1230 "id": "", ~/~/ идентификатор пользователя
1231 "commandText": "", ~/~/Текст команды.
1232 "templateId": "", ~/~/Идентификатор шаблона
1233 "updated": "", ~/~/ Время отправки  
1234 "tryCount": 0, ~/~/ Количество попыток отправки команды
1235 "answer": "", ~/~/ Ответ терминала.
1236 "status": "" ~/~/ Статус отправки
1237 }
1238 ]
1239 )))
1240
1241 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1242
1243 (% class="box successmessage" %)
1244 (((
1245 (% lang="en-US" %)**POST /api/v3/vehicles**
1246 )))
1247
1248 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1249
1250 (% style="color:#000000" %)Метод запроса: **POST**
1251
1252 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1253
1254 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1255
1256 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1257
1258 (% style="color:#000000" %){(%%)
1259 "parentId": "" , ~/~/ ID клиента
1260 "name": "" , ~/~/ имя ТС
1261 "imei": "" , ~/~/ IMEI
1262 "deviceTypeId": "" , ~/~/ ID типа устройства
1263 "modelId": "" , ~/~/ ID модели
1264 "unitId": "" , ~/~/ ID подразделения
1265 "sim1": "" , ~/~/ Номер SIM 1
1266 "sim2": "" , ~/~/ Номер SIM2
1267 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1268 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1269 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1270 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1271 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1272 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1273 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1274 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1275 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1276 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1277 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1278 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1279 "mileageCalcMethod": 0,
1280 "mileageCoeff": 0,
1281 "locationByCellId": true,
1282 "dottedLineTrackWhenNoCoords": true,
1283 "counters": ~/~/ счетчики
1284 {
1285 "mileage": "" , ~/~/ пробег
1286 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1287 "motohours": "" , ~/~/ моточасы
1288 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1289 },
1290 "cmsv6Parameters": { ~/~/ параметры CMSv6
1291 "enabled": true, ~/~/ флаг включения
1292 "id": "" , ~/~/ идентификатор
1293 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1294 "login": "" , ~/~/ имя учетной записи
1295 "password": "" ~/~/ пароль учетной записи
1296 },
1297 "inspectionTasks": ~/~/ задания на ТО
1298 {
1299 "enabled": "" , ~/~/ Признак включения
1300 "name": "" , ~/~/ Имя задания
1301 "description": "" , ~/~/ Описание задания
1302 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1303 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1304 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1305 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1306 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1307 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1308 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1309 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1310 }
1311 "drivers": [ ~/~/ Водители
1312 {
1313 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1314 "isDefault": true
1315 }
1316 ],
1317 "commandTemplates": [ ~/~/ Шаблон команды
1318 {
1319 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1320 "name": "string",
1321 "command": "string",
1322 "retries": 0
1323 }
1324 ],
1325 "sensors": [ ~/~/ Датчики
1326 {
1327 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1328 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1329 "type": 0, ~/~/ Тип датчика
1330 "name": "string", ~/~/ Имя датчика
1331 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1332 "inputNumber": 0, ~/~/ Номер входа
1333 "pseudonym": "string", ~/~/ Псевдоним
1334 "medianDegree": 0, ~/~/ Медианная фильтрация
1335 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1336 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1337 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1338 "gradesTables": [ ~/~/ Массив таблиц тарировки
1339 {
1340 "grades": [ ~/~/ Таблица тарировки 1
1341 {
1342 "input": 0, ~/~/ Входящее значение
1343 "output": 0 ~/~/ Выходящее значение
1344 }
1345 ],
1346 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1347 }
1348 ],
1349 "showInTooltip": true, ~/~/ Отображать в подсказке
1350 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1351 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1352 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1353 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1354 "expr": "string", ~/~/ Формула
1355 "children": [ ~/~/ массив дочерних датчиков
1356 "string"
1357 ],
1358 "customParams": { ~/~/ прочие произвольные параметры
1359 "additionalProp1": "string",
1360 "additionalProp2": "string",
1361 "additionalProp3": "string"
1362 },
1363 ~/~/ Характерные для произвольного:
1364 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1365 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1366 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1367 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1368 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1369 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1370 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1371 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1372 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1373 ~/~/ "ValueOn": "Вкл.",
1374 ~/~/ "ValueOff": "Выкл."
1375 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1376
1377 (((
1378 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1379 {
1380 "from": 0, ~/~/ С какого значения
1381 "color": "string", ~/~/ Каким цветом
1382 "text": "string" ~/~/ Текст подписи к этому интервалу
1383 }
1384 ]
1385 }
1386 ],
1387 )))
1388
1389 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1390
1391
1392 "customFields": [ ~/~/ Произвольные поля
1393 {
1394 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1395 "name": "string", ~/~/ Наименование произвольного поля
1396 "value": "string", ~/~/ Значение произвольного поля
1397 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1398 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1399 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1400 }
1401 ]
1402 }
1403
1404 (% style="color:#000000" %)Ответ:
1405
1406
1407 (((
1408 (((
1409 (((
1410 {
1411 "vehicleId": 0,  ~/~/ ID ТС
1412 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1413 "name": "string", ~/~/ Имя объекта
1414 "imei": "string", ~/~/ IMEI
1415 "deviceTypeId": 0, ~/~/ ID типа устройства
1416 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1417 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1418 "sim1": "string", ~/~/ SIM1
1419 "sim2": "string", ~/~/ SIM2
1420 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1421 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1422 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1423 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1424 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1425 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1426 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1427 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1428 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1429 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1430 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1431 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1432 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1433 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1434 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1435 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1436 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1437 "counters": {  ~/~/ Dto для состояний счётчиков
1438 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1439 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1440 "mileage": 0, ~/~/ Пробег
1441 "motohours": 0 ~/~/ Моточасы
1442 },
1443 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1444 "id": "string", ~/~/ CMSV6 Идентификатор
1445 "enabled": true, ~/~/ Признак включения
1446 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1447 "login": "string", ~/~/ CMSV6 имя учетной записи
1448 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1449 },
1450 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1451 {
1452 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1453 "enabled": true, ~/~/ Признак включения
1454 "name": "string", ~/~/ Имя задания
1455 "description": "string", ~/~/ Описание задания
1456 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1457 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1458 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1459 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1460 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1461 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1462 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1463 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1464 }
1465 ],
1466 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1467 {
1468 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1469 "inputNumber": 0, ~/~/ № входа.
1470 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1471 "comment": "string", ~/~/ Комментарий
1472 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1473 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1474 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1475 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1476 }
1477 ],
1478 "commandTemplates": [  ~/~/ Список шаблонов команд
1479 {
1480 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1481 "name": "string", ~/~/ Название шаблона команд
1482 "command": "string", ~/~/ Команда на выполнение
1483 "retries": 0 ~/~/ Лимит попыток отправки
1484 }
1485 ],
1486 "sensors": [ ~/~/ Список датчиков
1487 {
1488 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1489 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1490 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1491 "name": "string",  ~/~/ Имя датчика
1492 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1493 "inputNumber": 0, ~/~/ Номер входа
1494 "pseudonym": "string", ~/~/ Псевдоним
1495 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1496 "isInverted": true, ~/~/  Признак инверсии
1497 "disabled": true, ~/~/ Датчик не участвует в обработке
1498 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1499 "gradesTables": [ ~/~/ Тарировка
1500 {
1501 "grades": [ ~/~/ Таблицы тарировки
1502 {
1503 "input": 0, ~/~/ Вход
1504 "output": 0 ~/~/ Выход
1505 }
1506 ],
1507 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1508 }
1509 ],
1510 "showInTooltip": true, ~/~/ Отображение в подсказке
1511 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1512 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1513 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1514 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1515 "expr": "string", ~/~/ Выражение
1516 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1517 "string"
1518 ],
1519 "customParams": {
1520 "additionalProp1": "string",
1521 "additionalProp2": "string",
1522 "additionalProp3": "string"
1523 },
1524 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1525 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1526 {
1527 "from": 0, ~/~/ С какого значения
1528 "color": "string", ~/~/ Каким цветом
1529 )))
1530
1531 (((
1532 "text": "string" ~/~/ Текст подписи к этому интервалу
1533 }
1534 ]
1535 }
1536 ],
1537 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1538 "customFields": [ ~/~/ Список произвольных полей
1539 {
1540 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1541 "name": "string", ~/~/ Наименование произвольного поля
1542 "value": "string", ~/~/ Значение произвольного поля
1543 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1544 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1545 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1546 }
1547 ],
1548 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
1549 }
1550 )))
1551 )))
1552 )))
1553
1554
1555 **Валидация:**
1556 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1557 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1558 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1559
1560
1561 == **Импортировать историю ТС (Асинхронный запрос)** ==
1562
1563 (% class="box successmessage" %)
1564 (((
1565 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1566 )))
1567
1568 Метод запроса: **POST**
1569
1570 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1571
1572 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1573
1574
1575 Ответ:
1576
1577 {
1578
1579 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1580
1581 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1582
1583 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1584
1585 "Message": "string", ~/~/ Информация о выполнении запроса
1586
1587 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1588
1589 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1590
1591 "Data": "string" ~/~/ Данные
1592
1593 }
1594
1595
1596 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
1597
1598 (% class="box infomessage" %)
1599 (((
1600 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1601 )))
1602
1603 Метод запроса: **GET**
1604
1605 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1606
1607 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1608
1609
1610 Ответ:
1611
1612 {
1613
1614 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1615
1616 "Status": 0, ~/~/ Перечисление состояний выполения запроса
1617 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1618
1619 "Message": "string", ~/~/ Информация о выполнении запроса
1620
1621 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1622
1623 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1624
1625 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1626
1627 "Data": "string" ~/~/ Данные
1628
1629 }
1630
1631
1632 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1633
1634 (% class="box infomessage" %)
1635 (((
1636 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1637 )))
1638
1639 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1640
1641 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1642
1643 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1644
1645 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1646
1647 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1648
1649 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1650
1651 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1652
1653 (% style="color:#000000" %)Метод запроса: **POST**
1654
1655 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1656
1657 (% style="color:#000000" %)В заголовках запроса:
1658
1659 (% style="color:#000000" %)− Content-Type: __**application/json**__
1660
1661 (% style="color:#000000" %)− X-Auth: Токен авторизации
1662
1663 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1664
1665 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1666
1667 {
1668 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1669 "name": null, ~/~/ Имя ТС (string, опционально)
1670 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1671 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1672 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1673 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1674 "unitName": "string",  ~/~/ Название подразделения (опционально)
1675 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1676 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1677 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1678 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1679 }
1680
1681 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1682
1683 (% style="color:#000000" %)Ответ:
1684
1685 (% style="color:#000000" %)[
1686 {
1687
1688 (((
1689 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1690 )))
1691
1692 (((
1693 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1694 "name": "" ~/~/ наименование объекта
1695 "imei": "" ~/~/ IMEI объекта
1696 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1697 "deviceTypeName": "" ~/~/ наименование типа устройства
1698 "sim1": "" ~/~/ первый номер телефона
1699 "sim2": "" ~/~/ второй номер телефона
1700 "parentId": "" ~/~/ идентификатор клиента-родителя
1701 "parentName": "" ~/~/ наименование клиента-родителя
1702 "modelId": "" ~/~/ идентификатор модели объекта
1703 "modelName": "" ~/~/ наименование модели объекта
1704 "unitId": "" ~/~/ идентификатор подразделения
1705 "unitName": "" ~/~/ наименование подразделения
1706 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1707 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1708 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1709 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1710 "customFields": [ 
1711 {
1712 "id": "", ~/~/ идентификатор произвольного поля
1713 "name": "", ~/~/ имя произвольного поля
1714 "value": "", ~/~/ значение произвольного поля
1715 "forClient": true, ~/~/ право на отображение у клиента
1716 "forTooltip": false, ~/~/ право на отображение в подсказке
1717 "forReport": false ~/~/ право на отображение в отчетах
1718 )))
1719
1720 (((
1721 }
1722 ],
1723 "vehicleGroups": [  ~/~/ Группы ТС
1724 {
1725 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1726 "name": "string" ~/~/ Наименование группы ТС
1727 }
1728 ]
1729 }
1730 ]
1731 )))
1732
1733 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1734
1735 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1736
1737 (% class="box successmessage" %)
1738 (((
1739 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1740 )))
1741
1742 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1743
1744 (% style="color:#000000" %)Метод запроса: **POST**
1745
1746 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
1747
1748 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1749
1750 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1751
1752 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1753
1754 (% style="color:#000000" %){
1755
1756 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1757 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1758 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1759 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1760 "description": "", ~/~/ Описание
1761 "data": "", ~/~/ Данные
1762 "overwrite": false, ~/~/ Флаг перезаписи
1763 "stage": "", ~/~/ Состояние, может быть null
1764 (% style="color:#000000" %)}
1765
1766 (% style="color:#000000" %)Ответ:
1767
1768 (% style="color:#000000" %){(%%)
1769 "status": "", ~/~/ значение статуса
1770 "date": "", ~/~/ Дата смены статуса 
1771 "description": "", ~/~/ Описание
1772 "data": "", ~/~/ Данные
1773 "overwrite": false, ~/~/ Флаг перезаписи
1774 "stage": "", ~/~/ Состояние
1775 (% style="color:#000000" %) }
1776
1777 == ==
1778
1779 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1780
1781 (% class="box warningmessage" %)
1782 (((
1783 (% lang="en-US" %)**PUT /api/v3/vehicles**
1784 )))
1785
1786 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1787
1788 (% style="color:#000000" %)Метод запроса: **PUT**
1789
1790 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1791
1792 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1793
1794 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1795
1796 (% style="color:#000000" %){
1797 "vehicleId": , ~/~/ ID объекта
1798 "parentId": "" , ~/~/ ID клиента
1799 "name": "" , ~/~/ имя ТС
1800 "imei": "" , ~/~/ IMEI
1801 "deviceTypeId": "" , ~/~/ ID типа устройства
1802 "modelId": "" , ~/~/ ID модели
1803 "unitId": "" , ~/~/ ID подразделения
1804 "sim1": "" , ~/~/ Номер SIM 1
1805 "sim2": "" , ~/~/ Номер SIM2
1806 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1807 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1808 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1809 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1810 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1811 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1812 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1813 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1814 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1815 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1816 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1817 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1818
1819 "mileageCalcMethod": 0,
1820 "mileageCoeff": 0,
1821 "locationByCellId": true,
1822 "dottedLineTrackWhenNoCoords": true,
1823 "counters": ~/~/ счетчики
1824 {
1825 "mileage": "" , ~/~/ пробег
1826 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1827 "motohours": "" , ~/~/ моточасы
1828 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1829 },
1830 "cmsv6Parameters": { ~/~/ параметры CMSv6
1831 "enabled": true, ~/~/ флаг включения
1832 "id": "" , ~/~/ идентификатор
1833 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1834 "login": "" , ~/~/ имя учетной записи
1835 "password": "" ~/~/ пароль учетной записи
1836 },
1837 "inspectionTasks": ~/~/ задания на ТО
1838 {
1839 "enabled": "" , ~/~/ Признак включения
1840 "name": "" , ~/~/ Имя задания
1841 "description": "" , ~/~/ Описание задания
1842 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1843 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1844 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1845 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1846 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1847 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1848 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1849 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1850 }
1851
1852 "drivers": [ ~/~/ Водители
1853 {
1854 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1855 "isDefault": true
1856 }
1857 ],
1858 "commandTemplates": [ ~/~/ Шаблон команды
1859 {
1860 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1861 "name": "string",
1862 "command": "string",
1863 "retries": 0
1864 }
1865 ],
1866 "sensors": [ ~/~/ Датчики
1867 {
1868 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1869 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1870 "type": 0, ~/~/ Тип датчика
1871 "name": "string", ~/~/ Имя датчика
1872 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1873 "inputNumber": 0, ~/~/ Номер входа
1874 "pseudonym": "string", ~/~/ Псевдоним
1875 "medianDegree": 0, ~/~/ Медианная фильтрация
1876 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1877 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1878 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1879 "gradesTables": [ ~/~/ Массив таблиц тарировки
1880 {
1881 "grades": [ ~/~/ Таблица тарировки 1
1882 {
1883 "input": 0, ~/~/ Входящее значение
1884 "output": 0 ~/~/ Выходящее значение
1885 }
1886 ],
1887 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1888 }
1889 ],
1890 "showInTooltip": true, ~/~/ Отображать в подсказке
1891 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1892 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1893 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1894 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1895 "expr": "string", ~/~/ Формула
1896 "children": [ ~/~/ массив дочерних датчиков
1897 "string"
1898 ],
1899 "customParams": { ~/~/ прочие произвольные параметры
1900 "additionalProp1": "string",
1901 "additionalProp2": "string",
1902 "additionalProp3": "string"
1903 },
1904 ~/~/ Характерные для произвольного:
1905 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1906 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1907 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1908 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1909 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1910 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1911 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1912 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1913 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1914 ~/~/ "ValueOn": "Вкл.",
1915 ~/~/ "ValueOff": "Выкл."
1916 "summaryMaxValue": 0 ~/~/ Макс. значение
1917
1918 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1919 {
1920 "from": 0, ~/~/ С какого значения
1921 "color": "string", ~/~/ Каким цветом
1922 "text": "string" ~/~/ Текст подписи к этому интервалу
1923 }
1924 ]
1925 }
1926 ],
1927 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1928
1929 "customFields": [ ~/~/ Произвольные поля
1930 {     
1931 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1932 "name": "string", ~/~/ Наименование произвольного поля
1933 "value": "string", ~/~/ Значение произвольного поля
1934 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1935 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1936 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1937 }
1938 ]
1939 }
1940
1941
1942 (% style="color:#000000" %)Ответ:
1943
1944 (((
1945 {
1946 "vehicleId": 0, ~/~/ ID ТС
1947 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1948 "name": "string", ~/~/ Имя объекта
1949 "imei": "string", ~/~/ IMEI
1950 "deviceTypeId": 0, ~/~/ ID типа устройства
1951 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1952 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1953 "sim1": "string", ~/~/ SIM1
1954 "sim2": "string", ~/~/ SIM2
1955 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1956 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1957 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1958 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1959 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1960 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1961 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1962 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1963 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1964 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1965 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1966 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1967 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1968 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1969 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1970 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1971 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1972 "counters": { ~/~/ состояний счётчиков
1973 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1974 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1975 "mileage": 0, ~/~/ Пробег
1976 "motohours": 0 ~/~/ Моточасы 
1977 },
1978 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1979 "id": "string", ~/~/ CMSV6 Идентификатор
1980 "enabled": true, ~/~/ Признак включения
1981 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1982 )))
1983
1984
1985 (((
1986 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1987 "login": "string", ~/~/ CMSV6 имя учетной записи
1988 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1989 },
1990 "inspectionTasks": [ ~/~/ Задания на ТО
1991 {
1992 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1993 "enabled": true, ~/~/ Признак включения
1994 "name": "string", ~/~/ Имя задания
1995 "description": "string", ~/~/ Описание задания
1996 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1997 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1998 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1999 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2000 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2001 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2002 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2003 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2004 }
2005 ],
2006 "drivers": [  ~/~/ Список водителей
2007 {
2008 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2009 "inputNumber": 0, ~/~/ № входа.
2010 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2011 "comment": "string", ~/~/ Комментарий.
2012 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2013 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2014 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2015 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2016 }
2017 ],
2018 "commandTemplates": [ ~/~/ Список шаблонов команд
2019 {
2020 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2021 "name": "string", ~/~/ Название шаблона команд
2022 "command": "string", ~/~/ Команда на выполнение
2023 "retries": 0 ~/~/ Лимит попыток отправки
2024 }
2025 ],
2026 "sensors": [  ~/~/ Список датчиков 
2027 {
2028 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2029 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2030 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2031 )))
2032
2033 (((
2034 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2035 )))
2036
2037 (((
2038 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2039 )))
2040
2041 (((
2042 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2043 )))
2044
2045 (((
2046 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2047 )))
2048
2049 (((
2050 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2051 "name": "string", ~/~/ Имя датчика
2052 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2053 )))
2054
2055 (((
2056 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2057 "inputNumber": 0, ~/~/ Номер входа
2058 "pseudonym": "string", ~/~/ Псевдоним
2059 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2060 "isInverted": true, ~/~/ Признак инверсии
2061 "disabled": true, ~/~/ Датчик не участвует в обработке
2062 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2063 "gradesTables": [ ~/~/ Тарировка
2064 {
2065 "grades": [ ~/~/ Таблицы тарировки
2066 {
2067 "input": 0, ~/~/ Вход
2068 "output": 0 ~/~/ Выход
2069 }
2070 ],
2071 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2072 }
2073 ],
2074 "showInTooltip": true, ~/~/ Отображение в подсказке
2075 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2076 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2077 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2078 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2079 "expr": "string", ~/~/ Выражение
2080 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2081 "string" 
2082 ],
2083 "customParams": { ~/~/ Дополнительные настройки
2084 "additionalProp1": "string",
2085 "additionalProp2": "string",
2086 "additionalProp3": "string"
2087 },
2088 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2089 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2090 {
2091 "from": 0, ~/~/ С какого значения
2092 "color": "string", ~/~/ Каким цветом
2093 "text": "string" ~/~/ Текст подписи к этому интервалу
2094 }
2095 ]
2096 }
2097 ],
2098 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2099 "customFields": [ ~/~/ Список произвольных полей
2100 {
2101 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2102 "name": "string", ~/~/ Наименование произвольного поля
2103 "value": "string", ~/~/ Значение произвольного поля
2104 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2105 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2106 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2107 }
2108 ],
2109 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2110 }
2111 )))
2112
2113 **Валидация:**
2114 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2115 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2116 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2117
2118 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2119
2120 (% class="box errormessage" %)
2121 (((
2122 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2123 )))
2124
2125 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2126
2127 (% style="color:#000000" %)Метод запроса: **DELETE**
2128
2129 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2130
2131 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2132
2133 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2134
2135 (% style="text-align:left" %)
2136 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2137
2138 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2139
2140 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2141
2142 (% class="box infomessage" %)
2143 (((
2144 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2145 )))
2146
2147 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2148
2149 (% style="color:#000000" %)Метод запроса: **GET**
2150
2151 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2152
2153 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2154
2155 (% style="color:#000000" %)Ответ:
2156
2157 (% style="color:#000000" %){(%%)
2158 "deviceTypeId" : "", ~/~/ ID типа устройства
2159 "deviceTypeName" : "" ~/~/ Название типа устройства
2160 (% style="color:#000000" %)}
2161
2162 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2163
2164 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2165
2166 (% class="box infomessage" %)
2167 (((
2168 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2169 )))
2170
2171 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2172
2173 (% style="color:#000000" %)Метод запроса: **GET**
2174
2175 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2176
2177 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2178
2179 (% style="color:#000000" %)Ответ:
2180
2181 (% style="color:#000000" %){(%%)
2182 "id": "", ~/~/ ID типа датчика 
2183 "name": "", ~/~/ Название
2184 "description": "", ~/~/ Описание
2185 (% style="color:#000000" %)}
2186
2187 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2188
2189 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2190
2191 (% class="box infomessage" style="text-align: left;" %)
2192 (((
2193 **POST /api/v3/terminalMessages/count**
2194 )))
2195
2196 (% style="text-align: left;" %)
2197 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2198
2199 (% style="text-align: left;" %)
2200 Метод запроса **POST**
2201
2202 (% style="text-align: left;" %)
2203 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2204
2205 (% style="text-align: left;" %)
2206 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2207
2208 (% style="text-align: left;" %)
2209 {
2210 "vehicleIds": [
2211 id ~/~/ здесь передается список идентификаторов объектов
2212 ],
2213 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2214 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2215 }
2216
2217 (% style="text-align: left;" %)
2218 Ответ:
2219
2220 (% style="text-align: left;" %)
2221 [
2222 {
2223 "vehicleId": 0, ~/~/ идентификатор объекта
2224 "count": 0 ~/~/ количество сообщений за период
2225 }
2226 ]
2227
2228 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2229
2230 (% class="box infomessage" style="text-align: left;" %)
2231 (((
2232 **POST /api/v3/terminalMessages/mapping**
2233 )))
2234
2235 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2236
2237 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2238
2239 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2240
2241 {
2242 "protocolType": 0,
2243 "params": ["string"]
2244 }
2245
2246 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2247 |protocolType|ID типа протокола
2248 |params|(((
2249 Массив наименований параметров в сообщении
2250 )))
2251
2252 Ответ:
2253
2254 {
2255 "protocolType": 0,
2256 "mapping": {
2257 "additionalProp1": {
2258 "inputType": 0,
2259 "inputNumber": 0
2260 },
2261 "additionalProp2": {
2262 "inputType": 0,
2263 "inputNumber": 0
2264 }
2265 }
2266 }
2267
2268 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2269 |protocolType|Тип протокола
2270 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2271 |inputNumber|(((
2272 Номер входа
2273 )))
2274
2275 (% class="wikigeneratedid" %)
2276 Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2277
2278 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2279
2280 (% class="box infomessage" %)
2281 (((
2282 **POST /api/v3/terminalMessages**
2283 )))
2284
2285 Метод возвращает список сообщений терминала объекта за выбранный период.
2286
2287 (% style="text-align: left;" %)
2288 Метод запроса **POST**
2289
2290 (% style="text-align: left;" %)
2291 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2292
2293 (% style="text-align: left;" %)
2294 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2295
2296 {
2297 "vehicleId": 0, ~/~/ id объекта
2298 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2299 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2300 }
2301
2302 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2303 |vehicleId|ID объекта
2304 |from|Дата и время начала периода запроса
2305 |to|Дата и время окончания периода запроса
2306
2307 Ответ:
2308
2309 [
2310 {
2311 "messages": [
2312 {
2313 "deviceTime": "2023-11-29T07:40:44.052Z",
2314 "serverTime": "2023-11-29T07:40:44.052Z",
2315 "speed": 0,
2316 "altitude": 0,
2317 "latitude": 0,
2318 "longitude": 0,
2319 "satellites": 0,
2320 "course": 0,
2321 "voltage": 0,
2322 "parameters": {
2323 "additionalProp1": "string",
2324 "additionalProp2": "string",
2325 "additionalProp3": "string"
2326 },
2327 "photoCount": 0,
2328 "lbsCorrectedCoords": true,
2329 "protocolType": 0
2330 }
2331 ]
2332 }
2333 ]
2334
2335 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2336 |deviceTime|Время сообщения терминала
2337 |serverTime|Время когда сообщение поступило на сервер
2338 |speed|Скорость
2339 |altitude|Высота над уровнем моря
2340 |latitude|Широта
2341 |longitude|Долгота
2342 |satellites|Кол-во спутников
2343 |course|Курс
2344 |voltage|Бортовое напряжение
2345 |parameters|Список параметров и их значений
2346 |photoCount|Количество фото
2347 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2348 |protocolType|ID типа протокола
2349
2350 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2351
2352 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2353
2354 (% class="box infomessage" %)
2355 (((
2356 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2357 )))
2358
2359 (% style="color:#000000" %)Метод запроса: **POST**
2360
2361 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2362
2363 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2364
2365 (% style="text-align:left" %)
2366 Тело запроса:
2367
2368 {
2369 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2370 "vehicleIds": [0], ~/~/ Список ID объектов
2371 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2372 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2373 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2374 }
2375
2376 Ответ:
2377
2378 [
2379 {
2380 "vehicleId": 0, ~/~/ ID объекта
2381 "name": "string", ~/~/ Имя ТС
2382 "periods": [ ~/~/ Периоды
2383 {
2384 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2385 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2386 "mileage": 0, ~/~/ Пробег за период, километры
2387 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2388 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2389 "motohours": 0, ~/~/ Моточасы за период, секунды
2390 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2391 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2392 }
2393 ]
2394 }
2395 ]
2396
2397 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2398
2399 (% class="box infomessage" %)
2400 (((
2401 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2402 )))
2403
2404 (% style="color:#000000" %)Метод запроса: **POST**
2405
2406 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2407
2408 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2409
2410 (% style="text-align:left" %)
2411 Тело запроса:
2412
2413 {
2414 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2415 "vehicleIds": [0], ~/~/ Список ID объектов
2416 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2417 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2418 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2419 }
2420
2421 Ответ:
2422
2423 [
2424 {
2425 "vehicleId": 0, ~/~/ ID объекта
2426 "name": "string", ~/~/ Имя ТС
2427 "periods": [ ~/~/ Периоды
2428 {
2429 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2430 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2431 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2432 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2433 "fuelConsumption": 0, ~/~/ Расход топлива
2434 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2435 }
2436 ]
2437 }
2438 ]
2439
2440 (% class="box warningmessage" %)
2441 (((
2442 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2443 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2444 )))
2445
2446 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2447
2448 (% class="box infomessage" %)
2449 (((
2450 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2451 )))
2452
2453 (% style="color:#000000" %)Метод запроса: **POST**
2454
2455 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2456
2457 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2458
2459 (% style="text-align:left" %)
2460 Тело запроса:
2461
2462 {
2463 "vehicleIds": [0], ~/~/ Список ID объектов
2464 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2465 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2466 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2467 }
2468
2469 Ответ:
2470
2471 [
2472 {
2473 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2474 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2475 "vehicleId": 0, ~/~/ ID объекта
2476 "name": "string", ~/~/ Имя объекта
2477 "model": "string", ~/~/ Модель объекта
2478 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2479 {
2480 "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2481 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2482 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2483 "valueFuel": 0, ~/~/ Количество
2484 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2485 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2486 }
2487 ]
2488 }
2489 ]
2490
2491
2492 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2493
2494 (% class="box infomessage" %)
2495 (((
2496 **POST /api/v3/vehicles/moveStop**
2497 )))
2498
2499 Метод запроса: **POST**
2500
2501 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2502
2503 В заголовках запроса: X-Auth: Токен авторизации
2504
2505
2506 Тело запроса:
2507
2508 {
2509 "vehicleIds": [ ], ~/~/ Список ID объектов
2510 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2511 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2512 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2513 }
2514
2515 Ответ:
2516
2517 [ 
2518 {
2519 "vehicleId": 0, ~/~/ ID объекта
2520 "vehicleName": "string", ~/~/ Имя объекта
2521 "moves": [ ~/~/ Событие движения
2522 {
2523 "mileage": 0, ~/~/ Пробег, км
2524 "eventId": 0, ~/~/ Идентификатор события
2525 "eventName": "string", ~/~/ Название события
2526 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2527 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2528 "duration": 0 ~/~/ Продолжительность события, секунд
2529 }
2530 ],
2531 "stops": [ ~/~/ События стоянок
2532 {
2533 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2534 "eventId": 0, ~/~/ Идентификатор события
2535 "eventName": "string", ~/~/ Название события
2536 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2537 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2538 "duration": 0 ~/~/ Продолжительность события, секунд
2539 }
2540 ]
2541 }
2542 ]
2543
2544
2545 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2546
2547 (% class="box infomessage" %)
2548 (((
2549 **POST /api/v3/vehicles/getlastdata**
2550 )))
2551
2552 Метод запроса: **POST**
2553
2554 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2555
2556 В заголовках запроса: X-Auth: Токен авторизации
2557
2558
2559 В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2560
2561 Ответ:
2562 {
2563 "vehicleId": 0, ~/~/Идентификатор объекта.
2564 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2565 "vehicleNumber": "string",~/~/Номер объекта.
2566 "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2567 "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2568 "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2569 "speed": 0,~/~/Скорость объекта.
2570 "course": 0,~/~/Курс движения [0;360]
2571 "latitude": 0,~/~/Широта [-90°;90°].
2572 "longitude": 0,~/~/Долгота [-180°;180°].
2573 "address": "string",~/~/Адрес.
2574 "geozones": [ ~/~/Сведения по геозонам.
2575 {
2576 "id": 0,
2577 "name": "string"
2578 }
2579
2580
2581 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2582
2583 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2584
2585 (% class="box infomessage" %)
2586 (((
2587 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2588 )))
2589
2590 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2591
2592 (% style="color:#000000" %)Метод запроса: **POST**
2593
2594 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2595
2596 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2597
2598 (% style="text-align:left" %)
2599 Тело запроса:
2600
2601 (% style="text-align:left" %)
2602 {
2603 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2604 }
2605
2606 (% style="text-align:left" %)
2607 Ответ:
2608
2609 [
2610 {
2611 "id": 0, ~/~/ Идентификатор объекта геозоны
2612 "name": "string", ~/~/ Название объекта геозоны
2613 "type": 0, ~/~/ Тип объекта геозоны
2614 "fname": "string", ~/~/ Имя файла
2615 "parentId": "string", ~/~/ Идентификатор клиента
2616 "radius": 0, ~/~/ Радиус геообъекта
2617 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2618 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2619 "description": "string", ~/~/ Описание
2620 "area": 0, ~/~/ Площадь, м^^2^^
2621 "perimetr": 0, ~/~/ Периметр, м
2622 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2623 }
2624 ]
2625
2626 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2627
2628 (% class="box infomessage" %)
2629 (((
2630 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2631 )))
2632
2633 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2634
2635 (% style="color:#000000" %)Метод запроса: **POST**
2636
2637 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2638
2639 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2640
2641 (% style="text-align:left" %)
2642 Тело запроса:
2643
2644 {
2645 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2646 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2647 "ids": [ ], ~/~/ Массив id объектов
2648 "byTime": 0, ~/~/ Объединение событий по времени 
2649 "byDist": 0, ~/~/ Объединение событий по расстоянию
2650 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2651 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2652 }
2653
2654 Ответ:
2655 [
2656 {
2657 "geozoneId": 0, ~/~/ ID геообъекта
2658 "geozoneName": "string", ~/~/ Название геообъекта
2659 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2660 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2661 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2662 "vehicleId": 0, ~/~/ ID объекта
2663 "vehicleName": "string" ~/~/ Имя объекта
2664 }
2665 ]
2666
2667 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2668
2669 (% class="box infomessage" %)
2670 (((
2671 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2672 )))
2673
2674 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2675
2676 (% style="color:#000000" %)Метод запроса: **POST**
2677
2678 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2679
2680 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2681
2682 (% style="text-align:left" %)
2683 Тело запроса:
2684
2685 {
2686 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2687 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2688 "ids": [ ], ~/~/ Массив id геообъектов
2689 "byTime": 0, ~/~/ Объединение событий по времени 
2690 "byDist": 0, ~/~/ Объединение событий по расстоянию
2691 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2692 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2693 }
2694
2695 Ответ:
2696
2697 [
2698 {
2699 "geozoneId": 0, ~/~/ ID геообъекта
2700 "geozoneName": "string", ~/~/ Название геообъекта
2701 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2702 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2703 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2704 "vehicleId": 0, ~/~/ ID объекта
2705 "vehicleName": "string" ~/~/ Имя объекта
2706 }
2707 ]
2708
2709 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2710
2711 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2712
2713 (% class="box infomessage" %)
2714 (((
2715 **POST /api/v3/notifications/find**
2716 )))
2717
2718 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2719
2720 (% style="text-align: left;" %)
2721 Метод запроса **POST**
2722
2723 (% style="text-align: left;" %)
2724 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2725
2726 (% style="text-align: left;" %)
2727 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2728
2729 {
2730 "parentId": "" ~/~/ id клиента
2731 }
2732
2733 Ответ:
2734
2735 [
2736 {
2737 "id": 0, ~/~/ ID уведомления
2738 "name": "string", ~/~/ Название уведомления
2739 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2740 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2741 "userId": "", ~/~/ Пользователь, создавший уведомление
2742 "parentId": "", ~/~/ Идентификатор клиента
2743 "parentName": "string" ~/~/ Имя клиента
2744 }
2745 ]
2746
2747 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2748
2749 (% class="box infomessage" %)
2750 (((
2751 **GET /api/v3/notifications/{id}**
2752 )))
2753
2754 Метод возвращает данные правил формирования выбранного уведомления.
2755
2756 (% style="text-align: left;" %)
2757 Метод запроса **GET**
2758
2759 (% style="text-align: left;" %)
2760 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2761
2762 (% style="text-align: left;" %)
2763 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2764
2765 (% style="text-align: left;" %)
2766 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2767
2768 (% style="text-align: left;" %)
2769 (% style="color:#000000" %)Ответ:
2770
2771 (% style="text-align: left;" %)
2772 (% style="color:#000000" %){
2773 "id": 0, ~/~/ (%%)id уведомления
2774 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2775 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2776 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2777 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2778 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2779 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2780 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2781 (% style="color:#000000" %) 0
2782 ],
2783 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2784 (% style="color:#000000" %) 0
2785 ],
2786 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2787 (% style="color:#000000" %) 0
2788 ],
2789 "settings": { ~/~/ Список параметров уведомления
2790 "additionalProp1": "string",
2791 "additionalProp2": "string",
2792 "additionalProp3": "string"
2793 },
2794 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2795 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2796 (% style="color:#000000" %) ""
2797 ],
2798 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2799 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2800 (% style="color:#000000" %) "string"
2801 ],
2802 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2803 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2804 (% style="color:#000000" %) {
2805 "id": 0, ~/~/ (%%)Идентификатор участника чата
2806 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2807 (% style="color:#000000" %) }
2808 ],
2809 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2810 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2811 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2812 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2813 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2814 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2815 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2816 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2817 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2818 (% style="color:#000000" %)}
2819
2820 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2821
2822 (% class="box warningmessage" %)
2823 (((
2824 **PUT /api/v3/notifications/**
2825 )))
2826
2827 Метод позволяет отредактировать уведомление.
2828
2829 Метод запроса **PUT**
2830
2831 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2832
2833 В заголовках запроса: X-Auth: Токен авторизации
2834
2835 Тело запроса:
2836 {
2837 "id": 0, ~/~/ id уведомления
2838 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2839 "userId": "", ~/~/ Пользователь, создавший уведомление
2840 "parentId": "", ~/~/ Идентификатор клиента
2841 "parentName": "string", ~/~/ Имя клиента
2842 "name": "string", ~/~/ Название уведомления
2843 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2844 "vehicleIds": [ ~/~/ Список id объектов для анализа
2845 0
2846 ],
2847 "geoids": [ ~/~/ Список id геообъектов для анализа
2848 0
2849 ],
2850 "fieldids": [ ~/~/ Список id полей для анализа
2851 0
2852 ],
2853 "settings": { ~/~/ Список параметров уведомления
2854 "additionalProp1": "string",
2855 "additionalProp2": "string",
2856 "additionalProp3": "string"
2857 },
2858 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2859 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2860 ""
2861 ],
2862 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2863 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2864 "string"
2865 ],
2866 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2867 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2868 {
2869 "id": 0, ~/~/ Идентификатор участника чата
2870 "info": "string" ~/~/ Дополнительные сведения
2871 }
2872 ],
2873 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2874 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2875 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2876 "kind": 0, ~/~/ Определяет вид уведомления
2877 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2878 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2879 "timezone": 0, ~/~/ Сдвиг часового пояса
2880 "validity": 0, ~/~/ Срок действия в днях (1-90)
2881 "autoProlongation": true ~/~/ Автопродление срока действия
2882 }
2883
2884 Ответ:
2885
2886 Success
2887
2888
2889 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2890
2891 (% class="box warningmessage" %)
2892 (((
2893 **PUT** /api/v3/notifications/prolongation
2894 )))
2895
2896 Метод позволяет продлить уведомления.
2897
2898 Метод запроса **PUT**
2899
2900 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2901
2902 В заголовках запроса: X-Auth: Токен авторизации.
2903
2904 Тело запроса:
2905
2906 [
2907
2908 0
2909
2910 ]
2911
2912 где 0 идентификатор ids.
2913
2914 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2915
2916 (% class="box errormessage" %)
2917 (((
2918 **DELETE /api/v3/notifications/{id}**
2919 )))
2920
2921 Метод позволяет удалить выбранное уведомление.
2922
2923 Метод запроса **DELETE**
2924
2925 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2926
2927 Передаваемый параметр: {id} - id уведомления
2928
2929 В заголовках запроса: X-Auth: Токен авторизации
2930
2931 Ответ:
2932
2933 Success
2934
2935
2936 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2937
2938 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2939
2940 (% class="box infomessage" %)
2941 (((
2942 **POST /api/v3/Drivers/find**
2943 )))
2944
2945 Передается параметр: parentId - ID клиента-родителя
2946
2947 Ответ:
2948
2949 [
2950 {
2951 "name": "string", ~/~/ Определяет наименование
2952 "description": "string", ~/~/ Определяет описание
2953 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2954 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2955 "exclusive": true, ~/~/ Определяет признак "Исключительный"
2956 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2957 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2958 "deleted": true ~/~/ Признак удаления
2959 }
2960 ]
2961
2962 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2963
2964 (% class="box infomessage" %)
2965 (((
2966 **GET /api/v3/Drivers/{driverGuid}**
2967 )))
2968
2969 Передается параметр: ID водителя
2970
2971 Ответ:
2972
2973 {
2974 "name": "string", ~/~/ Определяет наименование
2975 "description": "string", ~/~/ Определяет описание
2976 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2977 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2978 "exclusive": true, ~/~/ Определяет признак "Исключительный"
2979 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2980 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2981 "deleted": true ~/~/ Признак удаления
2982 }
2983
2984 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2985
2986 (% class="box successmessage" %)
2987 (((
2988 **POST /api/v3/Drivers**
2989 )))
2990
2991 Запрос:
2992
2993 {
2994 "name": "string",
2995 "description": "string",
2996 "hiredate": "2023-06-30T12:50:54.020Z",
2997 "chopdate": "2023-06-30T12:50:54.020Z",
2998 "exclusive": true,
2999 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3000 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3001 "deleted": true
3002 }
3003
3004 Ответ:
3005
3006 {
3007 "name": "string",
3008 "description": "string",
3009 "hiredate": "2023-06-30T12:50:54.051Z",
3010 "chopdate": "2023-06-30T12:50:54.051Z",
3011 "exclusive": true,
3012 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3013 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3014 "deleted": true
3015 }
3016
3017
3018 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3019
3020 (% class="box warningmessage" %)
3021 (((
3022 **PUT /api/v3/Drivers**
3023 )))
3024
3025 Запрос:
3026
3027 {
3028 "name": "string",
3029 "description": "string",
3030 "hiredate": "2023-06-30T12:50:27.910Z",
3031 "chopdate": "2023-06-30T12:50:27.910Z",
3032 "exclusive": true,
3033 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 "deleted": true
3036 }
3037
3038 Ответ:
3039
3040 {
3041 "name": "string",
3042 "description": "string",
3043 "hiredate": "2023-06-30T12:50:27.929Z",
3044 "chopdate": "2023-06-30T12:50:27.929Z",
3045 "exclusive": true,
3046 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3047 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3048 "deleted": true
3049 }
3050
3051
3052 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3053
3054 (% class="box errormessage" %)
3055 (((
3056 **DELETE /api/v3/Drivers/{driverGuid}**
3057 )))
3058
3059 Передается параметр: ID водителя
3060
3061 Ответ:
3062
3063 Success
3064
3065
3066 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3067
3068 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3069
3070 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3071
3072 (% class="box infomessage" %)
3073 (((
3074 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3075 )))
3076
3077 Запрос:
3078
3079 {
3080 "Ids": [
3081 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3082 ],
3083 "BeginTime": "2023-06-30T12:49:04.365Z",
3084 "EndTime": "2023-06-30T12:49:04.365Z"
3085 }
3086
3087 Ответ:
3088
3089 [
3090 {
3091 "VehicleId": 0,
3092 "CreateTime": "2023-06-30T09:52:31.240Z",
3093 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3094 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3095 "BeginTime": "2023-06-30T09:52:31.240Z",
3096 "EndTime": "2023-06-30T09:52:31.240Z"
3097 }
3098 ]
3099
3100
3101 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3102
3103 (% class="box infomessage" %)
3104 (((
3105 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3106 )))
3107
3108 Запрос:
3109
3110 {
3111 "Ids": [
3112 0
3113 ],
3114 "BeginTime": "2023-06-30T12:48:39.419Z",
3115 "EndTime": "2023-06-30T12:48:39.419Z"
3116 }
3117
3118 Ответ:
3119
3120 [
3121 {
3122 "VehicleId": 0,
3123 "CreateTime": "2023-06-30T09:54:01.631Z",
3124 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3125 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3126 "BeginTime": "2023-06-30T09:54:01.631Z",
3127 "EndTime": "2023-06-30T09:54:01.631Z"
3128 }
3129 ]
3130
3131
3132 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3133
3134 (% class="box successmessage" %)
3135 (((
3136 **POST /api/v3/DriversVehiclesAssignments**
3137 )))
3138
3139 Передается массив назначений
3140
3141 Запрос:
3142
3143 [
3144 {
3145 "VehicleId": 0, ~/~/ Идентификатор объекта
3146 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3147 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3148 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3149 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3150 }
3151 ]
3152
3153 Ответ:
3154
3155 [
3156 {
3157 "VehicleId": 0,
3158 "CreateTime": "2023-06-30T11:04:46.903Z",
3159 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3160 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3161 "BeginTime": "2023-06-30T11:04:46.903Z",
3162 "EndTime": "2023-06-30T11:04:46.903Z"
3163 }
3164 ]
3165
3166
3167 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3168
3169 (% class="box warningmessage" %)
3170 (((
3171 **PUT /api/v3/DriversVehiclesAssignments**
3172 )))
3173
3174 Запрос:
3175
3176 [
3177 {
3178 "VehicleId": 0,
3179 "CreateTime": "2023-06-30T11:14:08.117Z",
3180 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3181 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3182 "BeginTime": "2023-06-30T11:14:08.117Z",
3183 "EndTime": "2023-06-30T11:14:08.117Z"
3184 }
3185 ]
3186
3187 Ответ:
3188
3189 [
3190 {
3191 "VehicleId": 0,
3192 "CreateTime": "2023-06-30T11:14:53.349Z",
3193 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3194 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3195 "BeginTime": "2023-06-30T11:14:53.349Z",
3196 "EndTime": "2023-06-30T11:14:53.349Z"
3197 }
3198 ]
3199
3200
3201 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3202
3203 (% class="box errormessage" %)
3204 (((
3205 **DELETE /api/v3/DriversVehiclesAssignments**
3206 )))
3207
3208 Запрос:
3209
3210 [
3211 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3212 ]
3213
3214 Ответ:
3215
3216 Success
3217
3218
3219 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3220
3221 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3222
3223 (% class="box infomessage" %)
3224 (((
3225 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3226 )))
3227
3228 Запрос:
3229
3230 {
3231 "Ids": [
3232 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3233 ],
3234 "BeginTime": "2023-06-30T12:47:12.162Z",
3235 "EndTime": "2023-06-30T12:47:12.162Z"
3236 }
3237
3238 Ответ:
3239
3240 [
3241 {
3242 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3243 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3244 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3245 "BeginTime": "2023-06-30T11:19:40.703Z",
3246 "EndTime": "2023-06-30T11:19:40.703Z"
3247 }
3248 ]
3249
3250
3251 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3252
3253 (% class="box infomessage" %)
3254 (((
3255 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3256 )))
3257
3258 Запрос:
3259
3260 {
3261 "Ids": [
3262 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3263 ],
3264 "BeginTime": "2023-06-30T12:47:12.162Z",
3265 "EndTime": "2023-06-30T12:47:12.162Z"
3266 }
3267
3268 Ответ:
3269
3270 [
3271 {
3272 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3273 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3274 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3275 "BeginTime": "2023-06-30T11:19:40.703Z",
3276 "EndTime": "2023-06-30T11:19:40.703Z"
3277 }
3278 ]
3279
3280
3281 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3282
3283 (% class="box successmessage" %)
3284 (((
3285 **POST /api/v3/DriversRfidsAssignments**
3286 )))
3287
3288 Запрос:
3289
3290 [
3291 {
3292 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3293 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3294 "BeginTime": "2023-06-30T11:27:08.635Z",
3295 "EndTime": "2023-06-30T11:27:08.635Z"
3296 }
3297 ]
3298
3299 Ответ:
3300
3301 [
3302 {
3303 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3304 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3305 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3306 "BeginTime": "2023-06-30T11:27:08.677Z",
3307 "EndTime": "2023-06-30T11:27:08.677Z"
3308 }
3309 ]
3310
3311
3312 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3313
3314 (% class="box warningmessage" %)
3315 (((
3316 **PUT /api/v3/DriversRfidsAssignments**
3317 )))
3318
3319 Запрос:
3320
3321 [
3322 {
3323 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3324 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3325 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3326 "BeginTime": "2023-06-30T11:28:43.330Z",
3327 "EndTime": "2023-06-30T11:28:43.330Z"
3328 }
3329 ]
3330
3331 Ответ:
3332
3333 [
3334 {
3335 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3336 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3337 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3338 "BeginTime": "2023-06-30T11:28:43.331Z",
3339 "EndTime": "2023-06-30T11:28:43.331Z"
3340 }
3341 ]
3342
3343
3344 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3345
3346 (% class="box errormessage" %)
3347 (((
3348 **DELETE /api/v3/DriversRfidsAssignments**
3349 )))
3350
3351 Запрос:
3352
3353 [
3354 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3355 ]
3356
3357 Ответ:
3358
3359 Success
3360
3361
3362 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3363
3364 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3365
3366 (% class="box infomessage" %)
3367 (((
3368 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3369 )))
3370
3371 Запрос:
3372
3373 {
3374 "Ids": [
3375 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3376 ],
3377 "BeginTime": "2023-06-30T12:45:10.852Z",
3378 "EndTime": "2023-06-30T12:45:10.852Z"
3379 }
3380
3381 Ответ:
3382
3383 [
3384 {
3385 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3386 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3387 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3388 "BeginTime": "2023-06-30T11:58:04.695Z",
3389 "EndTime": "2023-06-30T11:58:04.695Z"
3390 }
3391 ]
3392
3393
3394 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3395
3396 (% class="box infomessage" %)
3397 (((
3398 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3399 )))
3400
3401 Запрос:
3402
3403 {
3404 "Ids": [
3405 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3406 ],
3407 "BeginTime": "2023-06-30T12:45:10.852Z",
3408 "EndTime": "2023-06-30T12:45:10.852Z"
3409 }
3410
3411 Ответ:
3412
3413 [
3414 {
3415 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3416 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3417 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3418 "BeginTime": "2023-06-30T11:58:04.695Z",
3419 "EndTime": "2023-06-30T11:58:04.695Z"
3420 }
3421 ]
3422
3423
3424 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3425
3426 (% class="box successmessage" %)
3427 (((
3428 **POST /api/v3/DriversFuelCardsAssignments**
3429 )))
3430
3431 Запрос:
3432
3433 [
3434 {
3435 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3436 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3437 "BeginTime": "2023-06-30T12:09:53.175Z",
3438 "EndTime": "2023-06-30T12:09:53.175Z"
3439 }
3440 ]
3441
3442 Ответ:
3443
3444 [
3445 {
3446 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3447 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3448 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3449 "BeginTime": "2023-06-30T12:09:53.201Z",
3450 "EndTime": "2023-06-30T12:09:53.201Z"
3451 }
3452 ]
3453
3454
3455 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3456
3457 (% class="box warningmessage" %)
3458 (((
3459 **PUT /api/v3/DriversFuelCardsAssignments**
3460 )))
3461
3462 Запрос:
3463
3464 [
3465 {
3466 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3467 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3468 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3469 "BeginTime": "2023-06-30T12:09:53.201Z",
3470 "EndTime": "2023-06-30T12:09:53.201Z"
3471 }
3472 ]
3473
3474 Ответ:
3475
3476 [
3477 {
3478 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3479 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3480 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3481 "BeginTime": "2023-06-30T12:09:53.201Z",
3482 "EndTime": "2023-06-30T12:09:53.201Z"
3483 }
3484 ]
3485
3486
3487 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3488
3489 (% class="box errormessage" %)
3490 (((
3491 **DELETE /api/v3/DriversFuelCardsAssignments**
3492 )))
3493
3494 Запрос:
3495
3496 [
3497 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3498 ]
3499
3500 Ответ:
3501
3502 Success
3503
3504
3505 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3506
3507 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3508
3509 (% class="box infomessage" %)
3510 (((
3511 **POST /api/v3/Trailers**
3512 )))
3513
3514 Пример запроса:
3515
3516 {
3517 "startDate": "2023-11-14T10:48:03.671Z",
3518 "endDate": "2023-11-14T10:48:03.671Z",
3519 "ids": [ 0 ],
3520 "timezone": 0
3521 }
3522
3523 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3524 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3525 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3526 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3527 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3528
3529 Пример ответа:
3530
3531 [
3532 {
3533 "SD": "2023-11-14T10:48:03.717Z",
3534 "ED": "2023-11-14T10:48:03.717Z", 
3535 "id": 0,
3536 "SLat": 0,
3537 "SLon": 0,
3538 "ELat": 0,
3539 "ELon": 0,
3540 "mileage": 0
3541 "Duration": 0
3542 "Address": "string",
3543 "Address2": "string",
3544 "name": "string",
3545 "rid": "string",
3546 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3547 "trailer": {
3548 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3549 "Number": "string",
3550 "Description": "string",
3551 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3552 "ExternalID": "string",
3553 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3554 "CreateTime": "2023-11-14T10:48:03.717Z",
3555 "UpdateTime": "2023-11-14T10:48:03.717Z",
3556 "IsDeleted": true
3557 },
3558 "filesCount": 0,
3559 }
3560 ]
3561
3562 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3563 |SD|Дата и время начала события
3564 |ED|Дата и время окончания события
3565 |id|ID объекта
3566 |SLat|Широта начальной координаты
3567 |SLon|Долгота начальной координаты
3568 |ELat|Широта конечной координаты
3569 |ELon|Долгота конечной координаты
3570 |mileage|Пробег
3571 |Duration|Продолжительность
3572 |Address|Адрес начального местоположения
3573 |Address2|Адрес конечного местоположения
3574 |name|Имя радиометки
3575 |rid|Номер радиометки
3576 |rguid|ID радиометки
3577 |trailer|Информация об агрегате
3578 |ModelGuid|ID агрегата
3579 |Number|Название/номер агрегата
3580 |Description|Текст примечания агрегата
3581
3582 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3583
3584 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3585
3586 (% class="box infomessage" %)
3587 (((
3588 **POST /api/v3/Rfids/find**
3589 )))
3590
3591 Запрос:
3592
3593 {
3594 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3595 }
3596
3597 Ответ:
3598
3599 [
3600 {
3601 "name": "string",
3602 "number": 0,
3603 "period": 0,
3604 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3605 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3606 }
3607 ]
3608
3609 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3610 |parentId|ID клиента
3611 |name|Название карты-метки
3612 |number|Номер
3613 |period|Период запросов в секундах (работает только для агрегатов)
3614 |id|ID карты-метки
3615
3616 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3617
3618 (% class="box infomessage" %)
3619 (((
3620 **GET /api/v3/Rfids/{rfidGuid}**
3621 )))
3622
3623 Передаем параметр rfidGuid - идентификатор карты-метки
3624
3625 Ответ:
3626
3627 [
3628 {
3629 "name": "string",
3630 "number": 0,
3631 "period": 0,
3632 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3633 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3634 }
3635 ]
3636
3637 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3638 |name|Название карты-метки
3639 |number|Номер
3640 |period|Период запросов в секундах (работает только для агрегатов)
3641 |id|ID карты-метки
3642 |parentId|ID клиента
3643
3644 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3645
3646 (% class="box successmessage" %)
3647 (((
3648 **POST /api/v3/Rfids**
3649 )))
3650
3651 Запрос:
3652
3653 {
3654 "name": "string",
3655 "number": 0,
3656 "period": 0,
3657 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3658 }
3659
3660 Ответ:
3661
3662 {
3663 "name": "string",
3664 "number": 0,
3665 "period": 0,
3666 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3667 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3668 }
3669
3670 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3671 |name|Название карты-метки
3672 |number|Номер
3673 |period|Период запросов в секундах (работает только для агрегатов)
3674 |id|ID карты-метки
3675 |parentId|ID клиента
3676
3677 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3678
3679 (% class="box warningmessage" %)
3680 (((
3681 **PUT /api/v3/Rfids**
3682 )))
3683
3684 Запрос:
3685
3686 {
3687 "name": "string",
3688 "number": 0,
3689 "period": 0,
3690 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3691 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3692 }
3693
3694 Ответ:
3695
3696 {
3697 "name": "string",
3698 "number": 0,
3699 "period": 0,
3700 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3701 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3702 }
3703
3704 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3705 |name|Название карты-метки
3706 |number|Номер
3707 |period|Период запросов в секундах (работает только для агрегатов)
3708 |id|ID карты-метки
3709 |parentId|ID клиента
3710
3711 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3712
3713 (% class="box errormessage" %)
3714 (((
3715 **DELETE /api/v3/Rfids/{rfidGuid}**
3716 )))
3717
3718 Передаем параметр **rfidGuid** - идентификатор карты-метки
3719
3720 Ответ:
3721
3722 Success
3723
3724
3725 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3726
3727 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3728
3729 (% class="box infomessage" %)
3730 (((
3731 **GET /api/v3/Billing/client/balance/{clientId}**
3732 )))
3733
3734 Параметр запроса: **clientId **- идентификатор клиента.
3735
3736 Ответ:
3737
3738 {
3739 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3740 "Balance": 0
3741 }
3742
3743 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3744 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3745 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3746
3747 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3748
3749 (% class="box infomessage" %)
3750 (((
3751 **GET /api/v3/Billing/client/constraint/{clientId}**
3752 )))
3753
3754 Параметр запроса: **clientId **- идентификатор клиента.
3755
3756 Ответ:
3757
3758 {
3759 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3760 "CalculationType": 0,
3761 "PermissibleBalance": 0,
3762 "DefermentDays": 0,
3763 "SendUiNotifications": true,
3764 "SendEmailNotifications": true,
3765 "IsPrivate": true,
3766 }
3767
3768 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3769 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3770 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3771 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3772 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3773 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3774 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3775 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3776
3777 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3778
3779 (% class="box infomessage" %)
3780 (((
3781 **GET /api/v3/Billing/client/plan/{clientId}**
3782 )))
3783
3784 Параметры запроса:
3785
3786 **clientId **- идентификатор клиента.
3787
3788 **planId **- идентификатор тарифного плана.
3789
3790 Ответ:
3791
3792 {
3793 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3794 "Plan": { **~/~/ Описание тарифного плана**
3795 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3796 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3797 "Name": "string",
3798 "IsArchived": true,
3799 "Constraint": {
3800 "CalculationType": 0,
3801 "PermissibleBalance": 0,
3802 "DefermentDays": 0
3803 },
3804 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3805 {
3806 "Feature": "string",
3807 "IsFactual": true,
3808 "Limit": 0,
3809 "Price": 0,
3810 "PeriodValue": 0,
3811 "PeriodType": 0
3812 }
3813 ]
3814 },
3815 "DebitDate": "2023-10-18T12:46:24.213Z",
3816 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3817 {
3818 "Feature": "string",
3819 "IsEnabled": true,
3820 "IsPrivate": true,
3821 "IsFactual": true,
3822 "Limit": 0,
3823 "Price": 0,
3824 "DebitDate": "2023-10-18T12:46:24.213Z",
3825 "PeriodValue": 0,
3826 "PeriodType": 0
3827 }
3828 ]
3829 }
3830
3831 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3832 |ClientId|Идентификатор клиента
3833 |Id|Идентификатор тарифного плана
3834 |OwnerId|Идентификатор клиента-владельца
3835 |Name|Наименование тарифного плана
3836 |IsArchived|Признак, определяющий архивный тарифный план
3837 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3838 |PermissibleBalance|Допустимый баланс
3839 |DefermentDays|Отсрочка, количество дней
3840 |Feature|Код услуги
3841 |IsEnabled|Признак, определяющий активирована ли услуга
3842 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3843 |IsFactual|Признак, определяющий расчёт по факту
3844 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3845 |Price|Цена за единицу.
3846 |DebitDate|Следующий момент времени списания с баланса за услугу.
3847 |PeriodValue|Значение периода.
3848 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3849
3850 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3851
3852 (% class="box infomessage" %)
3853 (((
3854 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3855 )))
3856
3857 Параметр запроса: **clientId **- идентификатор клиента.
3858
3859 Ответ:
3860
3861 [
3862 {
3863 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3864 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3865 "Name": "string",
3866 "IsArchived": true,
3867 "Constraint": {
3868 "CalculationType": 0,
3869 "PermissibleBalance": 0,
3870 "DefermentDays": 0
3871 },
3872 "Features": [
3873 {
3874 "Feature": "string",
3875 "IsFactual": true,
3876 "Limit": 0,
3877 "Price": 0,
3878 "PeriodValue": 0,
3879 "PeriodType": 0
3880 }
3881 ]
3882 }
3883 ]
3884
3885 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3886 |ClientId|Идентификатор клиента
3887 |Id|Идентификатор тарифного плана
3888 |OwnerId|Идентификатор клиента-владельца
3889 |Name|Наименование тарифного плана
3890 |IsArchived|Признак, определяющий архивный тарифный план
3891 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3892 |PermissibleBalance|Допустимый баланс
3893 |DefermentDays|Отсрочка, количество дней
3894 |Feature|Код услуги
3895 |IsFactual|Признак, определяющий расчёт по факту
3896 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3897 |Price|Цена за единицу.
3898 |PeriodValue|Значение периода.
3899 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3900
3901 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3902
3903 (% class="box infomessage" %)
3904 (((
3905 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3906 )))
3907
3908 Параметр запроса: **clientId **- идентификатор клиента.
3909
3910 Ответ:
3911
3912 [
3913 {
3914 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3915 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3916 "Name": "string",
3917 "IsArchived": true,
3918 "Constraint": {
3919 "CalculationType": 0,
3920 "PermissibleBalance": 0,
3921 "DefermentDays": 0
3922 },
3923 "Features": [
3924 {
3925 "Feature": "string",
3926 "IsFactual": true,
3927 "Limit": 0,
3928 "Price": 0,
3929 "PeriodValue": 0,
3930 "PeriodType": 0
3931 }
3932 ]
3933 }
3934 ]
3935
3936 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3937 |ClientId|Идентификатор клиента
3938 |Id|Идентификатор тарифного плана
3939 |OwnerId|Идентификатор клиента-владельца
3940 |Name|Наименование тарифного плана
3941 |IsArchived|Признак, определяющий архивный тарифный план
3942 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3943 |PermissibleBalance|Допустимый баланс
3944 |DefermentDays|Отсрочка, количество дней
3945 |Feature|Код услуги
3946 |IsFactual|Признак, определяющий расчёт по факту
3947 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3948 |Price|Цена за единицу.
3949 |PeriodValue|Значение периода.
3950 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3951
3952 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3953
3954 (% class="box warningmessage" %)
3955 (((
3956 **PUT /api/v3/Billing/client/balance**
3957 )))
3958
3959 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3960
3961 Тело запроса:
3962
3963 {
3964 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3965 "Balance": 0
3966 }
3967
3968 Ответ: Success
3969
3970 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3971 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3972 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3973
3974 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3975
3976 (% class="box warningmessage" %)
3977 (((
3978 **PUT /api/v3/billing/client/balance/deposit**
3979 )))
3980
3981 Создает операцию **Пополнение **с указанной суммой
3982
3983 Тело запроса:
3984
3985 {
3986 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3987 "Balance": 0
3988 }
3989
3990 Ответ: Success
3991
3992 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3993 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3994 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3995
3996 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3997
3998 Создает операцию **Списание **с указанной суммой
3999
4000 (% class="box warningmessage" %)
4001 (((
4002 **PUT /api/v3/billing/client/balance/withdraw**
4003 )))
4004
4005 Тело запроса:
4006
4007 {
4008 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4009 "Balance": 0
4010 }
4011
4012 Ответ: Success
4013
4014 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4015 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4016 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4017
4018 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4019
4020 (% class="box warningmessage" %)
4021 (((
4022 **PUT /api/v3/Billing/client/constraint**
4023 )))
4024
4025 Тело запроса:
4026
4027 {
4028 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4029 "CalculationType": 0,
4030 "PermissibleBalance": 0,
4031 "DefermentDays": 0,
4032 "SendUiNotifications": true,
4033 "SendEmailNotifications": true,
4034 "IsPrivate": true,
4035 }
4036
4037 Ответ: Success
4038
4039 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4040 |ClientId|Идентификатор клиента
4041 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4042 |PermissibleBalance|Допустимый баланс
4043 |DefermentDays|(((
4044 Отсрочка, количество дней
4045 )))
4046 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4047 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4048 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4049
4050 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4051
4052 (% class="box warningmessage" %)
4053 (((
4054 **PUT /api/v3/Billing/client/plan**
4055 )))
4056
4057 Тело запроса:
4058
4059 {
4060 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4061 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4062 "Features": [
4063 {
4064 "Feature": "string",
4065 "IsEnabled": true,
4066 "IsFactual": true,
4067 "Limit": 0,
4068 "Price": 0,
4069 "DebitDate": "2023-10-18T13:26:58.987Z",
4070 "PeriodValue": 0,
4071 "PeriodType": 0
4072 }
4073 ]
4074 }
4075
4076 Ответ: Success
4077
4078 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4079 |ClientId|Идентификатор клиента
4080 |PlanId|Идентификатор тарифного плана
4081 |Feature|Код услуги
4082 |IsEnabled|Признак, определяющий активирована ли услуга
4083 |IsFactual|Признак, определяющий расчёт по факту
4084 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4085 |Price|Цена за единицу.
4086 |DebitDate|Следующий момент времени списания с баланса за услугу.
4087 |PeriodValue|Значение периода.
4088 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4089
4090 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4091
4092 (% class="box warningmessage" %)
4093 (((
4094 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4095 )))
4096
4097 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4098
4099 (% class="box infomessage" %)
4100 (((
4101 **POST /api/v3/vehicles/import/{agentId}**
4102 )))
4103
4104 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4105
4106 В пути указывается **agentId** - id клиента.
4107
4108 **Заголовок**
4109
4110 **X-Auth: [токен авторизации]**
4111
4112 **Параметры**
4113
4114 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4115 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4116 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4117
4118 В теле использовать тип **form-data,** тип значения** file**
4119
4120 **Ключи**
4121
4122 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4123 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4124 |csv|В значении передаем файл датчиков, формат **csv**
4125
4126 Ответ:
4127
4128 {
4129 "vehicleId": 0,
4130 "name": "string",
4131 "errors": ["string"]
4132 }
4133
4134 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4135 |vehicleId|ID созданного объекта
4136 |name|Имя созданного объекта
4137 |errors|Ошибки и их описание
4138
4139 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4140
4141 (% class="box infomessage" %)
4142 (((
4143 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4144 )))
4145
4146 (% class="wikigeneratedid" %)
4147 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4148
4149 (% class="wikigeneratedid" %)
4150 В пути указывается **vehicleId **- id объекта.
4151
4152 **Заголовок**
4153
4154 **X-Auth: [токен авторизации]**
4155
4156 В теле использовать тип **form-data.**
4157
4158 Ключи:
4159
4160 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4161 |**history**|В значении передавать файл с историей
4162
4163 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4164
4165 Ответ:
4166
4167 {
4168 "results": [
4169 {
4170 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4171 "vehicleId": 0,
4172 "errors": [
4173 "string"
4174 ],
4175 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4176 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4177 "producedCount": 0,
4178 "msgCount": 0
4179 }
4180 ]
4181 }
4182
4183 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4184 |results|Результаты импорта в разрезе ТС
4185 |vehicleGuid|Guid ТС
4186 |vehicleId|ID ТС
4187 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4188 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4189 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4190 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4191 |msgCount|Кол-во обработанных сообщений всего
4192
4193 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4194
4195 (% class="box infomessage" %)
4196 (((
4197 **GET /api/v3/vehicles/import/history/status**
4198 )))
4199
4200 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4201
4202 Ответ:
4203
4204 {
4205 "activity": true,
4206 "progress": 0,
4207 "message": "string"
4208 }
4209
4210 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4211 |activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4212 |progress|Guid ТС
4213
4214 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4215
4216 (% class="box infomessage" %)
4217 (((
4218 **POST /api/v3/vehicles/export**
4219 )))
4220
4221 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4222
4223 Тело запроса:
4224
4225 [
4226 id
4227 ]
4228
4229 Ответ: Success 200, получаете файлы с настройками.
4230
4231 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4232
4233 (% class="box infomessage" %)
4234 (((
4235 **POST /api/v3/vehicles/export/history**
4236 )))
4237
4238 Метод возвращает список сообщений терминала объекта за выбранный период.
4239
4240 Тело запроса:
4241
4242 {
4243 "vehicleId": 0,
4244 "asArchive": true,
4245 "from": "2023-09-27T12:17:45.973Z",
4246 "to": "2023-09-27T12:17:45.973Z"
4247 }
4248
4249 Ответ:
4250
4251 Получаете файл. Сообщение: Code 200/Success
4252
4253 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4254 |vehicleId|ID объекта
4255 |asArchive|true - Архивировать файл, False - не архивировать
4256 |from|Дата и время начала запроса
4257 |to|Дата и время окончания запроса
4258
4259 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4260
4261 (% class="box infomessage" %)
4262 (((
4263 **GET /api/v3/vehicles/export/history/status**
4264 )))
4265
4266 Метод возвращает список сообщений терминала объекта за выбранный период.
4267
4268 Ответ:
4269
4270 {
4271 "activity": true,
4272 "progress": 0,
4273 "message": "string"
4274 }
4275
4276 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4277 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4278 |progress|Прогресс экспорта, от 0 до 100%
4279 |message|Текст описывающий статус
4280
4281 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4282
4283 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4284
4285 (% class="box infomessage" %)
4286 (((
4287 **POST /api/v3/EcoDriving/rating**
4288 )))
4289
4290 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4291
4292 Тело запроса:
4293
4294 {
4295 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4296 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4297 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4298 }
4299
4300 Ответ:
4301
4302 {
4303 "items": [  ~/~/ Список в разрезе ТС
4304 {
4305 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4306 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4307 "vehicleId": 0, ~/~/ ID ТС
4308 "vehicleName": "string", ~/~/ Название ТС
4309 "vehicleModel": "string", ~/~/ Модель ТС
4310 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4311 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4312 "totalViolations": 0, ~/~/ Нарушений всего
4313 "violationsByType": { ~/~/ Информация о нарушениях по типу
4314 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4315 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4316 "brakingViolations": 0, ~/~/ Нарушений торможения
4317 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4318 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4319 "sensorViolations": 0 ~/~/ Нарушений по датчику
4320 },
4321
4322 (((
4323
4324 )))
4325
4326 "moveTime": 0, ~/~/ Продолжительность движения, сек
4327 "mileage": 0, ~/~/ Пробег, м
4328 "tripsCount": 0, ~/~/ Кол-во рейсов
4329 "trips": [  ~/~/ Информация по рейсу
4330 {
4331 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4332 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4333 "violationsCount": 0, ~/~/ Всего нарушений
4334 "violationsByType": { ~/~/ Информация о нарушениях по типу
4335 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4336 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4337 "brakingViolations": 0, ~/~/ Нарушений торможения
4338 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4339 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4340 "sensorViolations": 0 ~/~/ Нарушений по датчику
4341 },
4342
4343 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4344 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4345 "moveTime": 0, ~/~/ Продолжительность движения, сек
4346 "mileage": 0, ~/~/ Пробег, м
4347 "motohours": 0, ~/~/ Моточасы, секунды
4348 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4349 "startAddress": "string", ~/~/ Адрес начала рейса
4350 "endAddress": "string", ~/~/ Адрес конца рейса
4351 "drivers": [  ~/~/ Список водителей
4352 {
4353 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4354 "driverName": "string", ~/~/ФИО водителя
4355 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4356 }
4357 ]
4358 }
4359 ]
4360 }
4361 ]
4362 }
4363
4364 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4365
4366 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4367
4368 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4369
4370 (% class="box infomessage" %)
4371 (((
4372 POST /api/v3/fuelcards/transactions
4373 )))
4374
4375 Метод запроса: POST
4376
4377 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4378 \\В заголовках запроса: X-Auth: Токен авторизации
4379
4380 Параметры в теле запроса (JSON):
4381
4382 {
4383 "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4384 "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4385 "ids": [ 
4386 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4387 ],
4388 "timezone": 0 ~/~/Таймзона
4389 }
4390
4391
4392 Ответ:
4393 {
4394 "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4395 "driver": "string", ~/~/Водители, привязанные к ТК
4396 "object": "string", ~/~/Наименование ТС
4397 "amount": 0, ~/~/Количество топлива
4398 "amountDut": 0, ~/~/Количество по ДУТ
4399 "amountDiff": 0, ~/~/Разница, л
4400 "amountDiffPerc": 0, ~/~/Разница, %
4401 "summa": 0, ~/~/Стоимость, руб
4402 "serviceName": "string", ~/~/Тип топлива
4403 "price": 0, ~/~/Цена за литр, руб
4404 "cardName": "string", ~/~/Наименование ТК
4405 "cardNum": "string", ~/~/Номер ТК
4406 "operator": "string", ~/~/Оператор ТК
4407 "address": "string" ~/~/Адрес АЗС
4408 }
4409
4410
4411 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4412
4413
4414 == **Получение полных данных о ретрансляторе** ==
4415
4416 (% class="box infomessage" %)
4417 (((
4418 **GET ** **/api/v3/retranslations/{id}**
4419 )))
4420
4421 Идентификатор запроса: ID
4422
4423
4424 Пример ответа:
4425
4426 {  
4427 "description": "", ~/~/ Определяет описание
4428 "subscriberId": "", ~/~/ Подписчик
4429 "protocolType": 0, ~/~/ Тип протокола
4430 "isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4431 "address": "string", ~/~/ Адрес события
4432 "objects": [ ~/~/Объекты для ретрансляции
4433 {      
4434 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4435 "name": "", ~/~/ Наименование объекта ретрансляции
4436 "imei": "", ~/~/ IMEI объекта  
4437 "isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4438 }
4439 ],  
4440 "id": "", ~/~/ идентификатор пользователя   
4441 "parentId": "", ~/~/Guid родителя
4442 "deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4443 }
4444
4445
4446 == **Удаление данных ретранслятора** ==
4447
4448 (% class="box infomessage" %)
4449 (((
4450 **DELETE** **/api/v3/retranslations/{id}**
4451 )))
4452
4453 Параметр запроса: ID
4454
4455
4456 == **Создание ретранслятора** ==
4457
4458 (% class="box infomessage" %)
4459 (((
4460 **POST ** **/api/v3/retranslations/{id}**
4461 )))
4462
4463 Запрос:
4464
4465 {  
4466 "description": "", ~/~/ Описание
4467 "subscriberId": "", ~/~/ Подписчик
4468 "protocolType": 0, ~/~/ Тип протокола
4469 "address": "", ~/~/ Адрес ретрансляции
4470 "isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4471 "objects": [ ~/~/Объекты для ретрансляции
4472 {      
4473 "id": "", ~/~/ идентификатор пользователя     
4474 "imei": "", ~/~/IMEI объекта
4475 "isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4476 }
4477 ]
4478 }
4479
4480
4481 Ответ:
4482
4483 {  
4484 "description": "string", ~/~/ Определяет описание
4485 "subscriberId": "", ~/~/ идентификатор запроса
4486 "protocolType": 0, ~/~/ Тип протокола
4487 "isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4488 "address": "", ~/~/ Адрес события
4489 "objects": [ ~/~/Объекты для ретрансляции
4490 {      
4491 "id": "", ~/~/ идентификатор пользователя    
4492 "name": "string", ~/~/ Название уведомления
4493 "imei": "string", ~/~/IMEI объекта  
4494 "isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4495 }
4496 ],  
4497 "id": "", ~/~/ идентификатор пользователя  
4498 "parentId": "", ~/~/ Guid идентификатор родителя
4499 "deleted": true ~/~/ Признак удаления
4500 }
4501
4502
4503 == **Редактирование ретранслятора** ==
4504
4505 (% class="box infomessage" %)
4506 (((
4507 **PUT** **/api/v3/retranslations**
4508 )))
4509
4510 Пример запроса:
4511
4512 {  
4513 "id": "", ~/~/ идентификатор пользователя   
4514 "description": "string", ~/~/ Определяет описание
4515 "subscriberId": "", ~/~/ идентификатор запроса
4516 "protocolType": 0, ~/~/ Тип протокола
4517 "isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4518 "address": "string", ~/~/ Адрес события
4519 "objects": ~/~/Объекты для ретрансляции
4520 [    
4521 {      
4522 "id": "",  ~/~/ идентификатор пользователя         
4523 "imei": "", ~/~/IMEI объекта
4524 "isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4525 }
4526 ]
4527 }
4528
4529
4530 Пример ответа:
4531
4532 {  
4533 "description": "", ~/~/ Определяет описание
4534 "subscriberId": "", ~/~/ идентификатор запроса
4535 "protocolType": 0, ~/~/ Тип протокола
4536 "isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4537 "address": "string", ~/~/ Адрес события
4538 "objects": [ ~/~/Объекты для ретрансляции
4539 {      
4540 "id": "", ~/~/ идентификатор пользователя     
4541 "name": "string", ~/~/ Название уведомления    
4542 "imei": "", ~/~/IMEI объекта
4543 "isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4544 }
4545 ],
4546 "id": "", ~/~/ идентификатор пользователя   
4547 "parentId": "", ~/~/ Guid идентификатор родителя
4548 "deleted": true ~/~/ Признак удаления
4549 }
4550
4551
4552 == **Получение списка ретранслятора клиента** ==
4553
4554 (% class="box infomessage" %)
4555 (((
4556 **POST /api/v3/retranslations/find**
4557 )))
4558
4559 Пример запроса:
4560
4561 {  
4562 "id": "", ~/~/ идентификатор пользователя   
4563 "search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4564 "parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4565 }
4566
4567 Ответ:
4568
4569 [ 
4570 {    
4571 "description": "", ~/~/ Определяет описание
4572 "subscriberId": "", ~/~/ идентификатор запроса
4573 "protocolType": 0, ~/~/ Тип протокола
4574 "isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4575 "address": "string", ~/~/ Адрес события
4576 "id": "", ~/~/ идентификатор пользователя   
4577 "parentId": "", ~/~/ Guid идентификатор родителя
4578 "deleted": true ~/~/ Признак удаления
4579 }
4580 ]
4581
4582
4583 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4584
4585 == **API для отчета по выгрузке комбайнов** ==
4586
4587 (% class="box infomessage" %)
4588 (((
4589 POST **/api/v3/Reports/harvesterUnloading**
4590 )))
4591
4592 Пример запроса:
4593
4594 {
4595 "byTime": 0, ~/~/ Объединение событий по времени
4596 "byDist": 0, ~/~/ Объединение событий по расстоянию
4597 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4598 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4599 "showNearestObjects": true, ~/~/Показывать объекты рядом?
4600 "vehicleIds": [ ~/~/ Список id объектов для анализа
4601 0
4602 ],
4603 "from": "", ~/~/ Дата и время начало запроса
4604 "to": "", ~/~/ Дата и время окончания запроса
4605 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4606 }
4607
4608 Пример ответа:
4609
4610 [ 
4611 {
4612 "harvesterName": "", ~/~/Комбайн, номер
4613 "harvesterId": 0, ~/~/Комбайн, id
4614 "harvesterModel": "", ~/~/ Модель комбайна
4615 "hopperCapacity": 0, ~/~/ Объем бункера м3
4616 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4617 "events": [ ~/~/Список событий в разрезе комбайна
4618 {
4619 "driverId": "", ~/~/Идентификатор водителя
4620 "driverName": "", ~/~/Водитель комбайна, ФИО
4621 "RFID": "", ~/~/ идентификатор карты-метки
4622 "rfidName": "", ~/~/Водитель комбайна, имя метки
4623 "vehicleId": 0, ~/~/идентификатор объекта
4624 "vehicleName": "string", ~/~/ Имя объекта
4625 "modelName": "string", ~/~/ Имя модели объекта
4626 "nearestVehicles": [ ~/~/Объекты рядом
4627 {
4628 "vehicleId": 0, ~/~/идентификатор объекта
4629 "vehicleName": "string" ~/~/ Имя объекта
4630 }
4631 ],
4632 "fields": [ ~/~/Поля, где происходила выгрузка
4633 {
4634 "id": 0, ~/~/ идентификатор пользователя 
4635 "name": "string" ~/~/ имя пользователя 
4636 }
4637 ],
4638 "event": "string", ~/~/Событие
4639 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4640 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4641 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4642 "cultureName": "string", ~/~/ название культуры
4643 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4644 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4645 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4646 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4647 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4648 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4649 "issued": 0, ~/~/Выдано, бункеров
4650 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4651 "latitude": 0, ~/~/Широта
4652 "longitude": 0, ~/~/ Долгота
4653 "litresAway": 0, ~/~/Отдано, л
4654 "m3Away": 0 ~/~/Отдано, м3
4655 }
4656 ]
4657 }
4658 ]
4659
4660
4661 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4662
4663 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4664
4665
4666 (% class="box infomessage" %)
4667 (((
4668 GET api/v3/Vehicles/recyclebin/all
4669 )))
4670
4671 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4672
4673 Параметр запроса: {parentId} - идентификатор агента
4674
4675 В заголовках запроса: X-Auth: Токен авторизации
4676
4677 Ответ:
4678
4679 [ 
4680 {
4681 "recordTime": "", ~/~/Время записи
4682 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4683 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4684 "objectId": 0, ~/~/ID объекта, помещённого в корзину
4685 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4686 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4687 "details": { ~/~/Список деталей объекта, помещённого в корзину
4688 "items": [ ~/~/ 
4689 nullable: true ~/~/Детали
4690 {
4691 "name": "string", ~/~/наименование столбца
4692 "value": "string" ~/~/содержание столбца
4693 }
4694 ]
4695 },
4696 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4697 "string"
4698 ]
4699 }
4700 ]
4701
4702
4703 (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4704
4705 (% class="box infomessage" %)
4706 (((
4707 POST/api/v3/Vehicles/recyclebin/erase
4708 )))
4709
4710 В заголовках запроса: X-Auth: Токен авторизации
4711
4712 Пример запроса:
4713
4714 [
4715 0
4716 ]
4717
4718
4719 Пример ответа:
4720
4721 [ 
4722 {
4723 "recordTime": "", ~/~/Время записи
4724 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4725 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4726 "objectId": 0, ~/~/ID объекта, помещённого в корзин
4727 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4728 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4729 "details": { ~/~/Список деталей объекта, помещённого в корзину
4730 "items": [ ~/~/Детали
4731 {
4732 "name": "", ~/~/Имя свойства
4733 "value": "" ~/~/Значение свойства
4734 }
4735 ]
4736 },
4737 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4738 ""
4739 ]
4740 }
4741 ]
4742
4743 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4744
4745 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4746
4747 (% class="box infomessage" %)
4748 (((
4749 POST/api/v3/Vehicles/recyclebin/restore
4750 )))
4751
4752 В заголовках запроса: X-Auth: Токен авторизации
4753
4754 Параметры в теле запроса (JSON):
4755
4756 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4757
4758 В заголовках запроса: X-Auth: Токен авторизации
4759
4760
4761 Пример запроса:
4762
4763 (((
4764 [
4765 )))
4766
4767 (((
4768 0
4769 )))
4770
4771 (((
4772 ]
4773 )))
4774
4775
4776 Пример ответа:
4777
4778 [
4779 {
4780 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4781 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4782 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4783 "objectId": 0, ~/~/ID объекта, помещённого в корзину
4784 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4785 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4786 "details": { ~/~/Список деталей объекта, помещённого в корзину
4787 "items": [ ~/~/Детали
4788 {
4789 "name": "string", ~/~/Имя свойства
4790 "value": "string" ~/~/Значение свойства
4791 }
4792 ]
4793 },
4794 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4795 "string"
4796 ]
4797 }
4798 ]
4799
4800
4801
4802 (% class="box" lang="en-US" style="text-align: center;" %)
4803 (((
4804 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
4805 )))

Меню

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