Version 240.1 by Андрей Калиновский on 2025/06/09 16:36
Show last authors
1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 (((
3 (% class="box warningmessage" %)
4 (((
5 (% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 просим вас соблюдать несколько простых правил при использовании API-команд:##
7 )))
8
9 * Формировать не более 3 отчётов одновременно.
10 * Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11
12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13
14 (% class="box infomessage" %)
15 (((
16 **Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 \\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 )))
19
20 **Содержание страницы:**
21 )))
22
23 {{toc/}}
24
25
26 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
27
28 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
29
30 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
31
32 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
33
34 (% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
35
36
37 (% style="color:#000000; font-size:16px" %)**Рекомендации**
38
39 - Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
40
41 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
42
43 (% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
44 (((
45 (% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
46 (% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
47 )))
48
49 (% class="box successmessage" %)
50 (((
51 (% lang="en-US" %)**POST /api/v3/auth/login**
52 )))
53
54 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
55
56 (% style="color:#000000" %)Метод запроса: **POST**
57
58 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
59
60 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
61
62 (% style="color:#000000" %)Параметры в теле запроса (JSON):
63
64 (% style="color:#000000" %){
65 "login": "testuser",
66 "password": "testuser"
67 }
68
69 (% style="color:#000000" %)**Ответ:**
70
71 (% lang="en-US" %)
72 (% style="color:#000000" %){
73 "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
74 "User": "testuser" , ~/~/ имя пользователя(%%)
75 }
76
77 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
78
79 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
80 |(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
81 |(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
82 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
83 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
84
85 (% class="wikigeneratedid" %)
86 Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
87
88 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
89
90 (% class="box infomessage" %)
91 (((
92 (% lang="en-US" %)**GET /api/v3/auth/check**
93 )))
94
95 (% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
96
97 (% style="color:#000000" %)Метод запроса: **GET**
98
99 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
100
101 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
102
103 (% lang="en-US" %)
104 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
105
106 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
107
108 == (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
109
110 (% class="box infomessage" %)
111 (((
112 **GET api/v3/agents/{id}**
113 )))
114
115 Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
116
117 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
118
119 (% style="color:#000000" %)Метод запроса: **GET**
120
121 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
122
123 Запрос должен содержать данные параметра "**agentId**"
124
125 (% style="color:#000000" %)Ответ:
126
127 (((
128 {
129 "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 "parentName": "string", ~/~/ Наименование агента
132 "name": "string", ~/~/ Имя клиента
133 "fullName": "string", ~/~/ ФИО клиента
134 "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 "district": "string", ~/~/ Район
137 "region": "string", ~/~/ Область
138 "city": "string", ~/~/ Город
139 "email": "string", ~/~/ Email
140 "director": "string", ~/~/ Руководитель
141 "RegionalData": [ ~/~/ Определяет региональные сведения.
142 {
143 "Country": 0, ~/~/ Страна
144 "groups": [ ~/~/ Список групп
145 {
146 "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 "fields": [ ~/~/ Список значений полей
148 {
149 "name": "string", ~/~/ Имя поля формы
150 "value": "string" ~/~/ Значение поля формы
151 }
152 ]
153 }
154 ]
155 }
156 ]
157 }
158 )))
159
160
161 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
162 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
163 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
164 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
165 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
166 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
167 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
168 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
169 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
170 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
171 |(% style="width:215px" %)city|(% style="width:861px" %)Город
172 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
173 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
174 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
175 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
176 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
177 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
178 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
179 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
180 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
181 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
182
183 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
184
185 (% class="box infomessage" %)
186 (((
187 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
188 )))
189
190 (% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
191
192 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
193
194 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
195
196 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
197
198 (% style="color:#000000" %)Метод запроса: **POST**
199
200 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
201
202 (% style="color:#000000" %)Параметр запроса:
203
204 (% style="color:#000000" %){
205 "parentId": "string"
206 }
207
208 (% style="color:#000000" %)Ответ:
209
210 {
211 "agentId": "",(% style="color:#000000" %)   (%%)
212 "parentId": "",
213 "name": "string",
214 "fullName": "string",
215 "agentInfoType": 0,
216 (% style="color:#000000" %) "status": "",
217 }
218
219
220 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
221 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
222 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
223 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
224 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
225 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
226 |(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
227
228 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
229
230 (% class="box successmessage" %)
231 (((
232 **POST /api/v3/agents **
233 )))
234
235 Метод позволяет добавить клиента, указанного в запросе.
236
237 Метод запроса: **POST**
238
239 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
240
241 В заголовках запроса: X-Auth: Токен авторизации
242
243 Параметры в теле запроса (JSON):
244
245 {
246 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
247 "name": "string", ~/~/ имя
248 "fullName": "string", ~/~/ полное наименование
249 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
250 "isForeign": true, ~/~/ иностранный контрагент
251 "district": "string", ~/~/ округ
252 "region": "string", ~/~/ регион
253 "city": "string", ~/~/ город
254 "inn": "string", ~/~/ ИНН
255 "kpp": "string", ~/~/ КПП
256 "address": "string", ~/~/ юридический адрес
257 "addressFact": "string", ~/~/ фактический адрес
258 "email": "string", ~/~/ email
259 "director": "string", ~/~/ ФИО руководителя
260 "bankName": "string", ~/~/ банк
261 "bankBIK": "string", ~/~/ БИК
262 "bankRS": "string", ~/~/ номер счёта
263 "bankKS": "string" ~/~/ корр. счёт
264 }
265
266 Ответ:
267
268 {
269 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
270 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
271 "name": "string", ~/~/ имя
272 "fullName": "string", ~/~/ полное наименование
273 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
274 "isForeign": true, ~/~/ иностранный контрагент
275 "district": "string", ~/~/ округ
276 "region": "string", ~/~/ регион
277 "city": "string", ~/~/ город
278 "inn": "string", ~/~/ ИНН
279 "kpp": "string", ~/~/ КПП
280 "address": "string", ~/~/ юридический адрес
281 "addressFact": "string", ~/~/ фактический адрес
282 "email": "string", ~/~/ email
283 "director": "string", ~/~/ ФИО руководителя
284 "bankName": "string", ~/~/ банк
285 "bankBIK": "string", ~/~/ БИК
286 "bankRS": "string", ~/~/ номер счёта
287 "bankKS": "string" ~/~/ корр. счёт
288 }
289
290 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
291 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
292 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
293 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
294 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
295 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
296 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
297 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
298 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
299 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
300 |(% style="width:215px" %)city|(% style="width:861px" %)Город
301 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
302 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
303 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
304 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
305 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
306 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
307 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
308 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
309 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
310 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
311
312 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
313
314 (% class="box warningmessage" %)
315 (((
316 **PUT /api/v3/agents**
317 )))
318
319 Метод позволяет отредактировать клиента, указанного в запросе.
320
321 Метод запроса: **PUT**
322
323 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
324
325 В заголовках запроса: X-Auth: Токен авторизации
326
327 Параметры в теле запроса (JSON):
328
329 {
330 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
331 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
332 "name": "string", ~/~/ имя
333 "fullName": "string", ~/~/ полное наименование
334 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
335 "isForeign": true, ~/~/ иностранный контрагент
336 "district": "string", ~/~/ округ
337 "region": "string", ~/~/ регион
338 "city": "string", ~/~/ город
339 "inn": "string", ~/~/ ИНН
340 "kpp": "string", ~/~/ КПП
341 "address": "string", ~/~/ юридический адрес
342 "addressFact": "string", ~/~/ фактический адрес
343 "email": "string", ~/~/ email
344 "director": "string", ~/~/ ФИО руководителя
345 "bankName": "string", ~/~/ банк
346 "bankBIK": "string", ~/~/ БИК
347 "bankRS": "string", ~/~/ номер счёта
348 "bankKS": "string" ~/~/ корр. счёт
349 }
350
351 Ответ:
352
353 {
354 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
355 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
356 "name": "string", ~/~/ имя
357 "fullName": "string", ~/~/ полное наименование
358 "isForeign": true, ~/~/ иностранный контрагент
359 "district": "string", ~/~/ округ
360 "region": "string", ~/~/ регион
361 "city": "string", ~/~/ город
362 "inn": "string", ~/~/ ИНН
363 "kpp": "string", ~/~/ КПП
364 "address": "string", ~/~/ юридический адрес
365 "addressFact": "string", ~/~/ фактический адрес
366 "email": "string", ~/~/ email
367 "director": "string", ~/~/ ФИО руководителя
368 "bankName": "string", ~/~/ банк
369 "bankBIK": "string", ~/~/ БИК
370 "bankRS": "string", ~/~/ номер счёта
371 "bankKS": "string" ~/~/ корр. счёт
372 }
373
374 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
375
376 (% class="box errormessage" %)
377 (((
378 **DELETE /api/v3/agents/{clientId}**
379 )))
380
381 Метод позволяет удалить клиента, указанного в строке запроса.
382
383 Метод запроса: **DELETE**
384
385 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
386
387 Параметр запроса: **{clientId}** - Guid пользователя
388
389 В заголовках запроса: X-Auth: Токен авторизации
390
391 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
392
393 == (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
394
395 (% class="box warningmessage" %)
396 (((
397 **PUT /api/v3/agents/{id}/changeStatus/{status}**
398 )))
399
400 Метод позволяет изменить статус клиента, указанного в запросе.
401
402 В пути указывается GUID клиента и статус клиента.
403
404 **status **- значение 0 - заблокирован, 1 - активен.
405
406 Ответ: Code 204
407
408 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
409
410 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
411
412 (% class="box successmessage" %)
413 (((
414 (% lang="en-US" %)**POST /api/v3/users**
415 )))
416
417 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
418
419 (% style="color:#000000" %)Метод запроса: **POST**
420
421 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
422
423 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
424
425 (% style="color:#000000" %)Параметры в теле запроса (JSON):
426
427 (% style="color:#000000" %)
428 { 
429 "lastName": "", ~/~/ фамилия
430 "firstName": "", ~/~/ имя
431 "position": "", ~/~/ должность
432 "phone": "", ~/~/ телефон
433 "organization": "", ~/~/ организация
434 "login": "", ~/~/ логин (обязателен)
435 "password": "", ~/~/ пароль (обязателен)
436 "email": "", ~/~/ email (обязателен)
437 "description": "string", ~/~/ Описание
438 "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
439 "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
440 "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
441 "parentId": "", ~/~/ Guid родительского агента
442 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
443 "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
444 "doubleAuth":
445 {
446 "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
447 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
448 },
449 "groups":
450 [
451 "string" ~/~/ группы пользователя, перечисление названия системных ролей
452 ],
453 "customGroups":
454 [
455 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
456 ],
457 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
458 }
459 {
460 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
461 "lastName": "string",
462 "firstName": "string",
463 "position": "string",
464 "phone": "string",
465 "organization": "string",
466 "login": "string",
467 "password": "string",
468 "email": "string",
469
470 (% style="text-align:left" %)
471 (% style="color:#000000; font-weight:normal" %)Ответ:
472 {     
473 "id": "" , ~/~/ ID пользователя
474 "lastName": "" , ~/~/ Фамилия ,
475 "firstName": "" , ~/~/ Имя
476 "position": "" , ~/~/ Должность
477 "phone": "" , ~/~/ Телефон
478 "organization": "" , ~/~/ Организация
479 "login": "" , ~/~/ Логин
480 "password": "" , ~/~/ Пароль
481 "email": "" , ~/~/ Email
482 "description": "" , ~/~/ Описание
483 "isEnabled": "" , ~/~/ Признак включения
484 "parentId": "" , ~/~/ Guid родительского агента
485 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
486 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
487 "kind": "" , ~/~/ тип аутентификации
488 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
489 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
490 }
491
492
493 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
494
495 (% class="box infomessage" %)
496 (((
497 (% lang="en-US" %)**POST /api/v3/users/find**
498 )))
499
500 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
501
502 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
503
504 (% style="color:#000000" %)Метод запроса: **POST**
505
506 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
507
508 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
509
510 (% style="color:#000000" %)Параметры в теле запроса (JSON):
511
512 (% style="color:#000000" %){(%%)
513 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
514 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
515 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
516 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
517 (% style="color:#000000" %)}
518
519 (% style="color:#000000" %)Ответ:
520
521 (% style="color:#000000" %){         (%%)
522 "id": "" , ~/~/ идентификатор пользователя
523 "lastName": "" , ~/~/ фамилия
524 "firstName": "" , ~/~/ имя
525 "position": "" , ~/~/ должность
526 "phone": "" , ~/~/ телефон
527 "parentId": "" , ~/~/ идентификатор клиента-родителя
528 "parentName": "" , ~/~/ наименование клиента-родителя
529 "organization": "" , ~/~/ организация
530 "login": "" , ~/~/ логин
531 "email": "" , ~/~/ E-mail
532 "sessionDuration":"", ~/~/ длительность сессии в минутах
533 "status": "1",  ~/~/ статус пользователя
534 "lastLogged": "", ~/~/ дата/время последней авторизации
535 (% style="color:#000000" %)}
536
537 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
538
539 (% class="box infomessage" %)
540 (((
541 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
542 )))
543
544 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
545
546 (% style="color:#000000" %)Метод запроса: **GET**
547
548 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
549
550 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
551
552 (% style="color:#000000" %)Ответ:
553
554 (((
555 (((
556 {
557 "id": "", ~/~/ GUID пользователя
558 "lastName": "", ~/~/ Фамилия 
559 "firstName": "", ~/~/ Имя
560 "position": "", ~/~/ Должность
561 "phone": "", ~/~/ Номер телефона
562 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
563 "parentName": "", Наименование клиента, которому принадлежит пользователь
564 "organization": "", ~/~/ Организация
565 "login": "", ~/~/ Логин пользователя
566 "email": "", ~/~/ Адрес электронной почты
567 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
568 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
569 "description": "", ~/~/ Описание
570 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
571 "doubleAuth":
572 {
573 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
574 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
575 },
576 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
577 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
578 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
579 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
580 "groups": [], ~/~/ Список ролей пользователя
581 "customGroups": [], ~/~/ Список клиентских ролей пользователя
582 "authDevices": [ ], ~/~/ Список авторизованных устройств
583 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
584 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
585 }
586 )))
587 )))
588
589 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
590
591 (% class="box warningmessage" %)
592 (((
593 (% lang="en-US" %)**PUT /api/v3/users**
594 )))
595
596 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
597
598 (% style="color:#000000" %)Метод запроса: **PUT**
599
600 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
601
602 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
603
604 (% lang="en-US" style="text-align:left" %)
605 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
606
607 (% lang="en-US" style="text-align:left" %)
608 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
609 "id": "" , ~/~/ ID пользователя 
610 "lastName": "" , ~/~/ фамилия
611 "firstName": "" , ~/~/ имя
612 "position": "" , ~/~/ должность
613 "phone": "" , ~/~/ телефон
614 "organization": "" , ~/~/ организация
615 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
616 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
617 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
618 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
619 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
620 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
621 "isEnabled": "" , ~/~/ признак включения
622 "parentId": "" , ~/~/ Guid родительского агента
623 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
624 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
625 "doubleAuth":
626 {
627 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
628 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
629 },
630 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
631 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
632 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
633
634 (% lang="en-US" style="text-align:left" %)
635 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
636
637 (% lang="en-US" style="text-align:left" %)
638 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
639 "id": "" , ~/~/ идентификатор пользователя
640 "lastName": "" , ~/~/ фамилия
641 "firstName": "" , ~/~/ имя
642 "position": "" , ~/~/ должность
643 "phone": "" , ~/~/ телефон
644 "organization": "" , ~/~/ организация
645 "login": "" , ~/~/ логин
646 "password": "" , ~/~/ пароль 
647 "email": "" , ~/~/ email
648 "description": "" , ~/~/ описание
649 "isEnabled": "" , ~/~/ признак включения
650 "parentId": "" , ~/~/ Guid родительского агента
651 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
652 "doubleAuth":
653 {
654 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
655 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
656 },
657 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
658 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
659 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
660 }
661
662 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
663
664 (% class="box warningmessage" %)
665 (((
666 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
667 )))
668
669 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
670
671 (% style="color:#000000" %)Метод запроса: **PUT**
672
673 (% 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}
674
675 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
676
677 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
678
679 (% style="color:#000000" %)Параметры в теле запроса (JSON):
680
681 (% style="color:#000000" %){(%%)
682 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
683 "description": "" , ~/~/ описание
684 "data": "" , ~/~/ данные, связанные со сменой статуса
685 (% style="color:#000000" %)}
686
687 (% style="text-align:left" %)
688 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
689
690 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
691
692 (% class="box warningmessage" %)
693 (((
694 **POST /api/v3/users/disable**
695 )))
696
697 Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
698
699 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
700
701 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
702
703 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
704
705 [ 
706 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
707 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
708 ]
709
710 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
711
712 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
713
714 (% class="box warningmessage" %)
715 (((
716 **POST /api/v3/users/enable**
717 )))
718
719 Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
720
721 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
722
723 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
724
725 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
726
727 [ 
728 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
729 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
730 ]
731
732 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
733 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
734
735 (((
736 В теле ответа:
737 {
738 "errorMessages": [
739 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
740 ],
741 "users": [
742 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
743 ]
744 }
745 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
746 "users" - массив id пользователей, которых не удалось включить или отключить.
747 )))
748
749 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
750
751 (% class="box errormessage" %)
752 (((
753 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
754 )))
755
756 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
757
758 (% style="color:#000000" %)Метод запроса: **DELETE**
759
760 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
761
762 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
763
764 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
765
766 (% style="text-align:left" %)
767 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
768
769 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
770
771 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
772
773 (% class="box infomessage" %)
774 (((
775 (% lang="en-US" %)**GET /api/v3/models/{Id}**
776 )))
777
778 Метод возвращает полную информацию о модели объекта.
779
780 (% style="color:#000000" %)Метод запроса: **GET**
781
782 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
783
784 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
785
786 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
787
788 (% style="color:#000000" %)Ответ:
789
790 (% style="color:#000000" %){
791 "parentName": "string",
792 "name": "string",
793 "picture": "string",
794 "minspeed": 0,
795 "maxspeed": 0,
796 "width": 0,
797 "imbeddedtrailer": true,
798 "hoppercapacity": 0,
799 "hopperdischargespeed": 0,
800 "modelType": 0,
801 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
802 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
803 "deleted": true
804 }
805
806 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
807 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
808 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
809 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
810 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
811 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
812 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
813 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
814 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
815 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
816 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
817 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
818 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
819 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
820
821 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
822
823 (% class="box successmessage" %)
824 (((
825 (% lang="en-US" %)**POST /api/v3/models/find**
826 )))
827
828 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
829
830 (% style="color:#000000" %)Метод запроса: **POST**
831
832 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
833
834 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
835
836 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
837
838 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
839 }
840
841 (% style="color:#000000" %)Ответ:
842
843 (% style="color:#000000" %)[
844 {
845 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
846 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
847 "parentName": "string",
848 "name": "string",
849 "modelType": 0
850 }
851 ]
852
853 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
854 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
855 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
856 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
857 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
858 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
859
860 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
861
862 (% class="box successmessage" %)
863 (((
864 (% lang="en-US" %)**POST /api/v3/models**
865 )))
866
867 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
868
869 (% style="color:#000000" %)Метод запроса: **POST**
870
871 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
872
873 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
874
875 (% style="color:#000000" %)Параметры в теле запроса (JSON):
876
877 {
878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880 "deleted": false,
881 "extId": "string",
882 "name": "string",
883 "picture": "string",
884 "minspeed": 0,
885 "maxspeed": 0,
886 "width": 0,
887 "imbeddedtrailer": true,
888 "fueloutlay": 0,
889 "hoppercapacity": 0,
890 "hopperdischargespeed": 0,
891 "modelType": 0
892 }
893
894 Ответ:
895
896 {
897 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
898 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
899 "deleted": false,
900 "extId": "string",
901 "name": "string",
902 "picture": "string",
903 "minspeed": 0,
904 "maxspeed": 0,
905 "width": 0,
906 "imbeddedtrailer": true,
907 "hoppercapacity": 0,
908 "hopperdischargespeed": 0,
909 "modelType": 0
910 }
911
912 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
913 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
914 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
915 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
916 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
917 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
918 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
919 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
920 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
921 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
922 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
923 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
924 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
925
926 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
927
928 (% class="box warningmessage" %)
929 (((
930 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
931 )))
932
933 (% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
934
935 (% style="color:#000000" %)Метод запроса: **PUT**
936
937 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
938
939 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
940
941 (% style="color:#000000" %)Параметры в теле запроса (JSON):
942
943 {
944 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
945 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
946 "deleted": true,
947 "extId": "string",
948 "name": "string",
949 "picture": "string",
950 "minspeed": 0,
951 "maxspeed": 0,
952 "width": 0,
953 "imbeddedtrailer": true,
954 "fueloutlay": 0,
955 "hoppercapacity": 0,
956 "hopperdischargespeed": 0,
957 "modelType": 0
958 }
959
960 Ответ:
961
962 {
963 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
964 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
965 "deleted": true,
966 "extId": "string",
967 "name": "string",
968 "picture": "string",
969 "minspeed": 0,
970 "maxspeed": 0,
971 "width": 0,
972 "imbeddedtrailer": true,
973 "fueloutlay": 0,
974 "hoppercapacity": 0,
975 "hopperdischargespeed": 0,
976 "modelType": 0
977 }
978
979 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
980 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
981 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
982 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
983 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
984 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
985 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
986 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
987 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
988 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
989 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
990 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
991 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
992
993 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
994
995 (% class="box errormessage" %)
996 (((
997 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
998 )))
999
1000 (% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
1001
1002 (% style="color:#000000" %)Метод запроса: **DELETE**
1003
1004 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
1005
1006 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
1007
1008 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1009
1010 Ответ: В случае успеха **Success 200**
1011
1012 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
1013
1014 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1015
1016 (% class="box infomessage" %)
1017 (((
1018 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1019 )))
1020
1021 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1022
1023 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1024
1025 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1026
1027 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1028
1029 (% style="color:#000000" %)Метод запроса: **GET**
1030
1031 (% 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}
1032
1033 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1034
1035 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1036
1037 (% style="color:#000000" %)Ответ:
1038
1039 (((
1040 {
1041
1042 (((
1043 "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1044 "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1045 )))
1046
1047 (((
1048 ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1049 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1050 )))
1051
1052 "vehicleId": "", ~/~/ ID объекта
1053 "name": "", ~/~/ Имя объекта
1054 "imei": "", ~/~/ IMEI объекта
1055 "deviceTypeId": , ~/~/ ID типа устройства
1056 "deviceTypeName": "", ~/~/ Название типа устройства
1057 "sim1": "", ~/~/ Номер SIM1
1058 "sim2": "", ~/~/ Номер SIM2
1059 "parentId": "", ~/~/ ID клиента-родителя
1060 "parentName": "", ~/~/ Наименование клиента-родителя
1061 "modelId": "", ~/~/ ID модели объекта
1062 "modelName": "", ~/~/ Имя модели объекта
1063 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1064 "unitName": "string", ~/~/ Наименование подразделения
1065 "status": 0, ~/~/ Статус объекта
1066 "createdAt": "", ~/~/ Дата создания объекта
1067 },
1068 "customFields": [ ~/~/ Произвольные поля
1069 {
1070 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1071 "name": "string", ~/~/ Имя поля
1072 "value": "string", ~/~/ Значение поля
1073 "forClient": true, ~/~/ Не используемая функция
1074 "forTooltip": true, ~/~/ Отображать в подсказке
1075 "forReport": true ~/~/ Отображать в отчете
1076 }
1077
1078 ], ~/~/ Данные с вкладки нормы
1079 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1080 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1081 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1082 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1083 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1084 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1085 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1086 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1087 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1088 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1089 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1090 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1091 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1092 "mileageCoeff": 0, ~/~/ коэффициент пробега
1093 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1094 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1095 "counters": { ~/~/ Счетчики
1096 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1097 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1098 "mileage": 0, ~/~/ Текущий пробег
1099 "motohours": 0, ~/~/ Текущие моточасы
1100 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1101 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1102 },
1103
1104 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1105 "id": "string", ~/~/ ID объекта
1106 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1107 "host": "string", ~/~/ CMSV6 Web Host
1108 "login": "string", ~/~/ CMSV6 Account
1109 "password": "string" ~/~/ CMSV6 Password
1110 },
1111
1112 "commandTemplates": [ ~/~/ Шаблоны команд
1113 {
1114 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1115 "name": "string", ~/~/ Наименование команды
1116 "command": "string", ~/~/ Текст команды
1117 "retries": 0 ~/~/ Количество попыток
1118 }
1119 ],
1120 "sensors": [ ~/~/ Датчики
1121 {
1122 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1123 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1124 "type": 0, ~/~/ Тип датчика
1125 "name": "string", ~/~/ Имя датчика
1126 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1127 "inputNumber": 0, ~/~/ Номер входа
1128 "pseudonym": "string", ~/~/ Псевдоним
1129 "medianDegree": 0, ~/~/ Медианная фильтрация
1130 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1131 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1132 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1133 "gradesTables": [ ~/~/ Массив таблиц тарировки
1134 {
1135 "grades": [ ~/~/ Таблица тарировки 1
1136 {
1137 "input": 0, ~/~/ Входящее значение
1138 "output": 0 ~/~/ Выходящее значение
1139 }
1140 ],
1141 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1142 }
1143 ],
1144 "showInTooltip": true, ~/~/ Отображать в подсказке
1145 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1146 "color": "string", ~/~/ Код цвета датчиков
1147 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1148 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1149 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1150 "expr": "string", ~/~/ Формула
1151 "children": [ ~/~/ массив дочерних датчиков
1152 "string"
1153 ],
1154 "customParams": { ~/~/ прочие произвольные параметры
1155 "additionalProp1": "string",
1156 "additionalProp2": "string",
1157 "additionalProp3": "string"
1158 },
1159
1160 ~/~/ Характерные для произвольного:
1161 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1162 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1163 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1164 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1165 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1166 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1167 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1168 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1169 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1170 ~/~/ "ValueOn": "Вкл.",
1171 ~/~/ "ValueOff": "Выкл."
1172 "summaryMaxValue": 0 ~/~/ Макс. значение
1173 }
1174 "drivers": [ ~/~/ Водители
1175 {
1176 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1177 "name": "string", ~/~/ Наименование
1178 "description": "string",
1179 "isDefault": true ~/~/ По умолчанию
1180 }
1181 ],
1182 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1183 {
1184 "id": "", ~/~/ ID  задания
1185 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1186 "name": "", ~/~/ Наименование задания
1187 "description": "", ~/~/ Описание задания
1188 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1189 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1190 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1191 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1192 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1193 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1194 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1195 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1196 }
1197 ],
1198 "statusHistory": [ ~/~/ История статусов
1199 {
1200 "status": 0,
1201 "date": "2023-05-22T09:57:39.562Z",
1202 "description": "string",
1203 "additionalInfo": "string"
1204
1205 (((
1206 }
1207 ],
1208 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1209 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1210 )))
1211
1212 (((
1213 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1214 }
1215
1216 )))
1217 )))
1218
1219 (% style="text-align:left" %)
1220 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1221
1222 (% style="text-align:left" %)
1223 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1224
1225
1226 == **Отправить команду на терминал** ==
1227
1228 (% class="box successmessage" %)
1229 (((
1230 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1231 )))
1232
1233 Команда для отправки на тс.
1234
1235 {  
1236 "id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1237 "command": "", ~/~/ Текст отправляемой команды
1238 "retries": "", ~/~/ Количество попыток отправки на терминал
1239 "idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1240 }
1241
1242 В ответ получаем cmdid
1243
1244
1245 == **Получить ответ на отправленную на ТС команду** ==
1246
1247 (% class="box infomessage" %)
1248 (((
1249 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1250 )))
1251
1252 Идентификатор команды: cmdId
1253
1254 Запрос от терминала на ответ команды
1255
1256 Пример ответ от терминала:
1257
1258 ID= "" ~/~/ идентификатор объекта
1259 Soft="" ~/~/ версия софта
1260 GPS=4 ~/~/ тип трекера
1261 Time=11:05:43 28.06.24 ~/~/ время запроса
1262 Lat=45.056221 ~/~/ широта
1263 Lon=39.035938 ~/~/ долгота
1264 Speed=0.0 ~/~/ скорость
1265 Course=181.4 ~/~/направление
1266
1267 (((
1268 == **Список отправленных объекту команд с ответами** ==
1269
1270 (% class="box infomessage" %)
1271 (((
1272 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1273 )))
1274
1275 Идентификатор ТС: vehicleId
1276
1277 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1278
1279 Пример ответа терминала
1280
1281 [ 
1282 {    
1283 "id": "", ~/~/ идентификатор пользователя
1284 "commandText": "", ~/~/Текст команды.
1285 "templateId": "", ~/~/Идентификатор шаблона
1286 "updated": "", ~/~/ Время отправки  
1287 "tryCount": 0, ~/~/ Количество попыток отправки команды
1288 "answer": "", ~/~/ Ответ терминала.
1289 "status": "" ~/~/ Статус отправки
1290 }
1291 ]
1292 )))
1293
1294 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1295
1296 (% class="box successmessage" %)
1297 (((
1298 (% lang="en-US" %)**POST /api/v3/vehicles**
1299 )))
1300
1301 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1302
1303 (% style="color:#000000" %)Метод запроса: **POST**
1304
1305 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1306
1307 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1308
1309 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1310
1311 (% style="color:#000000" %){
1312
1313
1314 (((
1315 "vehicleId": 0, ~/~/ ID ТС
1316 )))
1317
1318 "parentId": "" , ~/~/ ID клиента
1319 "name": "" , ~/~/ имя ТС
1320 "imei": "" , ~/~/ IMEI
1321 "deviceTypeId": "" , ~/~/ ID типа устройства
1322 "modelId": "" , ~/~/ ID модели
1323 "unitId": "" , ~/~/ ID подразделения
1324 "sim1": "" , ~/~/ Номер SIM 1
1325 "sim2": "" , ~/~/ Номер SIM2
1326 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1327 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1328 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1329 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1330 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1331 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1332 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1333 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1334 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1335 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1336 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1337 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1338 "mileageCalcMethod": 0,
1339 "mileageCoeff": 0,
1340 "locationByCellId": true,
1341 "dottedLineTrackWhenNoCoords": true,
1342 "counters": ~/~/ счетчики
1343 {
1344 "mileage": "" , ~/~/ пробег
1345 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1346 "motohours": "" , ~/~/ моточасы
1347 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1348 },
1349 "cmsv6Parameters": { ~/~/ параметры CMSv6
1350 "enabled": true, ~/~/ флаг включения
1351 "id": "" , ~/~/ идентификатор
1352 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1353 "login": "" , ~/~/ имя учетной записи
1354 "password": "" ~/~/ пароль учетной записи
1355 },
1356 "inspectionTasks": ~/~/ задания на ТО
1357 {
1358 "enabled": "" , ~/~/ Признак включения
1359 "name": "" , ~/~/ Имя задания
1360 "description": "" , ~/~/ Описание задания
1361 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1362 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1363 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1364 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1365 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1366 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1367 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1368 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1369 }
1370 "drivers": [ ~/~/ Водители
1371 {
1372 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1373 "isDefault": true
1374 }
1375 ],
1376 "commandTemplates": [ ~/~/ Шаблон команды
1377 {
1378 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1379 "name": "string",
1380 "command": "string",
1381 "retries": 0
1382 }
1383 ],
1384 "sensors": [ ~/~/ Датчики
1385 {
1386 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1387 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1388 "type": 0, ~/~/ Тип датчика
1389 "name": "string", ~/~/ Имя датчика
1390 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1391 "inputNumber": 0, ~/~/ Номер входа
1392 "pseudonym": "string", ~/~/ Псевдоним
1393 "medianDegree": 0, ~/~/ Медианная фильтрация
1394 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1395 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1396 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1397 "gradesTables": [ ~/~/ Массив таблиц тарировки
1398 {
1399 "grades": [ ~/~/ Таблица тарировки 1
1400 {
1401 "input": 0, ~/~/ Входящее значение
1402 "output": 0 ~/~/ Выходящее значение
1403 }
1404 ],
1405 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1406 }
1407 ],
1408 "showInTooltip": true, ~/~/ Отображать в подсказке
1409 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1410 "color": "string", ~/~/ код цвета датчиков
1411 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1412 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1413 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1414 "expr": "string", ~/~/ Формула
1415 "children": [ ~/~/ массив дочерних датчиков
1416 "string"
1417 ],
1418 "customParams": { ~/~/ прочие произвольные параметры
1419 "additionalProp1": "string",
1420 "additionalProp2": "string",
1421 "additionalProp3": "string"
1422 },
1423 ~/~/ Характерные для произвольного:
1424 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1425 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1426 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1427 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1428 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1429 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1430 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1431 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1432 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1433 ~/~/ "ValueOn": "Вкл.",
1434 ~/~/ "ValueOff": "Выкл."
1435 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1436
1437 (((
1438 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1439 {
1440 "from": 0, ~/~/ С какого значения
1441 "color": "string", ~/~/ Каким цветом
1442 "text": "string" ~/~/ Текст подписи к этому интервалу
1443 }
1444 ]
1445 }
1446 ],
1447 )))
1448
1449 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1450
1451
1452 "customFields": [ ~/~/ Произвольные поля
1453 {
1454 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1455 "name": "string", ~/~/ Наименование произвольного поля
1456 "value": "string", ~/~/ Значение произвольного поля
1457 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1458 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1459 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1460
1461 (((
1462 }
1463 ],
1464 "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1465 )))
1466
1467 (((
1468 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1469 }
1470 )))
1471
1472
1473 (% style="color:#000000" %)Ответ:
1474
1475
1476 (((
1477 (((
1478 (((
1479 {
1480 "vehicleId": 0,  ~/~/ ID ТС
1481 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1482 "name": "string", ~/~/ Имя объекта
1483 "imei": "string", ~/~/ IMEI
1484 "deviceTypeId": 0, ~/~/ ID типа устройства
1485 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1486 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1487 "sim1": "string", ~/~/ SIM1
1488 "sim2": "string", ~/~/ SIM2
1489 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1490 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1491 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1492 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1493 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1494 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1495 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1496 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1497 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1498 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1499 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1500 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1501 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1502 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1503 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1504 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1505 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1506 "counters": {  ~/~/ Dto для состояний счётчиков
1507 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1508 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1509 "mileage": 0, ~/~/ Пробег
1510 "motohours": 0 ~/~/ Моточасы
1511 },
1512 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1513 "id": "string", ~/~/ CMSV6 Идентификатор
1514 "enabled": true, ~/~/ Признак включения
1515 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1516 "login": "string", ~/~/ CMSV6 имя учетной записи
1517 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1518 },
1519 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1520 {
1521 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1522 "enabled": true, ~/~/ Признак включения
1523 "name": "string", ~/~/ Имя задания
1524 "description": "string", ~/~/ Описание задания
1525 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1526 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1527 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1528 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1529 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1530 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1531 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1532 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1533 }
1534 ],
1535 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1536 {
1537 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1538 "inputNumber": 0, ~/~/ № входа.
1539 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1540 "comment": "string", ~/~/ Комментарий
1541 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1542 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1543 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1544 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1545 }
1546 ],
1547 "commandTemplates": [  ~/~/ Список шаблонов команд
1548 {
1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1550 "name": "string", ~/~/ Название шаблона команд
1551 "command": "string", ~/~/ Команда на выполнение
1552 "retries": 0 ~/~/ Лимит попыток отправки
1553 }
1554 ],
1555 "sensors": [ ~/~/ Список датчиков
1556 {
1557 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1558 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1559 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1560 "name": "string",  ~/~/ Имя датчика
1561 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1562 "inputNumber": 0, ~/~/ Номер входа
1563 "pseudonym": "string", ~/~/ Псевдоним
1564 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1565 "isInverted": true, ~/~/  Признак инверсии
1566 "disabled": true, ~/~/ Датчик не участвует в обработке
1567 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1568 "gradesTables": [ ~/~/ Тарировка
1569 {
1570 "grades": [ ~/~/ Таблицы тарировки
1571 {
1572 "input": 0, ~/~/ Вход
1573 "output": 0 ~/~/ Выход
1574 }
1575 ],
1576 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1577 }
1578 ],
1579 "showInTooltip": true, ~/~/ Отображение в подсказке
1580 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1581 "color": "string", ~/~/ код цвета датчиков
1582 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1583 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1584 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1585 "expr": "string", ~/~/ Выражение
1586 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1587 "string"
1588 ],
1589 "customParams": {
1590 "additionalProp1": "string",
1591 "additionalProp2": "string",
1592 "additionalProp3": "string"
1593 },
1594 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1595 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1596 {
1597 "from": 0, ~/~/ С какого значения
1598 "color": "string", ~/~/ Каким цветом
1599 )))
1600
1601 (((
1602 "text": "string" ~/~/ Текст подписи к этому интервалу
1603 }
1604 ]
1605 }
1606 ],
1607 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1608 "customFields": [ ~/~/ Список произвольных полей
1609 {
1610 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1611 "name": "string", ~/~/ Наименование произвольного поля
1612 "value": "string", ~/~/ Значение произвольного поля
1613 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1614 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1615 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1616 }
1617 ],
1618 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1619 }
1620 )))
1621 )))
1622 )))
1623
1624
1625 **Валидация:**
1626 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1627 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1629
1630
1631 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1632
1633 (% class="box infomessage" %)
1634 (((
1635 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1636 )))
1637
1638 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1639
1640 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1641
1642 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1643
1644 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1645
1646 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1647
1648 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1649
1650 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1651
1652 (% style="color:#000000" %)Метод запроса: **POST**
1653
1654 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1655
1656 (% style="color:#000000" %)В заголовках запроса:
1657
1658 (% style="color:#000000" %)− Content-Type: __**application/json**__
1659
1660 (% style="color:#000000" %)− X-Auth: Токен авторизации
1661
1662 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1663
1664 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1665
1666 {
1667 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1668 "name": null, ~/~/ Имя ТС (string, опционально)
1669 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1670 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1671 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1672 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1673 "unitName": "string",  ~/~/ Название подразделения (опционально)
1674 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1675 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1676 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1677 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1678 }
1679
1680 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1681
1682 (% style="color:#000000" %)Ответ:
1683
1684 (% style="color:#000000" %)[
1685 {
1686
1687 (((
1688 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1689 )))
1690
1691 (((
1692 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1693 "name": "" ~/~/ наименование объекта
1694 "imei": "" ~/~/ IMEI объекта
1695 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1696 "deviceTypeName": "" ~/~/ наименование типа устройства
1697 "sim1": "" ~/~/ первый номер телефона
1698 "sim2": "" ~/~/ второй номер телефона
1699 "parentId": "" ~/~/ идентификатор клиента-родителя
1700 "parentName": "" ~/~/ наименование клиента-родителя
1701 "modelId": "" ~/~/ идентификатор модели объекта
1702 "modelName": "" ~/~/ наименование модели объекта
1703 "unitId": "" ~/~/ идентификатор подразделения
1704 "unitName": "" ~/~/ наименование подразделения
1705 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1706 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1707 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1708 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1709 "customFields": [ 
1710 {
1711 "id": "", ~/~/ идентификатор произвольного поля
1712 "name": "", ~/~/ имя произвольного поля
1713 "value": "", ~/~/ значение произвольного поля
1714 "forClient": true, ~/~/ право на отображение у клиента
1715 "forTooltip": false, ~/~/ право на отображение в подсказке
1716 "forReport": false ~/~/ право на отображение в отчетах
1717 )))
1718
1719 (((
1720 }
1721 ],
1722 "vehicleGroups": [  ~/~/ Группы ТС
1723 {
1724 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1725 "name": "string" ~/~/ Наименование группы ТС
1726 }
1727 ]
1728 }
1729 ]
1730 )))
1731
1732 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1733
1734 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1735
1736 (% class="box successmessage" %)
1737 (((
1738 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1739 )))
1740
1741 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1742
1743 (% style="color:#000000" %)Метод запроса: **POST**
1744
1745 (% 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}
1746
1747 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1748
1749 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1750
1751 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1752
1753 (% style="color:#000000" %){
1754
1755 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1756 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1757 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1758 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1759 "description": "", ~/~/ Описание
1760 "data": "", ~/~/ Данные
1761 "overwrite": false, ~/~/ Флаг перезаписи
1762 "stage": "", ~/~/ Состояние, может быть null
1763 (% style="color:#000000" %)}
1764
1765 (% style="color:#000000" %)Ответ:
1766
1767 (% style="color:#000000" %){(%%)
1768 "status": "", ~/~/ значение статуса
1769 "date": "", ~/~/ Дата смены статуса 
1770 "description": "", ~/~/ Описание
1771 "data": "", ~/~/ Данные
1772 "overwrite": false, ~/~/ Флаг перезаписи
1773 "stage": "", ~/~/ Состояние
1774 (% style="color:#000000" %) }
1775
1776
1777 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1778
1779 (% class="box warningmessage" %)
1780 (((
1781 (% lang="en-US" %)**PUT /api/v3/vehicles**
1782 )))
1783
1784 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1785
1786 (% style="color:#000000" %)Метод запроса: **PUT**
1787
1788 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1789
1790 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1791
1792 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1793
1794 (% style="color:#000000" %){
1795 "vehicleId": , ~/~/ ID объекта
1796 "parentId": "" , ~/~/ ID клиента
1797 "name": "" , ~/~/ имя ТС
1798 "imei": "" , ~/~/ IMEI
1799 "deviceTypeId": "" , ~/~/ ID типа устройства
1800 "modelId": "" , ~/~/ ID модели
1801 "unitId": "" , ~/~/ ID подразделения
1802 "sim1": "" , ~/~/ Номер SIM 1
1803 "sim2": "" , ~/~/ Номер SIM2
1804 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1805 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1806 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1807 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1808 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1809 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1810 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1811 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1812 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1813 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1814 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1815 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1816
1817 "mileageCalcMethod": 0,
1818 "mileageCoeff": 0,
1819 "locationByCellId": true,
1820 "dottedLineTrackWhenNoCoords": true,
1821 "counters": ~/~/ счетчики
1822 {
1823 "mileage": "" , ~/~/ пробег
1824 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1825 "motohours": "" , ~/~/ моточасы
1826 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1827 },
1828 "cmsv6Parameters": { ~/~/ параметры CMSv6
1829 "enabled": true, ~/~/ флаг включения
1830 "id": "" , ~/~/ идентификатор
1831 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1832 "login": "" , ~/~/ имя учетной записи
1833 "password": "" ~/~/ пароль учетной записи
1834 },
1835 "inspectionTasks": ~/~/ задания на ТО
1836 {
1837 "enabled": "" , ~/~/ Признак включения
1838 "name": "" , ~/~/ Имя задания
1839 "description": "" , ~/~/ Описание задания
1840 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1841 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1842 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1843 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1844 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1845 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1846 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1847 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1848 }
1849
1850 "drivers": [ ~/~/ Водители
1851 {
1852
1853 (((
1854 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1855 "inputNumber": 0, ~/~/ № входа.
1856 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1857 "comment": "string", ~/~/ Комментарий.
1858 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1859 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1860 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1861 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1862 )))
1863
1864 } 
1865 ],
1866 "commandTemplates": [ ~/~/ Шаблон команды
1867 {
1868 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1869 "name": "string",
1870 "command": "string",
1871 "retries": 0
1872 }
1873 ],
1874 "sensors": [ ~/~/ Датчики
1875 {
1876 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1877 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1878 "type": 0, ~/~/ Тип датчика
1879 "name": "string", ~/~/ Имя датчика
1880 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1881 "inputNumber": 0, ~/~/ Номер входа
1882 "pseudonym": "string", ~/~/ Псевдоним
1883 "medianDegree": 0, ~/~/ Медианная фильтрация
1884 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1885 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1886 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1887 "gradesTables": [ ~/~/ Массив таблиц тарировки
1888 {
1889 "grades": [ ~/~/ Таблица тарировки 1
1890 {
1891 "input": 0, ~/~/ Входящее значение
1892 "output": 0 ~/~/ Выходящее значение
1893 }
1894 ],
1895 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1896 }
1897 ],
1898 "showInTooltip": true, ~/~/ Отображать в подсказке
1899 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1900
1901 (((
1902 "color": "string",** ~/~/ **Цвет датчика
1903 )))
1904
1905 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1906 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1907 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1908 "expr": "string", ~/~/ Формула
1909 "children": [ ~/~/ массив дочерних датчиков
1910 "string"
1911 ],
1912 "customParams": { ~/~/ прочие произвольные параметры
1913 "additionalProp1": "string",
1914 "additionalProp2": "string",
1915 "additionalProp3": "string"
1916 },
1917 ~/~/ Характерные для произвольного:
1918 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1919 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1920 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1921 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1922 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1923 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1924 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1925 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1926 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1927 ~/~/ "ValueOn": "Вкл.",
1928 ~/~/ "ValueOff": "Выкл."
1929 "summaryMaxValue": 0 ~/~/ Макс. значение
1930
1931 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1932 {
1933 "from": 0, ~/~/ С какого значения
1934 "color": "string", ~/~/ Каким цветом
1935 "text": "string" ~/~/ Текст подписи к этому интервалу
1936 }
1937 ]
1938 }
1939 ],
1940 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1941
1942 "customFields": [ ~/~/ Произвольные поля
1943 {     
1944 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1945 "name": "string", ~/~/ Наименование произвольного поля
1946 "value": "string", ~/~/ Значение произвольного поля
1947 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1948 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1949 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1950 }
1951
1952 (((
1953 ],
1954 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1955 )))
1956
1957 }
1958
1959
1960 (% style="color:#000000" %)Ответ:
1961
1962 (((
1963 {
1964 "vehicleId": 0, ~/~/ ID ТС
1965 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1966 "name": "string", ~/~/ Имя объекта
1967 "imei": "string", ~/~/ IMEI
1968 "deviceTypeId": 0, ~/~/ ID типа устройства
1969 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1970 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1971 "sim1": "string", ~/~/ SIM1
1972 "sim2": "string", ~/~/ SIM2
1973 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1974 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1975 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1976 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1977 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1978 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1979 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1980 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1981 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1982 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1983 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1984 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1985 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1986 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1987 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1988 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1989 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1990 "counters": { ~/~/ состояний счётчиков
1991 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1992 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1993 "mileage": 0, ~/~/ Пробег
1994 "motohours": 0 ~/~/ Моточасы 
1995 },
1996 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1997 "id": "string", ~/~/ CMSV6 Идентификатор
1998 "enabled": true, ~/~/ Признак включения
1999 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2000 )))
2001
2002
2003 (((
2004 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2005 "login": "string", ~/~/ CMSV6 имя учетной записи
2006 "password": "string" ~/~/ CMSV6 — пароль учетной записи
2007 },
2008 "inspectionTasks": [ ~/~/ Задания на ТО
2009 {
2010 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2011 "enabled": true, ~/~/ Признак включения
2012 "name": "string", ~/~/ Имя задания
2013 "description": "string", ~/~/ Описание задания
2014 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2015 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2016 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2017 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2018 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2019 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2020 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2021 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2022 }
2023 ],
2024 "drivers": [  ~/~/ Список водителей
2025 {
2026 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2027 "inputNumber": 0, ~/~/ № входа.
2028 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2029 "comment": "string", ~/~/ Комментарий.
2030 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2031 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2032 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2033 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2034 }
2035 ],
2036 "commandTemplates": [ ~/~/ Список шаблонов команд
2037 {
2038 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2039 "name": "string", ~/~/ Название шаблона команд
2040 "command": "string", ~/~/ Команда на выполнение
2041 "retries": 0 ~/~/ Лимит попыток отправки
2042 }
2043 ],
2044 "sensors": [  ~/~/ Список датчиков 
2045 {
2046 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2047 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2048 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2049 )))
2050
2051 (((
2052 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2053 )))
2054
2055 (((
2056 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2057 )))
2058
2059 (((
2060 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2061 )))
2062
2063 (((
2064 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2065 )))
2066
2067 (((
2068 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2069 "name": "string", ~/~/ Имя датчика
2070 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2071 )))
2072
2073 (((
2074 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2075 "inputNumber": 0, ~/~/ Номер входа
2076 "pseudonym": "string", ~/~/ Псевдоним
2077 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2078 "isInverted": true, ~/~/ Признак инверсии
2079 "disabled": true, ~/~/ Датчик не участвует в обработке
2080 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2081 "gradesTables": [ ~/~/ Тарировка
2082 {
2083 "grades": [ ~/~/ Таблицы тарировки
2084 {
2085 "input": 0, ~/~/ Вход
2086 "output": 0 ~/~/ Выход
2087 }
2088 ],
2089 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2090 }
2091 ],
2092 "showInTooltip": true, ~/~/ Отображение в подсказке
2093 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2094
2095 (((
2096 "color": "string", ~/~/ цвет уведомлений
2097 )))
2098
2099 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2100 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2101 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2102 "expr": "string", ~/~/ Выражение
2103 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2104 "string" 
2105 ],
2106 "customParams": { ~/~/ Дополнительные настройки
2107 "additionalProp1": "string",
2108 "additionalProp2": "string",
2109 "additionalProp3": "string"
2110 },
2111 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2112 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2113 {
2114 "from": 0, ~/~/ С какого значения
2115 "color": "string", ~/~/ Каким цветом
2116 "text": "string" ~/~/ Текст подписи к этому интервалу
2117 }
2118 ]
2119 }
2120 ],
2121 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2122 "customFields": [ ~/~/ Список произвольных полей
2123 {
2124 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2125 "name": "string", ~/~/ Наименование произвольного поля
2126 "value": "string", ~/~/ Значение произвольного поля
2127 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2128 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2129 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2130 }
2131 ],
2132 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2133 }
2134 )))
2135
2136 **Валидация:**
2137 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2138 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2139 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2140
2141 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2142
2143 (% class="box errormessage" %)
2144 (((
2145 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2146 )))
2147
2148 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2149
2150 (% style="color:#000000" %)Метод запроса: **DELETE**
2151
2152 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2153
2154 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2155
2156 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2157
2158 (% style="text-align:left" %)
2159 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2160
2161 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2162
2163 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2164
2165 (% class="box infomessage" %)
2166 (((
2167 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2168 )))
2169
2170 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2171
2172 (% style="color:#000000" %)Метод запроса: **GET**
2173
2174 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2175
2176 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2177
2178 (% style="color:#000000" %)Ответ:
2179
2180 (% style="color:#000000" %){(%%)
2181 "deviceTypeId" : "", ~/~/ ID типа устройства
2182 "deviceTypeName" : "" ~/~/ Название типа устройства
2183 (% style="color:#000000" %)}
2184
2185 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2186
2187 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2188
2189 (% class="box infomessage" %)
2190 (((
2191 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2192 )))
2193
2194 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2195
2196 (% style="color:#000000" %)Метод запроса: **GET**
2197
2198 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2199
2200 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2201
2202 (% style="color:#000000" %)Ответ:
2203
2204 (% style="color:#000000" %){(%%)
2205 "id": "", ~/~/ ID типа датчика 
2206 "name": "", ~/~/ Название
2207 "description": "", ~/~/ Описание
2208 (% style="color:#000000" %)}
2209
2210 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2211
2212 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2213
2214 (% class="box infomessage" style="text-align: left;" %)
2215 (((
2216 **POST /api/v3/terminalMessages/count**
2217 )))
2218
2219 (% style="text-align: left;" %)
2220 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2221
2222 (% style="text-align: left;" %)
2223 Метод запроса **POST**
2224
2225 (% style="text-align: left;" %)
2226 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2227
2228 (% style="text-align: left;" %)
2229 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2230
2231 (% style="text-align: left;" %)
2232 {
2233 "vehicleIds": [
2234 id ~/~/ здесь передается список идентификаторов объектов
2235 ],
2236 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2237 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2238 }
2239
2240 (% style="text-align: left;" %)
2241 Ответ:
2242
2243 (% style="text-align: left;" %)
2244 [
2245 {
2246 "vehicleId": 0, ~/~/ идентификатор объекта
2247 "count": 0 ~/~/ количество сообщений за период
2248 }
2249 ]
2250
2251 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2252
2253 (% class="box infomessage" style="text-align: left;" %)
2254 (((
2255 **POST /api/v3/terminalMessages/mapping**
2256 )))
2257
2258 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2259
2260 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2261
2262 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2263
2264 {
2265 "protocolType": 0,
2266 "params": ["string"]
2267 }
2268
2269 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2270 |protocolType|ID типа протокола
2271 |params|(((
2272 Массив наименований параметров в сообщении
2273 )))
2274
2275 Ответ:
2276
2277 {
2278 "protocolType": 0,
2279 "mapping": {
2280 "additionalProp1": {
2281 "inputType": 0,
2282 "inputNumber": 0
2283 },
2284 "additionalProp2": {
2285 "inputType": 0,
2286 "inputNumber": 0
2287 }
2288 }
2289 }
2290
2291 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2292 |protocolType|Тип протокола
2293 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2294 |inputNumber|(((
2295 Номер входа
2296 )))
2297
2298 (% class="wikigeneratedid" %)
2299 Перечень 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/]]
2300
2301 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2302
2303 (% class="box infomessage" %)
2304 (((
2305 **POST /api/v3/terminalMessages**
2306 )))
2307
2308 Метод возвращает список сообщений терминала объекта за выбранный период.
2309
2310 (% style="text-align: left;" %)
2311 Метод запроса **POST**
2312
2313 (% style="text-align: left;" %)
2314 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2315
2316 (% style="text-align: left;" %)
2317 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2318
2319 {
2320 "vehicleId": 0, ~/~/ id объекта
2321 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2322 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2323 }
2324
2325 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2326 |vehicleId|ID объекта
2327 |from|Дата и время начала периода запроса
2328 |to|Дата и время окончания периода запроса
2329
2330 Ответ:
2331
2332 [
2333 {
2334 "messages": [
2335 {
2336 "deviceTime": "2023-11-29T07:40:44.052Z",
2337 "serverTime": "2023-11-29T07:40:44.052Z",
2338 "speed": 0,
2339 "altitude": 0,
2340 "latitude": 0,
2341 "longitude": 0,
2342 "satellites": 0,
2343 "course": 0,
2344 "voltage": 0,
2345 "parameters": {
2346 "additionalProp1": "string",
2347 "additionalProp2": "string",
2348 "additionalProp3": "string"
2349 },
2350 "photoCount": 0,
2351 "lbsCorrectedCoords": true,
2352 "protocolType": 0
2353 }
2354 ]
2355 }
2356 ]
2357
2358 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2359 |deviceTime|Время сообщения терминала
2360 |serverTime|Время когда сообщение поступило на сервер
2361 |speed|Скорость
2362 |altitude|Высота над уровнем моря
2363 |latitude|Широта
2364 |longitude|Долгота
2365 |satellites|Кол-во спутников
2366 |course|Курс
2367 |voltage|Бортовое напряжение
2368 |parameters|Список параметров и их значений
2369 |photoCount|Количество фото
2370 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2371 |protocolType|ID типа протокола
2372
2373 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2374
2375 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2376
2377 (% class="box infomessage" %)
2378 (((
2379 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2380 )))
2381
2382 (% style="color:#000000" %)Метод запроса: **POST**
2383
2384 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2385
2386 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2387
2388 (% style="text-align:left" %)
2389 Тело запроса:
2390
2391 {
2392 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2393 "vehicleIds": [0], ~/~/ Список ID объектов
2394 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2395 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2396 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2397 }
2398
2399 Ответ:
2400
2401 [
2402 {
2403 "vehicleId": 0, ~/~/ ID объекта
2404 "name": "string", ~/~/ Имя ТС
2405 "periods": [ ~/~/ Периоды
2406 {
2407 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2408 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2409 "mileage": 0, ~/~/ Пробег за период, километры
2410 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2411 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2412 "motohours": 0, ~/~/ Моточасы за период, секунды
2413 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2414 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2415 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2416
2417 }
2418 ]
2419 }
2420 ]
2421
2422 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2423
2424 (% class="box infomessage" %)
2425 (((
2426 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2427 )))
2428
2429 (% style="color:#000000" %)Метод запроса: **POST**
2430
2431 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2432
2433 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2434
2435 (% style="text-align:left" %)
2436 Тело запроса:
2437
2438 {
2439 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2440 "vehicleIds": [0], ~/~/ Список ID объектов
2441 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2442 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2443 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2444 }
2445
2446 Ответ:
2447
2448 [
2449 {
2450 "vehicleId": 0, ~/~/ ID объекта
2451 "name": "string", ~/~/ Имя ТС
2452 "periods": [ ~/~/ Периоды
2453 {
2454 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2455 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2456 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2457 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2458 "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2459 "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2460 "fuelConsumption": 0, ~/~/ Расход топлива
2461 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2462 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2463
2464 }
2465 ]
2466 }
2467 ]
2468
2469 (% class="box warningmessage" %)
2470 (((
2471 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2472 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2473 )))
2474
2475 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2476
2477 (% class="box infomessage" %)
2478 (((
2479 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2480 )))
2481
2482 (% style="color:#000000" %)Метод запроса: **POST**
2483
2484 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2485
2486 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2487
2488 (% style="text-align:left" %)
2489 Тело запроса:
2490
2491 {
2492 "vehicleIds": [0], ~/~/ Список ID объектов
2493 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2494 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2495 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2496 }
2497
2498 Ответ:
2499
2500 [
2501 {
2502 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2503 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2504 "vehicleId": 0, ~/~/ ID объекта
2505 "name": "string", ~/~/ Имя объекта
2506 "model": "string", ~/~/ Модель объекта
2507 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2508 {
2509 "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2510
2511 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2512 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2513 "valueFuel": 0, ~/~/ Количество
2514 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2515 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2516 }
2517 ]
2518 }
2519 ]
2520
2521
2522 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2523
2524 (% class="box infomessage" %)
2525 (((
2526 **POST /api/v3/vehicles/moveStop**
2527 )))
2528
2529 Метод запроса: **POST**
2530
2531 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2532
2533 В заголовках запроса: X-Auth: Токен авторизации
2534
2535
2536 Тело запроса:
2537
2538 {
2539 "vehicleIds": [ ], ~/~/ Список ID объектов
2540 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2541 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2542 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2543 }
2544
2545 Ответ:
2546
2547 [ 
2548 {
2549 "vehicleId": 0, ~/~/ ID объекта
2550 "vehicleName": "string", ~/~/ Имя объекта
2551 "moves": [ ~/~/ Событие движения
2552 {
2553 "mileage": 0, ~/~/ Пробег, км
2554 "eventId": 0, ~/~/ Идентификатор события
2555 "eventName": "string", ~/~/ Название события
2556 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2557 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2558 "duration": 0 ~/~/ Продолжительность события, секунд
2559 }
2560 ],
2561 "stops": [ ~/~/ События стоянок
2562 {
2563 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2564 "eventId": 0, ~/~/ Идентификатор события
2565 "eventName": "string", ~/~/ Название события
2566 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2567 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2568 "duration": 0 ~/~/ Продолжительность события, секунд
2569 }
2570 ]
2571 }
2572 ]
2573
2574
2575 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2576
2577 (% class="box infomessage" %)
2578 (((
2579 **POST /api/v3/vehicles/getlastdata**
2580 )))
2581
2582 Метод запроса: **POST**
2583
2584 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2585
2586 В заголовках запроса: X-Auth: Токен авторизации
2587
2588
2589 В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2590
2591 Ответ:
2592 {
2593 "vehicleId": 0, ~/~/Идентификатор объекта.
2594 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2595 "vehicleNumber": "string",~/~/Номер объекта.
2596 "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2597 "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2598 "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2599 "speed": 0,~/~/Скорость объекта.
2600 "course": 0,~/~/Курс движения [0;360]
2601 "latitude": 0,~/~/Широта [-90°;90°].
2602 "longitude": 0,~/~/Долгота [-180°;180°].
2603 "address": "string",~/~/Адрес.
2604 "geozones": [ ~/~/Сведения по геозонам.
2605 {
2606 "id": 0,
2607 "name": "string"
2608 }
2609
2610
2611 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2612
2613 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2614
2615 (% class="box infomessage" %)
2616 (((
2617 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2618 )))
2619
2620 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2621
2622 (% style="color:#000000" %)Метод запроса: **POST**
2623
2624 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2625
2626 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2627
2628 (% style="text-align:left" %)
2629 Тело запроса:
2630
2631 (% style="text-align:left" %)
2632 {
2633 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2634 }
2635
2636 (% style="text-align:left" %)
2637 Ответ:
2638
2639 [
2640 {
2641 "id": 0, ~/~/ Идентификатор объекта геозоны
2642 "name": "string", ~/~/ Название объекта геозоны
2643 "type": 0, ~/~/ Тип объекта геозоны
2644 "fname": "string", ~/~/ Имя файла
2645 "parentId": "string", ~/~/ Идентификатор клиента
2646 "radius": 0, ~/~/ Радиус геообъекта
2647 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2648 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2649 "description": "string", ~/~/ Описание
2650 "area": 0, ~/~/ Площадь, м^^2^^
2651 "perimetr": 0, ~/~/ Периметр, м
2652 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2653 }
2654 ]
2655
2656 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2657
2658 (% class="box infomessage" %)
2659 (((
2660 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2661 )))
2662
2663 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2664
2665 (% style="color:#000000" %)Метод запроса: **POST**
2666
2667 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2668
2669 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2670
2671 (% style="text-align:left" %)
2672 Тело запроса:
2673
2674 {
2675 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2676 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2677 "ids": [ ], ~/~/ Массив id объектов
2678 "byTime": 0, ~/~/ Объединение событий по времени 
2679 "byDist": 0, ~/~/ Объединение событий по расстоянию
2680 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2681 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2682 }
2683
2684 Ответ:
2685 [
2686 {
2687 "geozoneId": 0, ~/~/ ID геообъекта
2688 "geozoneName": "string", ~/~/ Название геообъекта
2689 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2690 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2691 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2692 "vehicleId": 0, ~/~/ ID объекта
2693 "vehicleName": "string" ~/~/ Имя объекта
2694 }
2695 ]
2696
2697 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2698
2699 (% class="box infomessage" %)
2700 (((
2701 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2702 )))
2703
2704 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2705
2706 (% style="color:#000000" %)Метод запроса: **POST**
2707
2708 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2709
2710 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2711
2712 (% style="text-align:left" %)
2713 Тело запроса:
2714
2715 {
2716 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2717 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2718 "ids": [ ], ~/~/ Массив id геообъектов
2719 "byTime": 0, ~/~/ Объединение событий по времени 
2720 "byDist": 0, ~/~/ Объединение событий по расстоянию
2721 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2722 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2723 }
2724
2725 Ответ:
2726
2727 [
2728 {
2729 "geozoneId": 0, ~/~/ ID геообъекта
2730 "geozoneName": "string", ~/~/ Название геообъекта
2731 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2732 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2733 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2734 "vehicleId": 0, ~/~/ ID объекта
2735 "vehicleName": "string" ~/~/ Имя объекта
2736 }
2737 ]
2738
2739
2740 == (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2741
2742 (% class="box successmessage" %)
2743 (((
2744 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2745 )))
2746
2747 (% style="color:#000000" %)Метод запроса: **PUT**
2748
2749 Пример запроса:
2750
2751 (((
2752 {
2753 "id": 0,  ~/~/ Идентификатор объекта геозоны
2754 "name": "string",  ~/~/ Наименование объекта геозоны
2755 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2756 "description": "string", ~/~/ Описание объекта геозоны
2757 "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2758 "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2759 "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2760 }
2761 )))
2762
2763
2764 Пример ответа:
2765
2766 200 ~/~/ Success
2767
2768 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2769
2770 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2771
2772 (% class="box infomessage" %)
2773 (((
2774 **POST /api/v3/notifications/find**
2775 )))
2776
2777 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2778
2779 (% style="text-align: left;" %)
2780 Метод запроса **POST**
2781
2782 (% style="text-align: left;" %)
2783 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2784
2785 (% style="text-align: left;" %)
2786 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2787
2788 {
2789 "parentId": "" ~/~/ id клиента
2790 }
2791
2792 Ответ:
2793
2794 [
2795 {
2796 "id": 0, ~/~/ ID уведомления
2797 "name": "string", ~/~/ Название уведомления
2798 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2799 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2800 "userId": "", ~/~/ Пользователь, создавший уведомление
2801 "parentId": "", ~/~/ Идентификатор клиента
2802 "parentName": "string" ~/~/ Имя клиента
2803 }
2804 ]
2805
2806
2807 == (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2808
2809 (% class="box infomessage" %)
2810 (((
2811 **POST /api/v3/notifications**
2812 )))
2813
2814 Метод запроса **POST**
2815
2816 (% style="text-align: left;" %)
2817 (% style="color:#000000" %)Пример запроса
2818
2819 (((
2820 {
2821 "id": 0, ~/~/ ID правила
2822 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2823 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2824 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2825 "name": "string", ~/~/ Имя правила
2826 "active": true, ~/~/ Активность правила
2827 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2828 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2829 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2830 ],
2831 "vehicleIds": [ ~/~/ Список объектов для анализа.
2832 0
2833 ],
2834 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2835 0
2836 ],
2837 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2838 0
2839 ],
2840 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2841 "additionalProp1": "string",  
2842 "additionalProp2": "string",
2843 "additionalProp3": "string"
2844 },
2845 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2846 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2847 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2848 ],
2849 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2850 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2851 "string"
2852 ],
2853 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2854 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2855 {
2856 "id": 0, ~/~/ Идентификатор участника чата.
2857 "info": "string" ~/~/ Дополнительные сведения.
2858 }
2859 ],
2860 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2861 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2862 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2863 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2864 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2865 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2866 "timezone": 0, ~/~/ часовой пояс 
2867 "validity": 0, ~/~/ Срок действия в днях (1-90).
2868 "autoProlongation": true, ~/~/ Автопродление срока действия.
2869 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2870 {
2871 "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2872 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2873 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2874 "additionalProp1": "string",
2875 "additionalProp2": "string",
2876 "additionalProp3": "string"
2877 }
2878 }
2879 ]
2880 }
2881 )))
2882
2883 (((
2884
2885 )))
2886
2887 (((
2888
2889 )))
2890
2891 Ответ:
2892
2893 {
2894 "id": 0, ~/~/ ID правила
2895 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2896 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2897 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2898 "name": "string", ~/~/ Имя правила
2899 "active": true, ~/~/ Активность правила
2900 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2901 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2902 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2903 ],
2904 "vehicleIds": [ ~/~/ Список объектов для анализа.
2905 0
2906 ],
2907 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2908 0
2909 ],
2910 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2911 0
2912 ],
2913 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2914 "additionalProp1": "string",  
2915 "additionalProp2": "string",
2916 "additionalProp3": "string"
2917 },
2918 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2919 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2920 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2921 ],
2922 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2923 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2924 "string"
2925 ],
2926 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2927 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2928 {
2929 "id": 0, ~/~/ Идентификатор участника чата.
2930 "info": "string" ~/~/ Дополнительные сведения.
2931 }
2932 ],
2933 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2934 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2935 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2936 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2937 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2938 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2939 "timezone": 0, ~/~/ часовой пояс 
2940 "validity": 0, ~/~/ Срок действия в днях (1-90).
2941 "autoProlongation": true, ~/~/ Автопродление срока действия.
2942 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2943 {
2944 "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2945 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2946 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2947 "additionalProp1": "string",
2948 "additionalProp2": "string",
2949 "additionalProp3": "string"
2950 }
2951 }
2952 ]
2953 }
2954
2955 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2956
2957 (% class="box infomessage" %)
2958 (((
2959 **GET /api/v3/notifications/{id}**
2960 )))
2961
2962 Метод возвращает данные правил формирования выбранного уведомления.
2963
2964 (% style="text-align: left;" %)
2965 Метод запроса **GET**
2966
2967 (% style="text-align: left;" %)
2968 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2969
2970 (% style="text-align: left;" %)
2971 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2972
2973 (% style="text-align: left;" %)
2974 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2975
2976 (% style="text-align: left;" %)
2977 (% style="color:#000000" %)Ответ:
2978
2979 (% style="text-align: left;" %)
2980 (% style="color:#000000" %){
2981 "id": 0, ~/~/ (%%)id уведомления
2982 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2983 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2984 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2985 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2986 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2987 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2988 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2989 (% style="color:#000000" %) 0
2990 ],
2991 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2992 (% style="color:#000000" %) 0
2993 ],
2994 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2995 (% style="color:#000000" %) 0
2996 ],
2997 "settings": { ~/~/ Список параметров уведомления
2998 "additionalProp1": "string",
2999 "additionalProp2": "string",
3000 "additionalProp3": "string"
3001 },
3002 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3003 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3004 (% style="color:#000000" %) ""
3005 ],
3006 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3007 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
3008 (% style="color:#000000" %) "string"
3009 ],
3010 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
3011 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
3012 (% style="color:#000000" %) {
3013 "id": 0, ~/~/ (%%)Идентификатор участника чата
3014 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
3015 (% style="color:#000000" %) }
3016 ],
3017 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
3018 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
3019 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3020 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
3021 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3022 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
3023 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
3024 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
3025 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
3026 (% style="color:#000000" %)}
3027
3028 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
3029
3030 (% class="box warningmessage" %)
3031 (((
3032 **PUT /api/v3/notifications/**
3033 )))
3034
3035 Метод позволяет отредактировать уведомление.
3036
3037 Метод запроса **PUT**
3038
3039 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
3040
3041 В заголовках запроса: X-Auth: Токен авторизации
3042
3043 Тело запроса:
3044 {
3045 "id": 0, ~/~/ id уведомления
3046 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
3047 "userId": "", ~/~/ Пользователь, создавший уведомление
3048 "parentId": "", ~/~/ Идентификатор клиента
3049 "parentName": "string", ~/~/ Имя клиента
3050 "name": "string", ~/~/ Название уведомления
3051 "active": true, ~/~/ Состояние true - активен, false - деактивирован
3052 "vehicleIds": [ ~/~/ Список id объектов для анализа
3053 0
3054 ],
3055 "geoids": [ ~/~/ Список id геообъектов для анализа
3056 0
3057 ],
3058 "fieldids": [ ~/~/ Список id полей для анализа
3059 0
3060 ],
3061 "settings": { ~/~/ Список параметров уведомления
3062 "additionalProp1": "string",
3063 "additionalProp2": "string",
3064 "additionalProp3": "string"
3065 },
3066 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3067 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3068 ""
3069 ],
3070 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3071 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
3072 "string"
3073 ],
3074 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
3075 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
3076 {
3077 "id": 0, ~/~/ Идентификатор участника чата
3078 "info": "string" ~/~/ Дополнительные сведения
3079 }
3080 ],
3081 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
3082 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
3083 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3084 "kind": 0, ~/~/ Определяет вид уведомления
3085 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3086 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
3087 "timezone": 0, ~/~/ Сдвиг часового пояса
3088 "validity": 0, ~/~/ Срок действия в днях (1-90)
3089 "autoProlongation": true ~/~/ Автопродление срока действия
3090 }
3091
3092 Ответ:
3093
3094 Success
3095
3096
3097 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
3098
3099 (% class="box warningmessage" %)
3100 (((
3101 **PUT** /api/v3/notifications/prolongation
3102 )))
3103
3104 Метод позволяет продлить уведомления.
3105
3106 Метод запроса **PUT**
3107
3108 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
3109
3110 В заголовках запроса: X-Auth: Токен авторизации.
3111
3112 Тело запроса:
3113
3114 [
3115
3116 0
3117
3118 ]
3119
3120 где 0 идентификатор ids.
3121
3122 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
3123
3124 (% class="box errormessage" %)
3125 (((
3126 **DELETE /api/v3/notifications/{id}**
3127 )))
3128
3129 Метод позволяет удалить выбранное уведомление.
3130
3131 Метод запроса **DELETE**
3132
3133 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3134
3135 Передаваемый параметр: {id} - id уведомления
3136
3137 В заголовках запроса: X-Auth: Токен авторизации
3138
3139 Ответ:
3140
3141 Success
3142
3143
3144 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3145
3146 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3147
3148 (% class="box infomessage" %)
3149 (((
3150 **POST /api/v3/Drivers/find**
3151 )))
3152
3153 Передается параметр: parentId - ID клиента-родителя
3154
3155 Ответ:
3156
3157 [
3158 {
3159 "name": "string", ~/~/ Определяет наименование
3160 "description": "string", ~/~/ Определяет описание
3161 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3162 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3163 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3164 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3165 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3166 "deleted": true ~/~/ Признак удаления
3167 }
3168 ]
3169
3170 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3171
3172 (% class="box infomessage" %)
3173 (((
3174 **GET /api/v3/Drivers/{driverGuid}**
3175 )))
3176
3177 Передается параметр: ID водителя
3178
3179 Ответ:
3180
3181 {
3182 "name": "string", ~/~/ Определяет наименование
3183 "description": "string", ~/~/ Определяет описание
3184 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3185 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3186 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3187 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3188 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3189 "deleted": true ~/~/ Признак удаления
3190 }
3191
3192 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3193
3194 (% class="box successmessage" %)
3195 (((
3196 **POST /api/v3/Drivers**
3197 )))
3198
3199 Запрос:
3200
3201 {
3202 "name": "string",
3203 "description": "string",
3204 "hiredate": "2023-06-30T12:50:54.020Z",
3205 "chopdate": "2023-06-30T12:50:54.020Z",
3206 "exclusive": true,
3207 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3208 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3209 "deleted": true
3210 }
3211
3212 Ответ:
3213
3214 {
3215 "name": "string",
3216 "description": "string",
3217 "hiredate": "2023-06-30T12:50:54.051Z",
3218 "chopdate": "2023-06-30T12:50:54.051Z",
3219 "exclusive": true,
3220 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3221 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3222 "deleted": true
3223 }
3224
3225
3226 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3227
3228 (% class="box warningmessage" %)
3229 (((
3230 **PUT /api/v3/Drivers**
3231 )))
3232
3233 Запрос:
3234
3235 {
3236 "name": "string",
3237 "description": "string",
3238 "hiredate": "2023-06-30T12:50:27.910Z",
3239 "chopdate": "2023-06-30T12:50:27.910Z",
3240 "exclusive": true,
3241 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3242 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3243 "deleted": true
3244 }
3245
3246 Ответ:
3247
3248 {
3249 "name": "string",
3250 "description": "string",
3251 "hiredate": "2023-06-30T12:50:27.929Z",
3252 "chopdate": "2023-06-30T12:50:27.929Z",
3253 "exclusive": true,
3254 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3255 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3256 "deleted": true
3257 }
3258
3259
3260 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3261
3262 (% class="box errormessage" %)
3263 (((
3264 **DELETE /api/v3/Drivers/{driverGuid}**
3265 )))
3266
3267 Передается параметр: ID водителя
3268
3269 Ответ:
3270
3271 Success
3272
3273
3274 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3275
3276 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3277
3278 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3279
3280 (% class="box infomessage" %)
3281 (((
3282 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3283 )))
3284
3285 Запрос:
3286
3287 {
3288 "Ids": [
3289 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3290 ],
3291 "BeginTime": "2023-06-30T12:49:04.365Z",
3292 "EndTime": "2023-06-30T12:49:04.365Z"
3293 }
3294
3295 Ответ:
3296
3297 [
3298 {
3299 "VehicleId": 0,
3300 "CreateTime": "2023-06-30T09:52:31.240Z",
3301 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3302 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3303 "BeginTime": "2023-06-30T09:52:31.240Z",
3304 "EndTime": "2023-06-30T09:52:31.240Z"
3305 }
3306 ]
3307
3308
3309 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3310
3311 (% class="box infomessage" %)
3312 (((
3313 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3314 )))
3315
3316 Запрос:
3317
3318 {
3319 "Ids": [
3320 0
3321 ],
3322 "BeginTime": "2023-06-30T12:48:39.419Z",
3323 "EndTime": "2023-06-30T12:48:39.419Z"
3324 }
3325
3326 Ответ:
3327
3328 [
3329 {
3330 "VehicleId": 0,
3331 "CreateTime": "2023-06-30T09:54:01.631Z",
3332 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3333 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3334 "BeginTime": "2023-06-30T09:54:01.631Z",
3335 "EndTime": "2023-06-30T09:54:01.631Z"
3336 }
3337 ]
3338
3339
3340 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3341
3342 (% class="box successmessage" %)
3343 (((
3344 **POST /api/v3/DriversVehiclesAssignments**
3345 )))
3346
3347 Передается массив назначений
3348
3349 Запрос:
3350
3351 [
3352 {
3353 "VehicleId": 0, ~/~/ Идентификатор объекта
3354 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3355 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3356 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3357 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3358 }
3359 ]
3360
3361 Ответ:
3362
3363 [
3364 {
3365 "VehicleId": 0,
3366 "CreateTime": "2023-06-30T11:04:46.903Z",
3367 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3368 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3369 "BeginTime": "2023-06-30T11:04:46.903Z",
3370 "EndTime": "2023-06-30T11:04:46.903Z"
3371 }
3372 ]
3373
3374
3375 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3376
3377 (% class="box warningmessage" %)
3378 (((
3379 **PUT /api/v3/DriversVehiclesAssignments**
3380 )))
3381
3382 Запрос:
3383
3384 [
3385 {
3386 "VehicleId": 0,
3387 "CreateTime": "2023-06-30T11:14:08.117Z",
3388 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3389 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3390 "BeginTime": "2023-06-30T11:14:08.117Z",
3391 "EndTime": "2023-06-30T11:14:08.117Z"
3392 }
3393 ]
3394
3395 Ответ:
3396
3397 [
3398 {
3399 "VehicleId": 0,
3400 "CreateTime": "2023-06-30T11:14:53.349Z",
3401 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3402 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3403 "BeginTime": "2023-06-30T11:14:53.349Z",
3404 "EndTime": "2023-06-30T11:14:53.349Z"
3405 }
3406 ]
3407
3408
3409 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3410
3411 (% class="box errormessage" %)
3412 (((
3413 **DELETE /api/v3/DriversVehiclesAssignments**
3414 )))
3415
3416 Запрос:
3417
3418 [
3419 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3420 ]
3421
3422 Ответ:
3423
3424 Success
3425
3426
3427 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3428
3429 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3430
3431 (% class="box infomessage" %)
3432 (((
3433 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3434 )))
3435
3436 Запрос:
3437
3438 {
3439 "Ids": [
3440 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3441 ],
3442 "BeginTime": "2023-06-30T12:47:12.162Z",
3443 "EndTime": "2023-06-30T12:47:12.162Z"
3444 }
3445
3446 Ответ:
3447
3448 [
3449 {
3450 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3451 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3452 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3453 "BeginTime": "2023-06-30T11:19:40.703Z",
3454 "EndTime": "2023-06-30T11:19:40.703Z"
3455 }
3456 ]
3457
3458
3459 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3460
3461 (% class="box infomessage" %)
3462 (((
3463 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3464 )))
3465
3466 Запрос:
3467
3468 {
3469 "Ids": [
3470 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3471 ],
3472 "BeginTime": "2023-06-30T12:47:12.162Z",
3473 "EndTime": "2023-06-30T12:47:12.162Z"
3474 }
3475
3476 Ответ:
3477
3478 [
3479 {
3480 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3481 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3482 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3483 "BeginTime": "2023-06-30T11:19:40.703Z",
3484 "EndTime": "2023-06-30T11:19:40.703Z"
3485 }
3486 ]
3487
3488
3489 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3490
3491 (% class="box successmessage" %)
3492 (((
3493 **POST /api/v3/DriversRfidsAssignments**
3494 )))
3495
3496 Запрос:
3497
3498 [
3499 {
3500 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3501 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3502 "BeginTime": "2023-06-30T11:27:08.635Z",
3503 "EndTime": "2023-06-30T11:27:08.635Z"
3504 }
3505 ]
3506
3507 Ответ:
3508
3509 [
3510 {
3511 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3512 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3513 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3514 "BeginTime": "2023-06-30T11:27:08.677Z",
3515 "EndTime": "2023-06-30T11:27:08.677Z"
3516 }
3517 ]
3518
3519
3520 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3521
3522 (% class="box warningmessage" %)
3523 (((
3524 **PUT /api/v3/DriversRfidsAssignments**
3525 )))
3526
3527 Запрос:
3528
3529 [
3530 {
3531 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3532 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3533 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3534 "BeginTime": "2023-06-30T11:28:43.330Z",
3535 "EndTime": "2023-06-30T11:28:43.330Z"
3536 }
3537 ]
3538
3539 Ответ:
3540
3541 [
3542 {
3543 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3544 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3545 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3546 "BeginTime": "2023-06-30T11:28:43.331Z",
3547 "EndTime": "2023-06-30T11:28:43.331Z"
3548 }
3549 ]
3550
3551
3552 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3553
3554 (% class="box errormessage" %)
3555 (((
3556 **DELETE /api/v3/DriversRfidsAssignments**
3557 )))
3558
3559 Запрос:
3560
3561 [
3562 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3563 ]
3564
3565 Ответ:
3566
3567 Success
3568
3569
3570 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3571
3572 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3573
3574 (% class="box infomessage" %)
3575 (((
3576 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3577 )))
3578
3579 Запрос:
3580
3581 {
3582 "Ids": [
3583 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3584 ],
3585 "BeginTime": "2023-06-30T12:45:10.852Z",
3586 "EndTime": "2023-06-30T12:45:10.852Z"
3587 }
3588
3589 Ответ:
3590
3591 [
3592 {
3593 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3594 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3595 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3596 "BeginTime": "2023-06-30T11:58:04.695Z",
3597 "EndTime": "2023-06-30T11:58:04.695Z"
3598 }
3599 ]
3600
3601
3602 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3603
3604 (% class="box infomessage" %)
3605 (((
3606 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3607 )))
3608
3609 Запрос:
3610
3611 {
3612 "Ids": [
3613 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3614 ],
3615 "BeginTime": "2023-06-30T12:45:10.852Z",
3616 "EndTime": "2023-06-30T12:45:10.852Z"
3617 }
3618
3619 Ответ:
3620
3621 [
3622 {
3623 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3624 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3625 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3626 "BeginTime": "2023-06-30T11:58:04.695Z",
3627 "EndTime": "2023-06-30T11:58:04.695Z"
3628 }
3629 ]
3630
3631
3632 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3633
3634 (% class="box successmessage" %)
3635 (((
3636 **POST /api/v3/DriversFuelCardsAssignments**
3637 )))
3638
3639 Запрос:
3640
3641 [
3642 {
3643 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3644 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3645 "BeginTime": "2023-06-30T12:09:53.175Z",
3646 "EndTime": "2023-06-30T12:09:53.175Z"
3647 }
3648 ]
3649
3650 Ответ:
3651
3652 [
3653 {
3654 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3655 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3656 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3657 "BeginTime": "2023-06-30T12:09:53.201Z",
3658 "EndTime": "2023-06-30T12:09:53.201Z"
3659 }
3660 ]
3661
3662
3663 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3664
3665 (% class="box warningmessage" %)
3666 (((
3667 **PUT /api/v3/DriversFuelCardsAssignments**
3668 )))
3669
3670 Запрос:
3671
3672 [
3673 {
3674 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3675 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3676 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3677 "BeginTime": "2023-06-30T12:09:53.201Z",
3678 "EndTime": "2023-06-30T12:09:53.201Z"
3679 }
3680 ]
3681
3682 Ответ:
3683
3684 [
3685 {
3686 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3687 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3688 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3689 "BeginTime": "2023-06-30T12:09:53.201Z",
3690 "EndTime": "2023-06-30T12:09:53.201Z"
3691 }
3692 ]
3693
3694
3695 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3696
3697 (% class="box errormessage" %)
3698 (((
3699 **DELETE /api/v3/DriversFuelCardsAssignments**
3700 )))
3701
3702 Запрос:
3703
3704 [
3705 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3706 ]
3707
3708 Ответ:
3709
3710 Success
3711
3712
3713 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3714
3715 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3716
3717 (% class="box infomessage" %)
3718 (((
3719 **POST /api/v3/Trailers**
3720 )))
3721
3722 Пример запроса:
3723
3724 {
3725 "startDate": "2023-11-14T10:48:03.671Z",
3726 "endDate": "2023-11-14T10:48:03.671Z",
3727 "ids": [ 0 ],
3728 "timezone": 0
3729 }
3730
3731 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3732 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3733 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3734 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3735 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3736
3737 Пример ответа:
3738
3739 [
3740 {
3741 "SD": "2023-11-14T10:48:03.717Z",
3742 "ED": "2023-11-14T10:48:03.717Z", 
3743 "id": 0,
3744 "SLat": 0,
3745 "SLon": 0,
3746 "ELat": 0,
3747 "ELon": 0,
3748 "mileage": 0
3749 "Duration": 0
3750 "Address": "string",
3751 "Address2": "string",
3752 "name": "string",
3753 "rid": "string",
3754 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3755 "trailer": {
3756 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3757 "Number": "string",
3758 "Description": "string",
3759 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3760 "ExternalID": "string",
3761 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3762 "CreateTime": "2023-11-14T10:48:03.717Z",
3763 "UpdateTime": "2023-11-14T10:48:03.717Z",
3764 "IsDeleted": true
3765 },
3766 "filesCount": 0,
3767 }
3768 ]
3769
3770 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3771 |SD|Дата и время начала события
3772 |ED|Дата и время окончания события
3773 |id|ID объекта
3774 |SLat|Широта начальной координаты
3775 |SLon|Долгота начальной координаты
3776 |ELat|Широта конечной координаты
3777 |ELon|Долгота конечной координаты
3778 |mileage|Пробег
3779 |Duration|Продолжительность
3780 |Address|Адрес начального местоположения
3781 |Address2|Адрес конечного местоположения
3782 |name|Имя радиометки
3783 |rid|Номер радиометки
3784 |rguid|ID радиометки
3785 |trailer|Информация об агрегате
3786 |ModelGuid|ID агрегата
3787 |Number|Название/номер агрегата
3788 |Description|Текст примечания агрегата
3789
3790 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3791
3792 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3793
3794 (% class="box infomessage" %)
3795 (((
3796 **POST /api/v3/Rfids/find**
3797 )))
3798
3799 Запрос:
3800
3801 {
3802 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3803 }
3804
3805 Ответ:
3806
3807 [
3808 {
3809 "name": "string",
3810 "number": 0,
3811 "period": 0,
3812 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3813 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3814 }
3815 ]
3816
3817 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3818 |parentId|ID клиента
3819 |name|Название карты-метки
3820 |number|Номер
3821 |period|Период запросов в секундах (работает только для агрегатов)
3822 |id|ID карты-метки
3823
3824 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3825
3826 (% class="box infomessage" %)
3827 (((
3828 **GET /api/v3/Rfids/{rfidGuid}**
3829 )))
3830
3831 Передаем параметр rfidGuid - идентификатор карты-метки
3832
3833 Ответ:
3834
3835 [
3836 {
3837 "name": "string",
3838 "number": 0,
3839 "period": 0,
3840 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3841 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3842 }
3843 ]
3844
3845 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3846 |name|Название карты-метки
3847 |number|Номер
3848 |period|Период запросов в секундах (работает только для агрегатов)
3849 |id|ID карты-метки
3850 |parentId|ID клиента
3851
3852 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3853
3854 (% class="box successmessage" %)
3855 (((
3856 **POST /api/v3/Rfids**
3857 )))
3858
3859 Запрос:
3860
3861 {
3862 "name": "string",
3863 "number": 0,
3864 "period": 0,
3865 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3866 }
3867
3868 Ответ:
3869
3870 {
3871 "name": "string",
3872 "number": 0,
3873 "period": 0,
3874 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3875 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3876 }
3877
3878 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3879 |name|Название карты-метки
3880 |number|Номер
3881 |period|Период запросов в секундах (работает только для агрегатов)
3882 |id|ID карты-метки
3883 |parentId|ID клиента
3884
3885 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3886
3887 (% class="box warningmessage" %)
3888 (((
3889 **PUT /api/v3/Rfids**
3890 )))
3891
3892 Запрос:
3893
3894 {
3895 "name": "string",
3896 "number": 0,
3897 "period": 0,
3898 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3899 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3900 }
3901
3902 Ответ:
3903
3904 {
3905 "name": "string",
3906 "number": 0,
3907 "period": 0,
3908 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3909 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3910 }
3911
3912 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3913 |name|Название карты-метки
3914 |number|Номер
3915 |period|Период запросов в секундах (работает только для агрегатов)
3916 |id|ID карты-метки
3917 |parentId|ID клиента
3918
3919 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3920
3921 (% class="box errormessage" %)
3922 (((
3923 **DELETE /api/v3/Rfids/{rfidGuid}**
3924 )))
3925
3926 Передаем параметр **rfidGuid** - идентификатор карты-метки
3927
3928 Ответ:
3929
3930 Success
3931
3932
3933 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3934
3935 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3936
3937 (% class="box infomessage" %)
3938 (((
3939 **GET /api/v3/Billing/client/balance/{clientId}**
3940 )))
3941
3942 Параметр запроса: **clientId **- идентификатор клиента.
3943
3944 Ответ:
3945
3946 {
3947 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3948 "Balance": 0
3949 }
3950
3951 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3952 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3953 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3954
3955 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3956
3957 (% class="box infomessage" %)
3958 (((
3959 **GET /api/v3/Billing/client/constraint/{clientId}**
3960 )))
3961
3962 Параметр запроса: **clientId **- идентификатор клиента.
3963
3964 Ответ:
3965
3966 {
3967 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3968 "CalculationType": 0,
3969 "PermissibleBalance": 0,
3970 "DefermentDays": 0,
3971 "SendUiNotifications": true,
3972 "SendEmailNotifications": true,
3973 "IsPrivate": true,
3974 }
3975
3976 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3977 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3978 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3979 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3980 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3981 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3982 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3983 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3984
3985 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3986
3987 (% class="box infomessage" %)
3988 (((
3989 **GET /api/v3/Billing/client/plan/{clientId}**
3990 )))
3991
3992 Параметры запроса:
3993
3994 **clientId **- идентификатор клиента.
3995
3996 **planId **- идентификатор тарифного плана.
3997
3998 Ответ:
3999
4000 {
4001 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4002 "Plan": { **~/~/ Описание тарифного плана**
4003 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4004 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4005 "Name": "string",
4006 "IsArchived": true,
4007 "Constraint": {
4008 "CalculationType": 0,
4009 "PermissibleBalance": 0,
4010 "DefermentDays": 0
4011 },
4012 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
4013 {
4014 "Feature": "string",
4015 "IsFactual": true,
4016 "Limit": 0,
4017 "Price": 0,
4018 "PeriodValue": 0,
4019 "PeriodType": 0
4020 }
4021 ]
4022 },
4023 "DebitDate": "2023-10-18T12:46:24.213Z",
4024 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
4025 {
4026 "Feature": "string",
4027 "IsEnabled": true,
4028 "IsPrivate": true,
4029 "IsFactual": true,
4030 "Limit": 0,
4031 "Price": 0,
4032 "DebitDate": "2023-10-18T12:46:24.213Z",
4033 "PeriodValue": 0,
4034 "PeriodType": 0
4035 }
4036 ]
4037 }
4038
4039 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4040 |ClientId|Идентификатор клиента
4041 |Id|Идентификатор тарифного плана
4042 |OwnerId|Идентификатор клиента-владельца
4043 |Name|Наименование тарифного плана
4044 |IsArchived|Признак, определяющий архивный тарифный план
4045 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4046 |PermissibleBalance|Допустимый баланс
4047 |DefermentDays|Отсрочка, количество дней
4048 |Feature|Код услуги
4049 |IsEnabled|Признак, определяющий активирована ли услуга
4050 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4051 |IsFactual|Признак, определяющий расчёт по факту
4052 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4053 |Price|Цена за единицу.
4054 |DebitDate|Следующий момент времени списания с баланса за услугу.
4055 |PeriodValue|Значение периода.
4056 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4057
4058 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
4059
4060 (% class="box infomessage" %)
4061 (((
4062 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4063 )))
4064
4065 Параметр запроса: **clientId **- идентификатор клиента.
4066
4067 Ответ:
4068
4069 [
4070 {
4071 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4072 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4073 "Name": "string",
4074 "IsArchived": true,
4075 "Constraint": {
4076 "CalculationType": 0,
4077 "PermissibleBalance": 0,
4078 "DefermentDays": 0
4079 },
4080 "Features": [
4081 {
4082 "Feature": "string",
4083 "IsFactual": true,
4084 "Limit": 0,
4085 "Price": 0,
4086 "PeriodValue": 0,
4087 "PeriodType": 0
4088 }
4089 ]
4090 }
4091 ]
4092
4093 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4094 |ClientId|Идентификатор клиента
4095 |Id|Идентификатор тарифного плана
4096 |OwnerId|Идентификатор клиента-владельца
4097 |Name|Наименование тарифного плана
4098 |IsArchived|Признак, определяющий архивный тарифный план
4099 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4100 |PermissibleBalance|Допустимый баланс
4101 |DefermentDays|Отсрочка, количество дней
4102 |Feature|Код услуги
4103 |IsFactual|Признак, определяющий расчёт по факту
4104 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4105 |Price|Цена за единицу.
4106 |PeriodValue|Значение периода.
4107 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4108
4109 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
4110
4111 (% class="box infomessage" %)
4112 (((
4113 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4114 )))
4115
4116 Параметр запроса: **clientId **- идентификатор клиента.
4117
4118 Ответ:
4119
4120 [
4121 {
4122 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4123 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4124 "Name": "string",
4125 "IsArchived": true,
4126 "Constraint": {
4127 "CalculationType": 0,
4128 "PermissibleBalance": 0,
4129 "DefermentDays": 0
4130 },
4131 "Features": [
4132 {
4133 "Feature": "string",
4134 "IsFactual": true,
4135 "Limit": 0,
4136 "Price": 0,
4137 "PeriodValue": 0,
4138 "PeriodType": 0
4139 }
4140 ]
4141 }
4142 ]
4143
4144 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4145 |ClientId|Идентификатор клиента
4146 |Id|Идентификатор тарифного плана
4147 |OwnerId|Идентификатор клиента-владельца
4148 |Name|Наименование тарифного плана
4149 |IsArchived|Признак, определяющий архивный тарифный план
4150 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4151 |PermissibleBalance|Допустимый баланс
4152 |DefermentDays|Отсрочка, количество дней
4153 |Feature|Код услуги
4154 |IsFactual|Признак, определяющий расчёт по факту
4155 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4156 |Price|Цена за единицу.
4157 |PeriodValue|Значение периода.
4158 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4159
4160 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4161
4162 (% class="box warningmessage" %)
4163 (((
4164 **PUT /api/v3/Billing/client/balance**
4165 )))
4166
4167 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4168
4169 Тело запроса:
4170
4171 {
4172 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4173 "Balance": 0
4174 }
4175
4176 Ответ: Success
4177
4178 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4179 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4180 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4181
4182 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4183
4184 (% class="box warningmessage" %)
4185 (((
4186 **PUT /api/v3/billing/client/balance/deposit**
4187 )))
4188
4189 Создает операцию **Пополнение **с указанной суммой
4190
4191 Тело запроса:
4192
4193 {
4194 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4195 "Balance": 0
4196 }
4197
4198 Ответ: Success
4199
4200 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4201 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4202 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4203
4204 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4205
4206 Создает операцию **Списание **с указанной суммой
4207
4208 (% class="box warningmessage" %)
4209 (((
4210 **PUT /api/v3/billing/client/balance/withdraw**
4211 )))
4212
4213 Тело запроса:
4214
4215 {
4216 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4217 "Balance": 0
4218 }
4219
4220 Ответ: Success
4221
4222 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4223 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4224 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4225
4226 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4227
4228 (% class="box warningmessage" %)
4229 (((
4230 **PUT /api/v3/Billing/client/constraint**
4231 )))
4232
4233 Тело запроса:
4234
4235 {
4236 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4237 "CalculationType": 0,
4238 "PermissibleBalance": 0,
4239 "DefermentDays": 0,
4240 "SendUiNotifications": true,
4241 "SendEmailNotifications": true,
4242 "IsPrivate": true,
4243 }
4244
4245 Ответ: Success
4246
4247 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4248 |ClientId|Идентификатор клиента
4249 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4250 |PermissibleBalance|Допустимый баланс
4251 |DefermentDays|(((
4252 Отсрочка, количество дней
4253 )))
4254 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4255 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4256 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4257
4258 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4259
4260 (% class="box warningmessage" %)
4261 (((
4262 **PUT /api/v3/Billing/client/plan**
4263 )))
4264
4265 Тело запроса:
4266
4267 {
4268 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4269 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4270 "Features": [
4271 {
4272 "Feature": "string",
4273 "IsEnabled": true,
4274 "IsFactual": true,
4275 "Limit": 0,
4276 "Price": 0,
4277 "DebitDate": "2023-10-18T13:26:58.987Z",
4278 "PeriodValue": 0,
4279 "PeriodType": 0
4280 }
4281 ]
4282 }
4283
4284 Ответ: Success
4285
4286 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4287 |ClientId|Идентификатор клиента
4288 |PlanId|Идентификатор тарифного плана
4289 |Feature|Код услуги
4290 |IsEnabled|Признак, определяющий активирована ли услуга
4291 |IsFactual|Признак, определяющий расчёт по факту
4292 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4293 |Price|Цена за единицу.
4294 |DebitDate|Следующий момент времени списания с баланса за услугу.
4295 |PeriodValue|Значение периода.
4296 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4297
4298 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4299
4300 (% class="box warningmessage" %)
4301 (((
4302 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4303 )))
4304
4305 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4306
4307 (% class="box infomessage" %)
4308 (((
4309 **POST /api/v3/vehicles/import/{agentId}**
4310 )))
4311
4312 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4313
4314 В пути указывается **agentId** - id клиента.
4315
4316 **Заголовок**
4317
4318 **X-Auth: [токен авторизации]**
4319
4320 **Параметры**
4321
4322 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4323 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4324 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4325
4326 В теле использовать тип **form-data,** тип значения** file**
4327
4328 **Ключи**
4329
4330 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4331 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4332 |csv|В значении передаем файл датчиков, формат **csv**
4333
4334 Ответ:
4335
4336 {
4337 "vehicleId": 0,
4338 "name": "string",
4339 "errors": ["string"]
4340 }
4341
4342 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4343 |vehicleId|ID созданного объекта
4344 |name|Имя созданного объекта
4345 |errors|Ошибки и их описание
4346
4347 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4348
4349 (% class="box infomessage" %)
4350 (((
4351 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4352 )))
4353
4354 (% class="wikigeneratedid" %)
4355 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4356
4357 (% class="wikigeneratedid" %)
4358 В пути указывается **vehicleId **- id объекта.
4359
4360 **Заголовок**
4361
4362 **X-Auth: [токен авторизации]**
4363
4364 В теле использовать тип **form-data.**
4365
4366 Ключи:
4367
4368 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4369 |**history**|В значении передавать файл с историей
4370
4371 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4372
4373 Ответ:
4374
4375 {
4376 "results": [
4377 {
4378 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4379 "vehicleId": 0,
4380 "errors": [
4381 "string"
4382 ],
4383 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4384 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4385 "producedCount": 0,
4386 "msgCount": 0
4387 }
4388 ]
4389 }
4390
4391 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4392 |results|Результаты импорта в разрезе ТС
4393 |vehicleGuid|Guid ТС
4394 |vehicleId|ID ТС
4395 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4396 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4397 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4398 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4399 |msgCount|Кол-во обработанных сообщений всего
4400
4401 == **Импортировать историю ТС (Асинхронный запрос)** ==
4402
4403 (% class="box successmessage" %)
4404 (((
4405 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4406 )))
4407
4408 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4409
4410 Метод запроса: **POST**
4411
4412 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4413
4414 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4415
4416
4417 Ответ:
4418
4419 {
4420
4421 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4422
4423 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4424
4425 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4426
4427 "Message": "string", ~/~/ Информация о выполнении запроса
4428
4429 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4430
4431 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4432
4433 "Data": "string" ~/~/ Данные
4434
4435 }
4436
4437
4438 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4439
4440 (% class="box infomessage" %)
4441 (((
4442 **GET /api/v3/vehicles/import/history/status**
4443 )))
4444
4445 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4446
4447 Ответ:
4448
4449 {
4450 "activity": true,
4451 "progress": 0,
4452 "message": "string"
4453 }
4454
4455 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4456 **Параметр**
4457 )))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4458 **Описание**
4459 )))
4460 |(((
4461 activity
4462 )))|(((
4463 Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4464 )))
4465 |(((
4466 progress
4467 )))|(((
4468 Guid ТС
4469 )))
4470
4471 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
4472
4473 (% class="box infomessage" %)
4474 (((
4475 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4476 )))
4477
4478 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4479
4480 Метод запроса: **GET**
4481
4482 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4483
4484 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4485
4486
4487 Ответ:
4488
4489 {
4490
4491 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4492
4493 "Status": 0, ~/~/ Перечисление состояний выполения запроса
4494 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4495
4496 "Message": "string", ~/~/ Информация о выполнении запроса
4497
4498 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4499
4500 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4501
4502 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4503
4504 "Data": "string" ~/~/ Данные
4505
4506 }
4507
4508 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4509
4510 (% class="box infomessage" %)
4511 (((
4512 **POST /api/v3/vehicles/export**
4513 )))
4514
4515 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4516
4517 Тело запроса:
4518
4519 [
4520 id
4521 ]
4522
4523 Ответ: Success 200, получаете файлы с настройками.
4524
4525 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4526
4527 (% class="box infomessage" %)
4528 (((
4529 **POST /api/v3/vehicles/export/history**
4530 )))
4531
4532 Метод возвращает список сообщений терминала объекта за выбранный период.
4533
4534 Тело запроса:
4535
4536 {
4537 "vehicleId": 0,
4538 "asArchive": true,
4539 "from": "2023-09-27T12:17:45.973Z",
4540 "to": "2023-09-27T12:17:45.973Z"
4541 }
4542
4543 Ответ:
4544
4545 Получаете файл. Сообщение: Code 200/Success
4546
4547 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4548 |vehicleId|ID объекта
4549 |asArchive|true - Архивировать файл, False - не архивировать
4550 |from|Дата и время начала запроса
4551 |to|Дата и время окончания запроса
4552
4553 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4554
4555 (% class="box infomessage" %)
4556 (((
4557 **GET /api/v3/vehicles/export/history/status**
4558 )))
4559
4560 Метод возвращает список сообщений терминала объекта за выбранный период.
4561
4562 Ответ:
4563
4564 {
4565 "activity": true,
4566 "progress": 0,
4567 "message": "string"
4568 }
4569
4570 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4571 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4572 |progress|Прогресс экспорта, от 0 до 100%
4573 |message|Текст описывающий статус
4574
4575 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4576
4577 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4578
4579 (% class="box infomessage" %)
4580 (((
4581 **POST /api/v3/EcoDriving/rating**
4582 )))
4583
4584 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4585
4586 Тело запроса:
4587
4588 {
4589 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4590 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4591 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4592 }
4593
4594 Ответ:
4595
4596 {
4597 "items": [  ~/~/ Список в разрезе ТС
4598 {
4599 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4600 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4601 "vehicleId": 0, ~/~/ ID ТС
4602 "vehicleName": "string", ~/~/ Название ТС
4603 "vehicleModel": "string", ~/~/ Модель ТС
4604 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4605 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4606 "totalViolations": 0, ~/~/ Нарушений всего
4607 "violationsByType": { ~/~/ Информация о нарушениях по типу
4608 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4609 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4610 "brakingViolations": 0, ~/~/ Нарушений торможения
4611 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4612 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4613 "sensorViolations": 0 ~/~/ Нарушений по датчику
4614 },
4615
4616 (((
4617
4618 )))
4619
4620 "moveTime": 0, ~/~/ Продолжительность движения, сек
4621 "mileage": 0, ~/~/ Пробег, м
4622 "tripsCount": 0, ~/~/ Кол-во рейсов
4623 "trips": [  ~/~/ Информация по рейсу
4624 {
4625 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4626 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4627 "violationsCount": 0, ~/~/ Всего нарушений
4628 "violationsByType": { ~/~/ Информация о нарушениях по типу
4629 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4630 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4631 "brakingViolations": 0, ~/~/ Нарушений торможения
4632 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4633 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4634 "sensorViolations": 0 ~/~/ Нарушений по датчику
4635 },
4636
4637 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4638 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4639 "moveTime": 0, ~/~/ Продолжительность движения, сек
4640 "mileage": 0, ~/~/ Пробег, м
4641 "motohours": 0, ~/~/ Моточасы, секунды
4642 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4643 "startAddress": "string", ~/~/ Адрес начала рейса
4644 "endAddress": "string", ~/~/ Адрес конца рейса
4645 "drivers": [  ~/~/ Список водителей
4646 {
4647 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4648 "driverName": "string", ~/~/ФИО водителя
4649 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4650 }
4651 ]
4652 }
4653 ]
4654 }
4655 ]
4656 }
4657
4658 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4659
4660 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4661
4662 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4663
4664 (% class="box infomessage" %)
4665 (((
4666 **POST /api/v3/fuelcards/transactions**
4667 )))
4668
4669 Метод запроса: POST
4670
4671 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4672 \\В заголовках запроса: X-Auth: Токен авторизации
4673
4674 Параметры в теле запроса (JSON):
4675
4676 {
4677 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4678 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4679 "ids": [ 
4680 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4681 ],
4682 "timezone": 0 ~/~/ Часовой пояс
4683 }
4684
4685
4686 Ответ:
4687 {
4688 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4689 "driver": "string", ~/~/ Водители, привязанные к ТК
4690 "object": "string", ~/~/ Наименование ТС
4691 "amount": 0, ~/~/ Количество топлива
4692 "amountDut": 0, ~/~/ Количество по ДУТ
4693 "amountDiff": 0, ~/~/ Разница, л
4694 "amountDiffPerc": 0, ~/~/ Разница, %
4695 "summa": 0, ~/~/ Стоимость, руб
4696 "serviceName": "string", ~/~/ Тип топлива
4697 "price": 0, ~/~/ Цена за литр, руб
4698 "cardName": "string", ~/~/ Наименование ТК
4699 "cardNum": "string", ~/~/ Номер ТК
4700 "operator": "string", ~/~/ Оператор ТК
4701 "address": "string" ~/~/ Адрес АЗС
4702 }
4703
4704 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4705
4706 (% class="box infomessage" %)
4707 (((
4708 **GET /api/v3/fuelcards**
4709 )))
4710
4711 Метод запроса: GET
4712
4713 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4714
4715 Ответ:
4716
4717 [
4718 {
4719 "Name": "string", ~/~/ Определяет наименование карты.
4720 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4721 "Number": "string", ~/~/ Определяет № карты.
4722 "Enabled": true, ~/~/ Определяет признак активности карты.
4723 "Description": "string", ~/~/ Определяет описание карты.
4724 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4725 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4726 "deleted": true ~/~/ Признак удаления
4727 }
4728 ]
4729
4730 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4731
4732
4733 == **Получение полных данных о ретрансляторе** ==
4734
4735 (% class="box infomessage" %)
4736 (((
4737 **GET ** **/api/v3/retranslations/{id}**
4738 )))
4739
4740 id - Идентификатор ретранслятора
4741
4742
4743 Пример ответа:
4744
4745 {  
4746 "description": "", ~/~/ Поле описания ретранслятора
4747 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4748 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4749 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4750 "address": "string", ~/~/ Адрес и порт принимающего сервера
4751 "objects": [ ~/~/ Объекты для ретрансляции
4752 {      
4753 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4754 "name": "", ~/~/ Наименование объекта ретрансляции
4755 "imei": "", ~/~/ IMEI объекта  ретрансляции
4756 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4757 }
4758 ],  
4759 "id": "", ~/~/ Идентификатор ретранслятора 
4760 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4761 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4762 }
4763
4764
4765 == **Удаление данных ретранслятора** ==
4766
4767 (% class="box infomessage" %)
4768 (((
4769 **DELETE** **/api/v3/retranslations/{id}**
4770 )))
4771
4772 id - Идентификатор ретранслятора
4773
4774
4775 == **Создание ретранслятора** ==
4776
4777 (% class="box infomessage" %)
4778 (((
4779 **POST ** **/api/v3/retranslations/{id}**
4780 )))
4781
4782 Запрос:
4783
4784 {  
4785 "description": "", ~/~/ Поле описания ретранслятора
4786 "subscriberId": "", ~/~/ Идентификатор подписчика
4787 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4788 "address": "", ~/~/ Адрес и порт принимающего сервера
4789 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4790 "objects": [ ~/~/Объекты для ретрансляции
4791 {      
4792 "id": "", ~/~/ Идентификатор ретранслятора 
4793 "imei": "", ~/~/ IMEI объекта ретрансляции
4794 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4795 }
4796 ]
4797 }
4798
4799
4800 Ответ:
4801
4802 {  
4803 "description": "", ~/~/ Поле описания ретранслятора
4804 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4805 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4806 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4807 "address": "string", ~/~/ Адрес и порт принимающего сервера
4808 "objects": [ ~/~/ Объекты для ретрансляции
4809 {      
4810 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4811 "name": "string", ~/~/ Наименование объекта ретрансляции    
4812 "imei": "", ~/~/ IMEI объекта ретрансляции
4813 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4814 }
4815 ],
4816 "id": "", ~/~/ Идентификатор ретранслятора   
4817 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4818 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4819 }
4820
4821
4822 == **Редактирование ретранслятора** ==
4823
4824 (% class="box infomessage" %)
4825 (((
4826 **PUT** **/api/v3/retranslations**
4827 )))
4828
4829 Пример запроса:
4830
4831 {  
4832 "id": "", ~/~/ Идентификатор ретранслятора   
4833 "description": "string", ~/~/ Поле описания ретранслятора
4834 "subscriberId": "", ~/~/ Идентификатор подписчика
4835 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4836 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4837 "address": "string", ~/~/ Адрес и порт принимающего сервера
4838 "objects": ~/~/ Объекты для ретрансляции
4839 [    
4840 {      
4841 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
4842 "imei": "", ~/~/ IMEI объекта ретрансляции
4843 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4844 }
4845 ]
4846 }
4847
4848
4849 Пример ответа:
4850
4851 {  
4852 "description": "", ~/~/ Поле описания ретранслятора
4853 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4854 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4855 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4856 "address": "string", ~/~/ Адрес и порт принимающего сервера
4857 "objects": [ ~/~/ Объекты для ретрансляции
4858 {      
4859 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4860 "name": "string", ~/~/ Наименование объекта ретрансляции    
4861 "imei": "", ~/~/ IMEI объекта ретрансляции
4862 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4863 }
4864 ],
4865 "id": "", ~/~/ Идентификатор ретранслятора   
4866 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4867 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4868 }
4869
4870
4871 == **Получение списка ретранслятора клиента** ==
4872
4873 (% class="box infomessage" %)
4874 (((
4875 **POST /api/v3/retranslations/find**
4876 )))
4877
4878 Пример запроса:
4879
4880 {  
4881 "id": "", ~/~/ Идентификатор ретранслятора   
4882 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4883 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4884 }
4885
4886 Ответ:
4887
4888 [ 
4889 {    
4890 "description": "", ~/~/ Поле описания ретранслятора
4891 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4892 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4893 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4894 "address": "string", ~/~/ Адрес и порт принимающего сервера
4895 "id": "", ~/~/ Идентификатор ретранслятора   
4896 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4897 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4898 }
4899 ]
4900
4901
4902 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4903
4904 == **API для отчета по выгрузке комбайнов** ==
4905
4906 (% class="box infomessage" %)
4907 (((
4908 **POST /api/v3/Reports/harvesterUnloading**
4909 )))
4910
4911 Пример запроса:
4912
4913 {
4914 "byTime": 0, ~/~/ Объединение событий по времени
4915 "byDist": 0, ~/~/ Объединение событий по расстоянию
4916 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4917 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4918 "showNearestObjects": true, ~/~/Показывать объекты рядом?
4919 "vehicleIds": [ ~/~/ Список id объектов для анализа
4920 0
4921 ],
4922 "from": "", ~/~/ Дата и время начало запроса
4923 "to": "", ~/~/ Дата и время окончания запроса
4924 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4925 }
4926
4927 Пример ответа:
4928
4929 [ 
4930 {
4931 "harvesterName": "", ~/~/Комбайн, номер
4932 "harvesterId": 0, ~/~/Комбайн, id
4933 "harvesterModel": "", ~/~/ Модель комбайна
4934 "hopperCapacity": 0, ~/~/ Объем бункера м3
4935 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4936 "events": [ ~/~/Список событий в разрезе комбайна
4937 {
4938 "driverId": "", ~/~/Идентификатор водителя
4939 "driverName": "", ~/~/Водитель комбайна, ФИО
4940 "RFID": "", ~/~/ идентификатор карты-метки
4941 "rfidName": "", ~/~/Водитель комбайна, имя метки
4942 "vehicleId": 0, ~/~/идентификатор объекта
4943 "vehicleName": "string", ~/~/ Имя объекта
4944 "modelName": "string", ~/~/ Имя модели объекта
4945 "nearestVehicles": [ ~/~/Объекты рядом
4946 {
4947 "vehicleId": 0, ~/~/идентификатор объекта
4948 "vehicleName": "string" ~/~/ Имя объекта
4949 }
4950 ],
4951 "fields": [ ~/~/Поля, где происходила выгрузка
4952 {
4953 "id": 0, ~/~/ идентификатор пользователя 
4954 "name": "string" ~/~/ имя пользователя 
4955 }
4956 ],
4957 "event": "string", ~/~/Событие
4958 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4959 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4960 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4961 "cultureName": "string", ~/~/ название культуры
4962 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4963 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4964 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4965 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4966 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4967 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4968 "issued": 0, ~/~/Выдано, бункеров
4969 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4970 "latitude": 0, ~/~/Широта
4971 "longitude": 0, ~/~/ Долгота
4972 "litresAway": 0, ~/~/Отдано, л
4973 "m3Away": 0 ~/~/Отдано, м3
4974 }
4975 ]
4976 }
4977 ]
4978
4979
4980 == **Отчет трек-датчики** ==
4981
4982 (% class="box infomessage" %)
4983 (((
4984 **POST /api/v3/Reports/sensorsWorks**
4985 )))
4986
4987 **Пример запроса:**
4988
4989 {
4990 "vehicleIds": [ ~/~/ Список ID объектов
4991 0
4992 ],
4993 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4994 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4995 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4996 }
4997
4998 **Пример ответа:**
4999
5000 (((
5001 {
5002 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
5003 {
5004 "vehicleId": 0, ~/~/ Идентификатор ТС
5005 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
5006 {
5007 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
5008 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
5009 "duration": 0, ~/~/  Продолжительность интервала в секундах.
5010 "name": "string", ~/~/ Наименование оборудования.
5011 "mileage": 0, ~/~/ Пробег за время работы оборудования.
5012 "totalMileage": 0, ~/~/ Общий пробег.
5013 "avgSpeed": 0 ~/~/ Средняя скорость.
5014 }
5015 ]
5016 }
5017 ]
5018 }
5019
5020
5021 == **Превышение скорости** ==
5022
5023 (% class="box infomessage" %)
5024 (((
5025 **POST /api/v3/Reports/overSpeedDuration**
5026 )))
5027
5028 Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5029
5030 Пример запроса:
5031
5032 (((
5033 {
5034 "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5035 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5036 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5037 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5038 "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5039 }
5040 )))
5041
5042 (((
5043
5044 )))
5045
5046 (((
5047 Пример ответа:
5048 )))
5049
5050 (((
5051 (((
5052 [
5053 {
5054 "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5055 "duration": 0, ~/~/ Продолжительность события в секундах 
5056 "maxSpeed": 0, ~/~/ Максимальная скорость 
5057 "speedLimit": 0 ~/~/ Ограничение скорости 
5058 }
5059 ]
5060 )))
5061 )))
5062 )))
5063
5064 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
5065
5066
5067 == **Запрос списка полей** ==
5068
5069 (% class="box successmessage" %)
5070 (((
5071 **POST /api/v3/agroLands/find**
5072 )))
5073
5074 Пример запроса:
5075
5076 (((
5077 (((
5078 (((
5079 {
5080 "year": 0, ~/~/ Фильтр по году
5081 "name": "string", ~/~/ Фильтр по названию
5082 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
5083 }
5084 )))
5085 )))
5086
5087
5088 )))
5089
5090 Пример ответа:
5091
5092 (((
5093 [
5094 {
5095 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5096 "year": 0, ~/~/ Год поля
5097 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
5098 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
5099 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5100 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5101 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5102 "counts": { ~/~/ Счётчики с/х поля 
5103 "fieldOperations": 0, ~/~/ Количество операций на поле
5104 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5105 "facts": 0 ~/~/ Счётчик факта
5106 },
5107 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5108 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5109 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5110 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5111 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5112 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5113 "planComment": "string", ~/~/ Комментарий к полю
5114 "productivity": 0, ~/~/ Урожайность.
5115 "id": 0, ~/~/ Идентификатор объекта геозоны
5116 "name": "string", ~/~/ Название объекта геозоны
5117 "type": 0, ~/~/ Тип объекта геозоны
5118 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5119 "fname": "string", ~/~/ Имя файла
5120 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5121 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
5122 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
5123 "description": "string", ~/~/ Описание объекта геозоны
5124 "area": 0, ~/~/ Площадь, м2
5125 "perimetr": 0, ~/~/ Периметр, м
5126 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
5127 }
5128 ]
5129
5130
5131 == **Создание нового поля ** ==
5132
5133 (% class="box successmessage" %)
5134 (((
5135 **POST /api/v3/agroLands**
5136 )))
5137
5138 Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5139 X-agent  - ID клиента
5140
5141 Пример запроса:
5142
5143 (((
5144 {
5145 "extId": "string", 
5146 "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5147 "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5148 "display": "string", ~/~/ Настройки отображения
5149 "year": 0, ~/~/ Год поля
5150 "name": "string", ~/~/ Наименование
5151 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5152 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5153 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5154 "planComment": "string", ~/~/ Комментарий к полю
5155 "cropRotations": [ ~/~/ Данные по севообороту
5156 {
5157 "landId": 0, ~/~/ ID поля
5158 "landName": "string", ~/~/ Название поля
5159 "year": 0, ~/~/ Год урожая
5160 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5161 "cultureName": "string", ~/~/ Название культуры
5162 "productivity": 0, ~/~/ Урожайность
5163 "area": 0, ~/~/ Площадь поля, Га
5164 "total": 0, ~/~/ Валовый сбор
5165 "productivityFact": 0, ~/~/ Фактическая урожайность
5166 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5167 "totalFact": 0, ~/~/ Фактический валовый сбор
5168 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5169 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5170 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5171 "isyearplan": true, ~/~/ Годовой план 
5172 "comment": "string" ~/~/ Комментарий
5173 }
5174 ]
5175 }
5176 )))
5177
5178 (((
5179
5180 )))
5181
5182 Пример ответа:
5183
5184 (((
5185 (((
5186 {
5187 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5188 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5189 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5190 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5191 "cropRotations": [ ~/~/ Данные по севообороту
5192 {
5193 "landId": 0, ~/~/ ID поля
5194 "landName": "string", ~/~/ Название поля
5195 "year": 0, ~/~/ Год урожая 
5196 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5197 "cultureName": "string", ~/~/ Название культуры
5198 "productivity": 0, ~/~/ Урожайность
5199 "area": 0, ~/~/ Площадь поля, Га.
5200 "total": 0, ~/~/ Валовый сбор
5201 "productivityFact": 0, ~/~/ Фактическая урожайность
5202 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5203 "totalFact": 0, ~/~/ Фактический валовый сбор
5204 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5205 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5206 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5207 "isyearplan": true, ~/~/ годовой план 
5208 "comment": "string" ~/~/ Комментарий
5209 }
5210 ],
5211 "cropVegetation": [ ~/~/ История вегетации поля
5212 {
5213 "values": [  ~/~/ Данные вегетации и состояния посева
5214 {
5215 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5216 "ndvi": 0 ~/~/ Индекс вегетации
5217 }
5218 ],
5219 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5220 {
5221 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5222 "type": "string", ~/~/ Тип
5223 "pictureid": "string" ~/~/ Идентификатор ресурса
5224 }
5225 ],
5226 "states": [ ~/~/ Ключевые даты развития поля
5227 {
5228 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5229 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5230 }
5231 ]
5232 }
5233 ],
5234 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5235 "counts": {
5236 "fieldOperations": 0, ~/~/ Количество операций на поле
5237 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5238 "facts": 0 ~/~/ Счётчик факта
5239 },
5240 "planComment": "string", ~/~/ Комментарий к полю
5241 )))
5242
5243 (((
5244 "productivity": 0, ~/~/ Урожайность.
5245 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5246 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5247 "year": 0, ~/~/ Год поля
5248 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5249 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5250 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5251 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5252 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5253 "id": 0, ~/~/ Идентификатор объекта геозоны
5254 "name": "string", ~/~/ Название объекта геозоны
5255 "type": 0, ~/~/ Тип объекта геозоны
5256 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5257 "fname": "string", ~/~/ Имя файла
5258 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5259 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5260 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5261 "description": "string", ~/~/ Описание объекта геозоны
5262 "area": 0, ~/~/ Площадь, м2
5263 "perimetr": 0, ~/~/ Периметр, м
5264 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5265 }
5266
5267
5268 )))
5269 )))
5270 )))
5271
5272 == **Получение поля по id** ==
5273
5274 (% class="box infomessage" %)
5275 (((
5276 **GET /api/v3/agroLands/{id}**
5277 )))
5278
5279 Пример запроса:
5280 id  ~/~/ Идентификатор поля
5281
5282 Пример ответа:
5283
5284 (((
5285 {
5286 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5287 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5288 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5289 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5290 "cropRotations": [ ~/~/ Данные по севообороту
5291 {
5292 "landId": 0, ~/~/ ID поля
5293 "landName": "string", ~/~/ Название поля
5294 "year": 0, ~/~/ Год урожая
5295 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5296 "cultureName": "string", ~/~/ Название культуры
5297 "productivity": 0, ~/~/ Урожайность
5298 "area": 0, ~/~/ Площадь поля, Га
5299 "total": 0, ~/~/ Валовый сбор
5300 "productivityFact": 0, ~/~/ Фактическая урожайность
5301 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5302 "totalFact": 0, ~/~/ Фактический валовый сбор
5303 "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5304 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5305 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5306 "isyearplan": true, ~/~/ План года 
5307 "comment": "string" ~/~/ Комментарий
5308 }
5309 ],
5310 "cropVegetation": [ ~/~/ История вегетации поля
5311 {
5312 "values": [ ~/~/ Данные вегетации и состояния посева
5313 {
5314 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5315 "ndvi": 0 ~/~/ Индекс вегетации
5316 }
5317 ],
5318 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5319 {
5320 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5321 "type": "string", ~/~/ Тип 
5322 "pictureid": "string" ~/~/ Идентификатор ресурса
5323 }
5324 ],
5325 "states": [ ~/~/ Ключевые даты развития поля
5326 {
5327 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5328 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5329 }
5330 ]
5331 }
5332 ],
5333 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5334 "counts": {
5335 "fieldOperations": 0, ~/~/ Количество операций на поле
5336 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5337 "facts": 0 ~/~/ Счётчик факта
5338 },
5339 "planComment": "string", ~/~/ Комментарий к полю
5340 "productivity": 0, ~/~/ Урожайность.
5341 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5342 )))
5343
5344 (((
5345 (((
5346 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5347 "year": 0, ~/~/ Год поля
5348 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5349 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5350 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5351 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5352 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5353 "id": 0, ~/~/ Идентификатор объекта геозоны
5354 "name": "string", ~/~/ Название объекта геозоны
5355 "type": 0, ~/~/ Тип объекта геозоны 
5356 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5357 "fname": "string", ~/~/ Имя файла
5358 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5359 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5360 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5361 "description": "string", ~/~/ Описание объекта геозоны
5362 "area": 0, ~/~/ Площадь, м2
5363 "perimetr": 0, ~/~/ Периметр, м
5364 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5365 }
5366 )))
5367
5368
5369 == **Удаление существующего поля** ==
5370
5371 (% class="box errormessage" %)
5372 (((
5373 **DELETE /api/v3/agroLands/{id}**
5374 )))
5375
5376 Пример запроса:
5377 id  ~/~/ Идентификатор поля
5378
5379 Пример ответа:
5380
5381 (((
5382 200 ~/~/ Успех
5383 )))
5384
5385 (((
5386
5387 )))
5388
5389 (((
5390 (((
5391 (((
5392
5393 )))
5394
5395 (((
5396 == **Изменение поля** ==
5397
5398 (% class="box infomessage" %)
5399 (((
5400 **PUT /api/v3/agroLands**
5401 )))
5402
5403 Пример запроса:
5404
5405 (((
5406 (((
5407 {
5408 "id": 0, ~/~/ Идентификатор поля
5409 "extId": "string", ~/~/ ExtId
5410 "shape": "string", ~/~/ Форма поля
5411 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5412 "display": "string", ~/~/ Настройки отображения
5413 "year": 0, ~/~/ Год поля
5414 "name": "string", ~/~/ Наименование
5415 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5416 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5417 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5418 "planComment": "string", ~/~/Комментарий к полю
5419 "cropRotations": [  ~/~/ Данные по севообороту
5420 {
5421 "landId": 0, ~/~/ ID поля
5422 "landName": "string", ~/~/ Название поля
5423 "year": 0, ~/~/ Год урожая
5424 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5425 "cultureName": "string", ~/~/ Название культуры
5426 "productivity": 0, ~/~/ Урожайность
5427 "area": 0, ~/~/ Площадь поля, Га.
5428 "total": 0, ~/~/ Валовый сбор
5429 "productivityFact": 0, ~/~/ Фактическая урожайность
5430 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5431 "totalFact": 0, ~/~/ Фактический валовый сбор
5432 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5433 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5434 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5435 "isyearplan": true, 
5436 "comment": "string" ~/~/ Комментарий
5437 }
5438 ],
5439 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5440 }
5441 )))
5442 )))
5443
5444 (((
5445
5446 )))
5447
5448 Пример ответа:
5449
5450 (((
5451 (((
5452 (((
5453 {
5454 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5455 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5456 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5457 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5458 "cropRotations": [ ~/~/ Данные по севообороту
5459 {
5460 "landId": 0, ~/~/ ID поля
5461 "landName": "string", ~/~/ Название поля
5462 "year": 0, ~/~/  Год урожая
5463 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5464 "cultureName": "string", ~/~/ Название культуры
5465 "productivity": 0, ~/~/ Урожайность
5466 "area": 0, ~/~/ Площадь поля, Га
5467 "total": 0, ~/~/ Валовый сбор
5468 "productivityFact": 0, ~/~/ Фактическая урожайность
5469 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5470 "totalFact": 0, ~/~/ Фактический валовый сбор
5471 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5472 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5473 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5474 "isyearplan": true, ~/~/ 
5475 "comment": "string" ~/~/ Комментарий
5476 }
5477 ],
5478 "cropVegetation": [ ~/~/ История вегетации поля
5479 {
5480 "values": [ ~/~/ Данные вегетации и состояния посева
5481 {
5482 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5483 "ndvi": 0 ~/~/ Индекс вегетации
5484 }
5485 ],
5486 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5487 {
5488 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5489 "type": "string", ~/~/ Тип
5490 "pictureid": "string" ~/~/ Идентификатор ресурса
5491 }
5492 ],
5493 "states": [ ~/~/ Ключевые даты развития поля 
5494 {
5495 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5496 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5497 }
5498 ]
5499 }
5500 ],
5501 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5502 "counts": { 
5503 "fieldOperations": 0, ~/~/ Количество операций на поле
5504 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5505 "facts": 0 ~/~/ Счётчик факта
5506 },
5507 "planComment": "string", ~/~/ Комментарий к полю
5508 "productivity": 0, ~/~/ Урожайность.
5509 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5510 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5511 "year": 0, ~/~/ Год поля
5512 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5513 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5514 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5515 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5516 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5517 "id": 0, ~/~/ Идентификатор объекта геозоны
5518 "name": "string", ~/~/ Название объекта геозоны
5519 "type": 0, ~/~/ Тип объекта геозоны
5520 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5521 "fname": "string", ~/~/ Имя файла
5522 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5523 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5524 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5525 "description": "string", ~/~/ Описание объекта геозоны
5526 "area": 0, ~/~/ Площадь, м2
5527 "perimetr": 0, ~/~/ Периметр, м
5528 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5529 }
5530 )))
5531 )))
5532 )))
5533 )))
5534 )))
5535
5536
5537 == **Редактирование года урожая ** ==
5538
5539 (% class="box successmessage" %)
5540 (((
5541 **POST /api/v3/agroLands/updateOpenCloseYear**
5542 )))
5543
5544 Пример запроса:
5545
5546 (((
5547 (((
5548 {
5549 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5550 0
5551 ],
5552 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5553 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5554 }
5555 )))
5556
5557
5558 )))
5559
5560 Пример ответа:
5561
5562 (((
5563 (((
5564 {
5565 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5566 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5567 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5568 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5569 "cropRotations": [ ~/~/ Данные по севообороту
5570 {
5571 "landId": 0, ~/~/ ID поля
5572 "landName": "string", ~/~/ Название поля
5573 "year": 0, ~/~/ Год урожая
5574 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5575 "cultureName": "string", ~/~/ Название культуры
5576 "productivity": 0, ~/~/ Урожайность
5577 "area": 0, ~/~/ Площадь поля, Га.
5578 "total": 0, ~/~/ Валовый сбор
5579 "productivityFact": 0, ~/~/ Фактическая урожайность
5580 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5581 "totalFact": 0, ~/~/ Фактический валовый сбор
5582 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5583 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5584 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5585 "isyearplan": true, ~/~/ 
5586 "comment": "string" ~/~/ Комментарий
5587 }
5588 ],
5589 "cropVegetation": [ ~/~/ История вегетации поля
5590 {
5591 "values": [ ~/~/ Данные вегетации и состояния посева
5592 {
5593 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5594 "ndvi": 0 ~/~/ Индекс вегетации
5595 }
5596 ],
5597 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5598 {
5599 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5600 "type": "string", ~/~/ Тип
5601 "pictureid": "string" ~/~/ Идентификатор ресурса
5602 }
5603 ],
5604 "states": [ ~/~/ Ключевые даты развития поля
5605 {
5606 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5607 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5608 }
5609 ]
5610 }
5611 ],
5612 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5613 "counts": { 
5614 "fieldOperations": 0, ~/~/ Количество операций на поле
5615 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5616 "facts": 0 ~/~/ Счётчик факта
5617 },
5618 "planComment": "string", ~/~/ Комментарий к полю
5619 "productivity": 0, ~/~/ Урожайность.
5620 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5621 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5622 "year": 0, ~/~/ Год поля
5623 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5624 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5625 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5626 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5627 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5628 "id": 0, ~/~/ Идентификатор объекта геозоны
5629 "name": "string", ~/~/ Название объекта геозоны
5630 "type": 0, ~/~/ Тип объекта геозоны
5631 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5632 "fname": "string", ~/~/ Имя файла
5633 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5634 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5635 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5636 "description": "string", ~/~/ Описание объекта геозоны
5637 "area": 0, ~/~/ Площадь, м2
5638 "perimetr": 0, ~/~/ ериметр, м
5639 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5640 }
5641 )))
5642
5643
5644 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5645 )))
5646 )))
5647 )))
5648
5649 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5650
5651
5652 (% class="box infomessage" %)
5653 (((
5654 **GET api/v3/Vehicles/recyclebin/all**
5655 )))
5656
5657 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5658
5659 Параметр запроса: {parentId} - идентификатор агента
5660
5661 В заголовках запроса: X-Auth: Токен авторизации
5662
5663 Ответ:
5664
5665 [ 
5666 {
5667 "recordTime": "", ~/~/Время записи
5668 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5669 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5670 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5671 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5672 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5673 "details": { ~/~/Список деталей объекта, помещённого в корзину
5674 "items": [ ~/~/ 
5675 nullable: true ~/~/Детали
5676 {
5677 "name": "string", ~/~/наименование столбца
5678 "value": "string" ~/~/содержание столбца
5679 }
5680 ]
5681 },
5682 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5683 "string"
5684 ]
5685 }
5686 ]
5687
5688
5689 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5690
5691 (% class="box infomessage" %)
5692 (((
5693 **POST api/v3/Vehicles/recyclebin/erase**
5694 )))
5695
5696 В заголовках запроса: X-Auth: Токен авторизации
5697
5698 Пример запроса:
5699
5700 [
5701 0
5702 ]
5703
5704
5705 Пример ответа:
5706
5707 [ 
5708 {
5709 "recordTime": "", ~/~/Время записи
5710 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5711 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5712 "objectId": 0, ~/~/ID объекта, помещённого в корзин
5713 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5714 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5715 "details": { ~/~/Список деталей объекта, помещённого в корзину
5716 "items": [ ~/~/Детали
5717 {
5718 "name": "", ~/~/Имя свойства
5719 "value": "" ~/~/Значение свойства
5720 }
5721 ]
5722 },
5723 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5724 ""
5725 ]
5726 }
5727 ]
5728
5729 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5730
5731 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5732
5733 (% class="box infomessage" %)
5734 (((
5735 **POST api/v3/Vehicles/recyclebin/restore**
5736 )))
5737
5738 В заголовках запроса: X-Auth: Токен авторизации
5739
5740 Параметры в теле запроса (JSON):
5741
5742 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5743
5744 В заголовках запроса: X-Auth: Токен авторизации
5745
5746
5747 Пример запроса:
5748
5749 (((
5750 [
5751 )))
5752
5753 (((
5754 0
5755 )))
5756
5757 (((
5758 ]
5759 )))
5760
5761
5762 Пример ответа:
5763
5764 [
5765 {
5766 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5767 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5768 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5769 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5770 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5771 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5772 "details": { ~/~/Список деталей объекта, помещённого в корзину
5773 "items": [ ~/~/Детали
5774 {
5775 "name": "string", ~/~/Имя свойства
5776 "value": "string" ~/~/Значение свойства
5777 }
5778 ]
5779 },
5780 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5781 "string"
5782 ]
5783 }
5784 ]
5785
5786
5787 = **Раздел: Журнал заданий ** =
5788
5789
5790 == **Создание задания в Журнале заданий** ==
5791
5792 (% class="box infomessage" %)
5793 (((
5794 **POST /api/v3/vehicletasks**
5795 )))
5796
5797 Пример запроса:
5798
5799 (((
5800 {
5801 "vehicleId": 0, ~/~/ Идентификатор ТС
5802 "description": "string", ~/~/ Описание
5803 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5804 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5805 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5806 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5807 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5808 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5809 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5810 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5811 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5812 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5813 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5814 "cost": { 
5815 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5816 "Name": "string", ~/~/ Наименование
5817 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5818 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5819 "Norm": 0 ~/~/ Норма внесения
5820 },
5821 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5822 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5823 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5824 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5825 "deleted": true, ~/~/ Признак удаления
5826 "extId": "string", 
5827 "GeoIds": [ ~/~/ Cвязанные поля
5828 0
5829 ]
5830 }
5831 )))
5832
5833
5834 Пример ответа:
5835
5836 {
5837 "vehicleId": 0, ~/~/ Идентификатор ТС
5838 "description": "string", ~/~/ Описание
5839 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5840 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5841 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5842 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5843 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5844 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5845 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5846 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5847 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5848 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5849 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5850 "cost": { 
5851 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5852 "Name": "string", ~/~/ Наименование
5853 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5854 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5855 "Norm": 0 ~/~/ Норма внесения
5856 },
5857 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5858 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5859 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5860 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5861 "deleted": true, ~/~/ Признак удаления
5862 "extId": "string", ~/~/ ExtId
5863 "GeoIds": [ ~/~/ Связанные поля
5864 0
5865 ]
5866 }
5867
5868
5869 == **Редактирование задания в Журнале заданий** ==
5870
5871 (% class="box successmessage" %)
5872 (((
5873 **PUT /api/v3/vehicletasks**
5874 )))
5875
5876 Пример запроса:
5877
5878 (((
5879 {
5880 "vehicleId": 0, ~/~/ Идентификатор ТС
5881 "description": "string", ~/~/ Описание
5882 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5883 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5884 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5885 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5886 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5887 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5888 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5889 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5890 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5891 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5892 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5893 "cost": { 
5894 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5895 "Name": "string", ~/~/ Наименование
5896 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5897 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5898 "Norm": 0 ~/~/ Норма внесения
5899 },
5900 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5901 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5902 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5903 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5904 "deleted": true, ~/~/ Признак удаления
5905 "extId": "string", ~/~/ ExtId
5906 "GeoIds": [ ~/~/ Связанные поля
5907 0
5908 ]
5909 }
5910 )))
5911
5912
5913 Пример ответа:
5914
5915 {
5916 "vehicleId": 0, ~/~/ Идентификатор ТС
5917 "description": "string", ~/~/ Описание
5918 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5919 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5920 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5921 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5922 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5923 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5924 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5925 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5926 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5927 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5928 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5929 "cost": { 
5930 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5931 "Name": "string", ~/~/ Наименование
5932 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5933 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5934 "Norm": 0 ~/~/ Норма внесения
5935 },
5936 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5937 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5938 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5939 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5940 "deleted": true, ~/~/ Признак удаления
5941 "extId": "string", ~/~/ ExtId
5942 "GeoIds": [ ~/~/ Связанные поля
5943 0
5944 ]
5945 }
5946
5947
5948 == **Удаление задания в Журнале заданий** ==
5949
5950 (% class="box warningmessage" %)
5951 (((
5952 **DELETE /api/v3/vehicletasks**
5953 )))
5954
5955 Пример запроса:
5956
5957 (((
5958 [
5959 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5960 ]
5961 )))
5962
5963 (((
5964
5965 )))
5966
5967 Пример ответа:
5968
5969 {
5970 "vehicleId": 0, ~/~/ Идентификатор ТС
5971 "description": "string", ~/~/ Описание
5972 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5973 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5974 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5975 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5976 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5977 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5978 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5979 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5980 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5981 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5982 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5983 "cost": { 
5984 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5985 "Name": "string", ~/~/ Наименование
5986 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5987 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5988 "Norm": 0 ~/~/ Норма внесения
5989 },
5990 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5991 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5992 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5993 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5994 "deleted": true, ~/~/ Признак удаления
5995 "extId": "string", ~/~/ ExtId
5996 "GeoIds": [ ~/~/ Связанные поля
5997 0
5998 ]
5999 }
6000
6001
6002 == **Получение списка Журнала заданий** ==
6003
6004 (% class="box infomessage" %)
6005 (((
6006 **POST /api/v3/vehicletasks/getbyperiod**
6007 )))
6008
6009 Пример запроса:
6010
6011 (((
6012 {
6013 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6014 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6015 "TimeZone": 0, ~/~/ Часовой пояс.
6016 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6017 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6018 ],
6019 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6020 0
6021 ],
6022 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6023 0
6024 ],
6025 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6026 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6027 }
6028 )))
6029
6030
6031 Пример ответа:
6032
6033 (((
6034 {
6035 "total": 0,  ~/~/ Общее количество записей
6036 "pages": 0,  ~/~/ Общее количество страниц
6037 "currentPage": 0, ~/~/ Текущая страница
6038 "items": [  ~/~/ Записи 
6039 {
6040 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6041 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6042 "name": "string", ~/~/ Название задания.
6043 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6044 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6045 "workKind": "string", ~/~/ Вид работ
6046 "techOp": "string", ~/~/ Тех. операция
6047 "trailerModel": "string", ~/~/ Модель агрегата
6048 "width": "string", ~/~/ Ширина, м
6049 "speed": "string", ~/~/ Тех. скорость
6050 "fields": "string", ~/~/ Поля
6051 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6052 "vehicles": "string", ~/~/ Объект-модель
6053 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6054 "drivers": "string", ~/~/ Водители
6055 "tmc": "string", ~/~/ ТМЦ
6056 "client": "string", ~/~/  Клиент
6057 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6058 "dep": "string", ~/~/ Подразделение
6059 "geoIds": [ ~/~/  Связанные поля
6060 0
6061 ]
6062 }
6063 ]
6064 }
6065 )))
6066
6067
6068 = **Раздел: Роли** =
6069
6070 == **Получение списка клиентских и системных ролей пользователя ** ==
6071
6072 (% class="box successmessage" %)
6073 (((
6074 **POST /api/v3/groups/find**
6075 )))
6076
6077 Пример запроса:
6078
6079 (((
6080 {
6081 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6082 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6083 }
6084 )))
6085
6086 (((
6087
6088 )))
6089
6090 (((
6091 Пример ответа:
6092 )))
6093
6094 (((
6095 (((
6096 {
6097 "groups": [  ~/~/ Системные роли пользователя
6098 {
6099 "code": "string", ~/~/ Код роли.
6100 "name": "string", ~/~/ Имя  
6101 "shortName": "string" ~/~/ Короткое имя 
6102 }
6103 ],
6104 "customGroups": [ ~/~/ Системные роли пользователя
6105 {
6106 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6107 "name": "string", ~/~/ Наименование 
6108 "shortName": "string", ~/~/ Короткое наименование 
6109 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6110 }
6111 ]
6112 }
6113 )))
6114 )))
6115
6116 (((
6117
6118 )))
6119
6120 (((
6121
6122 )))
6123
6124 = **Раздел: Локатор ** =
6125
6126
6127 == **Получение списка локаторов, доступных пользователю ** ==
6128
6129 (% class="box infomessage" %)
6130 (((
6131 **GET /api/v3/locators **
6132 )))
6133
6134 В заголовках запроса: X-Auth: Токен авторизации
6135
6136
6137 Пример ответа:
6138
6139 (((
6140 (((
6141 {
6142 "vehiclesIds": [ ~/~/ Объекты
6143 0
6144 ],
6145 "geoIds": [ ~/~/ Геозоны
6146 0
6147 ],
6148 "fieldsIds": [ ~/~/ Поля
6149 0
6150 ],
6151 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6152 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6153 "agentName": "string", ~/~/ Наименование агента.
6154 "isEnabled": true, ~/~/ Активность 
6155 "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6156 "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6157 "name": "string", ~/~/ Наименование.
6158 "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6159 "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6160 "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6161 "validity": 0, ~/~/ Значение срока действия
6162 "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6163 "autoProlongation": true, ~/~/ Автопродление срока действия.
6164 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6165 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6166 "url": "string", ~/~/ Ссылка
6167 "language": 0, ~/~/ Язык
6168 "showVehicleName": true, ~/~/ Наименование объекта
6169 "showVehicleDirection": true, ~/~/ Направление движения на треке
6170 "allowTrackReport": true, ~/~/ Трек
6171 "showTrackTracing": true, ~/~/ Трассировка трека
6172 "showSensors": true, ~/~/ Датчик
6173 "availableMapLayers": [ ~/~/  Слои на карте
6174 0
6175 ]
6176 }
6177 )))
6178 )))
6179
6180
6181 == **Получение перечня моделей ** ==
6182
6183 (% class="box successmessage" %)
6184 (((
6185 **POST /api/v3/models/find**
6186 )))
6187
6188 Пример запроса:
6189
6190 (((
6191 (((
6192 {
6193 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6194 "name": "string", ~/~/ Наименование локатора
6195 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
6196 )))
6197
6198
6199
6200 Пример ответа: 
6201
6202
6203 (((
6204 [
6205 {
6206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 
6207 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
6208 "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
6209 "name": "string", ~/~/ Наименование локатора
6210 "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 
6211 }
6212 ]
6213 )))
6214 )))
6215
6216
6217 == **Создание локатора** ==
6218
6219 (% class="box successmessage" %)
6220 (((
6221 **POST /api/v3/locators**
6222 )))
6223
6224 Пример запроса:
6225
6226 (((
6227 {
6228 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6229 "isEnabled": true, ~/~/ Активность
6230 "name": "string", ~/~/ Наименование локатора
6231 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6232 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6233 "validity": 0, ~/~/ Срок действия в днях (1-90)
6234 "autoProlongation": true, ~/~/ Автопродление срока действия.
6235 "url": "string", ~/~/ Ссылка
6236 "language": 0 ~/~/ Язык
6237 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6238 "vehiclesIds": [ ~/~/ Oбъекты
6239 0
6240 ],
6241 "geoIds": [ ~/~/ Геозоны
6242 0
6243 ],
6244 "fieldsIds": [ ~/~/ Поля
6245 0
6246 ],
6247 "showVehicleName": true, ~/~/ Наименование объекта
6248 "showVehicleDirection": true, ~/~/ Направление движения на треке
6249 "allowTrackReport": true, ~/~/ Трек
6250 "showTrackTracing": true, ~/~/ Трассировка трека
6251 "showSensors": true, ~/~/ Датчик
6252 "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6253 0
6254 ]
6255 }
6256 )))
6257
6258
6259 Пример ответа:
6260
6261 (((
6262 3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6263 )))
6264
6265
6266
6267 == **Изменение локатора** ==
6268
6269 (% class="box infomessage" %)
6270 (((
6271 **PUT /api/v3/locators**
6272 )))
6273
6274 Пример запроса:
6275
6276 (((
6277 {
6278 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6279 "isEnabled": true, ~/~/ Активность 
6280 "name": "string", ~/~/ Наименование
6281 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6282 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6283 "validity": 0, ~/~/ Срок действия в днях (1-90)
6284 "autoProlongation": true, ~/~/ Автопродление срока действия
6285 "url": "string", ~/~/ Ссылка
6286 "language": 0 ~/~/ Язык
6287 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6288 "vehiclesIds": [ ~/~/ Oбъекты
6289 0
6290 ],
6291 "geoIds": [ ~/~/ Геозоны
6292 0
6293 ],
6294 "fieldsIds": [ ~/~/ Поля
6295 0
6296 ],
6297 "showVehicleName": true, ~/~/ Наименование объекта
6298 "showVehicleDirection": true, ~/~/ Направление движения на треке
6299 "allowTrackReport": true, ~/~/ Трек
6300 "showTrackTracing": true, ~/~/ Трассировка трека
6301 "showSensors": true, ~/~/ Датчик
6302 "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6303 0
6304 ]
6305 }
6306
6307
6308 )))
6309
6310 Пример ответа:
6311
6312 200 ~/~/ Success
6313
6314
6315 == **Удалить локатор** ==
6316
6317 (% class="box warningmessage" %)
6318 (((
6319 **DELETE /api/v3/locators**
6320 )))
6321
6322 Пример запроса:
6323
6324 (((
6325 [
6326 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6327 ]
6328 )))
6329
6330
6331
6332 = **Раздел: Яндекс Маршруты** =
6333
6334
6335 == **Возвращение списка маршрутов** ==
6336
6337 (% class="box infomessage" %)
6338 (((
6339 **GET /api/v3/TransportRoutes**
6340 )))
6341
6342 Пример запроса:
6343 Id  ~/~/ Идентификатор поля
6344
6345
6346 Пример ответа:
6347
6348 (((
6349 [
6350 {
6351 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6352 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6353 "name": "string", ~/~/ Наименование маршрута.
6354 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6355 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6356 0
6357 ]
6358 }
6359 ]
6360 )))
6361
6362
6363
6364 == **Добавить маршрут** ==
6365
6366 (% class="box infomessage" %)
6367 (((
6368 **POST /api/v3/TransportRoutes**
6369 )))
6370
6371 Пример запроса: 
6372 {
6373 "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6374 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6375 "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6376 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6377 0
6378 ]
6379 }
6380
6381
6382 Пример ответа:
6383
6384 (((
6385 {
6386 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6387 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6388 "name": "string", ~/~/ Определяет наименование маршрута 
6389 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6390 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6391 0
6392 ]
6393 }
6394 )))
6395
6396
6397 == **Обновление маршрута** ==
6398
6399 (% class="box successmessage" %)
6400 (((
6401 **PUT /api/v3/TransportRoutes**
6402 )))
6403
6404 Пример запроса:
6405
6406 (((
6407 {
6408 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6409 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6410 "name": "string", ~/~/ Опредлеляет наименование маршрута.
6411 "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6412 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6413 0
6414 ]
6415 }
6416 )))
6417
6418
6419 Пример ответа:
6420
6421 (((
6422 {
6423 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6424 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6425 "name": "string", ~/~/ Определяет наименование маршрута 
6426 "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6427 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6428 0
6429 ]
6430 }
6431 )))
6432
6433
6434 == **Получить связки маршрутов ТС** ==
6435
6436 (% class="box infomessage" %)
6437 (((
6438 **POST /api/v3/TransportRoutes/getroutesvehicles**
6439 )))
6440
6441 Пример запроса:
6442
6443 (((
6444 [
6445 "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6446 ]
6447 )))
6448
6449
6450 Пример ответа:
6451
6452 (((
6453 [
6454 {
6455 "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6456 "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6457 }
6458 ]
6459 )))
6460
6461
6462 == **Удалить маршрут** ==
6463
6464 (% class="box warningmessage" %)
6465 (((
6466 **DELETE /api/v3/TransportRoutes/{id}**
6467 )))
6468
6469 Пример запроса:
6470 Id  ~/~/ Идентификатор поля
6471
6472
6473
6474 = **Раздел: Управление доступа к машинам** =
6475
6476
6477 == Получение списка транспортных средств видимых пользователю ==
6478
6479 (% class="box infomessage" %)
6480 (((
6481 **GET /api/v3/UserVisibleVehicles/{userId}**
6482 )))
6483
6484 Пример ответа:
6485
6486 (((
6487 {
6488 "vehicleIds": [  ~/~/ Идентификаторы ТС
6489 0
6490 ]
6491 }
6492 )))
6493
6494
6495
6496 == Задает видимость транспортных средств пользователю ==
6497
6498 (% class="box infomessage" %)
6499 (((
6500 **POST /api/v3/UserVisibleVehicles**
6501 )))
6502
6503 Пример запроса:
6504
6505 (((
6506 (((
6507 {
6508 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6509 "vehicleIds": [ ~/~/ Идентификаторы ТС
6510 0
6511 ]
6512 }
6513 )))
6514
6515 (((
6516
6517 )))
6518
6519 (((
6520
6521 )))
6522
6523 (((
6524 Пример ответа :
6525 )))
6526
6527 (((
6528
6529 )))
6530
6531 (((
6532 200 ~/~/ Success
6533 )))
6534 )))
6535
6536
6537
6538
6539
6540
6541 (% class="box" lang="en-US" style="text-align: center;" %)
6542 (((
6543 (% 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]] **
6544 )))

Меню

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