Версия 227.2 от Андрей Калиновский на 2025/05/06 12:37
Последние авторы
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": true,
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": true,
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
1778 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1779
1780 (% class="box warningmessage" %)
1781 (((
1782 (% lang="en-US" %)**PUT /api/v3/vehicles**
1783 )))
1784
1785 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1786
1787 (% style="color:#000000" %)Метод запроса: **PUT**
1788
1789 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1790
1791 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1792
1793 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1794
1795 (% style="color:#000000" %){
1796 "vehicleId": , ~/~/ ID объекта
1797 "parentId": "" , ~/~/ ID клиента
1798 "name": "" , ~/~/ имя ТС
1799 "imei": "" , ~/~/ IMEI
1800 "deviceTypeId": "" , ~/~/ ID типа устройства
1801 "modelId": "" , ~/~/ ID модели
1802 "unitId": "" , ~/~/ ID подразделения
1803 "sim1": "" , ~/~/ Номер SIM 1
1804 "sim2": "" , ~/~/ Номер SIM2
1805 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1806 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1807 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1808 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1809 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1810 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1811 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1812 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1813 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1814 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1815 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1816 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1817
1818 "mileageCalcMethod": 0,
1819 "mileageCoeff": 0,
1820 "locationByCellId": true,
1821 "dottedLineTrackWhenNoCoords": true,
1822 "counters": ~/~/ счетчики
1823 {
1824 "mileage": "" , ~/~/ пробег
1825 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1826 "motohours": "" , ~/~/ моточасы
1827 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1828 },
1829 "cmsv6Parameters": { ~/~/ параметры CMSv6
1830 "enabled": true, ~/~/ флаг включения
1831 "id": "" , ~/~/ идентификатор
1832 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1833 "login": "" , ~/~/ имя учетной записи
1834 "password": "" ~/~/ пароль учетной записи
1835 },
1836 "inspectionTasks": ~/~/ задания на ТО
1837 {
1838 "enabled": "" , ~/~/ Признак включения
1839 "name": "" , ~/~/ Имя задания
1840 "description": "" , ~/~/ Описание задания
1841 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1842 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1843 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1844 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1845 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1846 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1847 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1848 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1849 }
1850
1851 "drivers": [ ~/~/ Водители
1852 {
1853
1854 (((
1855 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1856 "inputNumber": 0, ~/~/ № входа.
1857 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1858 "comment": "string", ~/~/ Комментарий.
1859 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1860 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1861 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1862 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1863 )))
1864
1865 } 
1866 ],
1867 "commandTemplates": [ ~/~/ Шаблон команды
1868 {
1869 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1870 "name": "string",
1871 "command": "string",
1872 "retries": 0
1873 }
1874 ],
1875 "sensors": [ ~/~/ Датчики
1876 {
1877 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1878 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1879 "type": 0, ~/~/ Тип датчика
1880 "name": "string", ~/~/ Имя датчика
1881 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1882 "inputNumber": 0, ~/~/ Номер входа
1883 "pseudonym": "string", ~/~/ Псевдоним
1884 "medianDegree": 0, ~/~/ Медианная фильтрация
1885 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1886 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1887 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1888 "gradesTables": [ ~/~/ Массив таблиц тарировки
1889 {
1890 "grades": [ ~/~/ Таблица тарировки 1
1891 {
1892 "input": 0, ~/~/ Входящее значение
1893 "output": 0 ~/~/ Выходящее значение
1894 }
1895 ],
1896 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1897 }
1898 ],
1899 "showInTooltip": true, ~/~/ Отображать в подсказке
1900 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1901
1902 (((
1903 "color": "string",** ~/~/ **Цвет датчика
1904 )))
1905
1906 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1907 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1908 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1909 "expr": "string", ~/~/ Формула
1910 "children": [ ~/~/ массив дочерних датчиков
1911 "string"
1912 ],
1913 "customParams": { ~/~/ прочие произвольные параметры
1914 "additionalProp1": "string",
1915 "additionalProp2": "string",
1916 "additionalProp3": "string"
1917 },
1918 ~/~/ Характерные для произвольного:
1919 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1920 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1921 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1922 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1923 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1924 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1925 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1926 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1927 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1928 ~/~/ "ValueOn": "Вкл.",
1929 ~/~/ "ValueOff": "Выкл."
1930 "summaryMaxValue": 0 ~/~/ Макс. значение
1931
1932 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1933 {
1934 "from": 0, ~/~/ С какого значения
1935 "color": "string", ~/~/ Каким цветом
1936 "text": "string" ~/~/ Текст подписи к этому интервалу
1937 }
1938 ]
1939 }
1940 ],
1941 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1942
1943 "customFields": [ ~/~/ Произвольные поля
1944 {     
1945 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1946 "name": "string", ~/~/ Наименование произвольного поля
1947 "value": "string", ~/~/ Значение произвольного поля
1948 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1949 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1950 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1951 }
1952
1953 (((
1954 ],
1955 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1956 )))
1957
1958 }
1959
1960
1961 (% style="color:#000000" %)Ответ:
1962
1963 (((
1964 {
1965 "vehicleId": 0, ~/~/ ID ТС
1966 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1967 "name": "string", ~/~/ Имя объекта
1968 "imei": "string", ~/~/ IMEI
1969 "deviceTypeId": 0, ~/~/ ID типа устройства
1970 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1971 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1972 "sim1": "string", ~/~/ SIM1
1973 "sim2": "string", ~/~/ SIM2
1974 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1975 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1976 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1977 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1978 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1979 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1980 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1981 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1982 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1983 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1984 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1985 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1986 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1987 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1988 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1989 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1990 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1991 "counters": { ~/~/ состояний счётчиков
1992 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1993 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1994 "mileage": 0, ~/~/ Пробег
1995 "motohours": 0 ~/~/ Моточасы 
1996 },
1997 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1998 "id": "string", ~/~/ CMSV6 Идентификатор
1999 "enabled": true, ~/~/ Признак включения
2000 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2001 )))
2002
2003
2004 (((
2005 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2006 "login": "string", ~/~/ CMSV6 имя учетной записи
2007 "password": "string" ~/~/ CMSV6 — пароль учетной записи
2008 },
2009 "inspectionTasks": [ ~/~/ Задания на ТО
2010 {
2011 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2012 "enabled": true, ~/~/ Признак включения
2013 "name": "string", ~/~/ Имя задания
2014 "description": "string", ~/~/ Описание задания
2015 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2016 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2017 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2018 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2019 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2020 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2021 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2022 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2023 }
2024 ],
2025 "drivers": [  ~/~/ Список водителей
2026 {
2027 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2028 "inputNumber": 0, ~/~/ № входа.
2029 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2030 "comment": "string", ~/~/ Комментарий.
2031 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2032 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2033 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2034 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2035 }
2036 ],
2037 "commandTemplates": [ ~/~/ Список шаблонов команд
2038 {
2039 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2040 "name": "string", ~/~/ Название шаблона команд
2041 "command": "string", ~/~/ Команда на выполнение
2042 "retries": 0 ~/~/ Лимит попыток отправки
2043 }
2044 ],
2045 "sensors": [  ~/~/ Список датчиков 
2046 {
2047 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2048 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2049 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2050 )))
2051
2052 (((
2053 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2054 )))
2055
2056 (((
2057 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2058 )))
2059
2060 (((
2061 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2062 )))
2063
2064 (((
2065 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2066 )))
2067
2068 (((
2069 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2070 "name": "string", ~/~/ Имя датчика
2071 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2072 )))
2073
2074 (((
2075 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2076 "inputNumber": 0, ~/~/ Номер входа
2077 "pseudonym": "string", ~/~/ Псевдоним
2078 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2079 "isInverted": true, ~/~/ Признак инверсии
2080 "disabled": true, ~/~/ Датчик не участвует в обработке
2081 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2082 "gradesTables": [ ~/~/ Тарировка
2083 {
2084 "grades": [ ~/~/ Таблицы тарировки
2085 {
2086 "input": 0, ~/~/ Вход
2087 "output": 0 ~/~/ Выход
2088 }
2089 ],
2090 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2091 }
2092 ],
2093 "showInTooltip": true, ~/~/ Отображение в подсказке
2094 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2095
2096 (((
2097 "color": "string", ~/~/ цвет уведомлений
2098 )))
2099
2100 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2101 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2102 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2103 "expr": "string", ~/~/ Выражение
2104 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2105 "string" 
2106 ],
2107 "customParams": { ~/~/ Дополнительные настройки
2108 "additionalProp1": "string",
2109 "additionalProp2": "string",
2110 "additionalProp3": "string"
2111 },
2112 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2113 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2114 {
2115 "from": 0, ~/~/ С какого значения
2116 "color": "string", ~/~/ Каким цветом
2117 "text": "string" ~/~/ Текст подписи к этому интервалу
2118 }
2119 ]
2120 }
2121 ],
2122 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2123 "customFields": [ ~/~/ Список произвольных полей
2124 {
2125 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2126 "name": "string", ~/~/ Наименование произвольного поля
2127 "value": "string", ~/~/ Значение произвольного поля
2128 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2129 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2130 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2131 }
2132 ],
2133 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2134 }
2135 )))
2136
2137 **Валидация:**
2138 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2139 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2140 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2141
2142 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2143
2144 (% class="box errormessage" %)
2145 (((
2146 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2147 )))
2148
2149 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2150
2151 (% style="color:#000000" %)Метод запроса: **DELETE**
2152
2153 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2154
2155 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2156
2157 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2158
2159 (% style="text-align:left" %)
2160 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2161
2162 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2163
2164 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2165
2166 (% class="box infomessage" %)
2167 (((
2168 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2169 )))
2170
2171 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2172
2173 (% style="color:#000000" %)Метод запроса: **GET**
2174
2175 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2176
2177 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2178
2179 (% style="color:#000000" %)Ответ:
2180
2181 (% style="color:#000000" %){(%%)
2182 "deviceTypeId" : "", ~/~/ ID типа устройства
2183 "deviceTypeName" : "" ~/~/ Название типа устройства
2184 (% style="color:#000000" %)}
2185
2186 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2187
2188 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2189
2190 (% class="box infomessage" %)
2191 (((
2192 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2193 )))
2194
2195 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2196
2197 (% style="color:#000000" %)Метод запроса: **GET**
2198
2199 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2200
2201 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2202
2203 (% style="color:#000000" %)Ответ:
2204
2205 (% style="color:#000000" %){(%%)
2206 "id": "", ~/~/ ID типа датчика 
2207 "name": "", ~/~/ Название
2208 "description": "", ~/~/ Описание
2209 (% style="color:#000000" %)}
2210
2211 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2212
2213 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2214
2215 (% class="box infomessage" style="text-align: left;" %)
2216 (((
2217 **POST /api/v3/terminalMessages/count**
2218 )))
2219
2220 (% style="text-align: left;" %)
2221 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2222
2223 (% style="text-align: left;" %)
2224 Метод запроса **POST**
2225
2226 (% style="text-align: left;" %)
2227 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2228
2229 (% style="text-align: left;" %)
2230 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2231
2232 (% style="text-align: left;" %)
2233 {
2234 "vehicleIds": [
2235 id ~/~/ здесь передается список идентификаторов объектов
2236 ],
2237 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2238 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2239 }
2240
2241 (% style="text-align: left;" %)
2242 Ответ:
2243
2244 (% style="text-align: left;" %)
2245 [
2246 {
2247 "vehicleId": 0, ~/~/ идентификатор объекта
2248 "count": 0 ~/~/ количество сообщений за период
2249 }
2250 ]
2251
2252 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2253
2254 (% class="box infomessage" style="text-align: left;" %)
2255 (((
2256 **POST /api/v3/terminalMessages/mapping**
2257 )))
2258
2259 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2260
2261 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2262
2263 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2264
2265 {
2266 "protocolType": 0,
2267 "params": ["string"]
2268 }
2269
2270 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2271 |protocolType|ID типа протокола
2272 |params|(((
2273 Массив наименований параметров в сообщении
2274 )))
2275
2276 Ответ:
2277
2278 {
2279 "protocolType": 0,
2280 "mapping": {
2281 "additionalProp1": {
2282 "inputType": 0,
2283 "inputNumber": 0
2284 },
2285 "additionalProp2": {
2286 "inputType": 0,
2287 "inputNumber": 0
2288 }
2289 }
2290 }
2291
2292 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2293 |protocolType|Тип протокола
2294 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2295 |inputNumber|(((
2296 Номер входа
2297 )))
2298
2299 (% class="wikigeneratedid" %)
2300 Перечень 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/]]
2301
2302 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2303
2304 (% class="box infomessage" %)
2305 (((
2306 **POST /api/v3/terminalMessages**
2307 )))
2308
2309 Метод возвращает список сообщений терминала объекта за выбранный период.
2310
2311 (% style="text-align: left;" %)
2312 Метод запроса **POST**
2313
2314 (% style="text-align: left;" %)
2315 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2316
2317 (% style="text-align: left;" %)
2318 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2319
2320 {
2321 "vehicleId": 0, ~/~/ id объекта
2322 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2323 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2324 }
2325
2326 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2327 |vehicleId|ID объекта
2328 |from|Дата и время начала периода запроса
2329 |to|Дата и время окончания периода запроса
2330
2331 Ответ:
2332
2333 [
2334 {
2335 "messages": [
2336 {
2337 "deviceTime": "2023-11-29T07:40:44.052Z",
2338 "serverTime": "2023-11-29T07:40:44.052Z",
2339 "speed": 0,
2340 "altitude": 0,
2341 "latitude": 0,
2342 "longitude": 0,
2343 "satellites": 0,
2344 "course": 0,
2345 "voltage": 0,
2346 "parameters": {
2347 "additionalProp1": "string",
2348 "additionalProp2": "string",
2349 "additionalProp3": "string"
2350 },
2351 "photoCount": 0,
2352 "lbsCorrectedCoords": true,
2353 "protocolType": 0
2354 }
2355 ]
2356 }
2357 ]
2358
2359 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2360 |deviceTime|Время сообщения терминала
2361 |serverTime|Время когда сообщение поступило на сервер
2362 |speed|Скорость
2363 |altitude|Высота над уровнем моря
2364 |latitude|Широта
2365 |longitude|Долгота
2366 |satellites|Кол-во спутников
2367 |course|Курс
2368 |voltage|Бортовое напряжение
2369 |parameters|Список параметров и их значений
2370 |photoCount|Количество фото
2371 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2372 |protocolType|ID типа протокола
2373
2374 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2375
2376 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2377
2378 (% class="box infomessage" %)
2379 (((
2380 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2381 )))
2382
2383 (% style="color:#000000" %)Метод запроса: **POST**
2384
2385 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2386
2387 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2388
2389 (% style="text-align:left" %)
2390 Тело запроса:
2391
2392 {
2393 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2394 "vehicleIds": [0], ~/~/ Список ID объектов
2395 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2396 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2397 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2398 }
2399
2400 Ответ:
2401
2402 [
2403 {
2404 "vehicleId": 0, ~/~/ ID объекта
2405 "name": "string", ~/~/ Имя ТС
2406 "periods": [ ~/~/ Периоды
2407 {
2408 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2409 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2410 "mileage": 0, ~/~/ Пробег за период, километры
2411 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2412 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2413 "motohours": 0, ~/~/ Моточасы за период, секунды
2414 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2415 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2416 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2417
2418 }
2419 ]
2420 }
2421 ]
2422
2423 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2424
2425 (% class="box infomessage" %)
2426 (((
2427 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2428 )))
2429
2430 (% style="color:#000000" %)Метод запроса: **POST**
2431
2432 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2433
2434 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2435
2436 (% style="text-align:left" %)
2437 Тело запроса:
2438
2439 {
2440 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2441 "vehicleIds": [0], ~/~/ Список ID объектов
2442 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2443 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2444 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2445 }
2446
2447 Ответ:
2448
2449 [
2450 {
2451 "vehicleId": 0, ~/~/ ID объекта
2452 "name": "string", ~/~/ Имя ТС
2453 "periods": [ ~/~/ Периоды
2454 {
2455 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2456 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2457 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2458 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2459 "fuelConsumption": 0, ~/~/ Расход топлива
2460 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2461 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2462
2463 }
2464 ]
2465 }
2466 ]
2467
2468 (% class="box warningmessage" %)
2469 (((
2470 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2471 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2472 )))
2473
2474 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2475
2476 (% class="box infomessage" %)
2477 (((
2478 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2479 )))
2480
2481 (% style="color:#000000" %)Метод запроса: **POST**
2482
2483 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2484
2485 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2486
2487 (% style="text-align:left" %)
2488 Тело запроса:
2489
2490 {
2491 "vehicleIds": [0], ~/~/ Список ID объектов
2492 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2493 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2494 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2495 }
2496
2497 Ответ:
2498
2499 [
2500 {
2501 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2502 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2503 "vehicleId": 0, ~/~/ ID объекта
2504 "name": "string", ~/~/ Имя объекта
2505 "model": "string", ~/~/ Модель объекта
2506 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2507 {
2508 "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
2509
2510 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2511 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2512 "valueFuel": 0, ~/~/ Количество
2513 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2514 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2515 }
2516 ]
2517 }
2518 ]
2519
2520
2521 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2522
2523 (% class="box infomessage" %)
2524 (((
2525 **POST /api/v3/vehicles/moveStop**
2526 )))
2527
2528 Метод запроса: **POST**
2529
2530 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2531
2532 В заголовках запроса: X-Auth: Токен авторизации
2533
2534
2535 Тело запроса:
2536
2537 {
2538 "vehicleIds": [ ], ~/~/ Список ID объектов
2539 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2540 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2541 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2542 }
2543
2544 Ответ:
2545
2546 [ 
2547 {
2548 "vehicleId": 0, ~/~/ ID объекта
2549 "vehicleName": "string", ~/~/ Имя объекта
2550 "moves": [ ~/~/ Событие движения
2551 {
2552 "mileage": 0, ~/~/ Пробег, км
2553 "eventId": 0, ~/~/ Идентификатор события
2554 "eventName": "string", ~/~/ Название события
2555 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2556 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2557 "duration": 0 ~/~/ Продолжительность события, секунд
2558 }
2559 ],
2560 "stops": [ ~/~/ События стоянок
2561 {
2562 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2563 "eventId": 0, ~/~/ Идентификатор события
2564 "eventName": "string", ~/~/ Название события
2565 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2566 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2567 "duration": 0 ~/~/ Продолжительность события, секунд
2568 }
2569 ]
2570 }
2571 ]
2572
2573
2574 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2575
2576 (% class="box infomessage" %)
2577 (((
2578 **POST /api/v3/vehicles/getlastdata**
2579 )))
2580
2581 Метод запроса: **POST**
2582
2583 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2584
2585 В заголовках запроса: X-Auth: Токен авторизации
2586
2587
2588 В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2589
2590 Ответ:
2591 {
2592 "vehicleId": 0, ~/~/Идентификатор объекта.
2593 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2594 "vehicleNumber": "string",~/~/Номер объекта.
2595 "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2596 "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2597 "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2598 "speed": 0,~/~/Скорость объекта.
2599 "course": 0,~/~/Курс движения [0;360]
2600 "latitude": 0,~/~/Широта [-90°;90°].
2601 "longitude": 0,~/~/Долгота [-180°;180°].
2602 "address": "string",~/~/Адрес.
2603 "geozones": [ ~/~/Сведения по геозонам.
2604 {
2605 "id": 0,
2606 "name": "string"
2607 }
2608
2609
2610 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2611
2612 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2613
2614 (% class="box infomessage" %)
2615 (((
2616 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2617 )))
2618
2619 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2620
2621 (% style="color:#000000" %)Метод запроса: **POST**
2622
2623 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2624
2625 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2626
2627 (% style="text-align:left" %)
2628 Тело запроса:
2629
2630 (% style="text-align:left" %)
2631 {
2632 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2633 }
2634
2635 (% style="text-align:left" %)
2636 Ответ:
2637
2638 [
2639 {
2640 "id": 0, ~/~/ Идентификатор объекта геозоны
2641 "name": "string", ~/~/ Название объекта геозоны
2642 "type": 0, ~/~/ Тип объекта геозоны
2643 "fname": "string", ~/~/ Имя файла
2644 "parentId": "string", ~/~/ Идентификатор клиента
2645 "radius": 0, ~/~/ Радиус геообъекта
2646 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2647 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2648 "description": "string", ~/~/ Описание
2649 "area": 0, ~/~/ Площадь, м^^2^^
2650 "perimetr": 0, ~/~/ Периметр, м
2651 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2652 }
2653 ]
2654
2655 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2656
2657 (% class="box infomessage" %)
2658 (((
2659 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2660 )))
2661
2662 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2663
2664 (% style="color:#000000" %)Метод запроса: **POST**
2665
2666 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2667
2668 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2669
2670 (% style="text-align:left" %)
2671 Тело запроса:
2672
2673 {
2674 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2675 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2676 "ids": [ ], ~/~/ Массив id объектов
2677 "byTime": 0, ~/~/ Объединение событий по времени 
2678 "byDist": 0, ~/~/ Объединение событий по расстоянию
2679 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2680 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2681 }
2682
2683 Ответ:
2684 [
2685 {
2686 "geozoneId": 0, ~/~/ ID геообъекта
2687 "geozoneName": "string", ~/~/ Название геообъекта
2688 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2689 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2690 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2691 "vehicleId": 0, ~/~/ ID объекта
2692 "vehicleName": "string" ~/~/ Имя объекта
2693 }
2694 ]
2695
2696 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2697
2698 (% class="box infomessage" %)
2699 (((
2700 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2701 )))
2702
2703 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2704
2705 (% style="color:#000000" %)Метод запроса: **POST**
2706
2707 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2708
2709 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2710
2711 (% style="text-align:left" %)
2712 Тело запроса:
2713
2714 {
2715 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2716 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2717 "ids": [ ], ~/~/ Массив id геообъектов
2718 "byTime": 0, ~/~/ Объединение событий по времени 
2719 "byDist": 0, ~/~/ Объединение событий по расстоянию
2720 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2721 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2722 }
2723
2724 Ответ:
2725
2726 [
2727 {
2728 "geozoneId": 0, ~/~/ ID геообъекта
2729 "geozoneName": "string", ~/~/ Название геообъекта
2730 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2731 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2732 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2733 "vehicleId": 0, ~/~/ ID объекта
2734 "vehicleName": "string" ~/~/ Имя объекта
2735 }
2736 ]
2737
2738
2739 == (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2740
2741 (% class="box successmessage" %)
2742 (((
2743 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2744 )))
2745
2746 (% style="color:#000000" %)Метод запроса: **PUT**
2747
2748 Пример запроса:
2749
2750 (((
2751 {
2752 "id": 0,  ~/~/ Идентификатор объекта геозоны
2753 "name": "string",  ~/~/ Наименование объекта геозоны
2754 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2755 "description": "string", ~/~/ Описание объекта геозоны
2756 "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2757 "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2758 "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2759 }
2760 )))
2761
2762
2763 Пример ответа:
2764
2765 200 ~/~/ Success
2766
2767 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2768
2769 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2770
2771 (% class="box infomessage" %)
2772 (((
2773 **POST /api/v3/notifications/find**
2774 )))
2775
2776 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2777
2778 (% style="text-align: left;" %)
2779 Метод запроса **POST**
2780
2781 (% style="text-align: left;" %)
2782 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2783
2784 (% style="text-align: left;" %)
2785 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2786
2787 {
2788 "parentId": "" ~/~/ id клиента
2789 }
2790
2791 Ответ:
2792
2793 [
2794 {
2795 "id": 0, ~/~/ ID уведомления
2796 "name": "string", ~/~/ Название уведомления
2797 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2798 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2799 "userId": "", ~/~/ Пользователь, создавший уведомление
2800 "parentId": "", ~/~/ Идентификатор клиента
2801 "parentName": "string" ~/~/ Имя клиента
2802 }
2803 ]
2804
2805 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2806
2807 (% class="box infomessage" %)
2808 (((
2809 **GET /api/v3/notifications/{id}**
2810 )))
2811
2812 Метод возвращает данные правил формирования выбранного уведомления.
2813
2814 (% style="text-align: left;" %)
2815 Метод запроса **GET**
2816
2817 (% style="text-align: left;" %)
2818 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2819
2820 (% style="text-align: left;" %)
2821 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2822
2823 (% style="text-align: left;" %)
2824 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2825
2826 (% style="text-align: left;" %)
2827 (% style="color:#000000" %)Ответ:
2828
2829 (% style="text-align: left;" %)
2830 (% style="color:#000000" %){
2831 "id": 0, ~/~/ (%%)id уведомления
2832 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2833 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2834 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2835 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2836 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2837 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2838 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2839 (% style="color:#000000" %) 0
2840 ],
2841 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2842 (% style="color:#000000" %) 0
2843 ],
2844 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2845 (% style="color:#000000" %) 0
2846 ],
2847 "settings": { ~/~/ Список параметров уведомления
2848 "additionalProp1": "string",
2849 "additionalProp2": "string",
2850 "additionalProp3": "string"
2851 },
2852 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2853 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2854 (% style="color:#000000" %) ""
2855 ],
2856 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2857 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2858 (% style="color:#000000" %) "string"
2859 ],
2860 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2861 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2862 (% style="color:#000000" %) {
2863 "id": 0, ~/~/ (%%)Идентификатор участника чата
2864 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2865 (% style="color:#000000" %) }
2866 ],
2867 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2868 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2869 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2870 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2871 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2872 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2873 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2874 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2875 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2876 (% style="color:#000000" %)}
2877
2878 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2879
2880 (% class="box warningmessage" %)
2881 (((
2882 **PUT /api/v3/notifications/**
2883 )))
2884
2885 Метод позволяет отредактировать уведомление.
2886
2887 Метод запроса **PUT**
2888
2889 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2890
2891 В заголовках запроса: X-Auth: Токен авторизации
2892
2893 Тело запроса:
2894 {
2895 "id": 0, ~/~/ id уведомления
2896 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2897 "userId": "", ~/~/ Пользователь, создавший уведомление
2898 "parentId": "", ~/~/ Идентификатор клиента
2899 "parentName": "string", ~/~/ Имя клиента
2900 "name": "string", ~/~/ Название уведомления
2901 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2902 "vehicleIds": [ ~/~/ Список id объектов для анализа
2903 0
2904 ],
2905 "geoids": [ ~/~/ Список id геообъектов для анализа
2906 0
2907 ],
2908 "fieldids": [ ~/~/ Список id полей для анализа
2909 0
2910 ],
2911 "settings": { ~/~/ Список параметров уведомления
2912 "additionalProp1": "string",
2913 "additionalProp2": "string",
2914 "additionalProp3": "string"
2915 },
2916 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2917 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2918 ""
2919 ],
2920 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2921 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2922 "string"
2923 ],
2924 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2925 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2926 {
2927 "id": 0, ~/~/ Идентификатор участника чата
2928 "info": "string" ~/~/ Дополнительные сведения
2929 }
2930 ],
2931 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2932 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2933 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2934 "kind": 0, ~/~/ Определяет вид уведомления
2935 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2936 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2937 "timezone": 0, ~/~/ Сдвиг часового пояса
2938 "validity": 0, ~/~/ Срок действия в днях (1-90)
2939 "autoProlongation": true ~/~/ Автопродление срока действия
2940 }
2941
2942 Ответ:
2943
2944 Success
2945
2946
2947 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2948
2949 (% class="box warningmessage" %)
2950 (((
2951 **PUT** /api/v3/notifications/prolongation
2952 )))
2953
2954 Метод позволяет продлить уведомления.
2955
2956 Метод запроса **PUT**
2957
2958 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2959
2960 В заголовках запроса: X-Auth: Токен авторизации.
2961
2962 Тело запроса:
2963
2964 [
2965
2966 0
2967
2968 ]
2969
2970 где 0 идентификатор ids.
2971
2972 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2973
2974 (% class="box errormessage" %)
2975 (((
2976 **DELETE /api/v3/notifications/{id}**
2977 )))
2978
2979 Метод позволяет удалить выбранное уведомление.
2980
2981 Метод запроса **DELETE**
2982
2983 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2984
2985 Передаваемый параметр: {id} - id уведомления
2986
2987 В заголовках запроса: X-Auth: Токен авторизации
2988
2989 Ответ:
2990
2991 Success
2992
2993
2994 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2995
2996 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2997
2998 (% class="box infomessage" %)
2999 (((
3000 **POST /api/v3/Drivers/find**
3001 )))
3002
3003 Передается параметр: parentId - ID клиента-родителя
3004
3005 Ответ:
3006
3007 [
3008 {
3009 "name": "string", ~/~/ Определяет наименование
3010 "description": "string", ~/~/ Определяет описание
3011 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3012 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3013 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3014 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3015 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3016 "deleted": true ~/~/ Признак удаления
3017 }
3018 ]
3019
3020 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3021
3022 (% class="box infomessage" %)
3023 (((
3024 **GET /api/v3/Drivers/{driverGuid}**
3025 )))
3026
3027 Передается параметр: ID водителя
3028
3029 Ответ:
3030
3031 {
3032 "name": "string", ~/~/ Определяет наименование
3033 "description": "string", ~/~/ Определяет описание
3034 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3035 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3036 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3037 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3038 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3039 "deleted": true ~/~/ Признак удаления
3040 }
3041
3042 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3043
3044 (% class="box successmessage" %)
3045 (((
3046 **POST /api/v3/Drivers**
3047 )))
3048
3049 Запрос:
3050
3051 {
3052 "name": "string",
3053 "description": "string",
3054 "hiredate": "2023-06-30T12:50:54.020Z",
3055 "chopdate": "2023-06-30T12:50:54.020Z",
3056 "exclusive": true,
3057 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3058 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3059 "deleted": true
3060 }
3061
3062 Ответ:
3063
3064 {
3065 "name": "string",
3066 "description": "string",
3067 "hiredate": "2023-06-30T12:50:54.051Z",
3068 "chopdate": "2023-06-30T12:50:54.051Z",
3069 "exclusive": true,
3070 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3071 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3072 "deleted": true
3073 }
3074
3075
3076 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3077
3078 (% class="box warningmessage" %)
3079 (((
3080 **PUT /api/v3/Drivers**
3081 )))
3082
3083 Запрос:
3084
3085 {
3086 "name": "string",
3087 "description": "string",
3088 "hiredate": "2023-06-30T12:50:27.910Z",
3089 "chopdate": "2023-06-30T12:50:27.910Z",
3090 "exclusive": true,
3091 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3092 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3093 "deleted": true
3094 }
3095
3096 Ответ:
3097
3098 {
3099 "name": "string",
3100 "description": "string",
3101 "hiredate": "2023-06-30T12:50:27.929Z",
3102 "chopdate": "2023-06-30T12:50:27.929Z",
3103 "exclusive": true,
3104 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3105 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3106 "deleted": true
3107 }
3108
3109
3110 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3111
3112 (% class="box errormessage" %)
3113 (((
3114 **DELETE /api/v3/Drivers/{driverGuid}**
3115 )))
3116
3117 Передается параметр: ID водителя
3118
3119 Ответ:
3120
3121 Success
3122
3123
3124 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3125
3126 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3127
3128 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3129
3130 (% class="box infomessage" %)
3131 (((
3132 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3133 )))
3134
3135 Запрос:
3136
3137 {
3138 "Ids": [
3139 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3140 ],
3141 "BeginTime": "2023-06-30T12:49:04.365Z",
3142 "EndTime": "2023-06-30T12:49:04.365Z"
3143 }
3144
3145 Ответ:
3146
3147 [
3148 {
3149 "VehicleId": 0,
3150 "CreateTime": "2023-06-30T09:52:31.240Z",
3151 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3152 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3153 "BeginTime": "2023-06-30T09:52:31.240Z",
3154 "EndTime": "2023-06-30T09:52:31.240Z"
3155 }
3156 ]
3157
3158
3159 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3160
3161 (% class="box infomessage" %)
3162 (((
3163 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3164 )))
3165
3166 Запрос:
3167
3168 {
3169 "Ids": [
3170 0
3171 ],
3172 "BeginTime": "2023-06-30T12:48:39.419Z",
3173 "EndTime": "2023-06-30T12:48:39.419Z"
3174 }
3175
3176 Ответ:
3177
3178 [
3179 {
3180 "VehicleId": 0,
3181 "CreateTime": "2023-06-30T09:54:01.631Z",
3182 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3183 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3184 "BeginTime": "2023-06-30T09:54:01.631Z",
3185 "EndTime": "2023-06-30T09:54:01.631Z"
3186 }
3187 ]
3188
3189
3190 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3191
3192 (% class="box successmessage" %)
3193 (((
3194 **POST /api/v3/DriversVehiclesAssignments**
3195 )))
3196
3197 Передается массив назначений
3198
3199 Запрос:
3200
3201 [
3202 {
3203 "VehicleId": 0, ~/~/ Идентификатор объекта
3204 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3205 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3206 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3207 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3208 }
3209 ]
3210
3211 Ответ:
3212
3213 [
3214 {
3215 "VehicleId": 0,
3216 "CreateTime": "2023-06-30T11:04:46.903Z",
3217 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3218 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3219 "BeginTime": "2023-06-30T11:04:46.903Z",
3220 "EndTime": "2023-06-30T11:04:46.903Z"
3221 }
3222 ]
3223
3224
3225 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3226
3227 (% class="box warningmessage" %)
3228 (((
3229 **PUT /api/v3/DriversVehiclesAssignments**
3230 )))
3231
3232 Запрос:
3233
3234 [
3235 {
3236 "VehicleId": 0,
3237 "CreateTime": "2023-06-30T11:14:08.117Z",
3238 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3239 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3240 "BeginTime": "2023-06-30T11:14:08.117Z",
3241 "EndTime": "2023-06-30T11:14:08.117Z"
3242 }
3243 ]
3244
3245 Ответ:
3246
3247 [
3248 {
3249 "VehicleId": 0,
3250 "CreateTime": "2023-06-30T11:14:53.349Z",
3251 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3252 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3253 "BeginTime": "2023-06-30T11:14:53.349Z",
3254 "EndTime": "2023-06-30T11:14:53.349Z"
3255 }
3256 ]
3257
3258
3259 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3260
3261 (% class="box errormessage" %)
3262 (((
3263 **DELETE /api/v3/DriversVehiclesAssignments**
3264 )))
3265
3266 Запрос:
3267
3268 [
3269 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3270 ]
3271
3272 Ответ:
3273
3274 Success
3275
3276
3277 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3278
3279 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3280
3281 (% class="box infomessage" %)
3282 (((
3283 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3284 )))
3285
3286 Запрос:
3287
3288 {
3289 "Ids": [
3290 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3291 ],
3292 "BeginTime": "2023-06-30T12:47:12.162Z",
3293 "EndTime": "2023-06-30T12:47:12.162Z"
3294 }
3295
3296 Ответ:
3297
3298 [
3299 {
3300 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3301 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3302 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3303 "BeginTime": "2023-06-30T11:19:40.703Z",
3304 "EndTime": "2023-06-30T11:19:40.703Z"
3305 }
3306 ]
3307
3308
3309 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3310
3311 (% class="box infomessage" %)
3312 (((
3313 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3314 )))
3315
3316 Запрос:
3317
3318 {
3319 "Ids": [
3320 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3321 ],
3322 "BeginTime": "2023-06-30T12:47:12.162Z",
3323 "EndTime": "2023-06-30T12:47:12.162Z"
3324 }
3325
3326 Ответ:
3327
3328 [
3329 {
3330 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3331 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3332 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3333 "BeginTime": "2023-06-30T11:19:40.703Z",
3334 "EndTime": "2023-06-30T11:19:40.703Z"
3335 }
3336 ]
3337
3338
3339 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3340
3341 (% class="box successmessage" %)
3342 (((
3343 **POST /api/v3/DriversRfidsAssignments**
3344 )))
3345
3346 Запрос:
3347
3348 [
3349 {
3350 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3351 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3352 "BeginTime": "2023-06-30T11:27:08.635Z",
3353 "EndTime": "2023-06-30T11:27:08.635Z"
3354 }
3355 ]
3356
3357 Ответ:
3358
3359 [
3360 {
3361 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3362 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3363 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3364 "BeginTime": "2023-06-30T11:27:08.677Z",
3365 "EndTime": "2023-06-30T11:27:08.677Z"
3366 }
3367 ]
3368
3369
3370 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3371
3372 (% class="box warningmessage" %)
3373 (((
3374 **PUT /api/v3/DriversRfidsAssignments**
3375 )))
3376
3377 Запрос:
3378
3379 [
3380 {
3381 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3382 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3383 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3384 "BeginTime": "2023-06-30T11:28:43.330Z",
3385 "EndTime": "2023-06-30T11:28:43.330Z"
3386 }
3387 ]
3388
3389 Ответ:
3390
3391 [
3392 {
3393 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3394 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3395 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3396 "BeginTime": "2023-06-30T11:28:43.331Z",
3397 "EndTime": "2023-06-30T11:28:43.331Z"
3398 }
3399 ]
3400
3401
3402 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3403
3404 (% class="box errormessage" %)
3405 (((
3406 **DELETE /api/v3/DriversRfidsAssignments**
3407 )))
3408
3409 Запрос:
3410
3411 [
3412 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3413 ]
3414
3415 Ответ:
3416
3417 Success
3418
3419
3420 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3421
3422 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3423
3424 (% class="box infomessage" %)
3425 (((
3426 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3427 )))
3428
3429 Запрос:
3430
3431 {
3432 "Ids": [
3433 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3434 ],
3435 "BeginTime": "2023-06-30T12:45:10.852Z",
3436 "EndTime": "2023-06-30T12:45:10.852Z"
3437 }
3438
3439 Ответ:
3440
3441 [
3442 {
3443 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3444 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3445 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3446 "BeginTime": "2023-06-30T11:58:04.695Z",
3447 "EndTime": "2023-06-30T11:58:04.695Z"
3448 }
3449 ]
3450
3451
3452 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3453
3454 (% class="box infomessage" %)
3455 (((
3456 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3457 )))
3458
3459 Запрос:
3460
3461 {
3462 "Ids": [
3463 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3464 ],
3465 "BeginTime": "2023-06-30T12:45:10.852Z",
3466 "EndTime": "2023-06-30T12:45:10.852Z"
3467 }
3468
3469 Ответ:
3470
3471 [
3472 {
3473 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3474 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3475 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3476 "BeginTime": "2023-06-30T11:58:04.695Z",
3477 "EndTime": "2023-06-30T11:58:04.695Z"
3478 }
3479 ]
3480
3481
3482 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3483
3484 (% class="box successmessage" %)
3485 (((
3486 **POST /api/v3/DriversFuelCardsAssignments**
3487 )))
3488
3489 Запрос:
3490
3491 [
3492 {
3493 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3494 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3495 "BeginTime": "2023-06-30T12:09:53.175Z",
3496 "EndTime": "2023-06-30T12:09:53.175Z"
3497 }
3498 ]
3499
3500 Ответ:
3501
3502 [
3503 {
3504 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3505 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3506 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3507 "BeginTime": "2023-06-30T12:09:53.201Z",
3508 "EndTime": "2023-06-30T12:09:53.201Z"
3509 }
3510 ]
3511
3512
3513 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3514
3515 (% class="box warningmessage" %)
3516 (((
3517 **PUT /api/v3/DriversFuelCardsAssignments**
3518 )))
3519
3520 Запрос:
3521
3522 [
3523 {
3524 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3525 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3526 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3527 "BeginTime": "2023-06-30T12:09:53.201Z",
3528 "EndTime": "2023-06-30T12:09:53.201Z"
3529 }
3530 ]
3531
3532 Ответ:
3533
3534 [
3535 {
3536 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3537 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3538 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3539 "BeginTime": "2023-06-30T12:09:53.201Z",
3540 "EndTime": "2023-06-30T12:09:53.201Z"
3541 }
3542 ]
3543
3544
3545 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3546
3547 (% class="box errormessage" %)
3548 (((
3549 **DELETE /api/v3/DriversFuelCardsAssignments**
3550 )))
3551
3552 Запрос:
3553
3554 [
3555 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3556 ]
3557
3558 Ответ:
3559
3560 Success
3561
3562
3563 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3564
3565 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3566
3567 (% class="box infomessage" %)
3568 (((
3569 **POST /api/v3/Trailers**
3570 )))
3571
3572 Пример запроса:
3573
3574 {
3575 "startDate": "2023-11-14T10:48:03.671Z",
3576 "endDate": "2023-11-14T10:48:03.671Z",
3577 "ids": [ 0 ],
3578 "timezone": 0
3579 }
3580
3581 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3582 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3583 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3584 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3585 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3586
3587 Пример ответа:
3588
3589 [
3590 {
3591 "SD": "2023-11-14T10:48:03.717Z",
3592 "ED": "2023-11-14T10:48:03.717Z", 
3593 "id": 0,
3594 "SLat": 0,
3595 "SLon": 0,
3596 "ELat": 0,
3597 "ELon": 0,
3598 "mileage": 0
3599 "Duration": 0
3600 "Address": "string",
3601 "Address2": "string",
3602 "name": "string",
3603 "rid": "string",
3604 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3605 "trailer": {
3606 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3607 "Number": "string",
3608 "Description": "string",
3609 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3610 "ExternalID": "string",
3611 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3612 "CreateTime": "2023-11-14T10:48:03.717Z",
3613 "UpdateTime": "2023-11-14T10:48:03.717Z",
3614 "IsDeleted": true
3615 },
3616 "filesCount": 0,
3617 }
3618 ]
3619
3620 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3621 |SD|Дата и время начала события
3622 |ED|Дата и время окончания события
3623 |id|ID объекта
3624 |SLat|Широта начальной координаты
3625 |SLon|Долгота начальной координаты
3626 |ELat|Широта конечной координаты
3627 |ELon|Долгота конечной координаты
3628 |mileage|Пробег
3629 |Duration|Продолжительность
3630 |Address|Адрес начального местоположения
3631 |Address2|Адрес конечного местоположения
3632 |name|Имя радиометки
3633 |rid|Номер радиометки
3634 |rguid|ID радиометки
3635 |trailer|Информация об агрегате
3636 |ModelGuid|ID агрегата
3637 |Number|Название/номер агрегата
3638 |Description|Текст примечания агрегата
3639
3640 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3641
3642 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3643
3644 (% class="box infomessage" %)
3645 (((
3646 **POST /api/v3/Rfids/find**
3647 )))
3648
3649 Запрос:
3650
3651 {
3652 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3653 }
3654
3655 Ответ:
3656
3657 [
3658 {
3659 "name": "string",
3660 "number": 0,
3661 "period": 0,
3662 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3663 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3664 }
3665 ]
3666
3667 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3668 |parentId|ID клиента
3669 |name|Название карты-метки
3670 |number|Номер
3671 |period|Период запросов в секундах (работает только для агрегатов)
3672 |id|ID карты-метки
3673
3674 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3675
3676 (% class="box infomessage" %)
3677 (((
3678 **GET /api/v3/Rfids/{rfidGuid}**
3679 )))
3680
3681 Передаем параметр rfidGuid - идентификатор карты-метки
3682
3683 Ответ:
3684
3685 [
3686 {
3687 "name": "string",
3688 "number": 0,
3689 "period": 0,
3690 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3691 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3692 }
3693 ]
3694
3695 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3696 |name|Название карты-метки
3697 |number|Номер
3698 |period|Период запросов в секундах (работает только для агрегатов)
3699 |id|ID карты-метки
3700 |parentId|ID клиента
3701
3702 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3703
3704 (% class="box successmessage" %)
3705 (((
3706 **POST /api/v3/Rfids**
3707 )))
3708
3709 Запрос:
3710
3711 {
3712 "name": "string",
3713 "number": 0,
3714 "period": 0,
3715 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3716 }
3717
3718 Ответ:
3719
3720 {
3721 "name": "string",
3722 "number": 0,
3723 "period": 0,
3724 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3725 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3726 }
3727
3728 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3729 |name|Название карты-метки
3730 |number|Номер
3731 |period|Период запросов в секундах (работает только для агрегатов)
3732 |id|ID карты-метки
3733 |parentId|ID клиента
3734
3735 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3736
3737 (% class="box warningmessage" %)
3738 (((
3739 **PUT /api/v3/Rfids**
3740 )))
3741
3742 Запрос:
3743
3744 {
3745 "name": "string",
3746 "number": 0,
3747 "period": 0,
3748 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3749 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3750 }
3751
3752 Ответ:
3753
3754 {
3755 "name": "string",
3756 "number": 0,
3757 "period": 0,
3758 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3759 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3760 }
3761
3762 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3763 |name|Название карты-метки
3764 |number|Номер
3765 |period|Период запросов в секундах (работает только для агрегатов)
3766 |id|ID карты-метки
3767 |parentId|ID клиента
3768
3769 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3770
3771 (% class="box errormessage" %)
3772 (((
3773 **DELETE /api/v3/Rfids/{rfidGuid}**
3774 )))
3775
3776 Передаем параметр **rfidGuid** - идентификатор карты-метки
3777
3778 Ответ:
3779
3780 Success
3781
3782
3783 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3784
3785 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3786
3787 (% class="box infomessage" %)
3788 (((
3789 **GET /api/v3/Billing/client/balance/{clientId}**
3790 )))
3791
3792 Параметр запроса: **clientId **- идентификатор клиента.
3793
3794 Ответ:
3795
3796 {
3797 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3798 "Balance": 0
3799 }
3800
3801 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3802 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3803 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3804
3805 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3806
3807 (% class="box infomessage" %)
3808 (((
3809 **GET /api/v3/Billing/client/constraint/{clientId}**
3810 )))
3811
3812 Параметр запроса: **clientId **- идентификатор клиента.
3813
3814 Ответ:
3815
3816 {
3817 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3818 "CalculationType": 0,
3819 "PermissibleBalance": 0,
3820 "DefermentDays": 0,
3821 "SendUiNotifications": true,
3822 "SendEmailNotifications": true,
3823 "IsPrivate": true,
3824 }
3825
3826 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3827 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3828 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3829 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3830 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3831 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3832 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3833 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3834
3835 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3836
3837 (% class="box infomessage" %)
3838 (((
3839 **GET /api/v3/Billing/client/plan/{clientId}**
3840 )))
3841
3842 Параметры запроса:
3843
3844 **clientId **- идентификатор клиента.
3845
3846 **planId **- идентификатор тарифного плана.
3847
3848 Ответ:
3849
3850 {
3851 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3852 "Plan": { **~/~/ Описание тарифного плана**
3853 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3854 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3855 "Name": "string",
3856 "IsArchived": true,
3857 "Constraint": {
3858 "CalculationType": 0,
3859 "PermissibleBalance": 0,
3860 "DefermentDays": 0
3861 },
3862 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3863 {
3864 "Feature": "string",
3865 "IsFactual": true,
3866 "Limit": 0,
3867 "Price": 0,
3868 "PeriodValue": 0,
3869 "PeriodType": 0
3870 }
3871 ]
3872 },
3873 "DebitDate": "2023-10-18T12:46:24.213Z",
3874 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3875 {
3876 "Feature": "string",
3877 "IsEnabled": true,
3878 "IsPrivate": true,
3879 "IsFactual": true,
3880 "Limit": 0,
3881 "Price": 0,
3882 "DebitDate": "2023-10-18T12:46:24.213Z",
3883 "PeriodValue": 0,
3884 "PeriodType": 0
3885 }
3886 ]
3887 }
3888
3889 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3890 |ClientId|Идентификатор клиента
3891 |Id|Идентификатор тарифного плана
3892 |OwnerId|Идентификатор клиента-владельца
3893 |Name|Наименование тарифного плана
3894 |IsArchived|Признак, определяющий архивный тарифный план
3895 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3896 |PermissibleBalance|Допустимый баланс
3897 |DefermentDays|Отсрочка, количество дней
3898 |Feature|Код услуги
3899 |IsEnabled|Признак, определяющий активирована ли услуга
3900 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3901 |IsFactual|Признак, определяющий расчёт по факту
3902 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3903 |Price|Цена за единицу.
3904 |DebitDate|Следующий момент времени списания с баланса за услугу.
3905 |PeriodValue|Значение периода.
3906 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3907
3908 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3909
3910 (% class="box infomessage" %)
3911 (((
3912 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3913 )))
3914
3915 Параметр запроса: **clientId **- идентификатор клиента.
3916
3917 Ответ:
3918
3919 [
3920 {
3921 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3922 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3923 "Name": "string",
3924 "IsArchived": true,
3925 "Constraint": {
3926 "CalculationType": 0,
3927 "PermissibleBalance": 0,
3928 "DefermentDays": 0
3929 },
3930 "Features": [
3931 {
3932 "Feature": "string",
3933 "IsFactual": true,
3934 "Limit": 0,
3935 "Price": 0,
3936 "PeriodValue": 0,
3937 "PeriodType": 0
3938 }
3939 ]
3940 }
3941 ]
3942
3943 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3944 |ClientId|Идентификатор клиента
3945 |Id|Идентификатор тарифного плана
3946 |OwnerId|Идентификатор клиента-владельца
3947 |Name|Наименование тарифного плана
3948 |IsArchived|Признак, определяющий архивный тарифный план
3949 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3950 |PermissibleBalance|Допустимый баланс
3951 |DefermentDays|Отсрочка, количество дней
3952 |Feature|Код услуги
3953 |IsFactual|Признак, определяющий расчёт по факту
3954 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3955 |Price|Цена за единицу.
3956 |PeriodValue|Значение периода.
3957 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3958
3959 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3960
3961 (% class="box infomessage" %)
3962 (((
3963 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3964 )))
3965
3966 Параметр запроса: **clientId **- идентификатор клиента.
3967
3968 Ответ:
3969
3970 [
3971 {
3972 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3973 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3974 "Name": "string",
3975 "IsArchived": true,
3976 "Constraint": {
3977 "CalculationType": 0,
3978 "PermissibleBalance": 0,
3979 "DefermentDays": 0
3980 },
3981 "Features": [
3982 {
3983 "Feature": "string",
3984 "IsFactual": true,
3985 "Limit": 0,
3986 "Price": 0,
3987 "PeriodValue": 0,
3988 "PeriodType": 0
3989 }
3990 ]
3991 }
3992 ]
3993
3994 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3995 |ClientId|Идентификатор клиента
3996 |Id|Идентификатор тарифного плана
3997 |OwnerId|Идентификатор клиента-владельца
3998 |Name|Наименование тарифного плана
3999 |IsArchived|Признак, определяющий архивный тарифный план
4000 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4001 |PermissibleBalance|Допустимый баланс
4002 |DefermentDays|Отсрочка, количество дней
4003 |Feature|Код услуги
4004 |IsFactual|Признак, определяющий расчёт по факту
4005 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4006 |Price|Цена за единицу.
4007 |PeriodValue|Значение периода.
4008 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4009
4010 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4011
4012 (% class="box warningmessage" %)
4013 (((
4014 **PUT /api/v3/Billing/client/balance**
4015 )))
4016
4017 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4018
4019 Тело запроса:
4020
4021 {
4022 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4023 "Balance": 0
4024 }
4025
4026 Ответ: Success
4027
4028 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4029 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4030 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4031
4032 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4033
4034 (% class="box warningmessage" %)
4035 (((
4036 **PUT /api/v3/billing/client/balance/deposit**
4037 )))
4038
4039 Создает операцию **Пополнение **с указанной суммой
4040
4041 Тело запроса:
4042
4043 {
4044 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4045 "Balance": 0
4046 }
4047
4048 Ответ: Success
4049
4050 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4051 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4052 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4053
4054 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4055
4056 Создает операцию **Списание **с указанной суммой
4057
4058 (% class="box warningmessage" %)
4059 (((
4060 **PUT /api/v3/billing/client/balance/withdraw**
4061 )))
4062
4063 Тело запроса:
4064
4065 {
4066 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4067 "Balance": 0
4068 }
4069
4070 Ответ: Success
4071
4072 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4073 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4074 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4075
4076 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4077
4078 (% class="box warningmessage" %)
4079 (((
4080 **PUT /api/v3/Billing/client/constraint**
4081 )))
4082
4083 Тело запроса:
4084
4085 {
4086 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4087 "CalculationType": 0,
4088 "PermissibleBalance": 0,
4089 "DefermentDays": 0,
4090 "SendUiNotifications": true,
4091 "SendEmailNotifications": true,
4092 "IsPrivate": true,
4093 }
4094
4095 Ответ: Success
4096
4097 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4098 |ClientId|Идентификатор клиента
4099 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4100 |PermissibleBalance|Допустимый баланс
4101 |DefermentDays|(((
4102 Отсрочка, количество дней
4103 )))
4104 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4105 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4106 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4107
4108 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4109
4110 (% class="box warningmessage" %)
4111 (((
4112 **PUT /api/v3/Billing/client/plan**
4113 )))
4114
4115 Тело запроса:
4116
4117 {
4118 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4119 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4120 "Features": [
4121 {
4122 "Feature": "string",
4123 "IsEnabled": true,
4124 "IsFactual": true,
4125 "Limit": 0,
4126 "Price": 0,
4127 "DebitDate": "2023-10-18T13:26:58.987Z",
4128 "PeriodValue": 0,
4129 "PeriodType": 0
4130 }
4131 ]
4132 }
4133
4134 Ответ: Success
4135
4136 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4137 |ClientId|Идентификатор клиента
4138 |PlanId|Идентификатор тарифного плана
4139 |Feature|Код услуги
4140 |IsEnabled|Признак, определяющий активирована ли услуга
4141 |IsFactual|Признак, определяющий расчёт по факту
4142 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4143 |Price|Цена за единицу.
4144 |DebitDate|Следующий момент времени списания с баланса за услугу.
4145 |PeriodValue|Значение периода.
4146 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4147
4148 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4149
4150 (% class="box warningmessage" %)
4151 (((
4152 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4153 )))
4154
4155 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4156
4157 (% class="box infomessage" %)
4158 (((
4159 **POST /api/v3/vehicles/import/{agentId}**
4160 )))
4161
4162 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4163
4164 В пути указывается **agentId** - id клиента.
4165
4166 **Заголовок**
4167
4168 **X-Auth: [токен авторизации]**
4169
4170 **Параметры**
4171
4172 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4173 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4174 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4175
4176 В теле использовать тип **form-data,** тип значения** file**
4177
4178 **Ключи**
4179
4180 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4181 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4182 |csv|В значении передаем файл датчиков, формат **csv**
4183
4184 Ответ:
4185
4186 {
4187 "vehicleId": 0,
4188 "name": "string",
4189 "errors": ["string"]
4190 }
4191
4192 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4193 |vehicleId|ID созданного объекта
4194 |name|Имя созданного объекта
4195 |errors|Ошибки и их описание
4196
4197 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4198
4199 (% class="box infomessage" %)
4200 (((
4201 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4202 )))
4203
4204 (% class="wikigeneratedid" %)
4205 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4206
4207 (% class="wikigeneratedid" %)
4208 В пути указывается **vehicleId **- id объекта.
4209
4210 **Заголовок**
4211
4212 **X-Auth: [токен авторизации]**
4213
4214 В теле использовать тип **form-data.**
4215
4216 Ключи:
4217
4218 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4219 |**history**|В значении передавать файл с историей
4220
4221 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4222
4223 Ответ:
4224
4225 {
4226 "results": [
4227 {
4228 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4229 "vehicleId": 0,
4230 "errors": [
4231 "string"
4232 ],
4233 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4234 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4235 "producedCount": 0,
4236 "msgCount": 0
4237 }
4238 ]
4239 }
4240
4241 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4242 |results|Результаты импорта в разрезе ТС
4243 |vehicleGuid|Guid ТС
4244 |vehicleId|ID ТС
4245 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4246 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4247 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4248 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4249 |msgCount|Кол-во обработанных сообщений всего
4250
4251 == ==
4252
4253 == **Импортировать историю ТС (Асинхронный запрос)** ==
4254
4255 (% class="box successmessage" %)
4256 (((
4257 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4258 )))
4259
4260 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4261
4262 Метод запроса: **POST**
4263
4264 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4265
4266 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4267
4268
4269 Ответ:
4270
4271 {
4272
4273 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4274
4275 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4276
4277 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4278
4279 "Message": "string", ~/~/ Информация о выполнении запроса
4280
4281 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4282
4283 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4284
4285 "Data": "string" ~/~/ Данные
4286
4287 }
4288
4289
4290 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4291
4292 (% class="box infomessage" %)
4293 (((
4294 **GET /api/v3/vehicles/import/history/status**
4295 )))
4296
4297 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4298
4299 Ответ:
4300
4301 {
4302 "activity": true,
4303 "progress": 0,
4304 "message": "string"
4305 }
4306
4307 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4308 **Параметр**
4309 )))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4310 **Описание**
4311 )))
4312 |(((
4313 activity
4314 )))|(((
4315 Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4316 )))
4317 |(((
4318 progress
4319 )))|(((
4320 Guid ТС
4321 )))
4322
4323
4324 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
4325
4326 (% class="box infomessage" %)
4327 (((
4328 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4329 )))
4330
4331 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4332
4333 Метод запроса: **GET**
4334
4335 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4336
4337 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4338
4339
4340 Ответ:
4341
4342 {
4343
4344 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4345
4346 "Status": 0, ~/~/ Перечисление состояний выполения запроса
4347 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4348
4349 "Message": "string", ~/~/ Информация о выполнении запроса
4350
4351 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4352
4353 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4354
4355 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4356
4357 "Data": "string" ~/~/ Данные
4358
4359 }
4360
4361 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4362
4363 (% class="box infomessage" %)
4364 (((
4365 **POST /api/v3/vehicles/export**
4366 )))
4367
4368 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4369
4370 Тело запроса:
4371
4372 [
4373 id
4374 ]
4375
4376 Ответ: Success 200, получаете файлы с настройками.
4377
4378 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4379
4380 (% class="box infomessage" %)
4381 (((
4382 **POST /api/v3/vehicles/export/history**
4383 )))
4384
4385 Метод возвращает список сообщений терминала объекта за выбранный период.
4386
4387 Тело запроса:
4388
4389 {
4390 "vehicleId": 0,
4391 "asArchive": true,
4392 "from": "2023-09-27T12:17:45.973Z",
4393 "to": "2023-09-27T12:17:45.973Z"
4394 }
4395
4396 Ответ:
4397
4398 Получаете файл. Сообщение: Code 200/Success
4399
4400 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4401 |vehicleId|ID объекта
4402 |asArchive|true - Архивировать файл, False - не архивировать
4403 |from|Дата и время начала запроса
4404 |to|Дата и время окончания запроса
4405
4406 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4407
4408 (% class="box infomessage" %)
4409 (((
4410 **GET /api/v3/vehicles/export/history/status**
4411 )))
4412
4413 Метод возвращает список сообщений терминала объекта за выбранный период.
4414
4415 Ответ:
4416
4417 {
4418 "activity": true,
4419 "progress": 0,
4420 "message": "string"
4421 }
4422
4423 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4424 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4425 |progress|Прогресс экспорта, от 0 до 100%
4426 |message|Текст описывающий статус
4427
4428 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4429
4430 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4431
4432 (% class="box infomessage" %)
4433 (((
4434 **POST /api/v3/EcoDriving/rating**
4435 )))
4436
4437 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4438
4439 Тело запроса:
4440
4441 {
4442 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4443 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4444 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4445 }
4446
4447 Ответ:
4448
4449 {
4450 "items": [  ~/~/ Список в разрезе ТС
4451 {
4452 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4453 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4454 "vehicleId": 0, ~/~/ ID ТС
4455 "vehicleName": "string", ~/~/ Название ТС
4456 "vehicleModel": "string", ~/~/ Модель ТС
4457 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4458 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4459 "totalViolations": 0, ~/~/ Нарушений всего
4460 "violationsByType": { ~/~/ Информация о нарушениях по типу
4461 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4462 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4463 "brakingViolations": 0, ~/~/ Нарушений торможения
4464 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4465 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4466 "sensorViolations": 0 ~/~/ Нарушений по датчику
4467 },
4468
4469 (((
4470
4471 )))
4472
4473 "moveTime": 0, ~/~/ Продолжительность движения, сек
4474 "mileage": 0, ~/~/ Пробег, м
4475 "tripsCount": 0, ~/~/ Кол-во рейсов
4476 "trips": [  ~/~/ Информация по рейсу
4477 {
4478 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4479 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4480 "violationsCount": 0, ~/~/ Всего нарушений
4481 "violationsByType": { ~/~/ Информация о нарушениях по типу
4482 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4483 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4484 "brakingViolations": 0, ~/~/ Нарушений торможения
4485 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4486 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4487 "sensorViolations": 0 ~/~/ Нарушений по датчику
4488 },
4489
4490 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4491 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4492 "moveTime": 0, ~/~/ Продолжительность движения, сек
4493 "mileage": 0, ~/~/ Пробег, м
4494 "motohours": 0, ~/~/ Моточасы, секунды
4495 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4496 "startAddress": "string", ~/~/ Адрес начала рейса
4497 "endAddress": "string", ~/~/ Адрес конца рейса
4498 "drivers": [  ~/~/ Список водителей
4499 {
4500 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4501 "driverName": "string", ~/~/ФИО водителя
4502 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4503 }
4504 ]
4505 }
4506 ]
4507 }
4508 ]
4509 }
4510
4511 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4512
4513 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4514
4515 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4516
4517 (% class="box infomessage" %)
4518 (((
4519 **POST /api/v3/fuelcards/transactions**
4520 )))
4521
4522 Метод запроса: POST
4523
4524 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4525 \\В заголовках запроса: X-Auth: Токен авторизации
4526
4527 Параметры в теле запроса (JSON):
4528
4529 {
4530 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4531 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4532 "ids": [ 
4533 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4534 ],
4535 "timezone": 0 ~/~/ Часовой пояс
4536 }
4537
4538
4539 Ответ:
4540 {
4541 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4542 "driver": "string", ~/~/ Водители, привязанные к ТК
4543 "object": "string", ~/~/ Наименование ТС
4544 "amount": 0, ~/~/ Количество топлива
4545 "amountDut": 0, ~/~/ Количество по ДУТ
4546 "amountDiff": 0, ~/~/ Разница, л
4547 "amountDiffPerc": 0, ~/~/ Разница, %
4548 "summa": 0, ~/~/ Стоимость, руб
4549 "serviceName": "string", ~/~/ Тип топлива
4550 "price": 0, ~/~/ Цена за литр, руб
4551 "cardName": "string", ~/~/ Наименование ТК
4552 "cardNum": "string", ~/~/ Номер ТК
4553 "operator": "string", ~/~/ Оператор ТК
4554 "address": "string" ~/~/ Адрес АЗС
4555 }
4556
4557 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4558
4559 (% class="box infomessage" %)
4560 (((
4561 **GET /api/v3/fuelcards**
4562 )))
4563
4564 Метод запроса: GET
4565
4566 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4567
4568 Ответ:
4569
4570 [
4571 {
4572 "Name": "string", ~/~/ Определяет наименование карты.
4573 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4574 "Number": "string", ~/~/ Определяет № карты.
4575 "Enabled": true, ~/~/ Определяет признак активности карты.
4576 "Description": "string", ~/~/ Определяет описание карты.
4577 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4578 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4579 "deleted": true ~/~/ Признак удаления
4580 }
4581 ]
4582
4583 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4584
4585
4586 == **Получение полных данных о ретрансляторе** ==
4587
4588 (% class="box infomessage" %)
4589 (((
4590 **GET ** **/api/v3/retranslations/{id}**
4591 )))
4592
4593 id - Идентификатор ретранслятора
4594
4595
4596 Пример ответа:
4597
4598 {  
4599 "description": "", ~/~/ Поле описания ретранслятора
4600 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4601 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4602 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4603 "address": "string", ~/~/ Адрес и порт принимающего сервера
4604 "objects": [ ~/~/ Объекты для ретрансляции
4605 {      
4606 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4607 "name": "", ~/~/ Наименование объекта ретрансляции
4608 "imei": "", ~/~/ IMEI объекта  ретрансляции
4609 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4610 }
4611 ],  
4612 "id": "", ~/~/ Идентификатор ретранслятора 
4613 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4614 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4615 }
4616
4617
4618 == **Удаление данных ретранслятора** ==
4619
4620 (% class="box infomessage" %)
4621 (((
4622 **DELETE** **/api/v3/retranslations/{id}**
4623 )))
4624
4625 id - Идентификатор ретранслятора
4626
4627
4628 == **Создание ретранслятора** ==
4629
4630 (% class="box infomessage" %)
4631 (((
4632 **POST ** **/api/v3/retranslations/{id}**
4633 )))
4634
4635 Запрос:
4636
4637 {  
4638 "description": "", ~/~/ Поле описания ретранслятора
4639 "subscriberId": "", ~/~/ Идентификатор подписчика
4640 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4641 "address": "", ~/~/ Адрес и порт принимающего сервера
4642 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4643 "objects": [ ~/~/Объекты для ретрансляции
4644 {      
4645 "id": "", ~/~/ Идентификатор ретранслятора 
4646 "imei": "", ~/~/ IMEI объекта ретрансляции
4647 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4648 }
4649 ]
4650 }
4651
4652
4653 Ответ:
4654
4655 {  
4656 "description": "", ~/~/ Поле описания ретранслятора
4657 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4658 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4659 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4660 "address": "string", ~/~/ Адрес и порт принимающего сервера
4661 "objects": [ ~/~/ Объекты для ретрансляции
4662 {      
4663 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4664 "name": "string", ~/~/ Наименование объекта ретрансляции    
4665 "imei": "", ~/~/ IMEI объекта ретрансляции
4666 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4667 }
4668 ],
4669 "id": "", ~/~/ Идентификатор ретранслятора   
4670 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4671 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4672 }
4673
4674
4675 == **Редактирование ретранслятора** ==
4676
4677 (% class="box infomessage" %)
4678 (((
4679 **PUT** **/api/v3/retranslations**
4680 )))
4681
4682 Пример запроса:
4683
4684 {  
4685 "id": "", ~/~/ Идентификатор ретранслятора   
4686 "description": "string", ~/~/ Поле описания ретранслятора
4687 "subscriberId": "", ~/~/ Идентификатор подписчика
4688 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4689 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4690 "address": "string", ~/~/ Адрес и порт принимающего сервера
4691 "objects": ~/~/ Объекты для ретрансляции
4692 [    
4693 {      
4694 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
4695 "imei": "", ~/~/ IMEI объекта ретрансляции
4696 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4697 }
4698 ]
4699 }
4700
4701
4702 Пример ответа:
4703
4704 {  
4705 "description": "", ~/~/ Поле описания ретранслятора
4706 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4707 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4708 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4709 "address": "string", ~/~/ Адрес и порт принимающего сервера
4710 "objects": [ ~/~/ Объекты для ретрансляции
4711 {      
4712 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4713 "name": "string", ~/~/ Наименование объекта ретрансляции    
4714 "imei": "", ~/~/ IMEI объекта ретрансляции
4715 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4716 }
4717 ],
4718 "id": "", ~/~/ Идентификатор ретранслятора   
4719 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4720 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4721 }
4722
4723
4724 == **Получение списка ретранслятора клиента** ==
4725
4726 (% class="box infomessage" %)
4727 (((
4728 **POST /api/v3/retranslations/find**
4729 )))
4730
4731 Пример запроса:
4732
4733 {  
4734 "id": "", ~/~/ Идентификатор ретранслятора   
4735 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4736 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4737 }
4738
4739 Ответ:
4740
4741 [ 
4742 {    
4743 "description": "", ~/~/ Поле описания ретранслятора
4744 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4745 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4746 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4747 "address": "string", ~/~/ Адрес и порт принимающего сервера
4748 "id": "", ~/~/ Идентификатор ретранслятора   
4749 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4750 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4751 }
4752 ]
4753
4754
4755 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4756
4757 == **API для отчета по выгрузке комбайнов** ==
4758
4759 (% class="box infomessage" %)
4760 (((
4761 **POST /api/v3/Reports/harvesterUnloading**
4762 )))
4763
4764 Пример запроса:
4765
4766 {
4767 "byTime": 0, ~/~/ Объединение событий по времени
4768 "byDist": 0, ~/~/ Объединение событий по расстоянию
4769 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4770 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4771 "showNearestObjects": true, ~/~/Показывать объекты рядом?
4772 "vehicleIds": [ ~/~/ Список id объектов для анализа
4773 0
4774 ],
4775 "from": "", ~/~/ Дата и время начало запроса
4776 "to": "", ~/~/ Дата и время окончания запроса
4777 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4778 }
4779
4780 Пример ответа:
4781
4782 [ 
4783 {
4784 "harvesterName": "", ~/~/Комбайн, номер
4785 "harvesterId": 0, ~/~/Комбайн, id
4786 "harvesterModel": "", ~/~/ Модель комбайна
4787 "hopperCapacity": 0, ~/~/ Объем бункера м3
4788 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4789 "events": [ ~/~/Список событий в разрезе комбайна
4790 {
4791 "driverId": "", ~/~/Идентификатор водителя
4792 "driverName": "", ~/~/Водитель комбайна, ФИО
4793 "RFID": "", ~/~/ идентификатор карты-метки
4794 "rfidName": "", ~/~/Водитель комбайна, имя метки
4795 "vehicleId": 0, ~/~/идентификатор объекта
4796 "vehicleName": "string", ~/~/ Имя объекта
4797 "modelName": "string", ~/~/ Имя модели объекта
4798 "nearestVehicles": [ ~/~/Объекты рядом
4799 {
4800 "vehicleId": 0, ~/~/идентификатор объекта
4801 "vehicleName": "string" ~/~/ Имя объекта
4802 }
4803 ],
4804 "fields": [ ~/~/Поля, где происходила выгрузка
4805 {
4806 "id": 0, ~/~/ идентификатор пользователя 
4807 "name": "string" ~/~/ имя пользователя 
4808 }
4809 ],
4810 "event": "string", ~/~/Событие
4811 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4812 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4813 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4814 "cultureName": "string", ~/~/ название культуры
4815 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4816 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4817 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4818 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4819 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4820 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4821 "issued": 0, ~/~/Выдано, бункеров
4822 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4823 "latitude": 0, ~/~/Широта
4824 "longitude": 0, ~/~/ Долгота
4825 "litresAway": 0, ~/~/Отдано, л
4826 "m3Away": 0 ~/~/Отдано, м3
4827 }
4828 ]
4829 }
4830 ]
4831
4832
4833 == **Отчет трек-датчики** ==
4834
4835 (% class="box infomessage" %)
4836 (((
4837 **POST /api/v3/Reports/sensorsWorks**
4838 )))
4839
4840 **Пример запроса:**
4841
4842 {
4843 "vehicleIds": [ ~/~/ Список ID объектов
4844 0
4845 ],
4846 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4847 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4848 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4849 }
4850
4851 **Пример ответа:**
4852
4853 (((
4854 {
4855 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4856 {
4857 "vehicleId": 0, ~/~/ Идентификатор ТС
4858 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4859 {
4860 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4861 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4862 "duration": 0, ~/~/  Продолжительность интервала в секундах.
4863 "name": "string", ~/~/ Наименование оборудования.
4864 "mileage": 0, ~/~/ Пробег за время работы оборудования.
4865 "totalMileage": 0, ~/~/ Общий пробег.
4866 "avgSpeed": 0 ~/~/ Средняя скорость.
4867 }
4868 ]
4869 }
4870 ]
4871 }
4872
4873
4874 == **Превышение скорости** ==
4875
4876 (% class="box infomessage" %)
4877 (((
4878 **POST /api/v3/Reports/overSpeedDuration**
4879 )))
4880
4881 Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4882
4883 Пример запроса:
4884
4885 (((
4886 {
4887 "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4888 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4889 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4890 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4891 "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4892 }
4893 )))
4894
4895 (((
4896
4897 )))
4898
4899 (((
4900 Пример ответа:
4901 )))
4902
4903 (((
4904 (((
4905 [
4906 {
4907 "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4908 "duration": 0, ~/~/ Продолжительность события в секундах 
4909 "maxSpeed": 0, ~/~/ Максимальная скорость 
4910 "speedLimit": 0 ~/~/ Ограничение скорости 
4911 }
4912 ]
4913 )))
4914 )))
4915 )))
4916
4917 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4918
4919
4920 == **Запрос списка полей** ==
4921
4922 (% class="box successmessage" %)
4923 (((
4924 **POST /api/v3/agroLands/find**
4925 )))
4926
4927 Пример запроса:
4928
4929 (((
4930 (((
4931 (((
4932 {
4933 "year": 0, ~/~/ Фильтр по году
4934 "name": "string", ~/~/ Фильтр по названию
4935 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4936 }
4937 )))
4938 )))
4939
4940
4941 )))
4942
4943 Пример ответа:
4944
4945 (((
4946 [
4947 {
4948 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4949 "year": 0, ~/~/ Год поля
4950 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4951 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4952 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4953 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4954 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4955 "counts": { ~/~/ Счётчики с/х поля 
4956 "fieldOperations": 0, ~/~/ Количество операций на поле
4957 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4958 "facts": 0 ~/~/ Счётчик факта
4959 },
4960 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4961 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4962 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4963 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4964 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4965 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4966 "planComment": "string", ~/~/ Комментарий к полю
4967 "productivity": 0, ~/~/ Урожайность.
4968 "id": 0, ~/~/ Идентификатор объекта геозоны
4969 "name": "string", ~/~/ Название объекта геозоны
4970 "type": 0, ~/~/ Тип объекта геозоны
4971 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4972 "fname": "string", ~/~/ Имя файла
4973 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4974 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4975 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4976 "description": "string", ~/~/ Описание объекта геозоны
4977 "area": 0, ~/~/ Площадь, м2
4978 "perimetr": 0, ~/~/ Периметр, м
4979 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4980 }
4981 ]
4982
4983
4984 == **Создание нового поля ** ==
4985
4986 (% class="box successmessage" %)
4987 (((
4988 **POST /api/v3/agroLands**
4989 )))
4990
4991 Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
4992 X-agent  - ID клиента
4993
4994 Пример запроса:
4995
4996 (((
4997 {
4998 "extId": "string", 
4999 "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5000 "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5001 "display": "string", ~/~/ Настройки отображения
5002 "year": 0, ~/~/ Год поля
5003 "name": "string", ~/~/ Наименование
5004 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5005 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5006 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5007 "planComment": "string", ~/~/ Комментарий к полю
5008 "cropRotations": [ ~/~/ Данные по севообороту
5009 {
5010 "landId": 0, ~/~/ ID поля
5011 "landName": "string", ~/~/ Название поля
5012 "year": 0, ~/~/ Год урожая
5013 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5014 "cultureName": "string", ~/~/ Название культуры
5015 "productivity": 0, ~/~/ Урожайность
5016 "area": 0, ~/~/ Площадь поля, Га
5017 "total": 0, ~/~/ Валовый сбор
5018 "productivityFact": 0, ~/~/ Фактическая урожайность
5019 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5020 "totalFact": 0, ~/~/ Фактический валовый сбор
5021 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5022 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5023 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5024 "isyearplan": true, ~/~/ Годовой план 
5025 "comment": "string" ~/~/ Комментарий
5026 }
5027 ]
5028 }
5029 )))
5030
5031 (((
5032
5033 )))
5034
5035 Пример ответа:
5036
5037 (((
5038 (((
5039 {
5040 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5041 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5042 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5043 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5044 "cropRotations": [ ~/~/ Данные по севообороту
5045 {
5046 "landId": 0, ~/~/ ID поля
5047 "landName": "string", ~/~/ Название поля
5048 "year": 0, ~/~/ Год урожая 
5049 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5050 "cultureName": "string", ~/~/ Название культуры
5051 "productivity": 0, ~/~/ Урожайность
5052 "area": 0, ~/~/ Площадь поля, Га.
5053 "total": 0, ~/~/ Валовый сбор
5054 "productivityFact": 0, ~/~/ Фактическая урожайность
5055 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5056 "totalFact": 0, ~/~/ Фактический валовый сбор
5057 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5058 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5059 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5060 "isyearplan": true, ~/~/ годовой план 
5061 "comment": "string" ~/~/ Комментарий
5062 }
5063 ],
5064 "cropVegetation": [ ~/~/ История вегетации поля
5065 {
5066 "values": [  ~/~/ Данные вегетации и состояния посева
5067 {
5068 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5069 "ndvi": 0 ~/~/ Индекс вегетации
5070 }
5071 ],
5072 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5073 {
5074 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5075 "type": "string", ~/~/ Тип
5076 "pictureid": "string" ~/~/ Идентификатор ресурса
5077 }
5078 ],
5079 "states": [ ~/~/ Ключевые даты развития поля
5080 {
5081 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5082 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5083 }
5084 ]
5085 }
5086 ],
5087 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5088 "counts": {
5089 "fieldOperations": 0, ~/~/ Количество операций на поле
5090 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5091 "facts": 0 ~/~/ Счётчик факта
5092 },
5093 "planComment": "string", ~/~/ Комментарий к полю
5094 )))
5095
5096 (((
5097 "productivity": 0, ~/~/ Урожайность.
5098 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5099 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5100 "year": 0, ~/~/ Год поля
5101 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5102 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5103 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5104 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5105 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5106 "id": 0, ~/~/ Идентификатор объекта геозоны
5107 "name": "string", ~/~/ Название объекта геозоны
5108 "type": 0, ~/~/ Тип объекта геозоны
5109 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5110 "fname": "string", ~/~/ Имя файла
5111 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5112 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5113 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5114 "description": "string", ~/~/ Описание объекта геозоны
5115 "area": 0, ~/~/ Площадь, м2
5116 "perimetr": 0, ~/~/ Периметр, м
5117 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5118 }
5119
5120
5121 )))
5122 )))
5123 )))
5124
5125 == **Получение поля по id** ==
5126
5127 (% class="box infomessage" %)
5128 (((
5129 **GET /api/v3/agroLands/{id}**
5130 )))
5131
5132 Пример запроса:
5133 id  ~/~/ Идентификатор поля
5134
5135 Пример ответа:
5136
5137 (((
5138 {
5139 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5140 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5141 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5142 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5143 "cropRotations": [ ~/~/ Данные по севообороту
5144 {
5145 "landId": 0, ~/~/ ID поля
5146 "landName": "string", ~/~/ Название поля
5147 "year": 0, ~/~/ Год урожая
5148 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5149 "cultureName": "string", ~/~/ Название культуры
5150 "productivity": 0, ~/~/ Урожайность
5151 "area": 0, ~/~/ Площадь поля, Га
5152 "total": 0, ~/~/ Валовый сбор
5153 "productivityFact": 0, ~/~/ Фактическая урожайность
5154 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5155 "totalFact": 0, ~/~/ Фактический валовый сбор
5156 "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5157 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5158 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5159 "isyearplan": true, ~/~/ План года 
5160 "comment": "string" ~/~/ Комментарий
5161 }
5162 ],
5163 "cropVegetation": [ ~/~/ История вегетации поля
5164 {
5165 "values": [ ~/~/ Данные вегетации и состояния посева
5166 {
5167 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5168 "ndvi": 0 ~/~/ Индекс вегетации
5169 }
5170 ],
5171 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5172 {
5173 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5174 "type": "string", ~/~/ Тип 
5175 "pictureid": "string" ~/~/ Идентификатор ресурса
5176 }
5177 ],
5178 "states": [ ~/~/ Ключевые даты развития поля
5179 {
5180 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5181 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5182 }
5183 ]
5184 }
5185 ],
5186 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5187 "counts": {
5188 "fieldOperations": 0, ~/~/ Количество операций на поле
5189 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5190 "facts": 0 ~/~/ Счётчик факта
5191 },
5192 "planComment": "string", ~/~/ Комментарий к полю
5193 "productivity": 0, ~/~/ Урожайность.
5194 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5195 )))
5196
5197 (((
5198 (((
5199 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5200 "year": 0, ~/~/ Год поля
5201 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5202 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5203 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5204 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5205 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5206 "id": 0, ~/~/ Идентификатор объекта геозоны
5207 "name": "string", ~/~/ Название объекта геозоны
5208 "type": 0, ~/~/ Тип объекта геозоны 
5209 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5210 "fname": "string", ~/~/ Имя файла
5211 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5212 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5213 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5214 "description": "string", ~/~/ Описание объекта геозоны
5215 "area": 0, ~/~/ Площадь, м2
5216 "perimetr": 0, ~/~/ Периметр, м
5217 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5218 }
5219 )))
5220
5221
5222 == **Удаление существующего поля** ==
5223
5224 (% class="box errormessage" %)
5225 (((
5226 **DELETE /api/v3/agroLands/{id}**
5227 )))
5228
5229 Пример запроса:
5230 id  ~/~/ Идентификатор поля
5231
5232 Пример ответа:
5233
5234 (((
5235 200 ~/~/ Успех
5236 )))
5237
5238 (((
5239
5240 )))
5241
5242 (((
5243 (((
5244 (((
5245
5246 )))
5247
5248 (((
5249 == **Изменение поля** ==
5250
5251 (% class="box infomessage" %)
5252 (((
5253 **PUT /api/v3/agroLands**
5254 )))
5255
5256 Пример запроса:
5257
5258 (((
5259 (((
5260 {
5261 "id": 0, ~/~/ Идентификатор поля
5262 "extId": "string", ~/~/ ExtId
5263 "shape": "string", ~/~/ Форма поля
5264 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5265 "display": "string", ~/~/ Настройки отображения
5266 "year": 0, ~/~/ Год поля
5267 "name": "string", ~/~/ Наименование
5268 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5269 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5270 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5271 "planComment": "string", ~/~/Комментарий к полю
5272 "cropRotations": [  ~/~/ Данные по севообороту
5273 {
5274 "landId": 0, ~/~/ ID поля
5275 "landName": "string", ~/~/ Название поля
5276 "year": 0, ~/~/ Год урожая
5277 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5278 "cultureName": "string", ~/~/ Название культуры
5279 "productivity": 0, ~/~/ Урожайность
5280 "area": 0, ~/~/ Площадь поля, Га.
5281 "total": 0, ~/~/ Валовый сбор
5282 "productivityFact": 0, ~/~/ Фактическая урожайность
5283 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5284 "totalFact": 0, ~/~/ Фактический валовый сбор
5285 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5286 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5287 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5288 "isyearplan": true, 
5289 "comment": "string" ~/~/ Комментарий
5290 }
5291 ],
5292 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5293 }
5294 )))
5295 )))
5296
5297 (((
5298
5299 )))
5300
5301 Пример ответа:
5302
5303 (((
5304 (((
5305 (((
5306 {
5307 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5308 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5309 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5310 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5311 "cropRotations": [ ~/~/ Данные по севообороту
5312 {
5313 "landId": 0, ~/~/ ID поля
5314 "landName": "string", ~/~/ Название поля
5315 "year": 0, ~/~/  Год урожая
5316 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5317 "cultureName": "string", ~/~/ Название культуры
5318 "productivity": 0, ~/~/ Урожайность
5319 "area": 0, ~/~/ Площадь поля, Га
5320 "total": 0, ~/~/ Валовый сбор
5321 "productivityFact": 0, ~/~/ Фактическая урожайность
5322 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5323 "totalFact": 0, ~/~/ Фактический валовый сбор
5324 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5325 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5326 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5327 "isyearplan": true, ~/~/ 
5328 "comment": "string" ~/~/ Комментарий
5329 }
5330 ],
5331 "cropVegetation": [ ~/~/ История вегетации поля
5332 {
5333 "values": [ ~/~/ Данные вегетации и состояния посева
5334 {
5335 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5336 "ndvi": 0 ~/~/ Индекс вегетации
5337 }
5338 ],
5339 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5340 {
5341 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5342 "type": "string", ~/~/ Тип
5343 "pictureid": "string" ~/~/ Идентификатор ресурса
5344 }
5345 ],
5346 "states": [ ~/~/ Ключевые даты развития поля 
5347 {
5348 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5349 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5350 }
5351 ]
5352 }
5353 ],
5354 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5355 "counts": { 
5356 "fieldOperations": 0, ~/~/ Количество операций на поле
5357 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5358 "facts": 0 ~/~/ Счётчик факта
5359 },
5360 "planComment": "string", ~/~/ Комментарий к полю
5361 "productivity": 0, ~/~/ Урожайность.
5362 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5363 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5364 "year": 0, ~/~/ Год поля
5365 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5366 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5367 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5368 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5369 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5370 "id": 0, ~/~/ Идентификатор объекта геозоны
5371 "name": "string", ~/~/ Название объекта геозоны
5372 "type": 0, ~/~/ Тип объекта геозоны
5373 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5374 "fname": "string", ~/~/ Имя файла
5375 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5376 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5377 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5378 "description": "string", ~/~/ Описание объекта геозоны
5379 "area": 0, ~/~/ Площадь, м2
5380 "perimetr": 0, ~/~/ Периметр, м
5381 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5382 }
5383 )))
5384 )))
5385 )))
5386 )))
5387 )))
5388
5389
5390 == **Редактирование года урожая ** ==
5391
5392 (% class="box successmessage" %)
5393 (((
5394 **POST /api/v3/agroLands/updateOpenCloseYear**
5395 )))
5396
5397 Пример запроса:
5398
5399 (((
5400 (((
5401 {
5402 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5403 0
5404 ],
5405 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5406 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5407 }
5408 )))
5409
5410
5411 )))
5412
5413 Пример ответа:
5414
5415 (((
5416 (((
5417 {
5418 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5419 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5420 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5421 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5422 "cropRotations": [ ~/~/ Данные по севообороту
5423 {
5424 "landId": 0, ~/~/ ID поля
5425 "landName": "string", ~/~/ Название поля
5426 "year": 0, ~/~/ Год урожая
5427 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5428 "cultureName": "string", ~/~/ Название культуры
5429 "productivity": 0, ~/~/ Урожайность
5430 "area": 0, ~/~/ Площадь поля, Га.
5431 "total": 0, ~/~/ Валовый сбор
5432 "productivityFact": 0, ~/~/ Фактическая урожайность
5433 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5434 "totalFact": 0, ~/~/ Фактический валовый сбор
5435 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5436 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5437 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5438 "isyearplan": true, ~/~/ 
5439 "comment": "string" ~/~/ Комментарий
5440 }
5441 ],
5442 "cropVegetation": [ ~/~/ История вегетации поля
5443 {
5444 "values": [ ~/~/ Данные вегетации и состояния посева
5445 {
5446 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5447 "ndvi": 0 ~/~/ Индекс вегетации
5448 }
5449 ],
5450 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5451 {
5452 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5453 "type": "string", ~/~/ Тип
5454 "pictureid": "string" ~/~/ Идентификатор ресурса
5455 }
5456 ],
5457 "states": [ ~/~/ Ключевые даты развития поля
5458 {
5459 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5460 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5461 }
5462 ]
5463 }
5464 ],
5465 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5466 "counts": { 
5467 "fieldOperations": 0, ~/~/ Количество операций на поле
5468 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5469 "facts": 0 ~/~/ Счётчик факта
5470 },
5471 "planComment": "string", ~/~/ Комментарий к полю
5472 "productivity": 0, ~/~/ Урожайность.
5473 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5474 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5475 "year": 0, ~/~/ Год поля
5476 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5477 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5478 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5479 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5480 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5481 "id": 0, ~/~/ Идентификатор объекта геозоны
5482 "name": "string", ~/~/ Название объекта геозоны
5483 "type": 0, ~/~/ Тип объекта геозоны
5484 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5485 "fname": "string", ~/~/ Имя файла
5486 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5487 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5488 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5489 "description": "string", ~/~/ Описание объекта геозоны
5490 "area": 0, ~/~/ Площадь, м2
5491 "perimetr": 0, ~/~/ ериметр, м
5492 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5493 }
5494 )))
5495
5496
5497 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5498 )))
5499 )))
5500 )))
5501
5502 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5503
5504
5505 (% class="box infomessage" %)
5506 (((
5507 **GET api/v3/Vehicles/recyclebin/all**
5508 )))
5509
5510 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5511
5512 Параметр запроса: {parentId} - идентификатор агента
5513
5514 В заголовках запроса: X-Auth: Токен авторизации
5515
5516 Ответ:
5517
5518 [ 
5519 {
5520 "recordTime": "", ~/~/Время записи
5521 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5522 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5523 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5524 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5525 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5526 "details": { ~/~/Список деталей объекта, помещённого в корзину
5527 "items": [ ~/~/ 
5528 nullable: true ~/~/Детали
5529 {
5530 "name": "string", ~/~/наименование столбца
5531 "value": "string" ~/~/содержание столбца
5532 }
5533 ]
5534 },
5535 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5536 "string"
5537 ]
5538 }
5539 ]
5540
5541
5542 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5543
5544 (% class="box infomessage" %)
5545 (((
5546 **POST api/v3/Vehicles/recyclebin/erase**
5547 )))
5548
5549 В заголовках запроса: X-Auth: Токен авторизации
5550
5551 Пример запроса:
5552
5553 [
5554 0
5555 ]
5556
5557
5558 Пример ответа:
5559
5560 [ 
5561 {
5562 "recordTime": "", ~/~/Время записи
5563 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5564 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5565 "objectId": 0, ~/~/ID объекта, помещённого в корзин
5566 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5567 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5568 "details": { ~/~/Список деталей объекта, помещённого в корзину
5569 "items": [ ~/~/Детали
5570 {
5571 "name": "", ~/~/Имя свойства
5572 "value": "" ~/~/Значение свойства
5573 }
5574 ]
5575 },
5576 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5577 ""
5578 ]
5579 }
5580 ]
5581
5582 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5583
5584 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5585
5586 (% class="box infomessage" %)
5587 (((
5588 **POST api/v3/Vehicles/recyclebin/restore**
5589 )))
5590
5591 В заголовках запроса: X-Auth: Токен авторизации
5592
5593 Параметры в теле запроса (JSON):
5594
5595 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5596
5597 В заголовках запроса: X-Auth: Токен авторизации
5598
5599
5600 Пример запроса:
5601
5602 (((
5603 [
5604 )))
5605
5606 (((
5607 0
5608 )))
5609
5610 (((
5611 ]
5612 )))
5613
5614
5615 Пример ответа:
5616
5617 [
5618 {
5619 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5620 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5621 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5622 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5623 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5624 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5625 "details": { ~/~/Список деталей объекта, помещённого в корзину
5626 "items": [ ~/~/Детали
5627 {
5628 "name": "string", ~/~/Имя свойства
5629 "value": "string" ~/~/Значение свойства
5630 }
5631 ]
5632 },
5633 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5634 "string"
5635 ]
5636 }
5637 ]
5638
5639
5640 = **Раздел: Журнал заданий ** =
5641
5642
5643 == **Создание задания в Журнале заданий** ==
5644
5645 (% class="box infomessage" %)
5646 (((
5647 **POST /api/v3/vehicletasks**
5648 )))
5649
5650 Пример запроса:
5651
5652 (((
5653 {
5654 "vehicleId": 0, ~/~/ Идентификатор ТС
5655 "description": "string", ~/~/ Описание
5656 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5657 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5658 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5659 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5660 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5661 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5662 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5663 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5664 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5665 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5666 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5667 "cost": { 
5668 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5669 "Name": "string", ~/~/ Наименование
5670 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5671 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5672 "Norm": 0 ~/~/ Норма внесения
5673 },
5674 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5675 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5676 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5677 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5678 "deleted": true, ~/~/ Признак удаления
5679 "extId": "string", 
5680 "GeoIds": [ ~/~/ Cвязанные поля
5681 0
5682 ]
5683 }
5684 )))
5685
5686
5687 Пример ответа:
5688
5689 {
5690 "vehicleId": 0, ~/~/ Идентификатор ТС
5691 "description": "string", ~/~/ Описание
5692 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5693 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5694 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5695 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5696 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5697 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5698 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5699 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5700 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5701 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5702 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5703 "cost": { 
5704 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5705 "Name": "string", ~/~/ Наименование
5706 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5707 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5708 "Norm": 0 ~/~/ Норма внесения
5709 },
5710 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5711 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5712 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5713 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5714 "deleted": true, ~/~/ Признак удаления
5715 "extId": "string", ~/~/ ExtId
5716 "GeoIds": [ ~/~/ Связанные поля
5717 0
5718 ]
5719 }
5720
5721
5722 == **Редактирование задания в Журнале заданий** ==
5723
5724 (% class="box successmessage" %)
5725 (((
5726 **PUT /api/v3/vehicletasks**
5727 )))
5728
5729 Пример запроса:
5730
5731 (((
5732 {
5733 "vehicleId": 0, ~/~/ Идентификатор ТС
5734 "description": "string", ~/~/ Описание
5735 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5736 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5737 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5738 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5739 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5740 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5741 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5742 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5743 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5744 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5745 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5746 "cost": { 
5747 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5748 "Name": "string", ~/~/ Наименование
5749 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5750 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5751 "Norm": 0 ~/~/ Норма внесения
5752 },
5753 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5754 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5755 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5756 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5757 "deleted": true, ~/~/ Признак удаления
5758 "extId": "string", ~/~/ ExtId
5759 "GeoIds": [ ~/~/ Связанные поля
5760 0
5761 ]
5762 }
5763 )))
5764
5765
5766 Пример ответа:
5767
5768 {
5769 "vehicleId": 0, ~/~/ Идентификатор ТС
5770 "description": "string", ~/~/ Описание
5771 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5772 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5773 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5774 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5775 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5776 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5777 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5778 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5779 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5780 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5781 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5782 "cost": { 
5783 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5784 "Name": "string", ~/~/ Наименование
5785 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5786 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5787 "Norm": 0 ~/~/ Норма внесения
5788 },
5789 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5790 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5791 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5792 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5793 "deleted": true, ~/~/ Признак удаления
5794 "extId": "string", ~/~/ ExtId
5795 "GeoIds": [ ~/~/ Связанные поля
5796 0
5797 ]
5798 }
5799
5800
5801 == **Удаление задания в Журнале заданий** ==
5802
5803 (% class="box warningmessage" %)
5804 (((
5805 **DELETE /api/v3/vehicletasks**
5806 )))
5807
5808 Пример запроса:
5809
5810 (((
5811 [
5812 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5813 ]
5814 )))
5815
5816 (((
5817
5818 )))
5819
5820 Пример ответа:
5821
5822 {
5823 "vehicleId": 0, ~/~/ Идентификатор ТС
5824 "description": "string", ~/~/ Описание
5825 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5826 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5827 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5828 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5829 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5830 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5831 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5832 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5833 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5834 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5835 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5836 "cost": { 
5837 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5838 "Name": "string", ~/~/ Наименование
5839 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5840 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5841 "Norm": 0 ~/~/ Норма внесения
5842 },
5843 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5844 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5845 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5846 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5847 "deleted": true, ~/~/ Признак удаления
5848 "extId": "string", ~/~/ ExtId
5849 "GeoIds": [ ~/~/ Связанные поля
5850 0
5851 ]
5852 }
5853
5854
5855 == **Получение списка Журнала заданий** ==
5856
5857 (% class="box infomessage" %)
5858 (((
5859 **POST /api/v3/vehicletasks/getbyperiod**
5860 )))
5861
5862 Пример запроса:
5863
5864 (((
5865 {
5866 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
5867 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
5868 "TimeZone": 0, ~/~/ Часовой пояс.
5869 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
5870 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
5871 ],
5872 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
5873 0
5874 ],
5875 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
5876 0
5877 ],
5878 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
5879 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
5880 }
5881 )))
5882
5883
5884 Пример ответа:
5885
5886 (((
5887 {
5888 "total": 0,  ~/~/ Общее количество записей
5889 "pages": 0,  ~/~/ Общее количество страниц
5890 "currentPage": 0, ~/~/ Текущая страница
5891 "items": [  ~/~/ Записи 
5892 {
5893 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5894 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
5895 "name": "string", ~/~/ Название задания.
5896 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
5897 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
5898 "workKind": "string", ~/~/ Вид работ
5899 "techOp": "string", ~/~/ Тех. операция
5900 "trailerModel": "string", ~/~/ Модель агрегата
5901 "width": "string", ~/~/ Ширина, м
5902 "speed": "string", ~/~/ Тех. скорость
5903 "fields": "string", ~/~/ Поля
5904 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
5905 "vehicles": "string", ~/~/ Объект-модель
5906 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
5907 "drivers": "string", ~/~/ Водители
5908 "tmc": "string", ~/~/ ТМЦ
5909 "client": "string", ~/~/  Клиент
5910 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5911 "dep": "string", ~/~/ Подразделение
5912 "geoIds": [ ~/~/  Связанные поля
5913 0
5914 ]
5915 }
5916 ]
5917 }
5918 )))
5919
5920
5921 = **Раздел: Локатор ** =
5922
5923
5924 == **Получение списка локаторов, доступных пользователю ** ==
5925
5926 (% class="box infomessage" %)
5927 (((
5928 **GET /api/v3/locators**
5929 )))
5930
5931 В заголовках запроса: X-Auth: Токен авторизации
5932
5933
5934 Пример ответа:
5935
5936 (((
5937 [
5938 {
5939 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5940 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5941 "agentName": "string", ~/~/ Наименование агента.
5942 "isEnabled": true, ~/~/ Активен 
5943 "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5944 "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5945 "name": "string", ~/~/ Наименование
5946 "status": 0, ~/~/ 
5947 "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5948 "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5949 "validity": 0, ~/~/ Срок действия в днях (1-90).
5950 "autoProlongation": true, ~/~/ Автопродление срока действия.
5951 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5952 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5953 "url": "string", ~/~/ Ссылка
5954 "language": 0, ~/~/ Язык.
5955 "vehiclesCount": 0, ~/~/ Количество объектов.
5956 "geozonesCount": 0, ~/~/ Количество геозон.
5957 "fieldsCount": 0 ~/~/ Количество полей.
5958 }
5959 ]
5960 )))
5961
5962
5963
5964 == **Создание локатора** ==
5965
5966 (% class="box successmessage" %)
5967 (((
5968 **POST /api/v3/locators**
5969 )))
5970
5971 Пример запроса:
5972
5973 (((
5974 {
5975 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5976 "isEnabled": true, ~/~/ Активность
5977 "name": "string", ~/~/ Наименование локатора
5978 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
5979 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5980 "validity": 0, ~/~/ Срок действия в днях (1-90)
5981 "autoProlongation": true, ~/~/ Автопродление срока действия.
5982 "url": "string", ~/~/ Ссылка
5983 "language": 0 ~/~/ Язык
5984 }
5985 )))
5986
5987
5988 Пример ответа:
5989
5990 (((
5991 3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
5992 )))
5993
5994
5995
5996 == **Изменение локатора** ==
5997
5998 (% class="box infomessage" %)
5999 (((
6000 **PUT /api/v3/locators**
6001 )))
6002
6003 Пример запроса:
6004
6005 (((
6006 {
6007 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6008 "isEnabled": true, ~/~/ Активность 
6009 "name": "string", ~/~/ Наименование
6010 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6011 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6012 "validity": 0, ~/~/ Срок действия в днях (1-90)
6013 "autoProlongation": true, ~/~/ Автопродление срока действия
6014 "url": "string", ~/~/ Ссылка
6015 "language": 0 ~/~/ Язык
6016 }
6017 )))
6018
6019
6020 Пример ответа:
6021
6022 200 ~/~/ Success
6023
6024
6025 == **Удалить локатор** ==
6026
6027 (% class="box warningmessage" %)
6028 (((
6029 **DELETE /api/v3/locators**
6030 )))
6031
6032 Пример запроса:
6033
6034 (((
6035 [
6036 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6037 ]
6038 )))
6039
6040
6041
6042 = **Раздел: Яндекс Маршруты** =
6043
6044
6045 == **Возвращение списка маршрутов** ==
6046
6047 (% class="box infomessage" %)
6048 (((
6049 **GET /api/v3/TransportRoutes**
6050 )))
6051
6052 Пример запроса:
6053 Id  ~/~/ Идентификатор поля
6054
6055
6056 Пример ответа:
6057
6058 (((
6059 [
6060 {
6061 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6062 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6063 "name": "string", ~/~/ Наименование маршрута.
6064 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6065 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6066 0
6067 ]
6068 }
6069 ]
6070 )))
6071
6072
6073
6074 == **Добавить маршрут** ==
6075
6076 (% class="box infomessage" %)
6077 (((
6078 **POST /api/v3/TransportRoutes**
6079 )))
6080
6081 Пример запроса: 
6082 {
6083 "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6084 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6085 "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6086 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6087 0
6088 ]
6089 }
6090
6091
6092 Пример ответа:
6093
6094 (((
6095 {
6096 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6097 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6098 "name": "string", ~/~/ Определяет наименование маршрута 
6099 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6100 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6101 0
6102 ]
6103 }
6104 )))
6105
6106
6107 == **Обновление маршрута** ==
6108
6109 (% class="box successmessage" %)
6110 (((
6111 **PUT /api/v3/TransportRoutes**
6112 )))
6113
6114 Пример запроса:
6115
6116 (((
6117 {
6118 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6119 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6120 "name": "string", ~/~/ Опредлеляет наименование маршрута.
6121 "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6122 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6123 0
6124 ]
6125 }
6126 )))
6127
6128
6129 Пример ответа:
6130
6131 (((
6132 {
6133 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6134 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6135 "name": "string", ~/~/ Определяет наименование маршрута 
6136 "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6137 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6138 0
6139 ]
6140 }
6141 )))
6142
6143
6144 == **Получить связки маршрутов ТС** ==
6145
6146 (% class="box infomessage" %)
6147 (((
6148 **POST /api/v3/TransportRoutes/getroutesvehicles**
6149 )))
6150
6151 Пример запроса:
6152
6153 (((
6154 [
6155 "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6156 ]
6157 )))
6158
6159
6160 Пример ответа:
6161
6162 (((
6163 [
6164 {
6165 "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6166 "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6167 }
6168 ]
6169 )))
6170
6171
6172 == **Удалить маршрут** ==
6173
6174 (% class="box warningmessage" %)
6175 (((
6176 **DELETE /api/v3/TransportRoutes/{id}**
6177 )))
6178
6179 Пример запроса:
6180 Id  ~/~/ Идентификатор поля
6181
6182
6183 ==== ====
6184
6185 = **Раздел: Управление доступа к машинам** =
6186
6187
6188 == Получение списка транспортных средств видимых пользователю ==
6189
6190 (% class="box infomessage" %)
6191 (((
6192 **GET /api/v3/UserVisibleVehicles/{userId}**
6193 )))
6194
6195 Пример ответа:
6196
6197 (((
6198 {
6199 "vehicleIds": [  ~/~/ Идентификаторы ТС
6200 0
6201 ]
6202 }
6203 )))
6204
6205
6206
6207 == Задает видимость транспортных средств пользователю ==
6208
6209 (% class="box infomessage" %)
6210 (((
6211 **POST /api/v3/UserVisibleVehicles**
6212 )))
6213
6214 Пример запроса:
6215
6216 (((
6217 (((
6218 {
6219 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6220 "vehicleIds": [ ~/~/ Идентификаторы ТС
6221 0
6222 ]
6223 }
6224 )))
6225
6226 (((
6227
6228 )))
6229
6230 (((
6231
6232 )))
6233
6234 (((
6235 Пример ответа :
6236 )))
6237
6238 (((
6239
6240 )))
6241
6242 (((
6243 200 ~/~/ Success
6244 )))
6245 )))
6246
6247
6248
6249
6250
6251
6252 (% class="box" lang="en-US" style="text-align: center;" %)
6253 (((
6254 (% 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]] **
6255 )))

Меню

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