Last modified by Андрей Калиновский on 2025/06/27 16:12
Show last authors
1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 (((
3 (% class="box warningmessage" %)
4 (((
5 (% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 просим вас соблюдать несколько простых правил при использовании API-команд:##
7 )))
8
9 * Формировать не более 3 отчётов одновременно.
10 * Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11
12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13
14 (% class="box infomessage" %)
15 (((
16 **Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 \\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 )))
19
20 **Содержание страницы:**
21 )))
22
23 {{toc/}}
24
25
26 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
27
28 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
29
30 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
31
32 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
33
34 (% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
35
36
37 (% style="color:#000000; font-size:16px" %)**Рекомендации**
38
39 - Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
40
41 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
42
43 (% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
44 (((
45 (% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
46 (% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
47 )))
48
49 (% class="box successmessage" %)
50 (((
51 (% lang="en-US" %)**POST /api/v3/auth/login**
52 )))
53
54 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
55
56 (% style="color:#000000" %)Метод запроса: **POST**
57
58 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
59
60 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
61
62 (% style="color:#000000" %)Параметры в теле запроса (JSON):
63
64 (% style="color:#000000" %){
65 "login": "testuser",
66 "password": "testuser"
67 }
68
69 (% style="color:#000000" %)**Ответ:**
70
71 (% lang="en-US" %)
72 (% style="color:#000000" %){
73 "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
74 "User": "testuser" , ~/~/ имя пользователя(%%)
75 }
76
77 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
78
79 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
80 |(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
81 |(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
82 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
83 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
84
85 (% class="wikigeneratedid" %)
86 Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
87
88 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
89
90 (% class="box infomessage" %)
91 (((
92 (% lang="en-US" %)**GET /api/v3/auth/check**
93 )))
94
95 (% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
96
97 (% style="color:#000000" %)Метод запроса: **GET**
98
99 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
100
101 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
102
103 (% lang="en-US" %)
104 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
105
106 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
107
108 == (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
109
110 (% class="box infomessage" %)
111 (((
112 **GET api/v3/agents/{id}**
113 )))
114
115 Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
116
117 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
118
119 (% style="color:#000000" %)Метод запроса: **GET**
120
121 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
122
123 Запрос должен содержать данные параметра "**agentId**"
124
125 (% style="color:#000000" %)Ответ:
126
127 (((
128 {
129 "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 "parentName": "string", ~/~/ Наименование агента
132 "name": "string", ~/~/ Имя клиента
133 "fullName": "string", ~/~/ ФИО клиента
134 "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 "district": "string", ~/~/ Район
137 "region": "string", ~/~/ Область
138 "city": "string", ~/~/ Город
139 "email": "string", ~/~/ Email
140 "director": "string", ~/~/ Руководитель
141 "RegionalData": [ ~/~/ Определяет региональные сведения.
142 {
143 "Country": 0, ~/~/ Страна
144 "groups": [ ~/~/ Список групп
145 {
146 "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 "fields": [ ~/~/ Список значений полей
148 {
149 "name": "string", ~/~/ Имя поля формы
150 "value": "string" ~/~/ Значение поля формы
151 }
152 ]
153 }
154 ]
155 }
156 ]
157 }
158 )))
159
160
161 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
162 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
163 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
164 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
165 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
166 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
167 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
168 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
169 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
170 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
171 |(% style="width:215px" %)city|(% style="width:861px" %)Город
172 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
173 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
174 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
175 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
176 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
177 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
178 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
179 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
180 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
181 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
182
183 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
184
185 (% class="box infomessage" %)
186 (((
187 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
188 )))
189
190 (% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
191
192 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
193
194 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
195
196 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
197
198 (% style="color:#000000" %)Метод запроса: **POST**
199
200 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
201
202 (% style="color:#000000" %)Параметр запроса:
203
204 (% style="color:#000000" %){
205 "parentId": "string"
206 }
207
208 (% style="color:#000000" %)Ответ:
209
210 {
211 "agentId": "",(% style="color:#000000" %)   (%%)
212 "parentId": "",
213 "name": "string",
214 "fullName": "string",
215 "agentInfoType": 0,
216 (% style="color:#000000" %) "status": "",
217 }
218
219
220 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
221 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
222 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
223 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
224 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
225 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
226 |(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
227
228 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
229
230 (% class="box successmessage" %)
231 (((
232 **POST /api/v3/agents **
233 )))
234
235 Метод позволяет добавить клиента, указанного в запросе.
236
237 Метод запроса: **POST**
238
239 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
240
241 В заголовках запроса: X-Auth: Токен авторизации
242
243 Параметры в теле запроса (JSON):
244
245 {
246 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
247 "name": "string", ~/~/ имя
248 "fullName": "string", ~/~/ полное наименование
249 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
250 "isForeign": true, ~/~/ иностранный контрагент
251 "district": "string", ~/~/ округ
252 "region": "string", ~/~/ регион
253 "city": "string", ~/~/ город
254 "inn": "string", ~/~/ ИНН
255 "kpp": "string", ~/~/ КПП
256 "address": "string", ~/~/ юридический адрес
257 "addressFact": "string", ~/~/ фактический адрес
258 "email": "string", ~/~/ email
259 "director": "string", ~/~/ ФИО руководителя
260 "bankName": "string", ~/~/ банк
261 "bankBIK": "string", ~/~/ БИК
262 "bankRS": "string", ~/~/ номер счёта
263 "bankKS": "string" ~/~/ корр. счёт
264 }
265
266 Ответ:
267
268 {
269 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
270 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
271 "name": "string", ~/~/ имя
272 "fullName": "string", ~/~/ полное наименование
273 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
274 "isForeign": true, ~/~/ иностранный контрагент
275 "district": "string", ~/~/ округ
276 "region": "string", ~/~/ регион
277 "city": "string", ~/~/ город
278 "inn": "string", ~/~/ ИНН
279 "kpp": "string", ~/~/ КПП
280 "address": "string", ~/~/ юридический адрес
281 "addressFact": "string", ~/~/ фактический адрес
282 "email": "string", ~/~/ email
283 "director": "string", ~/~/ ФИО руководителя
284 "bankName": "string", ~/~/ банк
285 "bankBIK": "string", ~/~/ БИК
286 "bankRS": "string", ~/~/ номер счёта
287 "bankKS": "string" ~/~/ корр. счёт
288 }
289
290 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
291 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
292 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
293 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
294 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
295 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
296 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
297 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
298 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
299 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
300 |(% style="width:215px" %)city|(% style="width:861px" %)Город
301 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
302 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
303 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
304 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
305 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
306 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
307 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
308 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
309 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
310 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
311
312 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
313
314 (% class="box warningmessage" %)
315 (((
316 **PUT /api/v3/agents**
317 )))
318
319 Метод позволяет отредактировать клиента, указанного в запросе.
320
321 Метод запроса: **PUT**
322
323 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
324
325 В заголовках запроса: X-Auth: Токен авторизации
326
327 Параметры в теле запроса (JSON):
328
329 {
330 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
331 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
332 "name": "string", ~/~/ имя
333 "fullName": "string", ~/~/ полное наименование
334 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
335 "isForeign": true, ~/~/ иностранный контрагент
336 "district": "string", ~/~/ округ
337 "region": "string", ~/~/ регион
338 "city": "string", ~/~/ город
339 "inn": "string", ~/~/ ИНН
340 "kpp": "string", ~/~/ КПП
341 "address": "string", ~/~/ юридический адрес
342 "addressFact": "string", ~/~/ фактический адрес
343 "email": "string", ~/~/ email
344 "director": "string", ~/~/ ФИО руководителя
345 "bankName": "string", ~/~/ банк
346 "bankBIK": "string", ~/~/ БИК
347 "bankRS": "string", ~/~/ номер счёта
348 "bankKS": "string" ~/~/ корр. счёт
349 }
350
351 Ответ:
352
353 {
354 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
355 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
356 "name": "string", ~/~/ имя
357 "fullName": "string", ~/~/ полное наименование
358 "isForeign": true, ~/~/ иностранный контрагент
359 "district": "string", ~/~/ округ
360 "region": "string", ~/~/ регион
361 "city": "string", ~/~/ город
362 "inn": "string", ~/~/ ИНН
363 "kpp": "string", ~/~/ КПП
364 "address": "string", ~/~/ юридический адрес
365 "addressFact": "string", ~/~/ фактический адрес
366 "email": "string", ~/~/ email
367 "director": "string", ~/~/ ФИО руководителя
368 "bankName": "string", ~/~/ банк
369 "bankBIK": "string", ~/~/ БИК
370 "bankRS": "string", ~/~/ номер счёта
371 "bankKS": "string" ~/~/ корр. счёт
372 }
373
374 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
375
376 (% class="box errormessage" %)
377 (((
378 **DELETE /api/v3/agents/{clientId}**
379 )))
380
381 Метод позволяет удалить клиента, указанного в строке запроса.
382
383 Метод запроса: **DELETE**
384
385 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
386
387 Параметр запроса: **{clientId}** - Guid пользователя
388
389 В заголовках запроса: X-Auth: Токен авторизации
390
391 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
392
393 == (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
394
395 (% class="box warningmessage" %)
396 (((
397 **PUT /api/v3/agents/{id}/changeStatus/{status}**
398 )))
399
400 Метод позволяет изменить статус клиента, указанного в запросе.
401
402 В пути указывается GUID клиента и статус клиента.
403
404 **status **- значение 0 - заблокирован, 1 - активен.
405
406 Ответ: Code 204
407
408 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
409
410 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
411
412 (% class="box successmessage" %)
413 (((
414 (% lang="en-US" %)**POST /api/v3/users**
415 )))
416
417 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
418
419 (% style="color:#000000" %)Метод запроса: **POST**
420
421 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
422
423 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
424
425 (% style="color:#000000" %)Параметры в теле запроса (JSON):
426
427 (% style="color:#000000" %)
428 { 
429 "lastName": "", ~/~/ фамилия
430 "firstName": "", ~/~/ имя
431 "position": "", ~/~/ должность
432 "phone": "", ~/~/ телефон
433 "organization": "", ~/~/ организация
434 "login": "", ~/~/ логин (обязателен)
435 "password": "", ~/~/ пароль (обязателен)
436 "email": "", ~/~/ email (обязателен)
437 "description": "string", ~/~/ Описание
438 "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
439 "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
440 "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
441 "parentId": "", ~/~/ Guid родительского агента
442 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
443 "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
444 "doubleAuth":
445 {
446 "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
447 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
448 },
449 "groups":
450 [
451 "string" ~/~/ группы пользователя, перечисление названия системных ролей
452 ],
453 "customGroups":
454 [
455 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
456 ],
457 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
458 }
459 {
460 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
461 "lastName": "string",
462 "firstName": "string",
463 "position": "string",
464 "phone": "string",
465 "organization": "string",
466 "login": "string",
467 "password": "string",
468 "email": "string",
469
470 (% style="text-align:left" %)
471 (% style="color:#000000; font-weight:normal" %)Ответ:
472 {     
473 "id": "" , ~/~/ ID пользователя
474 "lastName": "" , ~/~/ Фамилия ,
475 "firstName": "" , ~/~/ Имя
476 "position": "" , ~/~/ Должность
477 "phone": "" , ~/~/ Телефон
478 "organization": "" , ~/~/ Организация
479 "login": "" , ~/~/ Логин
480 "password": "" , ~/~/ Пароль
481 "email": "" , ~/~/ Email
482 "description": "" , ~/~/ Описание
483 "isEnabled": "" , ~/~/ Признак включения
484 "parentId": "" , ~/~/ Guid родительского агента
485 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
486 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
487 "kind": "" , ~/~/ тип аутентификации
488 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
489 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
490 }
491
492
493 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
494
495 (% class="box infomessage" %)
496 (((
497 (% lang="en-US" %)**POST /api/v3/users/find**
498 )))
499
500 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
501
502 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
503
504 (% style="color:#000000" %)Метод запроса: **POST**
505
506 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
507
508 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
509
510 (% style="color:#000000" %)Параметры в теле запроса (JSON):
511
512 (% style="color:#000000" %){(%%)
513 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
514 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
515 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
516 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
517 (% style="color:#000000" %)}
518
519 (% style="color:#000000" %)Ответ:
520
521 (% style="color:#000000" %){         (%%)
522 "id": "" , ~/~/ идентификатор пользователя
523 "lastName": "" , ~/~/ фамилия
524 "firstName": "" , ~/~/ имя
525 "position": "" , ~/~/ должность
526 "phone": "" , ~/~/ телефон
527 "parentId": "" , ~/~/ идентификатор клиента-родителя
528 "parentName": "" , ~/~/ наименование клиента-родителя
529 "organization": "" , ~/~/ организация
530 "login": "" , ~/~/ логин
531 "email": "" , ~/~/ E-mail
532 "sessionDuration":"", ~/~/ длительность сессии в минутах
533 "status": "1",  ~/~/ статус пользователя
534 "lastLogged": "", ~/~/ дата/время последней авторизации
535 (% style="color:#000000" %)}
536
537 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
538
539 (% class="box infomessage" %)
540 (((
541 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
542 )))
543
544 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
545
546 (% style="color:#000000" %)Метод запроса: **GET**
547
548 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
549
550 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
551
552 (% style="color:#000000" %)Ответ:
553
554 (((
555 (((
556 {
557 "id": "", ~/~/ GUID пользователя
558 "lastName": "", ~/~/ Фамилия 
559 "firstName": "", ~/~/ Имя
560 "position": "", ~/~/ Должность
561 "phone": "", ~/~/ Номер телефона
562 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
563 "parentName": "", Наименование клиента, которому принадлежит пользователь
564 "organization": "", ~/~/ Организация
565 "login": "", ~/~/ Логин пользователя
566 "email": "", ~/~/ Адрес электронной почты
567 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
568 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
569 "description": "", ~/~/ Описание
570 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
571 "doubleAuth":
572 {
573 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
574 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
575 },
576 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
577 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
578 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
579 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
580 "groups": [], ~/~/ Список ролей пользователя
581 "customGroups": [], ~/~/ Список клиентских ролей пользователя
582 "authDevices": [ ], ~/~/ Список авторизованных устройств
583 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
584 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
585 }
586 )))
587 )))
588
589 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
590
591 (% class="box warningmessage" %)
592 (((
593 (% lang="en-US" %)**PUT /api/v3/users**
594 )))
595
596 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
597
598 (% style="color:#000000" %)Метод запроса: **PUT**
599
600 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
601
602 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
603
604 (% lang="en-US" style="text-align:left" %)
605 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
606
607 (% lang="en-US" style="text-align:left" %)
608 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
609 "id": "" , ~/~/ ID пользователя 
610 "lastName": "" , ~/~/ фамилия
611 "firstName": "" , ~/~/ имя
612 "position": "" , ~/~/ должность
613 "phone": "" , ~/~/ телефон
614 "organization": "" , ~/~/ организация
615 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
616 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
617 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
618 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
619 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
620 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
621 "isEnabled": "" , ~/~/ признак включения
622 "parentId": "" , ~/~/ Guid родительского агента
623 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
624 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
625 "doubleAuth":
626 {
627 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
628 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
629 },
630 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
631 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
632 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
633
634 (% lang="en-US" style="text-align:left" %)
635 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
636
637 (% lang="en-US" style="text-align:left" %)
638 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
639 "id": "" , ~/~/ идентификатор пользователя
640 "lastName": "" , ~/~/ фамилия
641 "firstName": "" , ~/~/ имя
642 "position": "" , ~/~/ должность
643 "phone": "" , ~/~/ телефон
644 "organization": "" , ~/~/ организация
645 "login": "" , ~/~/ логин
646 "password": "" , ~/~/ пароль 
647 "email": "" , ~/~/ email
648 "description": "" , ~/~/ описание
649 "isEnabled": "" , ~/~/ признак включения
650 "parentId": "" , ~/~/ Guid родительского агента
651 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
652 "doubleAuth":
653 {
654 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
655 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
656 },
657 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
658 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
659 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
660 }
661
662 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
663
664 (% class="box warningmessage" %)
665 (((
666 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
667 )))
668
669 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
670
671 (% style="color:#000000" %)Метод запроса: **PUT**
672
673 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
674
675 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
676
677 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
678
679 (% style="color:#000000" %)Параметры в теле запроса (JSON):
680
681 (% style="color:#000000" %){(%%)
682 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
683 "description": "" , ~/~/ описание
684 "data": "" , ~/~/ данные, связанные со сменой статуса
685 (% style="color:#000000" %)}
686
687 (% style="text-align:left" %)
688 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
689
690 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
691
692 (% class="box warningmessage" %)
693 (((
694 **POST /api/v3/users/disable**
695 )))
696
697 Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
698
699 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
700
701 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
702
703 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
704
705 [ 
706 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
707 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
708 ]
709
710 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
711
712 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
713
714 (% class="box warningmessage" %)
715 (((
716 **POST /api/v3/users/enable**
717 )))
718
719 Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
720
721 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
722
723 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
724
725 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
726
727 [ 
728 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
729 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
730 ]
731
732 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
733 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
734
735 (((
736 В теле ответа:
737 {
738 "errorMessages": [
739 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
740 ],
741 "users": [
742 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
743 ]
744 }
745 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
746 "users" - массив id пользователей, которых не удалось включить или отключить.
747 )))
748
749 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
750
751 (% class="box errormessage" %)
752 (((
753 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
754 )))
755
756 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
757
758 (% style="color:#000000" %)Метод запроса: **DELETE**
759
760 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
761
762 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
763
764 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
765
766 (% style="text-align:left" %)
767 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
768
769 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
770
771 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
772
773 (% class="box infomessage" %)
774 (((
775 (% lang="en-US" %)**GET /api/v3/models/{Id}**
776 )))
777
778 Метод возвращает полную информацию о модели объекта.
779
780 (% style="color:#000000" %)Метод запроса: **GET**
781
782 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
783
784 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
785
786 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
787
788 (% style="color:#000000" %)Ответ:
789
790 (% style="color:#000000" %){
791 "parentName": "string",
792 "name": "string",
793 "picture": "string",
794 "minspeed": 0,
795 "maxspeed": 0,
796 "width": 0,
797 "imbeddedtrailer": true,
798 "hoppercapacity": 0,
799 "hopperdischargespeed": 0,
800 "modelType": 0,
801 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
802 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
803 "deleted": true
804 }
805
806 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
807 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
808 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
809 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
810 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
811 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
812 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
813 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
814 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
815 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
816 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
817 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
818 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
819 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
820
821 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
822
823 (% class="box successmessage" %)
824 (((
825 (% lang="en-US" %)**POST /api/v3/models/find**
826 )))
827
828 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
829
830 (% style="color:#000000" %)Метод запроса: **POST**
831
832 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
833
834 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
835
836 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
837
838 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
839 }
840
841 (% style="color:#000000" %)Ответ:
842
843 (% style="color:#000000" %)[
844 {
845 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
846 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
847 "parentName": "string",
848 "name": "string",
849 "modelType": 0
850 }
851 ]
852
853 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
854 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
855 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
856 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
857 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
858 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
859
860 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
861
862 (% class="box successmessage" %)
863 (((
864 (% lang="en-US" %)**POST /api/v3/models**
865 )))
866
867 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
868
869 (% style="color:#000000" %)Метод запроса: **POST**
870
871 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
872
873 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
874
875 (% style="color:#000000" %)Параметры в теле запроса (JSON):
876
877 {
878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880 "deleted": false,
881 "extId": "string",
882 "name": "string",
883 "picture": "string",
884 "minspeed": 0,
885 "maxspeed": 0,
886 "width": 0,
887 "imbeddedtrailer": true,
888 "fueloutlay": 0,
889 "hoppercapacity": 0,
890 "hopperdischargespeed": 0,
891 "modelType": 0
892 }
893
894 Ответ:
895
896 {
897 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
898 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
899 "deleted": false,
900 "extId": "string",
901 "name": "string",
902 "picture": "string",
903 "minspeed": 0,
904 "maxspeed": 0,
905 "width": 0,
906 "imbeddedtrailer": true,
907 "hoppercapacity": 0,
908 "hopperdischargespeed": 0,
909 "modelType": 0
910 }
911
912 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
913 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
914 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
915 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
916 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
917 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
918 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
919 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
920 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
921 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
922 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
923 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
924 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
925
926 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
927
928 (% class="box warningmessage" %)
929 (((
930 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
931 )))
932
933 (% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
934
935 (% style="color:#000000" %)Метод запроса: **PUT**
936
937 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
938
939 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
940
941 (% style="color:#000000" %)Параметры в теле запроса (JSON):
942
943 {
944 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
945 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
946 "deleted": true,
947 "extId": "string",
948 "name": "string",
949 "picture": "string",
950 "minspeed": 0,
951 "maxspeed": 0,
952 "width": 0,
953 "imbeddedtrailer": true,
954 "fueloutlay": 0,
955 "hoppercapacity": 0,
956 "hopperdischargespeed": 0,
957 "modelType": 0
958 }
959
960 Ответ:
961
962 {
963 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
964 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
965 "deleted": true,
966 "extId": "string",
967 "name": "string",
968 "picture": "string",
969 "minspeed": 0,
970 "maxspeed": 0,
971 "width": 0,
972 "imbeddedtrailer": true,
973 "fueloutlay": 0,
974 "hoppercapacity": 0,
975 "hopperdischargespeed": 0,
976 "modelType": 0
977 }
978
979 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
980 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
981 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
982 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
983 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
984 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
985 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
986 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
987 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
988 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
989 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
990 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
991 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
992
993 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
994
995 (% class="box errormessage" %)
996 (((
997 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
998 )))
999
1000 (% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
1001
1002 (% style="color:#000000" %)Метод запроса: **DELETE**
1003
1004 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
1005
1006 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
1007
1008 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1009
1010 Ответ: В случае успеха **Success 200**
1011
1012 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
1013
1014 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1015
1016 (% class="box infomessage" %)
1017 (((
1018 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1019 )))
1020
1021 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1022
1023 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1024
1025 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1026
1027 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1028
1029 (% style="color:#000000" %)Метод запроса: **GET**
1030
1031 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
1032
1033 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1034
1035 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1036
1037 (% style="color:#000000" %)Ответ:
1038
1039 (((
1040 {
1041
1042 (((
1043 "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1044 "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1045 )))
1046
1047 (((
1048 ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1049 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1050 )))
1051
1052 "vehicleId": "", ~/~/ ID объекта
1053 "name": "", ~/~/ Имя объекта
1054 "imei": "", ~/~/ IMEI объекта
1055 "deviceTypeId": , ~/~/ ID типа устройства
1056 "deviceTypeName": "", ~/~/ Название типа устройства
1057 "sim1": "", ~/~/ Номер SIM1
1058 "sim2": "", ~/~/ Номер SIM2
1059 "parentId": "", ~/~/ ID клиента-родителя
1060 "parentName": "", ~/~/ Наименование клиента-родителя
1061 "modelId": "", ~/~/ ID модели объекта
1062 "modelName": "", ~/~/ Имя модели объекта
1063 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1064 "unitName": "string", ~/~/ Наименование подразделения
1065 "status": 0, ~/~/ Статус объекта
1066 "createdAt": "", ~/~/ Дата создания объекта
1067 },
1068 "customFields": [ ~/~/ Произвольные поля
1069 {
1070 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1071 "name": "string", ~/~/ Имя поля
1072 "value": "string", ~/~/ Значение поля
1073 "forClient": true, ~/~/ Не используемая функция
1074 "forTooltip": true, ~/~/ Отображать в подсказке
1075 "forReport": true ~/~/ Отображать в отчете
1076 }
1077
1078 ], ~/~/ Данные с вкладки нормы
1079 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1080 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1081 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1082 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1083 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1084 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1085 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1086 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1087 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1088 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1089 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1090 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1091 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1092 "mileageCoeff": 0, ~/~/ коэффициент пробега
1093 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1094 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1095 "counters": { ~/~/ Счетчики
1096 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1097 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1098 "mileage": 0, ~/~/ Текущий пробег
1099 "motohours": 0, ~/~/ Текущие моточасы
1100 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1101 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1102 },
1103
1104 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1105 "id": "string", ~/~/ ID объекта
1106 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1107 "host": "string", ~/~/ CMSV6 Web Host
1108 "login": "string", ~/~/ CMSV6 Account
1109 "password": "string" ~/~/ CMSV6 Password
1110 },
1111
1112 "commandTemplates": [ ~/~/ Шаблоны команд
1113 {
1114 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1115 "name": "string", ~/~/ Наименование команды
1116 "command": "string", ~/~/ Текст команды
1117 "retries": 0 ~/~/ Количество попыток
1118 }
1119 ],
1120 "sensors": [ ~/~/ Датчики
1121 {
1122 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1123 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1124 "type": 0, ~/~/ Тип датчика
1125 "name": "string", ~/~/ Имя датчика
1126 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1127 "inputNumber": 0, ~/~/ Номер входа
1128 "pseudonym": "string", ~/~/ Псевдоним
1129 "medianDegree": 0, ~/~/ Медианная фильтрация
1130 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1131 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1132 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1133 "gradesTables": [ ~/~/ Массив таблиц тарировки
1134 {
1135 "grades": [ ~/~/ Таблица тарировки 1
1136 {
1137 "input": 0, ~/~/ Входящее значение
1138 "output": 0 ~/~/ Выходящее значение
1139 }
1140 ],
1141 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1142 }
1143 ],
1144 "showInTooltip": true, ~/~/ Отображать в подсказке
1145 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1146 "color": "string", ~/~/ Код цвета датчиков
1147 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1148 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1149 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1150 "expr": "string", ~/~/ Формула
1151 "children": [ ~/~/ массив дочерних датчиков
1152 "string"
1153 ],
1154 "customParams": { ~/~/ прочие произвольные параметры
1155 "additionalProp1": "string",
1156 "additionalProp2": "string",
1157 "additionalProp3": "string"
1158 },
1159
1160 ~/~/ Характерные для произвольного:
1161 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1162 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1163 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1164 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1165 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1166 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1167 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1168 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1169 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1170 ~/~/ "ValueOn": "Вкл.",
1171 ~/~/ "ValueOff": "Выкл."
1172 "summaryMaxValue": 0 ~/~/ Макс. значение
1173 }
1174 "drivers": [ ~/~/ Водители
1175 {
1176 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1177 "name": "string", ~/~/ Наименование
1178 "description": "string",
1179 "isDefault": true ~/~/ По умолчанию
1180 }
1181 ],
1182 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1183 {
1184 "id": "", ~/~/ ID  задания
1185 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1186 "name": "", ~/~/ Наименование задания
1187 "description": "", ~/~/ Описание задания
1188 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1189 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1190 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1191 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1192 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1193 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1194 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1195 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1196 }
1197 ],
1198 "statusHistory": [ ~/~/ История статусов
1199 {
1200 "status": 0,
1201 "date": "2023-05-22T09:57:39.562Z",
1202 "description": "string",
1203 "additionalInfo": "string"
1204
1205 (((
1206 }
1207 ],
1208 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1209 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1210 )))
1211
1212 (((
1213 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1214 }
1215
1216 )))
1217 )))
1218
1219 (% style="text-align:left" %)
1220 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1221
1222 (% style="text-align:left" %)
1223 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1224
1225
1226 == **Отправить команду на терминал** ==
1227
1228 (% class="box successmessage" %)
1229 (((
1230 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1231 )))
1232
1233 Команда для отправки на тс.
1234
1235 {  
1236 "id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1237 "command": "", ~/~/ Текст отправляемой команды
1238 "retries": "", ~/~/ Количество попыток отправки на терминал
1239 "idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1240 }
1241
1242 В ответ получаем cmdid
1243
1244
1245 == **Получить ответ на отправленную на ТС команду** ==
1246
1247 (% class="box infomessage" %)
1248 (((
1249 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1250 )))
1251
1252 Идентификатор команды: cmdId
1253
1254 Запрос от терминала на ответ команды
1255
1256 Пример ответ от терминала:
1257
1258 ID= "" ~/~/ идентификатор объекта
1259 Soft="" ~/~/ версия софта
1260 GPS=4 ~/~/ тип трекера
1261 Time=11:05:43 28.06.24 ~/~/ время запроса
1262 Lat=45.056221 ~/~/ широта
1263 Lon=39.035938 ~/~/ долгота
1264 Speed=0.0 ~/~/ скорость
1265 Course=181.4 ~/~/направление
1266
1267 (((
1268 == **Список отправленных объекту команд с ответами** ==
1269
1270 (% class="box infomessage" %)
1271 (((
1272 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1273 )))
1274
1275 Идентификатор ТС: vehicleId
1276
1277 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1278
1279 Пример ответа терминала
1280
1281 [ 
1282 {    
1283 "id": "", ~/~/ идентификатор пользователя
1284 "commandText": "", ~/~/Текст команды.
1285 "templateId": "", ~/~/Идентификатор шаблона
1286 "updated": "", ~/~/ Время отправки  
1287 "tryCount": 0, ~/~/ Количество попыток отправки команды
1288 "answer": "", ~/~/ Ответ терминала.
1289 "status": "" ~/~/ Статус отправки
1290 }
1291 ]
1292 )))
1293
1294 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1295
1296 (% class="box successmessage" %)
1297 (((
1298 (% lang="en-US" %)**POST /api/v3/vehicles**
1299 )))
1300
1301 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1302
1303 (% style="color:#000000" %)Метод запроса: **POST**
1304
1305 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1306
1307 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1308
1309 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1310
1311 (% style="color:#000000" %){
1312
1313
1314 (((
1315 "vehicleId": 0, ~/~/ ID ТС
1316 )))
1317
1318 "parentId": "" , ~/~/ ID клиента
1319 "name": "" , ~/~/ имя ТС
1320 "imei": "" , ~/~/ IMEI
1321 "deviceTypeId": "" , ~/~/ ID типа устройства
1322 "modelId": "" , ~/~/ ID модели
1323 "unitId": "" , ~/~/ ID подразделения
1324 "sim1": "" , ~/~/ Номер SIM 1
1325 "sim2": "" , ~/~/ Номер SIM2
1326 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1327 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1328 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1329 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1330 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1331 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1332 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1333 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1334 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1335 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1336 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1337 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1338 "mileageCalcMethod": 0,
1339 "mileageCoeff": 0,
1340 "locationByCellId": true,
1341 "dottedLineTrackWhenNoCoords": true,
1342 "counters": ~/~/ счетчики
1343 {
1344 "mileage": "" , ~/~/ пробег
1345 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1346 "motohours": "" , ~/~/ моточасы
1347 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1348 },
1349 "cmsv6Parameters": { ~/~/ параметры CMSv6
1350 "enabled": true, ~/~/ флаг включения
1351 "id": "" , ~/~/ идентификатор
1352 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1353 "login": "" , ~/~/ имя учетной записи
1354 "password": "" ~/~/ пароль учетной записи
1355 },
1356 "inspectionTasks": ~/~/ задания на ТО
1357 {
1358 "enabled": "" , ~/~/ Признак включения
1359 "name": "" , ~/~/ Имя задания
1360 "description": "" , ~/~/ Описание задания
1361 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1362 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1363 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1364 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1365 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1366 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1367 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1368 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1369 }
1370 "drivers": [ ~/~/ Водители
1371 {
1372 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1373 "isDefault": true
1374 }
1375 ],
1376 "commandTemplates": [ ~/~/ Шаблон команды
1377 {
1378 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1379 "name": "string",
1380 "command": "string",
1381 "retries": 0
1382 }
1383 ],
1384 "sensors": [ ~/~/ Датчики
1385 {
1386 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1387 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1388 "type": 0, ~/~/ Тип датчика
1389 "name": "string", ~/~/ Имя датчика
1390 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1391 "inputNumber": 0, ~/~/ Номер входа
1392 "pseudonym": "string", ~/~/ Псевдоним
1393 "medianDegree": 0, ~/~/ Медианная фильтрация
1394 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1395 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1396 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1397 "gradesTables": [ ~/~/ Массив таблиц тарировки
1398 {
1399 "grades": [ ~/~/ Таблица тарировки 1
1400 {
1401 "input": 0, ~/~/ Входящее значение
1402 "output": 0 ~/~/ Выходящее значение
1403 }
1404 ],
1405 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1406 }
1407 ],
1408 "showInTooltip": true, ~/~/ Отображать в подсказке
1409 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1410 "color": "string", ~/~/ код цвета датчиков
1411 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1412 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1413 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1414 "expr": "string", ~/~/ Формула
1415 "children": [ ~/~/ массив дочерних датчиков
1416 "string"
1417 ],
1418 "customParams": { ~/~/ прочие произвольные параметры
1419 "additionalProp1": "string",
1420 "additionalProp2": "string",
1421 "additionalProp3": "string"
1422 },
1423 ~/~/ Характерные для произвольного:
1424 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1425 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1426 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1427 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1428 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1429 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1430 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1431 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1432 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1433 ~/~/ "ValueOn": "Вкл.",
1434 ~/~/ "ValueOff": "Выкл."
1435 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1436
1437 (((
1438 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1439 {
1440 "from": 0, ~/~/ С какого значения
1441 "color": "string", ~/~/ Каким цветом
1442 "text": "string" ~/~/ Текст подписи к этому интервалу
1443 }
1444 ]
1445 }
1446 ],
1447 )))
1448
1449 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1450
1451
1452 "customFields": [ ~/~/ Произвольные поля
1453 {
1454 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1455 "name": "string", ~/~/ Наименование произвольного поля
1456 "value": "string", ~/~/ Значение произвольного поля
1457 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1458 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1459 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1460
1461 (((
1462 }
1463 ],
1464 "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1465 )))
1466
1467 (((
1468 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1469 }
1470 )))
1471
1472
1473 (% style="color:#000000" %)Ответ:
1474
1475
1476 (((
1477 (((
1478 (((
1479 {
1480 "vehicleId": 0,  ~/~/ ID ТС
1481 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1482 "name": "string", ~/~/ Имя объекта
1483 "imei": "string", ~/~/ IMEI
1484 "deviceTypeId": 0, ~/~/ ID типа устройства
1485 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1486 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1487 "sim1": "string", ~/~/ SIM1
1488 "sim2": "string", ~/~/ SIM2
1489 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1490 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1491 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1492 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1493 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1494 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1495 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1496 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1497 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1498 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1499 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1500 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1501 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1502 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1503 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1504 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1505 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1506 "counters": {  ~/~/ Dto для состояний счётчиков
1507 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1508 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1509 "mileage": 0, ~/~/ Пробег
1510 "motohours": 0 ~/~/ Моточасы
1511 },
1512 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1513 "id": "string", ~/~/ CMSV6 Идентификатор
1514 "enabled": true, ~/~/ Признак включения
1515 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1516 "login": "string", ~/~/ CMSV6 имя учетной записи
1517 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1518 },
1519 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1520 {
1521 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1522 "enabled": true, ~/~/ Признак включения
1523 "name": "string", ~/~/ Имя задания
1524 "description": "string", ~/~/ Описание задания
1525 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1526 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1527 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1528 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1529 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1530 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1531 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1532 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1533 }
1534 ],
1535 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1536 {
1537 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1538 "inputNumber": 0, ~/~/ № входа.
1539 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1540 "comment": "string", ~/~/ Комментарий
1541 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1542 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1543 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1544 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1545 }
1546 ],
1547 "commandTemplates": [  ~/~/ Список шаблонов команд
1548 {
1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1550 "name": "string", ~/~/ Название шаблона команд
1551 "command": "string", ~/~/ Команда на выполнение
1552 "retries": 0 ~/~/ Лимит попыток отправки
1553 }
1554 ],
1555 "sensors": [ ~/~/ Список датчиков
1556 {
1557 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1558 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1559 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1560 "name": "string",  ~/~/ Имя датчика
1561 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1562 "inputNumber": 0, ~/~/ Номер входа
1563 "pseudonym": "string", ~/~/ Псевдоним
1564 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1565 "isInverted": true, ~/~/  Признак инверсии
1566 "disabled": true, ~/~/ Датчик не участвует в обработке
1567 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1568 "gradesTables": [ ~/~/ Тарировка
1569 {
1570 "grades": [ ~/~/ Таблицы тарировки
1571 {
1572 "input": 0, ~/~/ Вход
1573 "output": 0 ~/~/ Выход
1574 }
1575 ],
1576 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1577 }
1578 ],
1579 "showInTooltip": true, ~/~/ Отображение в подсказке
1580 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1581 "color": "string", ~/~/ код цвета датчиков
1582 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1583 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1584 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1585 "expr": "string", ~/~/ Выражение
1586 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1587 "string"
1588 ],
1589 "customParams": {
1590 "additionalProp1": "string",
1591 "additionalProp2": "string",
1592 "additionalProp3": "string"
1593 },
1594 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1595 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1596 {
1597 "from": 0, ~/~/ С какого значения
1598 "color": "string", ~/~/ Каким цветом
1599 )))
1600
1601 (((
1602 "text": "string" ~/~/ Текст подписи к этому интервалу
1603 }
1604 ]
1605 }
1606 ],
1607 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1608 "customFields": [ ~/~/ Список произвольных полей
1609 {
1610 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1611 "name": "string", ~/~/ Наименование произвольного поля
1612 "value": "string", ~/~/ Значение произвольного поля
1613 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1614 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1615 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1616 }
1617 ],
1618 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1619 }
1620 )))
1621 )))
1622 )))
1623
1624
1625 **Валидация:**
1626 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1627 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1629
1630
1631 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1632
1633 (% class="box infomessage" %)
1634 (((
1635 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1636 )))
1637
1638 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1639
1640 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1641
1642 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1643
1644 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1645
1646 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1647
1648 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1649
1650 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1651
1652 (% style="color:#000000" %)Метод запроса: **POST**
1653
1654 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1655
1656 (% style="color:#000000" %)В заголовках запроса:
1657
1658 (% style="color:#000000" %)− Content-Type: __**application/json**__
1659
1660 (% style="color:#000000" %)− X-Auth: Токен авторизации
1661
1662 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1663
1664 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1665
1666 {
1667 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1668 "name": null, ~/~/ Имя ТС (string, опционально)
1669 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1670 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1671 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1672 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1673 "unitName": "string",  ~/~/ Название подразделения (опционально)
1674 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1675 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1676 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1677 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1678 }
1679
1680 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1681
1682 (% style="color:#000000" %)Ответ:
1683
1684 (% style="color:#000000" %)[
1685 {
1686
1687 (((
1688 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1689 )))
1690
1691 (((
1692 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1693 "name": "" ~/~/ наименование объекта
1694 "imei": "" ~/~/ IMEI объекта
1695 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1696 "deviceTypeName": "" ~/~/ наименование типа устройства
1697 "sim1": "" ~/~/ первый номер телефона
1698 "sim2": "" ~/~/ второй номер телефона
1699 "parentId": "" ~/~/ идентификатор клиента-родителя
1700 "parentName": "" ~/~/ наименование клиента-родителя
1701 "modelId": "" ~/~/ идентификатор модели объекта
1702 "modelName": "" ~/~/ наименование модели объекта
1703 "unitId": "" ~/~/ идентификатор подразделения
1704 "unitName": "" ~/~/ наименование подразделения
1705 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1706 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1707 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1708 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1709 "customFields": [ 
1710 {
1711 "id": "", ~/~/ идентификатор произвольного поля
1712 "name": "", ~/~/ имя произвольного поля
1713 "value": "", ~/~/ значение произвольного поля
1714 "forClient": true, ~/~/ право на отображение у клиента
1715 "forTooltip": false, ~/~/ право на отображение в подсказке
1716 "forReport": false ~/~/ право на отображение в отчетах
1717 )))
1718
1719 (((
1720 }
1721 ],
1722 "vehicleGroups": [  ~/~/ Группы ТС
1723 {
1724 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1725 "name": "string" ~/~/ Наименование группы ТС
1726 }
1727 ]
1728 }
1729 ]
1730 )))
1731
1732 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1733
1734 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1735
1736 (% class="box successmessage" %)
1737 (((
1738 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1739 )))
1740
1741 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1742
1743 (% style="color:#000000" %)Метод запроса: **POST**
1744
1745 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
1746
1747 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1748
1749 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1750
1751 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1752
1753 (% style="color:#000000" %){
1754
1755 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1756 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1757 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1758 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1759 "description": "", ~/~/ Описание
1760 "data": "", ~/~/ Данные
1761 "overwrite": false, ~/~/ Флаг перезаписи
1762 "stage": "", ~/~/ Состояние, может быть null
1763 (% style="color:#000000" %)}
1764
1765 (% style="color:#000000" %)Ответ:
1766
1767 (% style="color:#000000" %){(%%)
1768 "status": "", ~/~/ значение статуса
1769 "date": "", ~/~/ Дата смены статуса 
1770 "description": "", ~/~/ Описание
1771 "data": "", ~/~/ Данные
1772 "overwrite": false, ~/~/ Флаг перезаписи
1773 "stage": "", ~/~/ Состояние
1774 (% style="color:#000000" %) }
1775
1776
1777 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1778
1779 (% class="box warningmessage" %)
1780 (((
1781 (% lang="en-US" %)**PUT /api/v3/vehicles**
1782 )))
1783
1784 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1785
1786 (% style="color:#000000" %)Метод запроса: **PUT**
1787
1788 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1789
1790 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1791
1792 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1793
1794 (% style="color:#000000" %){
1795 "vehicleId": , ~/~/ ID объекта
1796 "parentId": "" , ~/~/ ID клиента
1797 "name": "" , ~/~/ имя ТС
1798 "imei": "" , ~/~/ IMEI
1799 "deviceTypeId": "" , ~/~/ ID типа устройства
1800 "modelId": "" , ~/~/ ID модели
1801 "unitId": "" , ~/~/ ID подразделения
1802 "sim1": "" , ~/~/ Номер SIM 1
1803 "sim2": "" , ~/~/ Номер SIM2
1804 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1805 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1806 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1807 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1808 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1809 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1810 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1811 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1812 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1813 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1814 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1815 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1816
1817 "mileageCalcMethod": 0,
1818 "mileageCoeff": 0,
1819 "locationByCellId": true,
1820 "dottedLineTrackWhenNoCoords": true,
1821 "counters": ~/~/ счетчики
1822 {
1823 "mileage": "" , ~/~/ пробег
1824 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1825 "motohours": "" , ~/~/ моточасы
1826 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1827 },
1828 "cmsv6Parameters": { ~/~/ параметры CMSv6
1829 "enabled": true, ~/~/ флаг включения
1830 "id": "" , ~/~/ идентификатор
1831 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1832 "login": "" , ~/~/ имя учетной записи
1833 "password": "" ~/~/ пароль учетной записи
1834 },
1835 "inspectionTasks": ~/~/ задания на ТО
1836 {
1837 "enabled": "" , ~/~/ Признак включения
1838 "name": "" , ~/~/ Имя задания
1839 "description": "" , ~/~/ Описание задания
1840 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1841 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1842 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1843 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1844 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1845 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1846 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1847 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1848 }
1849
1850 "drivers": [ ~/~/ Водители
1851 {
1852
1853 (((
1854 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1855 "inputNumber": 0, ~/~/ № входа.
1856 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1857 "comment": "string", ~/~/ Комментарий.
1858 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1859 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1860 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1861 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1862 )))
1863
1864 } 
1865 ],
1866 "commandTemplates": [ ~/~/ Шаблон команды
1867 {
1868 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1869 "name": "string",
1870 "command": "string",
1871 "retries": 0
1872 }
1873 ],
1874 "sensors": [ ~/~/ Датчики
1875 {
1876 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1877 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1878 "type": 0, ~/~/ Тип датчика
1879 "name": "string", ~/~/ Имя датчика
1880 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1881 "inputNumber": 0, ~/~/ Номер входа
1882 "pseudonym": "string", ~/~/ Псевдоним
1883 "medianDegree": 0, ~/~/ Медианная фильтрация
1884 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1885 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1886 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1887 "gradesTables": [ ~/~/ Массив таблиц тарировки
1888 {
1889 "grades": [ ~/~/ Таблица тарировки 1
1890 {
1891 "input": 0, ~/~/ Входящее значение
1892 "output": 0 ~/~/ Выходящее значение
1893 }
1894 ],
1895 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1896 }
1897 ],
1898 "showInTooltip": true, ~/~/ Отображать в подсказке
1899 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1900
1901 (((
1902 "color": "string",** ~/~/ **Цвет датчика
1903 )))
1904
1905 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1906 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1907 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1908 "expr": "string", ~/~/ Формула
1909 "children": [ ~/~/ массив дочерних датчиков
1910 "string"
1911 ],
1912 "customParams": { ~/~/ прочие произвольные параметры
1913 "additionalProp1": "string",
1914 "additionalProp2": "string",
1915 "additionalProp3": "string"
1916 },
1917 ~/~/ Характерные для произвольного:
1918 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1919 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1920 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1921 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1922 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1923 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1924 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1925 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1926 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1927 ~/~/ "ValueOn": "Вкл.",
1928 ~/~/ "ValueOff": "Выкл."
1929 "summaryMaxValue": 0 ~/~/ Макс. значение
1930
1931 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1932 {
1933 "from": 0, ~/~/ С какого значения
1934 "color": "string", ~/~/ Каким цветом
1935 "text": "string" ~/~/ Текст подписи к этому интервалу
1936 }
1937 ]
1938 }
1939 ],
1940 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1941
1942 "customFields": [ ~/~/ Произвольные поля
1943 {     
1944 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1945 "name": "string", ~/~/ Наименование произвольного поля
1946 "value": "string", ~/~/ Значение произвольного поля
1947 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1948 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1949 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1950 }
1951
1952 (((
1953 ],
1954 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1955 )))
1956
1957 }
1958
1959
1960 (% style="color:#000000" %)Ответ:
1961
1962 (((
1963 {
1964 "vehicleId": 0, ~/~/ ID ТС
1965 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1966 "name": "string", ~/~/ Имя объекта
1967 "imei": "string", ~/~/ IMEI
1968 "deviceTypeId": 0, ~/~/ ID типа устройства
1969 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1970 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1971 "sim1": "string", ~/~/ SIM1
1972 "sim2": "string", ~/~/ SIM2
1973 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1974 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1975 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1976 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1977 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1978 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1979 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1980 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1981 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1982 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1983 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1984 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1985 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1986 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1987 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1988 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1989 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1990 "counters": { ~/~/ состояний счётчиков
1991 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1992 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1993 "mileage": 0, ~/~/ Пробег
1994 "motohours": 0 ~/~/ Моточасы 
1995 },
1996 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1997 "id": "string", ~/~/ CMSV6 Идентификатор
1998 "enabled": true, ~/~/ Признак включения
1999 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2000 )))
2001
2002
2003 (((
2004 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2005 "login": "string", ~/~/ CMSV6 имя учетной записи
2006 "password": "string" ~/~/ CMSV6 — пароль учетной записи
2007 },
2008 "inspectionTasks": [ ~/~/ Задания на ТО
2009 {
2010 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2011 "enabled": true, ~/~/ Признак включения
2012 "name": "string", ~/~/ Имя задания
2013 "description": "string", ~/~/ Описание задания
2014 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2015 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2016 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2017 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2018 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2019 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2020 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2021 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2022 }
2023 ],
2024 "drivers": [  ~/~/ Список водителей
2025 {
2026 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2027 "inputNumber": 0, ~/~/ № входа.
2028 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2029 "comment": "string", ~/~/ Комментарий.
2030 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2031 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2032 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2033 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2034 }
2035 ],
2036 "commandTemplates": [ ~/~/ Список шаблонов команд
2037 {
2038 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2039 "name": "string", ~/~/ Название шаблона команд
2040 "command": "string", ~/~/ Команда на выполнение
2041 "retries": 0 ~/~/ Лимит попыток отправки
2042 }
2043 ],
2044 "sensors": [  ~/~/ Список датчиков 
2045 {
2046 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2047 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2048 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2049 )))
2050
2051 (((
2052 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2053 )))
2054
2055 (((
2056 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2057 )))
2058
2059 (((
2060 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2061 )))
2062
2063 (((
2064 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2065 )))
2066
2067 (((
2068 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2069 "name": "string", ~/~/ Имя датчика
2070 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2071 )))
2072
2073 (((
2074 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2075 "inputNumber": 0, ~/~/ Номер входа
2076 "pseudonym": "string", ~/~/ Псевдоним
2077 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2078 "isInverted": true, ~/~/ Признак инверсии
2079 "disabled": true, ~/~/ Датчик не участвует в обработке
2080 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2081 "gradesTables": [ ~/~/ Тарировка
2082 {
2083 "grades": [ ~/~/ Таблицы тарировки
2084 {
2085 "input": 0, ~/~/ Вход
2086 "output": 0 ~/~/ Выход
2087 }
2088 ],
2089 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2090 }
2091 ],
2092 "showInTooltip": true, ~/~/ Отображение в подсказке
2093 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2094
2095 (((
2096 "color": "string", ~/~/ цвет уведомлений
2097 )))
2098
2099 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2100 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2101 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2102 "expr": "string", ~/~/ Выражение
2103 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2104 "string" 
2105 ],
2106 "customParams": { ~/~/ Дополнительные настройки
2107 "additionalProp1": "string",
2108 "additionalProp2": "string",
2109 "additionalProp3": "string"
2110 },
2111 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2112 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2113 {
2114 "from": 0, ~/~/ С какого значения
2115 "color": "string", ~/~/ Каким цветом
2116 "text": "string" ~/~/ Текст подписи к этому интервалу
2117 }
2118 ]
2119 }
2120 ],
2121 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2122 "customFields": [ ~/~/ Список произвольных полей
2123 {
2124 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2125 "name": "string", ~/~/ Наименование произвольного поля
2126 "value": "string", ~/~/ Значение произвольного поля
2127 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2128 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2129 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2130 }
2131 ],
2132 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2133 }
2134 )))
2135
2136 **Валидация:**
2137 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2138 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2139 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2140
2141 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2142
2143 (% class="box errormessage" %)
2144 (((
2145 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2146 )))
2147
2148 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2149
2150 (% style="color:#000000" %)Метод запроса: **DELETE**
2151
2152 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2153
2154 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2155
2156 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2157
2158 (% style="text-align:left" %)
2159 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2160
2161 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2162
2163 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2164
2165 (% class="box infomessage" %)
2166 (((
2167 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2168 )))
2169
2170 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2171
2172 (% style="color:#000000" %)Метод запроса: **GET**
2173
2174 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2175
2176 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2177
2178 (% style="color:#000000" %)Ответ:
2179
2180 (% style="color:#000000" %){(%%)
2181 "deviceTypeId" : "", ~/~/ ID типа устройства
2182 "deviceTypeName" : "" ~/~/ Название типа устройства
2183 (% style="color:#000000" %)}
2184
2185 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2186
2187 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2188
2189 (% class="box infomessage" %)
2190 (((
2191 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2192 )))
2193
2194 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2195
2196 (% style="color:#000000" %)Метод запроса: **GET**
2197
2198 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2199
2200 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2201
2202 (% style="color:#000000" %)Ответ:
2203
2204 (% style="color:#000000" %){(%%)
2205 "id": "", ~/~/ ID типа датчика 
2206 "name": "", ~/~/ Название
2207 "description": "", ~/~/ Описание
2208 (% style="color:#000000" %)}
2209
2210 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2211
2212 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2213
2214 (% class="box infomessage" style="text-align: left;" %)
2215 (((
2216 **POST /api/v3/terminalMessages/count**
2217 )))
2218
2219 (% style="text-align: left;" %)
2220 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2221
2222 (% style="text-align: left;" %)
2223 Метод запроса **POST**
2224
2225 (% style="text-align: left;" %)
2226 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2227
2228 (% style="text-align: left;" %)
2229 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2230
2231 (% style="text-align: left;" %)
2232 {
2233 "vehicleIds": [
2234 id ~/~/ здесь передается список идентификаторов объектов
2235 ],
2236 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2237 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2238 }
2239
2240 (% style="text-align: left;" %)
2241 Ответ:
2242
2243 (% style="text-align: left;" %)
2244 [
2245 {
2246 "vehicleId": 0, ~/~/ идентификатор объекта
2247 "count": 0 ~/~/ количество сообщений за период
2248 }
2249 ]
2250
2251 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2252
2253 (% class="box infomessage" style="text-align: left;" %)
2254 (((
2255 **POST /api/v3/terminalMessages/mapping**
2256 )))
2257
2258 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2259
2260 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2261
2262 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2263
2264 {
2265 "protocolType": 0,
2266 "params": ["string"]
2267 }
2268
2269 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2270 |protocolType|ID типа протокола
2271 |params|(((
2272 Массив наименований параметров в сообщении
2273 )))
2274
2275 Ответ:
2276
2277 {
2278 "protocolType": 0,
2279 "mapping": {
2280 "additionalProp1": {
2281 "inputType": 0,
2282 "inputNumber": 0
2283 },
2284 "additionalProp2": {
2285 "inputType": 0,
2286 "inputNumber": 0
2287 }
2288 }
2289 }
2290
2291 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2292 |protocolType|Тип протокола
2293 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2294 |inputNumber|(((
2295 Номер входа
2296 )))
2297
2298 (% class="wikigeneratedid" %)
2299 Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2300
2301 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2302
2303 (% class="box infomessage" %)
2304 (((
2305 **POST /api/v3/terminalMessages**
2306 )))
2307
2308 Метод возвращает список сообщений терминала объекта за выбранный период.
2309
2310 (% style="text-align: left;" %)
2311 Метод запроса **POST**
2312
2313 (% style="text-align: left;" %)
2314 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2315
2316 (% style="text-align: left;" %)
2317 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2318
2319 {
2320 "vehicleId": 0, ~/~/ id объекта
2321 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2322 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2323 }
2324
2325 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2326 |vehicleId|ID объекта
2327 |from|Дата и время начала периода запроса
2328 |to|Дата и время окончания периода запроса
2329
2330 Ответ:
2331
2332 [
2333 {
2334 "messages": [
2335 {
2336 "deviceTime": "2023-11-29T07:40:44.052Z",
2337 "serverTime": "2023-11-29T07:40:44.052Z",
2338 "speed": 0,
2339 "altitude": 0,
2340 "latitude": 0,
2341 "longitude": 0,
2342 "satellites": 0,
2343 "course": 0,
2344 "voltage": 0,
2345 "parameters": {
2346 "additionalProp1": "string",
2347 "additionalProp2": "string",
2348 "additionalProp3": "string"
2349 },
2350 "photoCount": 0,
2351 "lbsCorrectedCoords": true,
2352 "protocolType": 0
2353 }
2354 ]
2355 }
2356 ]
2357
2358 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2359 |deviceTime|Время сообщения терминала
2360 |serverTime|Время когда сообщение поступило на сервер
2361 |speed|Скорость
2362 |altitude|Высота над уровнем моря
2363 |latitude|Широта
2364 |longitude|Долгота
2365 |satellites|Кол-во спутников
2366 |course|Курс
2367 |voltage|Бортовое напряжение
2368 |parameters|Список параметров и их значений
2369 |photoCount|Количество фото
2370 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2371 |protocolType|ID типа протокола
2372
2373 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2374
2375 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2376
2377 (% class="box infomessage" %)
2378 (((
2379 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2380 )))
2381
2382 (% style="color:#000000" %)Метод запроса: **POST**
2383
2384 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2385
2386 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2387
2388 (% style="text-align:left" %)
2389 Тело запроса:
2390
2391 {
2392 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2393 "vehicleIds": [0], ~/~/ Список ID объектов
2394 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2395 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2396 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2397 }
2398
2399 Ответ:
2400
2401 [
2402 {
2403 "vehicleId": 0, ~/~/ ID объекта
2404 "name": "string", ~/~/ Имя ТС
2405 "periods": [ ~/~/ Периоды
2406 {
2407 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2408 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2409 "mileage": 0, ~/~/ Пробег за период, километры
2410 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2411 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2412 "motohours": 0, ~/~/ Моточасы за период, секунды
2413 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2414 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2415 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2416
2417 }
2418 ]
2419 }
2420 ]
2421
2422 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2423
2424 (% class="box infomessage" %)
2425 (((
2426 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2427 )))
2428
2429 (% style="color:#000000" %)Метод запроса: **POST**
2430
2431 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2432
2433 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2434
2435 (% style="text-align:left" %)
2436 Тело запроса:
2437
2438 {
2439 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2440 "vehicleIds": [0], ~/~/ Список ID объектов
2441 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2442 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2443 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2444 }
2445
2446 Ответ:
2447
2448 [
2449 {
2450 "vehicleId": 0, ~/~/ ID объекта
2451 "name": "string", ~/~/ Имя ТС
2452 "periods": [ ~/~/ Периоды
2453 {
2454 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2455 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2456 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2457 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2458 "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2459 "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2460 "fuelConsumption": 0, ~/~/ Расход топлива
2461 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2462 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2463
2464 }
2465 ]
2466 }
2467 ]
2468
2469 (% class="box warningmessage" %)
2470 (((
2471 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2472 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2473 )))
2474
2475 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2476
2477 (% class="box infomessage" %)
2478 (((
2479 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2480 )))
2481
2482 (% style="color:#000000" %)Метод запроса: **POST**
2483
2484 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2485
2486 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2487
2488 (% style="text-align:left" %)
2489 Тело запроса:
2490
2491 {
2492 "vehicleIds": [0], ~/~/ Список ID объектов
2493 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2494 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2495 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2496 }
2497
2498 Ответ:
2499
2500 [
2501 {
2502 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2503 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2504 "vehicleId": 0, ~/~/ ID объекта
2505 "name": "string", ~/~/ Имя объекта
2506 "model": "string", ~/~/ Модель объекта
2507 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2508 {
2509 "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2510
2511 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2512 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2513 "valueFuel": 0, ~/~/ Количество
2514 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2515 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2516 }
2517 ]
2518 }
2519 ]
2520
2521
2522 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2523
2524 (% class="box infomessage" %)
2525 (((
2526 **POST /api/v3/vehicles/moveStop**
2527 )))
2528
2529 Метод запроса: **POST**
2530
2531 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2532
2533 В заголовках запроса: X-Auth: Токен авторизации
2534
2535
2536 Тело запроса:
2537
2538 {
2539 "vehicleIds": [ ], ~/~/ Список ID объектов
2540 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2541 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2542 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2543 }
2544
2545 Ответ:
2546
2547 [ 
2548 {
2549 "vehicleId": 0, ~/~/ ID объекта
2550 "vehicleName": "string", ~/~/ Имя объекта
2551 "moves": [ ~/~/ Событие движения
2552 {
2553 "mileage": 0, ~/~/ Пробег, км
2554 "eventId": 0, ~/~/ Идентификатор события
2555 "eventName": "string", ~/~/ Название события
2556 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2557 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2558 "duration": 0 ~/~/ Продолжительность события, секунд
2559 }
2560 ],
2561 "stops": [ ~/~/ События стоянок
2562 {
2563 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2564 "eventId": 0, ~/~/ Идентификатор события
2565 "eventName": "string", ~/~/ Название события
2566 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2567 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2568 "duration": 0 ~/~/ Продолжительность события, секунд
2569 }
2570 ]
2571 }
2572 ]
2573
2574
2575 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2576
2577 (% class="box infomessage" %)
2578 (((
2579 **POST /api/v3/vehicles/getlastdata**
2580 )))
2581
2582 Метод запроса: **POST**
2583
2584 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2585
2586 В заголовках запроса: X-Auth: Токен авторизации
2587
2588
2589 В массиве указываем id объектов через запятую
2590
2591 Ответ:
2592
2593 [
2594 {
2595 "vehicleId": 55728, ~/~/ Идентификатор объекта 
2596 "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2597 "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2598 "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2599 "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2600 "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2601 "speed": 31, ~/~/ Скорость объекта 
2602 "course": 116, ~/~/ Курс движения [0;360]
2603 "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2604 "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2605 "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2606 "geozones": [ ~/~/ Сведения по геозонам. 
2607 {
2608 "id": 10225647, ~/~/ ID Геозоны 
2609 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2610 },
2611 {
2612 "id": 10282875, ~/~/ ID Геозоны 
2613 "name": "Ё2" ~/~/ Наименование геозоны 
2614 },
2615 {
2616 "id": 10226240, ~/~/ ID Геозоны 
2617 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2618 },
2619 {
2620 "id": 9747869, ~/~/ ID Геозоны 
2621 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2622 },
2623 {
2624 "id": 10221123, ~/~/ ID Геозоны 
2625 "name": "53r" ~/~/ Наименование геозоны 
2626 },
2627 {
2628 "id": 10197638, ~/~/ ID Геозоны 
2629 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2630 }
2631 ]
2632 }
2633
2634
2635 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2636
2637 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2638
2639 (% class="box infomessage" %)
2640 (((
2641 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2642 )))
2643
2644 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2645
2646 (% style="color:#000000" %)Метод запроса: **POST**
2647
2648 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2649
2650 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2651
2652 (% style="text-align:left" %)
2653 Тело запроса:
2654
2655 (% style="text-align:left" %)
2656 {
2657 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2658 }
2659
2660 (% style="text-align:left" %)
2661 Ответ:
2662
2663 [
2664 {
2665 "id": 0, ~/~/ Идентификатор объекта геозоны
2666 "name": "string", ~/~/ Название объекта геозоны
2667 "type": 0, ~/~/ Тип объекта геозоны
2668 "fname": "string", ~/~/ Имя файла
2669 "parentId": "string", ~/~/ Идентификатор клиента
2670 "radius": 0, ~/~/ Радиус геообъекта
2671 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2672 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2673 "description": "string", ~/~/ Описание
2674 "area": 0, ~/~/ Площадь, м^^2^^
2675 "perimetr": 0, ~/~/ Периметр, м
2676 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2677 }
2678 ]
2679
2680 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2681
2682 (% class="box infomessage" %)
2683 (((
2684 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2685 )))
2686
2687 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2688
2689 (% style="color:#000000" %)Метод запроса: **POST**
2690
2691 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2692
2693 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2694
2695 (% style="text-align:left" %)
2696 Тело запроса:
2697
2698 {
2699 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2700 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2701 "ids": [ ], ~/~/ Массив id объектов
2702 "byTime": 0, ~/~/ Объединение событий по времени 
2703 "byDist": 0, ~/~/ Объединение событий по расстоянию
2704 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2705 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2706 }
2707
2708 Ответ:
2709 [
2710 {
2711 "geozoneId": 0, ~/~/ ID геообъекта
2712 "geozoneName": "string", ~/~/ Название геообъекта
2713 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2714 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2715 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2716 "vehicleId": 0, ~/~/ ID объекта
2717 "vehicleName": "string" ~/~/ Имя объекта
2718 }
2719 ]
2720
2721 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2722
2723 (% class="box infomessage" %)
2724 (((
2725 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2726 )))
2727
2728 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2729
2730 (% style="color:#000000" %)Метод запроса: **POST**
2731
2732 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2733
2734 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2735
2736 (% style="text-align:left" %)
2737 Тело запроса:
2738
2739 {
2740 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2741 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2742 "ids": [ ], ~/~/ Массив id геообъектов
2743 "byTime": 0, ~/~/ Объединение событий по времени 
2744 "byDist": 0, ~/~/ Объединение событий по расстоянию
2745 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2746 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2747 }
2748
2749 Ответ:
2750
2751 [
2752 {
2753 "geozoneId": 0, ~/~/ ID геообъекта
2754 "geozoneName": "string", ~/~/ Название геообъекта
2755 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2756 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2757 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2758 "vehicleId": 0, ~/~/ ID объекта
2759 "vehicleName": "string" ~/~/ Имя объекта
2760 }
2761 ]
2762
2763
2764 == (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2765
2766 (% class="box successmessage" %)
2767 (((
2768 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2769 )))
2770
2771 (% style="color:#000000" %)Метод запроса: **PUT**
2772
2773 Пример запроса:
2774
2775 (((
2776 {
2777 "id": 0,  ~/~/ Идентификатор объекта геозоны
2778 "name": "string",  ~/~/ Наименование объекта геозоны
2779 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2780 "description": "string", ~/~/ Описание объекта геозоны
2781 "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2782 "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2783 "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2784 }
2785 )))
2786
2787
2788 Пример ответа:
2789
2790 200 ~/~/ Success
2791
2792 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2793
2794 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2795
2796 (% class="box infomessage" %)
2797 (((
2798 **POST /api/v3/notifications/find**
2799 )))
2800
2801 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2802
2803 (% style="text-align: left;" %)
2804 Метод запроса **POST**
2805
2806 (% style="text-align: left;" %)
2807 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2808
2809 (% style="text-align: left;" %)
2810 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2811
2812 {
2813 "parentId": "" ~/~/ id клиента
2814 }
2815
2816 Ответ:
2817
2818 [
2819 {
2820 "id": 0, ~/~/ ID уведомления
2821 "name": "string", ~/~/ Название уведомления
2822 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2823 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2824 "userId": "", ~/~/ Пользователь, создавший уведомление
2825 "parentId": "", ~/~/ Идентификатор клиента
2826 "parentName": "string" ~/~/ Имя клиента
2827 }
2828 ]
2829
2830
2831 == (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2832
2833 (% class="box infomessage" %)
2834 (((
2835 **POST /api/v3/notifications**
2836 )))
2837
2838 Метод запроса **POST**
2839
2840 (% style="text-align: left;" %)
2841 (% style="color:#000000" %)Пример запроса
2842
2843 (((
2844 {
2845 "id": 0, ~/~/ ID правила
2846 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2847 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2848 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2849 "name": "string", ~/~/ Имя правила
2850 "active": true, ~/~/ Активность правила
2851 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2852 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2853 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2854 ],
2855 "vehicleIds": [ ~/~/ Список объектов для анализа.
2856 0
2857 ],
2858 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2859 0
2860 ],
2861 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2862 0
2863 ],
2864 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2865 "additionalProp1": "string",  
2866 "additionalProp2": "string",
2867 "additionalProp3": "string"
2868 },
2869 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2870 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2871 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2872 ],
2873 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2874 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2875 "string"
2876 ],
2877 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2878 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2879 {
2880 "id": 0, ~/~/ Идентификатор участника чата.
2881 "info": "string" ~/~/ Дополнительные сведения.
2882 }
2883 ],
2884 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2885 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2886 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2887 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2888 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2889 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2890 "timezone": 0, ~/~/ часовой пояс 
2891 "validity": 0, ~/~/ Срок действия в днях (1-90).
2892 "autoProlongation": true, ~/~/ Автопродление срока действия.
2893 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2894 {
2895 "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2896 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2897 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2898 "additionalProp1": "string",
2899 "additionalProp2": "string",
2900 "additionalProp3": "string"
2901 }
2902 }
2903 ]
2904 }
2905 )))
2906
2907 (((
2908
2909 )))
2910
2911 (((
2912
2913 )))
2914
2915 Ответ:
2916
2917 {
2918 "id": 0, ~/~/ ID правила
2919 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2920 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2921 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2922 "name": "string", ~/~/ Имя правила
2923 "active": true, ~/~/ Активность правила
2924 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2925 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2926 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2927 ],
2928 "vehicleIds": [ ~/~/ Список объектов для анализа.
2929 0
2930 ],
2931 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2932 0
2933 ],
2934 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2935 0
2936 ],
2937 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2938 "additionalProp1": "string",  
2939 "additionalProp2": "string",
2940 "additionalProp3": "string"
2941 },
2942 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2943 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2944 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2945 ],
2946 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2947 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2948 "string"
2949 ],
2950 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2951 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2952 {
2953 "id": 0, ~/~/ Идентификатор участника чата.
2954 "info": "string" ~/~/ Дополнительные сведения.
2955 }
2956 ],
2957 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2958 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2959 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2960 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2961 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2962 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2963 "timezone": 0, ~/~/ часовой пояс 
2964 "validity": 0, ~/~/ Срок действия в днях (1-90).
2965 "autoProlongation": true, ~/~/ Автопродление срока действия.
2966 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2967 {
2968 "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2969 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2970 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2971 "additionalProp1": "string",
2972 "additionalProp2": "string",
2973 "additionalProp3": "string"
2974 }
2975 }
2976 ]
2977 }
2978
2979 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2980
2981 (% class="box infomessage" %)
2982 (((
2983 **GET /api/v3/notifications/{id}**
2984 )))
2985
2986 Метод возвращает данные правил формирования выбранного уведомления.
2987
2988 (% style="text-align: left;" %)
2989 Метод запроса **GET**
2990
2991 (% style="text-align: left;" %)
2992 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2993
2994 (% style="text-align: left;" %)
2995 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2996
2997 (% style="text-align: left;" %)
2998 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2999
3000 (% style="text-align: left;" %)
3001 (% style="color:#000000" %)Ответ:
3002
3003 (% style="text-align: left;" %)
3004 (% style="color:#000000" %){
3005 "id": 0, ~/~/ (%%)id уведомления
3006 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
3007 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
3008 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
3009 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
3010 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
3011 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
3012 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
3013 (% style="color:#000000" %) 0
3014 ],
3015 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
3016 (% style="color:#000000" %) 0
3017 ],
3018 "fieldids": [ ~/~/ (%%)Список id полей для анализа
3019 (% style="color:#000000" %) 0
3020 ],
3021 "settings": { ~/~/ Список параметров уведомления
3022 "additionalProp1": "string",
3023 "additionalProp2": "string",
3024 "additionalProp3": "string"
3025 },
3026 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3027 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3028 (% style="color:#000000" %) ""
3029 ],
3030 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3031 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
3032 (% style="color:#000000" %) "string"
3033 ],
3034 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
3035 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
3036 (% style="color:#000000" %) {
3037 "id": 0, ~/~/ (%%)Идентификатор участника чата
3038 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
3039 (% style="color:#000000" %) }
3040 ],
3041 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
3042 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
3043 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3044 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
3045 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3046 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
3047 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
3048 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
3049 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
3050 (% style="color:#000000" %)}
3051
3052 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
3053
3054 (% class="box warningmessage" %)
3055 (((
3056 **PUT /api/v3/notifications/**
3057 )))
3058
3059 Метод позволяет отредактировать уведомление.
3060
3061 Метод запроса **PUT**
3062
3063 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
3064
3065 В заголовках запроса: X-Auth: Токен авторизации
3066
3067 Тело запроса:
3068 {
3069 "id": 0, ~/~/ id уведомления
3070 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
3071 "userId": "", ~/~/ Пользователь, создавший уведомление
3072 "parentId": "", ~/~/ Идентификатор клиента
3073 "parentName": "string", ~/~/ Имя клиента
3074 "name": "string", ~/~/ Название уведомления
3075 "active": true, ~/~/ Состояние true - активен, false - деактивирован
3076 "vehicleIds": [ ~/~/ Список id объектов для анализа
3077 0
3078 ],
3079 "geoids": [ ~/~/ Список id геообъектов для анализа
3080 0
3081 ],
3082 "fieldids": [ ~/~/ Список id полей для анализа
3083 0
3084 ],
3085 "settings": { ~/~/ Список параметров уведомления
3086 "additionalProp1": "string",
3087 "additionalProp2": "string",
3088 "additionalProp3": "string"
3089 },
3090 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3091 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3092 ""
3093 ],
3094 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3095 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
3096 "string"
3097 ],
3098 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
3099 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
3100 {
3101 "id": 0, ~/~/ Идентификатор участника чата
3102 "info": "string" ~/~/ Дополнительные сведения
3103 }
3104 ],
3105 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
3106 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
3107 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3108 "kind": 0, ~/~/ Определяет вид уведомления
3109 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3110 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
3111 "timezone": 0, ~/~/ Сдвиг часового пояса
3112 "validity": 0, ~/~/ Срок действия в днях (1-90)
3113 "autoProlongation": true ~/~/ Автопродление срока действия
3114 }
3115
3116 Ответ:
3117
3118 Success
3119
3120
3121 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
3122
3123 (% class="box warningmessage" %)
3124 (((
3125 **PUT** /api/v3/notifications/prolongation
3126 )))
3127
3128 Метод позволяет продлить уведомления.
3129
3130 Метод запроса **PUT**
3131
3132 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
3133
3134 В заголовках запроса: X-Auth: Токен авторизации.
3135
3136 Тело запроса:
3137
3138 [
3139
3140 0
3141
3142 ]
3143
3144 где 0 идентификатор ids.
3145
3146 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
3147
3148 (% class="box errormessage" %)
3149 (((
3150 **DELETE /api/v3/notifications/{id}**
3151 )))
3152
3153 Метод позволяет удалить выбранное уведомление.
3154
3155 Метод запроса **DELETE**
3156
3157 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3158
3159 Передаваемый параметр: {id} - id уведомления
3160
3161 В заголовках запроса: X-Auth: Токен авторизации
3162
3163 Ответ:
3164
3165 Success
3166
3167
3168 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3169
3170 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3171
3172 (% class="box infomessage" %)
3173 (((
3174 **POST /api/v3/Drivers/find**
3175 )))
3176
3177 Передается параметр: parentId - ID клиента-родителя
3178
3179 Ответ:
3180
3181 [
3182 {
3183 "name": "string", ~/~/ Определяет наименование
3184 "description": "string", ~/~/ Определяет описание
3185 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3186 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3187 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3188 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3189 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3190 "deleted": true ~/~/ Признак удаления
3191 }
3192 ]
3193
3194 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3195
3196 (% class="box infomessage" %)
3197 (((
3198 **GET /api/v3/Drivers/{driverGuid}**
3199 )))
3200
3201 Передается параметр: ID водителя
3202
3203 Ответ:
3204
3205 {
3206 "name": "string", ~/~/ Определяет наименование
3207 "description": "string", ~/~/ Определяет описание
3208 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3209 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3210 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3211 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3212 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3213 "deleted": true ~/~/ Признак удаления
3214 }
3215
3216 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3217
3218 (% class="box successmessage" %)
3219 (((
3220 **POST /api/v3/Drivers**
3221 )))
3222
3223 Запрос:
3224
3225 {
3226 "name": "string",
3227 "description": "string",
3228 "hiredate": "2023-06-30T12:50:54.020Z",
3229 "chopdate": "2023-06-30T12:50:54.020Z",
3230 "exclusive": true,
3231 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3232 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3233 "deleted": true
3234 }
3235
3236 Ответ:
3237
3238 {
3239 "name": "string",
3240 "description": "string",
3241 "hiredate": "2023-06-30T12:50:54.051Z",
3242 "chopdate": "2023-06-30T12:50:54.051Z",
3243 "exclusive": true,
3244 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3245 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3246 "deleted": true
3247 }
3248
3249
3250 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3251
3252 (% class="box warningmessage" %)
3253 (((
3254 **PUT /api/v3/Drivers**
3255 )))
3256
3257 Запрос:
3258
3259 {
3260 "name": "string",
3261 "description": "string",
3262 "hiredate": "2023-06-30T12:50:27.910Z",
3263 "chopdate": "2023-06-30T12:50:27.910Z",
3264 "exclusive": true,
3265 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3266 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3267 "deleted": true
3268 }
3269
3270 Ответ:
3271
3272 {
3273 "name": "string",
3274 "description": "string",
3275 "hiredate": "2023-06-30T12:50:27.929Z",
3276 "chopdate": "2023-06-30T12:50:27.929Z",
3277 "exclusive": true,
3278 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3279 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3280 "deleted": true
3281 }
3282
3283
3284 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3285
3286 (% class="box errormessage" %)
3287 (((
3288 **DELETE /api/v3/Drivers/{driverGuid}**
3289 )))
3290
3291 Передается параметр: ID водителя
3292
3293 Ответ:
3294
3295 Success
3296
3297
3298 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3299
3300 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3301
3302 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3303
3304 (% class="box infomessage" %)
3305 (((
3306 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3307 )))
3308
3309 Запрос:
3310
3311 {
3312 "Ids": [
3313 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3314 ],
3315 "BeginTime": "2023-06-30T12:49:04.365Z",
3316 "EndTime": "2023-06-30T12:49:04.365Z"
3317 }
3318
3319 Ответ:
3320
3321 [
3322 {
3323 "VehicleId": 0,
3324 "CreateTime": "2023-06-30T09:52:31.240Z",
3325 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3326 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3327 "BeginTime": "2023-06-30T09:52:31.240Z",
3328 "EndTime": "2023-06-30T09:52:31.240Z"
3329 }
3330 ]
3331
3332
3333 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3334
3335 (% class="box infomessage" %)
3336 (((
3337 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3338 )))
3339
3340 Запрос:
3341
3342 {
3343 "Ids": [
3344 0
3345 ],
3346 "BeginTime": "2023-06-30T12:48:39.419Z",
3347 "EndTime": "2023-06-30T12:48:39.419Z"
3348 }
3349
3350 Ответ:
3351
3352 [
3353 {
3354 "VehicleId": 0,
3355 "CreateTime": "2023-06-30T09:54:01.631Z",
3356 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3357 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3358 "BeginTime": "2023-06-30T09:54:01.631Z",
3359 "EndTime": "2023-06-30T09:54:01.631Z"
3360 }
3361 ]
3362
3363
3364 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3365
3366 (% class="box successmessage" %)
3367 (((
3368 **POST /api/v3/DriversVehiclesAssignments**
3369 )))
3370
3371 Передается массив назначений
3372
3373 Запрос:
3374
3375 [
3376 {
3377 "VehicleId": 0, ~/~/ Идентификатор объекта
3378 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3379 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3380 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3381 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3382 }
3383 ]
3384
3385 Ответ:
3386
3387 [
3388 {
3389 "VehicleId": 0,
3390 "CreateTime": "2023-06-30T11:04:46.903Z",
3391 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3392 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3393 "BeginTime": "2023-06-30T11:04:46.903Z",
3394 "EndTime": "2023-06-30T11:04:46.903Z"
3395 }
3396 ]
3397
3398
3399 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3400
3401 (% class="box warningmessage" %)
3402 (((
3403 **PUT /api/v3/DriversVehiclesAssignments**
3404 )))
3405
3406 Запрос:
3407
3408 [
3409 {
3410 "VehicleId": 0,
3411 "CreateTime": "2023-06-30T11:14:08.117Z",
3412 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3413 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3414 "BeginTime": "2023-06-30T11:14:08.117Z",
3415 "EndTime": "2023-06-30T11:14:08.117Z"
3416 }
3417 ]
3418
3419 Ответ:
3420
3421 [
3422 {
3423 "VehicleId": 0,
3424 "CreateTime": "2023-06-30T11:14:53.349Z",
3425 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3426 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3427 "BeginTime": "2023-06-30T11:14:53.349Z",
3428 "EndTime": "2023-06-30T11:14:53.349Z"
3429 }
3430 ]
3431
3432
3433 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3434
3435 (% class="box errormessage" %)
3436 (((
3437 **DELETE /api/v3/DriversVehiclesAssignments**
3438 )))
3439
3440 Запрос:
3441
3442 [
3443 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3444 ]
3445
3446 Ответ:
3447
3448 Success
3449
3450
3451 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3452
3453 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3454
3455 (% class="box infomessage" %)
3456 (((
3457 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3458 )))
3459
3460 Запрос:
3461
3462 {
3463 "Ids": [
3464 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3465 ],
3466 "BeginTime": "2023-06-30T12:47:12.162Z",
3467 "EndTime": "2023-06-30T12:47:12.162Z"
3468 }
3469
3470 Ответ:
3471
3472 [
3473 {
3474 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3475 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3476 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3477 "BeginTime": "2023-06-30T11:19:40.703Z",
3478 "EndTime": "2023-06-30T11:19:40.703Z"
3479 }
3480 ]
3481
3482
3483 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3484
3485 (% class="box infomessage" %)
3486 (((
3487 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3488 )))
3489
3490 Запрос:
3491
3492 {
3493 "Ids": [
3494 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3495 ],
3496 "BeginTime": "2023-06-30T12:47:12.162Z",
3497 "EndTime": "2023-06-30T12:47:12.162Z"
3498 }
3499
3500 Ответ:
3501
3502 [
3503 {
3504 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3505 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3506 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3507 "BeginTime": "2023-06-30T11:19:40.703Z",
3508 "EndTime": "2023-06-30T11:19:40.703Z"
3509 }
3510 ]
3511
3512
3513 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3514
3515 (% class="box successmessage" %)
3516 (((
3517 **POST /api/v3/DriversRfidsAssignments**
3518 )))
3519
3520 Запрос:
3521
3522 [
3523 {
3524 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3525 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3526 "BeginTime": "2023-06-30T11:27:08.635Z",
3527 "EndTime": "2023-06-30T11:27:08.635Z"
3528 }
3529 ]
3530
3531 Ответ:
3532
3533 [
3534 {
3535 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3536 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3537 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3538 "BeginTime": "2023-06-30T11:27:08.677Z",
3539 "EndTime": "2023-06-30T11:27:08.677Z"
3540 }
3541 ]
3542
3543
3544 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3545
3546 (% class="box warningmessage" %)
3547 (((
3548 **PUT /api/v3/DriversRfidsAssignments**
3549 )))
3550
3551 Запрос:
3552
3553 [
3554 {
3555 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3556 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3557 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3558 "BeginTime": "2023-06-30T11:28:43.330Z",
3559 "EndTime": "2023-06-30T11:28:43.330Z"
3560 }
3561 ]
3562
3563 Ответ:
3564
3565 [
3566 {
3567 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3568 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3569 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3570 "BeginTime": "2023-06-30T11:28:43.331Z",
3571 "EndTime": "2023-06-30T11:28:43.331Z"
3572 }
3573 ]
3574
3575
3576 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3577
3578 (% class="box errormessage" %)
3579 (((
3580 **DELETE /api/v3/DriversRfidsAssignments**
3581 )))
3582
3583 Запрос:
3584
3585 [
3586 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3587 ]
3588
3589 Ответ:
3590
3591 Success
3592
3593
3594 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3595
3596 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3597
3598 (% class="box infomessage" %)
3599 (((
3600 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3601 )))
3602
3603 Запрос:
3604
3605 {
3606 "Ids": [
3607 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3608 ],
3609 "BeginTime": "2023-06-30T12:45:10.852Z",
3610 "EndTime": "2023-06-30T12:45:10.852Z"
3611 }
3612
3613 Ответ:
3614
3615 [
3616 {
3617 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3618 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3619 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3620 "BeginTime": "2023-06-30T11:58:04.695Z",
3621 "EndTime": "2023-06-30T11:58:04.695Z"
3622 }
3623 ]
3624
3625
3626 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3627
3628 (% class="box infomessage" %)
3629 (((
3630 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3631 )))
3632
3633 Запрос:
3634
3635 {
3636 "Ids": [
3637 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3638 ],
3639 "BeginTime": "2023-06-30T12:45:10.852Z",
3640 "EndTime": "2023-06-30T12:45:10.852Z"
3641 }
3642
3643 Ответ:
3644
3645 [
3646 {
3647 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3648 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3649 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3650 "BeginTime": "2023-06-30T11:58:04.695Z",
3651 "EndTime": "2023-06-30T11:58:04.695Z"
3652 }
3653 ]
3654
3655
3656 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3657
3658 (% class="box successmessage" %)
3659 (((
3660 **POST /api/v3/DriversFuelCardsAssignments**
3661 )))
3662
3663 Запрос:
3664
3665 [
3666 {
3667 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3668 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3669 "BeginTime": "2023-06-30T12:09:53.175Z",
3670 "EndTime": "2023-06-30T12:09:53.175Z"
3671 }
3672 ]
3673
3674 Ответ:
3675
3676 [
3677 {
3678 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3679 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3680 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3681 "BeginTime": "2023-06-30T12:09:53.201Z",
3682 "EndTime": "2023-06-30T12:09:53.201Z"
3683 }
3684 ]
3685
3686
3687 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3688
3689 (% class="box warningmessage" %)
3690 (((
3691 **PUT /api/v3/DriversFuelCardsAssignments**
3692 )))
3693
3694 Запрос:
3695
3696 [
3697 {
3698 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3699 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3700 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3701 "BeginTime": "2023-06-30T12:09:53.201Z",
3702 "EndTime": "2023-06-30T12:09:53.201Z"
3703 }
3704 ]
3705
3706 Ответ:
3707
3708 [
3709 {
3710 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3711 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3712 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3713 "BeginTime": "2023-06-30T12:09:53.201Z",
3714 "EndTime": "2023-06-30T12:09:53.201Z"
3715 }
3716 ]
3717
3718
3719 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3720
3721 (% class="box errormessage" %)
3722 (((
3723 **DELETE /api/v3/DriversFuelCardsAssignments**
3724 )))
3725
3726 Запрос:
3727
3728 [
3729 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3730 ]
3731
3732 Ответ:
3733
3734 Success
3735
3736
3737 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3738
3739 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3740
3741 (% class="box infomessage" %)
3742 (((
3743 **POST /api/v3/Trailers**
3744 )))
3745
3746 Пример запроса:
3747
3748 {
3749 "startDate": "2023-11-14T10:48:03.671Z",
3750 "endDate": "2023-11-14T10:48:03.671Z",
3751 "ids": [ 0 ],
3752 "timezone": 0
3753 }
3754
3755 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3756 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3757 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3758 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3759 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3760
3761 Пример ответа:
3762
3763 [
3764 {
3765 "SD": "2023-11-14T10:48:03.717Z",
3766 "ED": "2023-11-14T10:48:03.717Z", 
3767 "id": 0,
3768 "SLat": 0,
3769 "SLon": 0,
3770 "ELat": 0,
3771 "ELon": 0,
3772 "mileage": 0
3773 "Duration": 0
3774 "Address": "string",
3775 "Address2": "string",
3776 "name": "string",
3777 "rid": "string",
3778 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3779 "trailer": {
3780 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3781 "Number": "string",
3782 "Description": "string",
3783 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3784 "ExternalID": "string",
3785 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3786 "CreateTime": "2023-11-14T10:48:03.717Z",
3787 "UpdateTime": "2023-11-14T10:48:03.717Z",
3788 "IsDeleted": true
3789 },
3790 "filesCount": 0,
3791 }
3792 ]
3793
3794 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3795 |SD|Дата и время начала события
3796 |ED|Дата и время окончания события
3797 |id|ID объекта
3798 |SLat|Широта начальной координаты
3799 |SLon|Долгота начальной координаты
3800 |ELat|Широта конечной координаты
3801 |ELon|Долгота конечной координаты
3802 |mileage|Пробег
3803 |Duration|Продолжительность
3804 |Address|Адрес начального местоположения
3805 |Address2|Адрес конечного местоположения
3806 |name|Имя радиометки
3807 |rid|Номер радиометки
3808 |rguid|ID радиометки
3809 |trailer|Информация об агрегате
3810 |ModelGuid|ID агрегата
3811 |Number|Название/номер агрегата
3812 |Description|Текст примечания агрегата
3813
3814 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3815
3816 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3817
3818 (% class="box infomessage" %)
3819 (((
3820 **POST /api/v3/Rfids/find**
3821 )))
3822
3823 Запрос:
3824
3825 {
3826 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3827 }
3828
3829 Ответ:
3830
3831 [
3832 {
3833 "name": "string",
3834 "number": 0,
3835 "period": 0,
3836 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3837 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3838 }
3839 ]
3840
3841 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3842 |parentId|ID клиента
3843 |name|Название карты-метки
3844 |number|Номер
3845 |period|Период запросов в секундах (работает только для агрегатов)
3846 |id|ID карты-метки
3847
3848 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3849
3850 (% class="box infomessage" %)
3851 (((
3852 **GET /api/v3/Rfids/{rfidGuid}**
3853 )))
3854
3855 Передаем параметр rfidGuid - идентификатор карты-метки
3856
3857 Ответ:
3858
3859 [
3860 {
3861 "name": "string",
3862 "number": 0,
3863 "period": 0,
3864 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3865 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3866 }
3867 ]
3868
3869 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3870 |name|Название карты-метки
3871 |number|Номер
3872 |period|Период запросов в секундах (работает только для агрегатов)
3873 |id|ID карты-метки
3874 |parentId|ID клиента
3875
3876 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3877
3878 (% class="box successmessage" %)
3879 (((
3880 **POST /api/v3/Rfids**
3881 )))
3882
3883 Запрос:
3884
3885 {
3886 "name": "string",
3887 "number": 0,
3888 "period": 0,
3889 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3890 }
3891
3892 Ответ:
3893
3894 {
3895 "name": "string",
3896 "number": 0,
3897 "period": 0,
3898 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3899 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3900 }
3901
3902 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3903 |name|Название карты-метки
3904 |number|Номер
3905 |period|Период запросов в секундах (работает только для агрегатов)
3906 |id|ID карты-метки
3907 |parentId|ID клиента
3908
3909 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3910
3911 (% class="box warningmessage" %)
3912 (((
3913 **PUT /api/v3/Rfids**
3914 )))
3915
3916 Запрос:
3917
3918 {
3919 "name": "string",
3920 "number": 0,
3921 "period": 0,
3922 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3923 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3924 }
3925
3926 Ответ:
3927
3928 {
3929 "name": "string",
3930 "number": 0,
3931 "period": 0,
3932 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3933 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3934 }
3935
3936 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3937 |name|Название карты-метки
3938 |number|Номер
3939 |period|Период запросов в секундах (работает только для агрегатов)
3940 |id|ID карты-метки
3941 |parentId|ID клиента
3942
3943 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3944
3945 (% class="box errormessage" %)
3946 (((
3947 **DELETE /api/v3/Rfids/{rfidGuid}**
3948 )))
3949
3950 Передаем параметр **rfidGuid** - идентификатор карты-метки
3951
3952 Ответ:
3953
3954 Success
3955
3956
3957 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3958
3959 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3960
3961 (% class="box infomessage" %)
3962 (((
3963 **GET /api/v3/Billing/client/balance/{clientId}**
3964 )))
3965
3966 Параметр запроса: **clientId **- идентификатор клиента.
3967
3968 Ответ:
3969
3970 {
3971 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3972 "Balance": 0
3973 }
3974
3975 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3976 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3977 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3978
3979 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3980
3981 (% class="box infomessage" %)
3982 (((
3983 **GET /api/v3/Billing/client/constraint/{clientId}**
3984 )))
3985
3986 Параметр запроса: **clientId **- идентификатор клиента.
3987
3988 Ответ:
3989
3990 {
3991 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3992 "CalculationType": 0,
3993 "PermissibleBalance": 0,
3994 "DefermentDays": 0,
3995 "SendUiNotifications": true,
3996 "SendEmailNotifications": true,
3997 "IsPrivate": true,
3998 }
3999
4000 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4001 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4002 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
4003 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
4004 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
4005 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4006 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4007 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4008
4009 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
4010
4011 (% class="box infomessage" %)
4012 (((
4013 **GET /api/v3/Billing/client/plan/{clientId}**
4014 )))
4015
4016 Параметры запроса:
4017
4018 **clientId **- идентификатор клиента.
4019
4020 **planId **- идентификатор тарифного плана.
4021
4022 Ответ:
4023
4024 {
4025 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4026 "Plan": { **~/~/ Описание тарифного плана**
4027 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4028 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4029 "Name": "string",
4030 "IsArchived": true,
4031 "Constraint": {
4032 "CalculationType": 0,
4033 "PermissibleBalance": 0,
4034 "DefermentDays": 0
4035 },
4036 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
4037 {
4038 "Feature": "string",
4039 "IsFactual": true,
4040 "Limit": 0,
4041 "Price": 0,
4042 "PeriodValue": 0,
4043 "PeriodType": 0
4044 }
4045 ]
4046 },
4047 "DebitDate": "2023-10-18T12:46:24.213Z",
4048 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
4049 {
4050 "Feature": "string",
4051 "IsEnabled": true,
4052 "IsPrivate": true,
4053 "IsFactual": true,
4054 "Limit": 0,
4055 "Price": 0,
4056 "DebitDate": "2023-10-18T12:46:24.213Z",
4057 "PeriodValue": 0,
4058 "PeriodType": 0
4059 }
4060 ]
4061 }
4062
4063 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4064 |ClientId|Идентификатор клиента
4065 |Id|Идентификатор тарифного плана
4066 |OwnerId|Идентификатор клиента-владельца
4067 |Name|Наименование тарифного плана
4068 |IsArchived|Признак, определяющий архивный тарифный план
4069 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4070 |PermissibleBalance|Допустимый баланс
4071 |DefermentDays|Отсрочка, количество дней
4072 |Feature|Код услуги
4073 |IsEnabled|Признак, определяющий активирована ли услуга
4074 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4075 |IsFactual|Признак, определяющий расчёт по факту
4076 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4077 |Price|Цена за единицу.
4078 |DebitDate|Следующий момент времени списания с баланса за услугу.
4079 |PeriodValue|Значение периода.
4080 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4081
4082 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
4083
4084 (% class="box infomessage" %)
4085 (((
4086 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4087 )))
4088
4089 Параметр запроса: **clientId **- идентификатор клиента.
4090
4091 Ответ:
4092
4093 [
4094 {
4095 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4096 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4097 "Name": "string",
4098 "IsArchived": true,
4099 "Constraint": {
4100 "CalculationType": 0,
4101 "PermissibleBalance": 0,
4102 "DefermentDays": 0
4103 },
4104 "Features": [
4105 {
4106 "Feature": "string",
4107 "IsFactual": true,
4108 "Limit": 0,
4109 "Price": 0,
4110 "PeriodValue": 0,
4111 "PeriodType": 0
4112 }
4113 ]
4114 }
4115 ]
4116
4117 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4118 |ClientId|Идентификатор клиента
4119 |Id|Идентификатор тарифного плана
4120 |OwnerId|Идентификатор клиента-владельца
4121 |Name|Наименование тарифного плана
4122 |IsArchived|Признак, определяющий архивный тарифный план
4123 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4124 |PermissibleBalance|Допустимый баланс
4125 |DefermentDays|Отсрочка, количество дней
4126 |Feature|Код услуги
4127 |IsFactual|Признак, определяющий расчёт по факту
4128 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4129 |Price|Цена за единицу.
4130 |PeriodValue|Значение периода.
4131 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4132
4133 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
4134
4135 (% class="box infomessage" %)
4136 (((
4137 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4138 )))
4139
4140 Параметр запроса: **clientId **- идентификатор клиента.
4141
4142 Ответ:
4143
4144 [
4145 {
4146 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4147 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4148 "Name": "string",
4149 "IsArchived": true,
4150 "Constraint": {
4151 "CalculationType": 0,
4152 "PermissibleBalance": 0,
4153 "DefermentDays": 0
4154 },
4155 "Features": [
4156 {
4157 "Feature": "string",
4158 "IsFactual": true,
4159 "Limit": 0,
4160 "Price": 0,
4161 "PeriodValue": 0,
4162 "PeriodType": 0
4163 }
4164 ]
4165 }
4166 ]
4167
4168 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4169 |ClientId|Идентификатор клиента
4170 |Id|Идентификатор тарифного плана
4171 |OwnerId|Идентификатор клиента-владельца
4172 |Name|Наименование тарифного плана
4173 |IsArchived|Признак, определяющий архивный тарифный план
4174 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4175 |PermissibleBalance|Допустимый баланс
4176 |DefermentDays|Отсрочка, количество дней
4177 |Feature|Код услуги
4178 |IsFactual|Признак, определяющий расчёт по факту
4179 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4180 |Price|Цена за единицу.
4181 |PeriodValue|Значение периода.
4182 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4183
4184 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4185
4186 (% class="box warningmessage" %)
4187 (((
4188 **PUT /api/v3/Billing/client/balance**
4189 )))
4190
4191 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4192
4193 Тело запроса:
4194
4195 {
4196 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4197 "Balance": 0 ~/~/ Значение баланса.
4198 }
4199
4200 Ответ: Success
4201
4202 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4203
4204 (% class="box warningmessage" %)
4205 (((
4206 **PUT /api/v3/billing/client/balance/deposit**
4207 )))
4208
4209 Создает операцию **Пополнение **с указанной суммой
4210
4211 Тело запроса:
4212
4213 (((
4214 {
4215 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4216 "amount": 0 ~/~/ Сумма пополнения баланса 
4217 }
4218 )))
4219
4220 (((
4221
4222 )))
4223
4224 Ответ: Success
4225
4226 (((
4227 {
4228 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4229 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4230 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4231 "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4232 "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4233 "Description": "string" ~/~/ Описание корректировки.
4234 }
4235 )))
4236
4237 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4238
4239 Создает операцию **Списание **с указанной суммой
4240
4241 (% class="box warningmessage" %)
4242 (((
4243 **PUT /api/v3/billing/client/balance/withdraw**
4244 )))
4245
4246 Тело запроса:
4247
4248 (((
4249 {
4250 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4251 "amount": 0 ~/~/ Сумма списания с баланса
4252 }
4253 )))
4254
4255 Ответ: Success
4256
4257 (((
4258 {
4259 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4260 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4261 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4262 "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4263 "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4264 "Description": "string" ~/~/ Описание корректировки
4265 }
4266 )))
4267
4268 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4269
4270 (% class="box warningmessage" %)
4271 (((
4272 **PUT /api/v3/Billing/client/constraint**
4273 )))
4274
4275 Тело запроса:
4276
4277 (((
4278 {
4279 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4280 "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4281 "PermissibleBalance": 0, ~/~/ Допустимый баланс
4282 "DefermentDays": 0, ~/~/ Отсрочка (дни).
4283 "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4284 "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4285 }
4286 )))
4287
4288 (((
4289
4290 )))
4291
4292 Ответ: Success
4293
4294 (((
4295 {
4296 "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4297 "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4298 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4299 "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4300 "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4301 "DefermentDays": 0, ~/~/ Отсрочка (дни)
4302 "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4303 "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4304 }
4305 )))
4306
4307 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4308
4309 (% class="box warningmessage" %)
4310 (((
4311 **PUT /api/v3/Billing/client/plan**
4312 )))
4313
4314 Тело запроса:
4315
4316 {
4317 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4318 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4319 "Features": [ ~/~/ Набор услуг по тарифу клиента.
4320 {
4321 "Feature": "string", ~/~/ Код услуги.
4322 "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4323 "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4324 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4325 "Price": 0, ~/~/ Цена за единицу.
4326 "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4327 "PeriodValue": 0, ~/~/ Значение периода.
4328 "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4329 }
4330 ]
4331 }
4332
4333
4334 Ответ: Success
4335
4336 (((
4337 {
4338 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4339 "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4340 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4341 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4342 "Name": "string", ~/~/ Наименование.
4343 "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4344 "Constraint": { ~/~/ Ограничения по тарифу 
4345 "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4346 "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4347 "DefermentDays": 0 ~/~/ Отсрочка (дни)
4348 },
4349 "Features": [ ~/~/ Набор услуг по тарифному плану.
4350 {
4351 "Feature": "string", ~/~/Код услуги.
4352 "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4353 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4354 "Price": 0, ~/~/ Цена за единицу.
4355 "PeriodValue": 0, ~/~/ Значение периода.
4356 "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4357 }
4358 ],
4359 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4360 "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4361 "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4362 },
4363 "Features": [ ~/~/ Набор услуг по тарифу клиента.
4364 {
4365 "Feature": "string", ~/~/ Код услуги.
4366 "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4367 "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4368 "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4369 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4370 "Price": 0, ~/~/ Цена за единицу.
4371 "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4372 "PeriodValue": 0, ~/~/ Значение периода.
4373 "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4374 "Quantity": 0 ~/~/ Количество использования услуги.
4375 }
4376 ]
4377 }
4378 )))
4379
4380 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4381
4382 (% class="box warningmessage" %)
4383 (((
4384 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4385 )))
4386
4387 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4388
4389 (% class="box infomessage" %)
4390 (((
4391 **POST /api/v3/vehicles/import/{agentId}**
4392 )))
4393
4394 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4395
4396 В пути указывается **agentId** - id клиента.
4397
4398 **Заголовок**
4399
4400 **X-Auth: [токен авторизации]**
4401
4402 **Параметры**
4403
4404 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4405 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4406 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4407
4408 В теле использовать тип **form-data,** тип значения** file**
4409
4410 **Ключи**
4411
4412 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4413 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4414 |csv|В значении передаем файл датчиков, формат **csv**
4415
4416 Ответ:
4417
4418 {
4419 "vehicleId": 0,
4420 "name": "string",
4421 "errors": ["string"]
4422 }
4423
4424 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4425 |vehicleId|ID созданного объекта
4426 |name|Имя созданного объекта
4427 |errors|Ошибки и их описание
4428
4429 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4430
4431 (% class="box infomessage" %)
4432 (((
4433 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4434 )))
4435
4436 (% class="wikigeneratedid" %)
4437 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4438
4439 (% class="wikigeneratedid" %)
4440 В пути указывается **vehicleId **- id объекта.
4441
4442 **Заголовок**
4443
4444 **X-Auth: [токен авторизации]**
4445
4446 В теле использовать тип **form-data.**
4447
4448 Ключи:
4449
4450 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4451 |**history**|В значении передавать файл с историей
4452
4453 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4454
4455 Ответ:
4456
4457 {
4458 "results": [
4459 {
4460 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4461 "vehicleId": 0,
4462 "errors": [
4463 "string"
4464 ],
4465 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4466 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4467 "producedCount": 0,
4468 "msgCount": 0
4469 }
4470 ]
4471 }
4472
4473 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4474 |results|Результаты импорта в разрезе ТС
4475 |vehicleGuid|Guid ТС
4476 |vehicleId|ID ТС
4477 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4478 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4479 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4480 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4481 |msgCount|Кол-во обработанных сообщений всего
4482
4483 == **Импортировать историю ТС (Асинхронный запрос)** ==
4484
4485 (% class="box successmessage" %)
4486 (((
4487 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4488 )))
4489
4490 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4491
4492 Метод запроса: **POST**
4493
4494 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4495
4496 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4497
4498
4499 Ответ:
4500
4501 {
4502
4503 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4504
4505 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4506
4507 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4508
4509 "Message": "string", ~/~/ Информация о выполнении запроса
4510
4511 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4512
4513 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4514
4515 "Data": "string" ~/~/ Данные
4516
4517 }
4518
4519
4520 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4521
4522 (% class="box infomessage" %)
4523 (((
4524 **GET /api/v3/vehicles/import/history/status**
4525 )))
4526
4527 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4528
4529 Ответ:
4530
4531 {
4532 "activity": true,
4533 "progress": 0,
4534 "message": "string"
4535 }
4536
4537 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4538 **Параметр**
4539 )))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4540 **Описание**
4541 )))
4542 |(((
4543 activity
4544 )))|(((
4545 Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4546 )))
4547 |(((
4548 progress
4549 )))|(((
4550 Guid ТС
4551 )))
4552
4553 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
4554
4555 (% class="box infomessage" %)
4556 (((
4557 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4558 )))
4559
4560 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4561
4562 Метод запроса: **GET**
4563
4564 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4565
4566 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4567
4568
4569 Ответ:
4570
4571 {
4572
4573 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4574
4575 "Status": 0, ~/~/ Перечисление состояний выполения запроса
4576 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4577
4578 "Message": "string", ~/~/ Информация о выполнении запроса
4579
4580 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4581
4582 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4583
4584 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4585
4586 "Data": "string" ~/~/ Данные
4587
4588 }
4589
4590 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4591
4592 (% class="box infomessage" %)
4593 (((
4594 **POST /api/v3/vehicles/export**
4595 )))
4596
4597 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4598
4599 Тело запроса:
4600
4601 [
4602 id
4603 ]
4604
4605 Ответ: Success 200, получаете файлы с настройками.
4606
4607 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4608
4609 (% class="box infomessage" %)
4610 (((
4611 **POST /api/v3/vehicles/export/history**
4612 )))
4613
4614 Метод возвращает список сообщений терминала объекта за выбранный период.
4615
4616 Тело запроса:
4617
4618 {
4619 "vehicleId": 0,
4620 "asArchive": true,
4621 "from": "2023-09-27T12:17:45.973Z",
4622 "to": "2023-09-27T12:17:45.973Z"
4623 }
4624
4625 Ответ:
4626
4627 Получаете файл. Сообщение: Code 200/Success
4628
4629 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4630 |vehicleId|ID объекта
4631 |asArchive|true - Архивировать файл, False - не архивировать
4632 |from|Дата и время начала запроса
4633 |to|Дата и время окончания запроса
4634
4635 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4636
4637 (% class="box infomessage" %)
4638 (((
4639 **GET /api/v3/vehicles/export/history/status**
4640 )))
4641
4642 Метод возвращает список сообщений терминала объекта за выбранный период.
4643
4644 Ответ:
4645
4646 {
4647 "activity": true,
4648 "progress": 0,
4649 "message": "string"
4650 }
4651
4652 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4653 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4654 |progress|Прогресс экспорта, от 0 до 100%
4655 |message|Текст описывающий статус
4656
4657 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4658
4659 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4660
4661 (% class="box infomessage" %)
4662 (((
4663 **POST /api/v3/EcoDriving/rating**
4664 )))
4665
4666 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4667
4668 Тело запроса:
4669
4670 {
4671 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4672 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4673 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4674 }
4675
4676 Ответ:
4677
4678 {
4679 "items": [  ~/~/ Список в разрезе ТС
4680 {
4681 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4682 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4683 "vehicleId": 0, ~/~/ ID ТС
4684 "vehicleName": "string", ~/~/ Название ТС
4685 "vehicleModel": "string", ~/~/ Модель ТС
4686 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4687 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4688 "totalViolations": 0, ~/~/ Нарушений всего
4689 "violationsByType": { ~/~/ Информация о нарушениях по типу
4690 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4691 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4692 "brakingViolations": 0, ~/~/ Нарушений торможения
4693 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4694 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4695 "sensorViolations": 0 ~/~/ Нарушений по датчику
4696 },
4697
4698 (((
4699
4700 )))
4701
4702 "moveTime": 0, ~/~/ Продолжительность движения, сек
4703 "mileage": 0, ~/~/ Пробег, м
4704 "tripsCount": 0, ~/~/ Кол-во рейсов
4705 "trips": [  ~/~/ Информация по рейсу
4706 {
4707 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4708 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4709 "violationsCount": 0, ~/~/ Всего нарушений
4710 "violationsByType": { ~/~/ Информация о нарушениях по типу
4711 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4712 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4713 "brakingViolations": 0, ~/~/ Нарушений торможения
4714 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4715 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4716 "sensorViolations": 0 ~/~/ Нарушений по датчику
4717 },
4718
4719 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4720 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4721 "moveTime": 0, ~/~/ Продолжительность движения, сек
4722 "mileage": 0, ~/~/ Пробег, м
4723 "motohours": 0, ~/~/ Моточасы, секунды
4724 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4725 "startAddress": "string", ~/~/ Адрес начала рейса
4726 "endAddress": "string", ~/~/ Адрес конца рейса
4727 "drivers": [  ~/~/ Список водителей
4728 {
4729 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4730 "driverName": "string", ~/~/ФИО водителя
4731 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4732 }
4733 ]
4734 }
4735 ]
4736 }
4737 ]
4738 }
4739
4740 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4741
4742 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4743
4744 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4745
4746 (% class="box infomessage" %)
4747 (((
4748 **POST /api/v3/fuelcards/transactions**
4749 )))
4750
4751 Метод запроса: POST
4752
4753 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4754 \\В заголовках запроса: X-Auth: Токен авторизации
4755
4756 Параметры в теле запроса (JSON):
4757
4758 {
4759 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4760 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4761 "ids": [ 
4762 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4763 ],
4764 "timezone": 0 ~/~/ Часовой пояс
4765 }
4766
4767
4768 Ответ:
4769 {
4770 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4771 "driver": "string", ~/~/ Водители, привязанные к ТК
4772 "object": "string", ~/~/ Наименование ТС
4773 "amount": 0, ~/~/ Количество топлива
4774 "amountDut": 0, ~/~/ Количество по ДУТ
4775 "amountDiff": 0, ~/~/ Разница, л
4776 "amountDiffPerc": 0, ~/~/ Разница, %
4777 "summa": 0, ~/~/ Стоимость, руб
4778 "serviceName": "string", ~/~/ Тип топлива
4779 "price": 0, ~/~/ Цена за литр, руб
4780 "cardName": "string", ~/~/ Наименование ТК
4781 "cardNum": "string", ~/~/ Номер ТК
4782 "operator": "string", ~/~/ Оператор ТК
4783 "address": "string" ~/~/ Адрес АЗС
4784 }
4785
4786 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4787
4788 (% class="box infomessage" %)
4789 (((
4790 **GET /api/v3/fuelcards**
4791 )))
4792
4793 Метод запроса: GET
4794
4795 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4796
4797 Ответ:
4798
4799 [
4800 {
4801 "Name": "string", ~/~/ Определяет наименование карты.
4802 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4803 "Number": "string", ~/~/ Определяет № карты.
4804 "Enabled": true, ~/~/ Определяет признак активности карты.
4805 "Description": "string", ~/~/ Определяет описание карты.
4806 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4807 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4808 "deleted": true ~/~/ Признак удаления
4809 }
4810 ]
4811
4812 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4813
4814
4815 == **Получение полных данных о ретрансляторе** ==
4816
4817 (% class="box infomessage" %)
4818 (((
4819 **GET ** **/api/v3/retranslations/{id}**
4820 )))
4821
4822 id - Идентификатор ретранслятора
4823
4824
4825 Пример ответа:
4826
4827 {  
4828 "description": "", ~/~/ Поле описания ретранслятора
4829 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4830 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4831 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4832 "address": "string", ~/~/ Адрес и порт принимающего сервера
4833 "objects": [ ~/~/ Объекты для ретрансляции
4834 {      
4835 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4836 "name": "", ~/~/ Наименование объекта ретрансляции
4837 "imei": "", ~/~/ IMEI объекта  ретрансляции
4838 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4839 }
4840 ],  
4841 "id": "", ~/~/ Идентификатор ретранслятора 
4842 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4843 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4844 }
4845
4846
4847 == **Удаление данных ретранслятора** ==
4848
4849 (% class="box infomessage" %)
4850 (((
4851 **DELETE** **/api/v3/retranslations/{id}**
4852 )))
4853
4854 id - Идентификатор ретранслятора
4855
4856
4857 == **Создание ретранслятора** ==
4858
4859 (% class="box infomessage" %)
4860 (((
4861 **POST ** **/api/v3/retranslations/{id}**
4862 )))
4863
4864 Запрос:
4865
4866 {  
4867 "description": "", ~/~/ Поле описания ретранслятора
4868 "subscriberId": "", ~/~/ Идентификатор подписчика
4869 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4870 "address": "", ~/~/ Адрес и порт принимающего сервера
4871 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4872 "objects": [ ~/~/Объекты для ретрансляции
4873 {      
4874 "id": "", ~/~/ Идентификатор ретранслятора 
4875 "imei": "", ~/~/ IMEI объекта ретрансляции
4876 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4877 }
4878 ]
4879 }
4880
4881
4882 Ответ:
4883
4884 {  
4885 "description": "", ~/~/ Поле описания ретранслятора
4886 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4887 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4888 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4889 "address": "string", ~/~/ Адрес и порт принимающего сервера
4890 "objects": [ ~/~/ Объекты для ретрансляции
4891 {      
4892 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4893 "name": "string", ~/~/ Наименование объекта ретрансляции    
4894 "imei": "", ~/~/ IMEI объекта ретрансляции
4895 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4896 }
4897 ],
4898 "id": "", ~/~/ Идентификатор ретранслятора   
4899 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4900 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4901 }
4902
4903
4904 == **Редактирование ретранслятора** ==
4905
4906 (% class="box infomessage" %)
4907 (((
4908 **PUT** **/api/v3/retranslations**
4909 )))
4910
4911 Пример запроса:
4912
4913 {  
4914 "id": "", ~/~/ Идентификатор ретранслятора   
4915 "description": "string", ~/~/ Поле описания ретранслятора
4916 "subscriberId": "", ~/~/ Идентификатор подписчика
4917 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4918 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4919 "address": "string", ~/~/ Адрес и порт принимающего сервера
4920 "objects": ~/~/ Объекты для ретрансляции
4921 [    
4922 {      
4923 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
4924 "imei": "", ~/~/ IMEI объекта ретрансляции
4925 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4926 }
4927 ]
4928 }
4929
4930
4931 Пример ответа:
4932
4933 {  
4934 "description": "", ~/~/ Поле описания ретранслятора
4935 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4936 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4937 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4938 "address": "string", ~/~/ Адрес и порт принимающего сервера
4939 "objects": [ ~/~/ Объекты для ретрансляции
4940 {      
4941 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4942 "name": "string", ~/~/ Наименование объекта ретрансляции    
4943 "imei": "", ~/~/ IMEI объекта ретрансляции
4944 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4945 }
4946 ],
4947 "id": "", ~/~/ Идентификатор ретранслятора   
4948 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4949 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4950 }
4951
4952
4953 == **Получение списка ретранслятора клиента** ==
4954
4955 (% class="box infomessage" %)
4956 (((
4957 **POST /api/v3/retranslations/find**
4958 )))
4959
4960 Пример запроса:
4961
4962 {  
4963 "id": "", ~/~/ Идентификатор ретранслятора   
4964 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4965 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4966 }
4967
4968 Ответ:
4969
4970 [ 
4971 {    
4972 "description": "", ~/~/ Поле описания ретранслятора
4973 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4974 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4975 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4976 "address": "string", ~/~/ Адрес и порт принимающего сервера
4977 "id": "", ~/~/ Идентификатор ретранслятора   
4978 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4979 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4980 }
4981 ]
4982
4983
4984 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4985
4986 == **API для отчета по выгрузке комбайнов** ==
4987
4988 (% class="box infomessage" %)
4989 (((
4990 **POST /api/v3/Reports/harvesterUnloading**
4991 )))
4992
4993 Пример запроса:
4994
4995 {
4996 "byTime": 0, ~/~/ Объединение событий по времени
4997 "byDist": 0, ~/~/ Объединение событий по расстоянию
4998 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4999 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5000 "showNearestObjects": true, ~/~/Показывать объекты рядом?
5001 "vehicleIds": [ ~/~/ Список id объектов для анализа
5002 0
5003 ],
5004 "from": "", ~/~/ Дата и время начало запроса
5005 "to": "", ~/~/ Дата и время окончания запроса
5006 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
5007 }
5008
5009 Пример ответа:
5010
5011 [ 
5012 {
5013 "harvesterName": "", ~/~/Комбайн, номер
5014 "harvesterId": 0, ~/~/Комбайн, id
5015 "harvesterModel": "", ~/~/ Модель комбайна
5016 "hopperCapacity": 0, ~/~/ Объем бункера м3
5017 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
5018 "events": [ ~/~/Список событий в разрезе комбайна
5019 {
5020 "driverId": "", ~/~/Идентификатор водителя
5021 "driverName": "", ~/~/Водитель комбайна, ФИО
5022 "RFID": "", ~/~/ идентификатор карты-метки
5023 "rfidName": "", ~/~/Водитель комбайна, имя метки
5024 "vehicleId": 0, ~/~/идентификатор объекта
5025 "vehicleName": "string", ~/~/ Имя объекта
5026 "modelName": "string", ~/~/ Имя модели объекта
5027 "nearestVehicles": [ ~/~/Объекты рядом
5028 {
5029 "vehicleId": 0, ~/~/идентификатор объекта
5030 "vehicleName": "string" ~/~/ Имя объекта
5031 }
5032 ],
5033 "fields": [ ~/~/Поля, где происходила выгрузка
5034 {
5035 "id": 0, ~/~/ идентификатор пользователя 
5036 "name": "string" ~/~/ имя пользователя 
5037 }
5038 ],
5039 "event": "string", ~/~/Событие
5040 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
5041 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
5042 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
5043 "cultureName": "string", ~/~/ название культуры
5044 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
5045 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
5046 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
5047 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
5048 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
5049 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
5050 "issued": 0, ~/~/Выдано, бункеров
5051 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
5052 "latitude": 0, ~/~/Широта
5053 "longitude": 0, ~/~/ Долгота
5054 "litresAway": 0, ~/~/Отдано, л
5055 "m3Away": 0 ~/~/Отдано, м3
5056 }
5057 ]
5058 }
5059 ]
5060
5061
5062 == **Отчет трек-датчики** ==
5063
5064 (% class="box infomessage" %)
5065 (((
5066 **POST /api/v3/Reports/sensorsWorks**
5067 )))
5068
5069 **Пример запроса:**
5070
5071 {
5072 "vehicleIds": [ ~/~/ Список ID объектов
5073 0
5074 ],
5075 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
5076 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
5077 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5078 }
5079
5080 **Пример ответа:**
5081
5082 (((
5083 {
5084 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
5085 {
5086 "vehicleId": 0, ~/~/ Идентификатор ТС
5087 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
5088 {
5089 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
5090 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
5091 "duration": 0, ~/~/  Продолжительность интервала в секундах.
5092 "name": "string", ~/~/ Наименование оборудования.
5093 "mileage": 0, ~/~/ Пробег за время работы оборудования.
5094 "totalMileage": 0, ~/~/ Общий пробег.
5095 "avgSpeed": 0 ~/~/ Средняя скорость.
5096 }
5097 ]
5098 }
5099 ]
5100 }
5101
5102
5103 == **Превышение скорости** ==
5104
5105 (% class="box infomessage" %)
5106 (((
5107 **POST /api/v3/Reports/overSpeedDuration**
5108 )))
5109
5110 Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5111
5112 Пример запроса:
5113
5114 (((
5115 {
5116 "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5117 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5118 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5119 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5120 "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5121 }
5122 )))
5123
5124 (((
5125
5126 )))
5127
5128 (((
5129 Пример ответа:
5130 )))
5131
5132 (((
5133 (((
5134 [
5135 {
5136 "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5137 "duration": 0, ~/~/ Продолжительность события в секундах 
5138 "maxSpeed": 0, ~/~/ Максимальная скорость 
5139 "speedLimit": 0 ~/~/ Ограничение скорости 
5140 }
5141 ]
5142 )))
5143 )))
5144 )))
5145
5146 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
5147
5148
5149 == **Запрос списка полей** ==
5150
5151 (% class="box successmessage" %)
5152 (((
5153 **POST /api/v3/agroLands/find**
5154 )))
5155
5156 Пример запроса:
5157
5158 (((
5159 (((
5160 (((
5161 {
5162 "year": 0, ~/~/ Фильтр по году
5163 "name": "string", ~/~/ Фильтр по названию
5164 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
5165 }
5166 )))
5167 )))
5168
5169
5170 )))
5171
5172 Пример ответа:
5173
5174 (((
5175 [
5176 {
5177 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5178 "year": 0, ~/~/ Год поля
5179 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
5180 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
5181 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5182 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5183 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5184 "counts": { ~/~/ Счётчики с/х поля 
5185 "fieldOperations": 0, ~/~/ Количество операций на поле
5186 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5187 "facts": 0 ~/~/ Счётчик факта
5188 },
5189 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5190 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5191 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5192 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5193 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5194 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5195 "planComment": "string", ~/~/ Комментарий к полю
5196 "productivity": 0, ~/~/ Урожайность.
5197 "id": 0, ~/~/ Идентификатор объекта геозоны
5198 "name": "string", ~/~/ Название объекта геозоны
5199 "type": 0, ~/~/ Тип объекта геозоны
5200 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5201 "fname": "string", ~/~/ Имя файла
5202 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5203 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
5204 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
5205 "description": "string", ~/~/ Описание объекта геозоны
5206 "area": 0, ~/~/ Площадь, м2
5207 "perimetr": 0, ~/~/ Периметр, м
5208 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
5209 }
5210 ]
5211
5212
5213 == **Создание нового поля ** ==
5214
5215 (% class="box successmessage" %)
5216 (((
5217 **POST /api/v3/agroLands**
5218 )))
5219
5220 Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5221 X-agent  - ID клиента
5222
5223 Пример запроса:
5224
5225 (((
5226 {
5227 "extId": "string", 
5228 "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5229 "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5230 "display": "string", ~/~/ Настройки отображения
5231 "year": 0, ~/~/ Год поля
5232 "name": "string", ~/~/ Наименование
5233 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5234 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5235 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5236 "planComment": "string", ~/~/ Комментарий к полю
5237 "cropRotations": [ ~/~/ Данные по севообороту
5238 {
5239 "landId": 0, ~/~/ ID поля
5240 "landName": "string", ~/~/ Название поля
5241 "year": 0, ~/~/ Год урожая
5242 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5243 "cultureName": "string", ~/~/ Название культуры
5244 "productivity": 0, ~/~/ Урожайность
5245 "area": 0, ~/~/ Площадь поля, Га
5246 "total": 0, ~/~/ Валовый сбор
5247 "productivityFact": 0, ~/~/ Фактическая урожайность
5248 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5249 "totalFact": 0, ~/~/ Фактический валовый сбор
5250 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5251 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5252 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5253 "isyearplan": true, ~/~/ Годовой план 
5254 "comment": "string" ~/~/ Комментарий
5255 }
5256 ]
5257 }
5258 )))
5259
5260 (((
5261
5262 )))
5263
5264 Пример ответа:
5265
5266 (((
5267 (((
5268 {
5269 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5270 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5271 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5272 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5273 "cropRotations": [ ~/~/ Данные по севообороту
5274 {
5275 "landId": 0, ~/~/ ID поля
5276 "landName": "string", ~/~/ Название поля
5277 "year": 0, ~/~/ Год урожая 
5278 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5279 "cultureName": "string", ~/~/ Название культуры
5280 "productivity": 0, ~/~/ Урожайность
5281 "area": 0, ~/~/ Площадь поля, Га.
5282 "total": 0, ~/~/ Валовый сбор
5283 "productivityFact": 0, ~/~/ Фактическая урожайность
5284 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5285 "totalFact": 0, ~/~/ Фактический валовый сбор
5286 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5287 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5288 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5289 "isyearplan": true, ~/~/ годовой план 
5290 "comment": "string" ~/~/ Комментарий
5291 }
5292 ],
5293 "cropVegetation": [ ~/~/ История вегетации поля
5294 {
5295 "values": [  ~/~/ Данные вегетации и состояния посева
5296 {
5297 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5298 "ndvi": 0 ~/~/ Индекс вегетации
5299 }
5300 ],
5301 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5302 {
5303 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5304 "type": "string", ~/~/ Тип
5305 "pictureid": "string" ~/~/ Идентификатор ресурса
5306 }
5307 ],
5308 "states": [ ~/~/ Ключевые даты развития поля
5309 {
5310 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5311 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5312 }
5313 ]
5314 }
5315 ],
5316 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5317 "counts": {
5318 "fieldOperations": 0, ~/~/ Количество операций на поле
5319 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5320 "facts": 0 ~/~/ Счётчик факта
5321 },
5322 "planComment": "string", ~/~/ Комментарий к полю
5323 )))
5324
5325 (((
5326 "productivity": 0, ~/~/ Урожайность.
5327 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5328 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5329 "year": 0, ~/~/ Год поля
5330 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5331 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5332 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5333 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5334 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5335 "id": 0, ~/~/ Идентификатор объекта геозоны
5336 "name": "string", ~/~/ Название объекта геозоны
5337 "type": 0, ~/~/ Тип объекта геозоны
5338 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5339 "fname": "string", ~/~/ Имя файла
5340 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5341 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5342 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5343 "description": "string", ~/~/ Описание объекта геозоны
5344 "area": 0, ~/~/ Площадь, м2
5345 "perimetr": 0, ~/~/ Периметр, м
5346 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5347 }
5348
5349
5350 )))
5351 )))
5352 )))
5353
5354 == **Получение поля по id** ==
5355
5356 (% class="box infomessage" %)
5357 (((
5358 **GET /api/v3/agroLands/{id}**
5359 )))
5360
5361 Пример запроса:
5362 id  ~/~/ Идентификатор поля
5363
5364 Пример ответа:
5365
5366 (((
5367 {
5368 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5369 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5370 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5371 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5372 "cropRotations": [ ~/~/ Данные по севообороту
5373 {
5374 "landId": 0, ~/~/ ID поля
5375 "landName": "string", ~/~/ Название поля
5376 "year": 0, ~/~/ Год урожая
5377 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5378 "cultureName": "string", ~/~/ Название культуры
5379 "productivity": 0, ~/~/ Урожайность
5380 "area": 0, ~/~/ Площадь поля, Га
5381 "total": 0, ~/~/ Валовый сбор
5382 "productivityFact": 0, ~/~/ Фактическая урожайность
5383 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5384 "totalFact": 0, ~/~/ Фактический валовый сбор
5385 "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5386 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5387 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5388 "isyearplan": true, ~/~/ План года 
5389 "comment": "string" ~/~/ Комментарий
5390 }
5391 ],
5392 "cropVegetation": [ ~/~/ История вегетации поля
5393 {
5394 "values": [ ~/~/ Данные вегетации и состояния посева
5395 {
5396 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5397 "ndvi": 0 ~/~/ Индекс вегетации
5398 }
5399 ],
5400 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5401 {
5402 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5403 "type": "string", ~/~/ Тип 
5404 "pictureid": "string" ~/~/ Идентификатор ресурса
5405 }
5406 ],
5407 "states": [ ~/~/ Ключевые даты развития поля
5408 {
5409 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5410 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5411 }
5412 ]
5413 }
5414 ],
5415 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5416 "counts": {
5417 "fieldOperations": 0, ~/~/ Количество операций на поле
5418 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5419 "facts": 0 ~/~/ Счётчик факта
5420 },
5421 "planComment": "string", ~/~/ Комментарий к полю
5422 "productivity": 0, ~/~/ Урожайность.
5423 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5424 )))
5425
5426 (((
5427 (((
5428 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5429 "year": 0, ~/~/ Год поля
5430 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5431 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5432 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5433 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5434 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5435 "id": 0, ~/~/ Идентификатор объекта геозоны
5436 "name": "string", ~/~/ Название объекта геозоны
5437 "type": 0, ~/~/ Тип объекта геозоны 
5438 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5439 "fname": "string", ~/~/ Имя файла
5440 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5441 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5442 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5443 "description": "string", ~/~/ Описание объекта геозоны
5444 "area": 0, ~/~/ Площадь, м2
5445 "perimetr": 0, ~/~/ Периметр, м
5446 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5447 }
5448 )))
5449
5450
5451 == **Удаление существующего поля** ==
5452
5453 (% class="box errormessage" %)
5454 (((
5455 **DELETE /api/v3/agroLands/{id}**
5456 )))
5457
5458 Пример запроса:
5459 id  ~/~/ Идентификатор поля
5460
5461 Пример ответа:
5462
5463 (((
5464 200 ~/~/ Успех
5465 )))
5466
5467 (((
5468
5469 )))
5470
5471 (((
5472 (((
5473 (((
5474
5475 )))
5476
5477 (((
5478 == **Изменение поля** ==
5479
5480 (% class="box infomessage" %)
5481 (((
5482 **PUT /api/v3/agroLands**
5483 )))
5484
5485 Пример запроса:
5486
5487 (((
5488 (((
5489 {
5490 "id": 0, ~/~/ Идентификатор поля
5491 "extId": "string", ~/~/ ExtId
5492 "shape": "string", ~/~/ Форма поля
5493 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5494 "display": "string", ~/~/ Настройки отображения
5495 "year": 0, ~/~/ Год поля
5496 "name": "string", ~/~/ Наименование
5497 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5498 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5499 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5500 "planComment": "string", ~/~/Комментарий к полю
5501 "cropRotations": [  ~/~/ Данные по севообороту
5502 {
5503 "landId": 0, ~/~/ ID поля
5504 "landName": "string", ~/~/ Название поля
5505 "year": 0, ~/~/ Год урожая
5506 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5507 "cultureName": "string", ~/~/ Название культуры
5508 "productivity": 0, ~/~/ Урожайность
5509 "area": 0, ~/~/ Площадь поля, Га.
5510 "total": 0, ~/~/ Валовый сбор
5511 "productivityFact": 0, ~/~/ Фактическая урожайность
5512 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5513 "totalFact": 0, ~/~/ Фактический валовый сбор
5514 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5515 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5516 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5517 "isyearplan": true, 
5518 "comment": "string" ~/~/ Комментарий
5519 }
5520 ],
5521 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5522 }
5523 )))
5524 )))
5525
5526 (((
5527
5528 )))
5529
5530 Пример ответа:
5531
5532 (((
5533 (((
5534 (((
5535 {
5536 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5537 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5538 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5539 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5540 "cropRotations": [ ~/~/ Данные по севообороту
5541 {
5542 "landId": 0, ~/~/ ID поля
5543 "landName": "string", ~/~/ Название поля
5544 "year": 0, ~/~/  Год урожая
5545 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5546 "cultureName": "string", ~/~/ Название культуры
5547 "productivity": 0, ~/~/ Урожайность
5548 "area": 0, ~/~/ Площадь поля, Га
5549 "total": 0, ~/~/ Валовый сбор
5550 "productivityFact": 0, ~/~/ Фактическая урожайность
5551 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5552 "totalFact": 0, ~/~/ Фактический валовый сбор
5553 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5554 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5555 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5556 "isyearplan": true, ~/~/ 
5557 "comment": "string" ~/~/ Комментарий
5558 }
5559 ],
5560 "cropVegetation": [ ~/~/ История вегетации поля
5561 {
5562 "values": [ ~/~/ Данные вегетации и состояния посева
5563 {
5564 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5565 "ndvi": 0 ~/~/ Индекс вегетации
5566 }
5567 ],
5568 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5569 {
5570 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5571 "type": "string", ~/~/ Тип
5572 "pictureid": "string" ~/~/ Идентификатор ресурса
5573 }
5574 ],
5575 "states": [ ~/~/ Ключевые даты развития поля 
5576 {
5577 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5578 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5579 }
5580 ]
5581 }
5582 ],
5583 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5584 "counts": { 
5585 "fieldOperations": 0, ~/~/ Количество операций на поле
5586 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5587 "facts": 0 ~/~/ Счётчик факта
5588 },
5589 "planComment": "string", ~/~/ Комментарий к полю
5590 "productivity": 0, ~/~/ Урожайность.
5591 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5592 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5593 "year": 0, ~/~/ Год поля
5594 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5595 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5596 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5597 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5598 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5599 "id": 0, ~/~/ Идентификатор объекта геозоны
5600 "name": "string", ~/~/ Название объекта геозоны
5601 "type": 0, ~/~/ Тип объекта геозоны
5602 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5603 "fname": "string", ~/~/ Имя файла
5604 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5605 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5606 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5607 "description": "string", ~/~/ Описание объекта геозоны
5608 "area": 0, ~/~/ Площадь, м2
5609 "perimetr": 0, ~/~/ Периметр, м
5610 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5611 }
5612 )))
5613 )))
5614 )))
5615 )))
5616 )))
5617
5618
5619 == **Редактирование года урожая ** ==
5620
5621 (% class="box successmessage" %)
5622 (((
5623 **POST /api/v3/agroLands/updateOpenCloseYear**
5624 )))
5625
5626 Пример запроса:
5627
5628 (((
5629 (((
5630 {
5631 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5632 0
5633 ],
5634 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5635 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5636 }
5637 )))
5638
5639
5640 )))
5641
5642 Пример ответа:
5643
5644 (((
5645 (((
5646 {
5647 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5648 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5649 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5650 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5651 "cropRotations": [ ~/~/ Данные по севообороту
5652 {
5653 "landId": 0, ~/~/ ID поля
5654 "landName": "string", ~/~/ Название поля
5655 "year": 0, ~/~/ Год урожая
5656 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5657 "cultureName": "string", ~/~/ Название культуры
5658 "productivity": 0, ~/~/ Урожайность
5659 "area": 0, ~/~/ Площадь поля, Га.
5660 "total": 0, ~/~/ Валовый сбор
5661 "productivityFact": 0, ~/~/ Фактическая урожайность
5662 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5663 "totalFact": 0, ~/~/ Фактический валовый сбор
5664 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5665 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5666 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5667 "isyearplan": true, ~/~/ 
5668 "comment": "string" ~/~/ Комментарий
5669 }
5670 ],
5671 "cropVegetation": [ ~/~/ История вегетации поля
5672 {
5673 "values": [ ~/~/ Данные вегетации и состояния посева
5674 {
5675 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5676 "ndvi": 0 ~/~/ Индекс вегетации
5677 }
5678 ],
5679 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5680 {
5681 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5682 "type": "string", ~/~/ Тип
5683 "pictureid": "string" ~/~/ Идентификатор ресурса
5684 }
5685 ],
5686 "states": [ ~/~/ Ключевые даты развития поля
5687 {
5688 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5689 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5690 }
5691 ]
5692 }
5693 ],
5694 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5695 "counts": { 
5696 "fieldOperations": 0, ~/~/ Количество операций на поле
5697 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5698 "facts": 0 ~/~/ Счётчик факта
5699 },
5700 "planComment": "string", ~/~/ Комментарий к полю
5701 "productivity": 0, ~/~/ Урожайность.
5702 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5703 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5704 "year": 0, ~/~/ Год поля
5705 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5706 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5707 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5708 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5709 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5710 "id": 0, ~/~/ Идентификатор объекта геозоны
5711 "name": "string", ~/~/ Название объекта геозоны
5712 "type": 0, ~/~/ Тип объекта геозоны
5713 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5714 "fname": "string", ~/~/ Имя файла
5715 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5716 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5717 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5718 "description": "string", ~/~/ Описание объекта геозоны
5719 "area": 0, ~/~/ Площадь, м2
5720 "perimetr": 0, ~/~/ ериметр, м
5721 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5722 }
5723 )))
5724
5725
5726 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5727 )))
5728 )))
5729 )))
5730
5731 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5732
5733
5734 (% class="box infomessage" %)
5735 (((
5736 **GET api/v3/Vehicles/recyclebin/all**
5737 )))
5738
5739 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5740
5741 Параметр запроса: {parentId} - идентификатор агента
5742
5743 В заголовках запроса: X-Auth: Токен авторизации
5744
5745 Ответ:
5746
5747 [ 
5748 {
5749 "recordTime": "", ~/~/Время записи
5750 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5751 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5752 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5753 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5754 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5755 "details": { ~/~/Список деталей объекта, помещённого в корзину
5756 "items": [ ~/~/ 
5757 nullable: true ~/~/Детали
5758 {
5759 "name": "string", ~/~/наименование столбца
5760 "value": "string" ~/~/содержание столбца
5761 }
5762 ]
5763 },
5764 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5765 "string"
5766 ]
5767 }
5768 ]
5769
5770
5771 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5772
5773 (% class="box infomessage" %)
5774 (((
5775 **POST api/v3/Vehicles/recyclebin/erase**
5776 )))
5777
5778 В заголовках запроса: X-Auth: Токен авторизации
5779
5780 Пример запроса:
5781
5782 [
5783 0
5784 ]
5785
5786
5787 Пример ответа:
5788
5789 [ 
5790 {
5791 "recordTime": "", ~/~/Время записи
5792 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5793 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5794 "objectId": 0, ~/~/ID объекта, помещённого в корзин
5795 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5796 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5797 "details": { ~/~/Список деталей объекта, помещённого в корзину
5798 "items": [ ~/~/Детали
5799 {
5800 "name": "", ~/~/Имя свойства
5801 "value": "" ~/~/Значение свойства
5802 }
5803 ]
5804 },
5805 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5806 ""
5807 ]
5808 }
5809 ]
5810
5811 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5812
5813 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5814
5815 (% class="box infomessage" %)
5816 (((
5817 **POST api/v3/Vehicles/recyclebin/restore**
5818 )))
5819
5820 В заголовках запроса: X-Auth: Токен авторизации
5821
5822 Параметры в теле запроса (JSON):
5823
5824 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5825
5826 В заголовках запроса: X-Auth: Токен авторизации
5827
5828
5829 Пример запроса:
5830
5831 (((
5832 [
5833 )))
5834
5835 (((
5836 0
5837 )))
5838
5839 (((
5840 ]
5841 )))
5842
5843
5844 Пример ответа:
5845
5846 [
5847 {
5848 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5849 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5850 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5851 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5852 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5853 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5854 "details": { ~/~/Список деталей объекта, помещённого в корзину
5855 "items": [ ~/~/Детали
5856 {
5857 "name": "string", ~/~/Имя свойства
5858 "value": "string" ~/~/Значение свойства
5859 }
5860 ]
5861 },
5862 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5863 "string"
5864 ]
5865 }
5866 ]
5867
5868
5869 = **Раздел: Журнал заданий ** =
5870
5871
5872 == **Создание задания в Журнале заданий** ==
5873
5874 (% class="box infomessage" %)
5875 (((
5876 **POST /api/v3/vehicletasks**
5877 )))
5878
5879 Пример запроса:
5880
5881 (((
5882 {
5883 "vehicleId": 0, ~/~/ Идентификатор ТС
5884 "description": "string", ~/~/ Описание
5885 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5886 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5887 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5888 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5889 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5890 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5891 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5892 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5893 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5894 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5895 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5896 "cost": { 
5897 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5898 "Name": "string", ~/~/ Наименование
5899 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5900 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5901 "Norm": 0 ~/~/ Норма внесения
5902 },
5903 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5904 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5905 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5906 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5907 "deleted": true, ~/~/ Признак удаления
5908 "extId": "string", 
5909 "GeoIds": [ ~/~/ Cвязанные поля
5910 0
5911 ]
5912 }
5913 )))
5914
5915
5916 Пример ответа:
5917
5918 {
5919 "vehicleId": 0, ~/~/ Идентификатор ТС
5920 "description": "string", ~/~/ Описание
5921 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5922 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5923 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5924 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5925 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5926 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5927 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5928 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5929 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5930 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5931 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5932 "cost": { 
5933 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5934 "Name": "string", ~/~/ Наименование
5935 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5936 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5937 "Norm": 0 ~/~/ Норма внесения
5938 },
5939 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5940 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5941 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5942 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5943 "deleted": true, ~/~/ Признак удаления
5944 "extId": "string", ~/~/ ExtId
5945 "GeoIds": [ ~/~/ Связанные поля
5946 0
5947 ]
5948 }
5949
5950
5951 == **Редактирование задания в Журнале заданий** ==
5952
5953 (% class="box successmessage" %)
5954 (((
5955 **PUT /api/v3/vehicletasks**
5956 )))
5957
5958 Пример запроса:
5959
5960 (((
5961 {
5962 "vehicleId": 0, ~/~/ Идентификатор ТС
5963 "description": "string", ~/~/ Описание
5964 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5965 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5966 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5967 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5968 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5969 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5970 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5971 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5972 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5973 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5974 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5975 "cost": { 
5976 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5977 "Name": "string", ~/~/ Наименование
5978 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5979 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5980 "Norm": 0 ~/~/ Норма внесения
5981 },
5982 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5983 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5984 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5985 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5986 "deleted": true, ~/~/ Признак удаления
5987 "extId": "string", ~/~/ ExtId
5988 "GeoIds": [ ~/~/ Связанные поля
5989 0
5990 ]
5991 }
5992 )))
5993
5994
5995 Пример ответа:
5996
5997 {
5998 "vehicleId": 0, ~/~/ Идентификатор ТС
5999 "description": "string", ~/~/ Описание
6000 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6001 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6002 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6003 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6004 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6005 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6006 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6007 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6008 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6009 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6010 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6011 "cost": { 
6012 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6013 "Name": "string", ~/~/ Наименование
6014 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6015 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6016 "Norm": 0 ~/~/ Норма внесения
6017 },
6018 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6019 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6020 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6021 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6022 "deleted": true, ~/~/ Признак удаления
6023 "extId": "string", ~/~/ ExtId
6024 "GeoIds": [ ~/~/ Связанные поля
6025 0
6026 ]
6027 }
6028
6029
6030 == **Удаление задания в Журнале заданий** ==
6031
6032 (% class="box warningmessage" %)
6033 (((
6034 **DELETE /api/v3/vehicletasks**
6035 )))
6036
6037 Пример запроса:
6038
6039 (((
6040 [
6041 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
6042 ]
6043 )))
6044
6045 (((
6046
6047 )))
6048
6049 Пример ответа:
6050
6051 {
6052 "vehicleId": 0, ~/~/ Идентификатор ТС
6053 "description": "string", ~/~/ Описание
6054 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6055 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6056 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6057 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6058 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6059 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6060 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6061 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6062 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6063 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6064 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6065 "cost": { 
6066 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6067 "Name": "string", ~/~/ Наименование
6068 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6069 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6070 "Norm": 0 ~/~/ Норма внесения
6071 },
6072 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6073 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6074 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6075 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6076 "deleted": true, ~/~/ Признак удаления
6077 "extId": "string", ~/~/ ExtId
6078 "GeoIds": [ ~/~/ Связанные поля
6079 0
6080 ]
6081 }
6082
6083
6084 == **Получение списка Журнала заданий** ==
6085
6086 (% class="box infomessage" %)
6087 (((
6088 **POST /api/v3/vehicletasks/getbyperiod**
6089 )))
6090
6091 Пример запроса:
6092
6093 (((
6094 {
6095 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6096 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6097 "TimeZone": 0, ~/~/ Часовой пояс.
6098 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6099 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6100 ],
6101 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6102 0
6103 ],
6104 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6105 0
6106 ],
6107 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6108 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6109 }
6110 )))
6111
6112
6113 Пример ответа:
6114
6115 (((
6116 {
6117 "total": 0,  ~/~/ Общее количество записей
6118 "pages": 0,  ~/~/ Общее количество страниц
6119 "currentPage": 0, ~/~/ Текущая страница
6120 "items": [  ~/~/ Записи 
6121 {
6122 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6123 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6124 "name": "string", ~/~/ Название задания.
6125 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6126 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6127 "workKind": "string", ~/~/ Вид работ
6128 "techOp": "string", ~/~/ Тех. операция
6129 "trailerModel": "string", ~/~/ Модель агрегата
6130 "width": "string", ~/~/ Ширина, м
6131 "speed": "string", ~/~/ Тех. скорость
6132 "fields": "string", ~/~/ Поля
6133 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6134 "vehicles": "string", ~/~/ Объект-модель
6135 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6136 "drivers": "string", ~/~/ Водители
6137 "tmc": "string", ~/~/ ТМЦ
6138 "client": "string", ~/~/  Клиент
6139 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6140 "dep": "string", ~/~/ Подразделение
6141 "geoIds": [ ~/~/  Связанные поля
6142 0
6143 ]
6144 }
6145 ]
6146 }
6147 )))
6148
6149
6150 = **Раздел: Роли** =
6151
6152 == **Получение списка клиентских и системных ролей пользователя ** ==
6153
6154 (% class="box successmessage" %)
6155 (((
6156 **POST /api/v3/groups/find**
6157 )))
6158
6159 Пример запроса:
6160
6161 (((
6162 {
6163 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6164 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6165 }
6166 )))
6167
6168 (((
6169
6170 )))
6171
6172 (((
6173 Пример ответа:
6174 )))
6175
6176 (((
6177 (((
6178 {
6179 "groups": [  ~/~/ Системные роли пользователя
6180 {
6181 "code": "string", ~/~/ Код роли.
6182 "name": "string", ~/~/ Имя  
6183 "shortName": "string" ~/~/ Короткое имя 
6184 }
6185 ],
6186 "customGroups": [ ~/~/ Системные роли пользователя
6187 {
6188 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6189 "name": "string", ~/~/ Наименование 
6190 "shortName": "string", ~/~/ Короткое наименование 
6191 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6192 }
6193 ]
6194 }
6195 )))
6196 )))
6197
6198 (((
6199
6200 )))
6201
6202 (((
6203
6204 )))
6205
6206 = **Раздел: Локатор ** =
6207
6208
6209 == **Получение списка локаторов, доступных пользователю ** ==
6210
6211 (% class="box infomessage" %)
6212 (((
6213 **GET /api/v3/locators **
6214 )))
6215
6216 В заголовках запроса: X-Auth: Токен авторизации
6217
6218
6219 Пример ответа:
6220
6221 (((
6222 (((
6223 {
6224 "vehiclesIds": [ ~/~/ Объекты
6225 0
6226 ],
6227 "geoIds": [ ~/~/ Геозоны
6228 0
6229 ],
6230 "fieldsIds": [ ~/~/ Поля
6231 0
6232 ],
6233 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6234 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6235 "agentName": "string", ~/~/ Наименование агента.
6236 "isEnabled": true, ~/~/ Активность 
6237 "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6238 "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6239 "name": "string", ~/~/ Наименование.
6240 "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6241 "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6242 "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6243 "validity": 0, ~/~/ Значение срока действия
6244 "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6245 "autoProlongation": true, ~/~/ Автопродление срока действия.
6246 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6247 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6248 "url": "string", ~/~/ Ссылка
6249 "language": 0, ~/~/ Язык
6250 "showVehicleName": true, ~/~/ Наименование объекта
6251 "showVehicleDirection": true, ~/~/ Направление движения на треке
6252 "allowTrackReport": true, ~/~/ Трек
6253 "showTrackTracing": true, ~/~/ Трассировка трека
6254 "showSensors": true, ~/~/ Датчик
6255 "availableMapLayers": [ ~/~/  Слои на карте
6256 0
6257 ]
6258 }
6259 )))
6260 )))
6261
6262
6263 == **Получение перечня моделей ** ==
6264
6265 (% class="box successmessage" %)
6266 (((
6267 **POST /api/v3/models/find**
6268 )))
6269
6270 Пример запроса:
6271
6272 (((
6273 (((
6274 {
6275 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6276 "name": "string", ~/~/ Наименование локатора
6277 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
6278 )))
6279
6280
6281
6282 Пример ответа: 
6283
6284
6285 (((
6286 [
6287 {
6288 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 
6289 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
6290 "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
6291 "name": "string", ~/~/ Наименование локатора
6292 "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 
6293 }
6294 ]
6295 )))
6296 )))
6297
6298
6299 == **Создание локатора** ==
6300
6301 (% class="box successmessage" %)
6302 (((
6303 **POST /api/v3/locators**
6304 )))
6305
6306 Пример запроса:
6307
6308 (((
6309 {
6310 "isEnabled": true, ~/~/ Активность
6311 "name": "string", ~/~/ Наименование локатора
6312 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6313 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6314 "validity": 0, ~/~/ Срок действия в днях (1-90)
6315 "autoProlongation": true, ~/~/ Автопродление срока действия.
6316 "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6317 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6318 "vehiclesIds": [ ~/~/ Oбъекты
6319 0
6320 ],
6321 "geoIds": [ ~/~/ Геозоны
6322 0
6323 ],
6324 "fieldsIds": [ ~/~/ Поля
6325 0
6326 ],
6327 "showVehicleName": true, ~/~/ Наименование объекта
6328 "showVehicleDirection": true, ~/~/ Направление движения на треке
6329 "allowTrackReport": true, ~/~/ Трек
6330 "showTrackTracing": true, ~/~/ Трассировка трека
6331 "showSensors": true, ~/~/ Датчик
6332 "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 
6333 ]
6334 }
6335 )))
6336
6337
6338 Пример ответа:
6339
6340 (((
6341 3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6342 )))
6343
6344
6345
6346 == **Изменение локатора** ==
6347
6348 (% class="box infomessage" %)
6349 (((
6350 **PUT /api/v3/locators**
6351 )))
6352
6353 Пример запроса:
6354
6355 (((
6356 {
6357 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6358 "isEnabled": true, ~/~/ Активность 
6359 "name": "string", ~/~/ Наименование
6360 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6361 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6362 "validity": 0, ~/~/ Срок действия в днях (1-90)
6363 "autoProlongation": true, ~/~/ Автопродление срока действия
6364 "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6365 "vehiclesIds": [ ~/~/ Oбъекты
6366 0
6367 ],
6368 "geoIds": [ ~/~/ Геозоны
6369 0
6370 ],
6371 "fieldsIds": [ ~/~/ Поля
6372 0
6373 ],
6374 "showVehicleName": true, ~/~/ Наименование объекта
6375 "showVehicleDirection": true, ~/~/ Направление движения на треке
6376 "allowTrackReport": true, ~/~/ Трек
6377 "showTrackTracing": true, ~/~/ Трассировка трека
6378 "showSensors": true, ~/~/ Датчик
6379 "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 
6380 ]
6381 }
6382
6383
6384 )))
6385
6386 Пример ответа:
6387
6388 200 ~/~/ Success
6389
6390
6391 == **Удалить локатор** ==
6392
6393 (% class="box warningmessage" %)
6394 (((
6395 **DELETE /api/v3/locators**
6396 )))
6397
6398 Пример запроса:
6399
6400 (((
6401 [
6402 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6403 ]
6404 )))
6405
6406
6407
6408 = **Раздел: Яндекс Маршруты** =
6409
6410
6411 == **Возвращение списка маршрутов** ==
6412
6413 (% class="box infomessage" %)
6414 (((
6415 **GET /api/v3/TransportRoutes**
6416 )))
6417
6418 Пример запроса:
6419 Id  ~/~/ Идентификатор поля
6420
6421
6422 Пример ответа:
6423
6424 (((
6425 [
6426 {
6427 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6428 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6429 "name": "string", ~/~/ Наименование маршрута.
6430 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6431 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6432 0
6433 ]
6434 }
6435 ]
6436 )))
6437
6438
6439
6440 == **Добавить маршрут** ==
6441
6442 (% class="box infomessage" %)
6443 (((
6444 **POST /api/v3/TransportRoutes**
6445 )))
6446
6447 Пример запроса: 
6448 {
6449 "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6450 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6451 "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6452 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6453 0
6454 ]
6455 }
6456
6457
6458 Пример ответа:
6459
6460 (((
6461 {
6462 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6463 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6464 "name": "string", ~/~/ Определяет наименование маршрута 
6465 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6466 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6467 0
6468 ]
6469 }
6470 )))
6471
6472
6473 == **Обновление маршрута** ==
6474
6475 (% class="box successmessage" %)
6476 (((
6477 **PUT /api/v3/TransportRoutes**
6478 )))
6479
6480 Пример запроса:
6481
6482 (((
6483 {
6484 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6485 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6486 "name": "string", ~/~/ Опредлеляет наименование маршрута.
6487 "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6488 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6489 0
6490 ]
6491 }
6492 )))
6493
6494
6495 Пример ответа:
6496
6497 (((
6498 {
6499 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6500 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6501 "name": "string", ~/~/ Определяет наименование маршрута 
6502 "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6503 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6504 0
6505 ]
6506 }
6507 )))
6508
6509
6510 == **Получить связки маршрутов ТС** ==
6511
6512 (% class="box infomessage" %)
6513 (((
6514 **POST /api/v3/TransportRoutes/getroutesvehicles**
6515 )))
6516
6517 Пример запроса:
6518
6519 (((
6520 [
6521 "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6522 ]
6523 )))
6524
6525
6526 Пример ответа:
6527
6528 (((
6529 [
6530 {
6531 "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6532 "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6533 }
6534 ]
6535 )))
6536
6537
6538 == **Удалить маршрут** ==
6539
6540 (% class="box warningmessage" %)
6541 (((
6542 **DELETE /api/v3/TransportRoutes/{id}**
6543 )))
6544
6545 Пример запроса:
6546 Id  ~/~/ Идентификатор поля
6547
6548
6549
6550 = **Раздел: Управление доступа к машинам** =
6551
6552
6553 == Получение списка транспортных средств видимых пользователю ==
6554
6555 (% class="box infomessage" %)
6556 (((
6557 **GET /api/v3/UserVisibleVehicles/{userId}**
6558 )))
6559
6560 Пример ответа:
6561
6562 (((
6563 {
6564 "vehicleIds": [  ~/~/ Идентификаторы ТС
6565 0
6566 ]
6567 }
6568 )))
6569
6570
6571
6572 == Задает видимость транспортных средств пользователю ==
6573
6574 (% class="box infomessage" %)
6575 (((
6576 **POST /api/v3/UserVisibleVehicles**
6577 )))
6578
6579 Пример запроса:
6580
6581 (((
6582 (((
6583 {
6584 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6585 "vehicleIds": [ ~/~/ Идентификаторы ТС
6586 0
6587 ]
6588 }
6589 )))
6590
6591 (((
6592
6593 )))
6594
6595 (((
6596
6597 )))
6598
6599 (((
6600 Пример ответа :
6601 )))
6602
6603 (((
6604
6605 )))
6606
6607 (((
6608 200 ~/~/ Success
6609 )))
6610 )))
6611
6612
6613
6614
6615
6616
6617 (% class="box" lang="en-US" style="text-align: center;" %)
6618 (((
6619 (% 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]] **
6620 )))

Меню

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