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

Меню

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