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

Меню

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