Редактировал(а) Андрей Калиновский 2025/03/28 11:43
Последние авторы
1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 (((
3 (% class="box warningmessage" %)
4 (((
5 (% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 просим вас соблюдать несколько простых правил при использовании API-команд:##
7 )))
8
9 * Формировать не более 3 отчётов одновременно.
10 * Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11
12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13
14 (% class="box infomessage" %)
15 (((
16 **Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 \\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 )))
19
20 **Содержание страницы:**
21 )))
22
23 {{toc/}}
24
25
26 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
27
28 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
29
30 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
31
32 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
33
34 (% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
35
36
37 (% style="color:#000000; font-size:16px" %)**Рекомендации**
38
39 - Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
40
41 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
42
43 (% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
44 (((
45 (% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
46 (% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
47 )))
48
49 (% class="box successmessage" %)
50 (((
51 (% lang="en-US" %)**POST /api/v3/auth/login**
52 )))
53
54 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
55
56 (% style="color:#000000" %)Метод запроса: **POST**
57
58 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
59
60 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
61
62 (% style="color:#000000" %)Параметры в теле запроса (JSON):
63
64 (% style="color:#000000" %){
65 "login": "testuser",
66 "password": "testuser"
67 }
68
69 (% style="color:#000000" %)**Ответ:**
70
71 (% lang="en-US" %)
72 (% style="color:#000000" %){
73 "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
74 "User": "testuser" , ~/~/ имя пользователя(%%)
75 }
76
77 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
78
79 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
80 |(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
81 |(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
82 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
83 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
84
85 (% class="wikigeneratedid" %)
86 Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
87
88 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
89
90 (% class="box infomessage" %)
91 (((
92 (% lang="en-US" %)**GET /api/v3/auth/check**
93 )))
94
95 (% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
96
97 (% style="color:#000000" %)Метод запроса: **GET**
98
99 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
100
101 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
102
103 (% lang="en-US" %)
104 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
105
106 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
107
108 == (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
109
110 (% class="box infomessage" %)
111 (((
112 **GET api/v3/agents/{id}**
113 )))
114
115 Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
116
117 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
118
119 (% style="color:#000000" %)Метод запроса: **GET**
120
121 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
122
123 Запрос должен содержать данные параметра "**agentId**"
124
125 (% style="color:#000000" %)Ответ:
126
127 (((
128 {
129 "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 "parentName": "string", ~/~/ Наименование агента
132 "name": "string", ~/~/ Имя клиента
133 "fullName": "string", ~/~/ ФИО клиента
134 "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 "district": "string", ~/~/ Район
137 "region": "string", ~/~/ Область
138 "city": "string", ~/~/ Город
139 "email": "string", ~/~/ Email
140 "director": "string", ~/~/ Руководитель
141 "RegionalData": [ ~/~/ Определяет региональные сведения.
142 {
143 "Country": 0, ~/~/ Страна
144 "groups": [ ~/~/ Список групп
145 {
146 "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 "fields": [ ~/~/ Список значений полей
148 {
149 "name": "string", ~/~/ Имя поля формы
150 "value": "string" ~/~/ Значение поля формы
151 }
152 ]
153 }
154 ]
155 }
156 ]
157 }
158 )))
159
160
161 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
162 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
163 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
164 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
165 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
166 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
167 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
168 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
169 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
170 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
171 |(% style="width:215px" %)city|(% style="width:861px" %)Город
172 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
173 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
174 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
175 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
176 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
177 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
178 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
179 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
180 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
181 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
182
183 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
184
185 (% class="box infomessage" %)
186 (((
187 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
188 )))
189
190 (% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
191
192 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
193
194 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
195
196 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
197
198 (% style="color:#000000" %)Метод запроса: **POST**
199
200 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
201
202 (% style="color:#000000" %)Параметр запроса:
203
204 (% style="color:#000000" %){
205 "parentId": "string"
206 }
207
208 (% style="color:#000000" %)Ответ:
209
210 {
211 "agentId": "",(% style="color:#000000" %)   (%%)
212 "parentId": "",
213 "name": "string",
214 "fullName": "string",
215 "agentInfoType": 0,
216 (% style="color:#000000" %) "status": "",
217 }
218
219
220 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
221 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
222 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
223 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
224 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
225 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
226 |(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
227
228 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
229
230 (% class="box successmessage" %)
231 (((
232 **POST /api/v3/agents **
233 )))
234
235 Метод позволяет добавить клиента, указанного в запросе.
236
237 Метод запроса: **POST**
238
239 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
240
241 В заголовках запроса: X-Auth: Токен авторизации
242
243 Параметры в теле запроса (JSON):
244
245 {
246 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
247 "name": "string", ~/~/ имя
248 "fullName": "string", ~/~/ полное наименование
249 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
250 "isForeign": true, ~/~/ иностранный контрагент
251 "district": "string", ~/~/ округ
252 "region": "string", ~/~/ регион
253 "city": "string", ~/~/ город
254 "inn": "string", ~/~/ ИНН
255 "kpp": "string", ~/~/ КПП
256 "address": "string", ~/~/ юридический адрес
257 "addressFact": "string", ~/~/ фактический адрес
258 "email": "string", ~/~/ email
259 "director": "string", ~/~/ ФИО руководителя
260 "bankName": "string", ~/~/ банк
261 "bankBIK": "string", ~/~/ БИК
262 "bankRS": "string", ~/~/ номер счёта
263 "bankKS": "string" ~/~/ корр. счёт
264 }
265
266 Ответ:
267
268 {
269 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
270 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
271 "name": "string", ~/~/ имя
272 "fullName": "string", ~/~/ полное наименование
273 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
274 "isForeign": true, ~/~/ иностранный контрагент
275 "district": "string", ~/~/ округ
276 "region": "string", ~/~/ регион
277 "city": "string", ~/~/ город
278 "inn": "string", ~/~/ ИНН
279 "kpp": "string", ~/~/ КПП
280 "address": "string", ~/~/ юридический адрес
281 "addressFact": "string", ~/~/ фактический адрес
282 "email": "string", ~/~/ email
283 "director": "string", ~/~/ ФИО руководителя
284 "bankName": "string", ~/~/ банк
285 "bankBIK": "string", ~/~/ БИК
286 "bankRS": "string", ~/~/ номер счёта
287 "bankKS": "string" ~/~/ корр. счёт
288 }
289
290 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
291 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
292 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
293 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
294 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
295 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
296 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
297 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
298 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
299 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
300 |(% style="width:215px" %)city|(% style="width:861px" %)Город
301 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
302 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
303 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
304 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
305 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
306 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
307 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
308 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
309 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
310 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
311
312 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
313
314 (% class="box warningmessage" %)
315 (((
316 **PUT /api/v3/agents**
317 )))
318
319 Метод позволяет отредактировать клиента, указанного в запросе.
320
321 Метод запроса: **PUT**
322
323 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
324
325 В заголовках запроса: X-Auth: Токен авторизации
326
327 Параметры в теле запроса (JSON):
328
329 {
330 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
331 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
332 "name": "string", ~/~/ имя
333 "fullName": "string", ~/~/ полное наименование
334 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
335 "isForeign": true, ~/~/ иностранный контрагент
336 "district": "string", ~/~/ округ
337 "region": "string", ~/~/ регион
338 "city": "string", ~/~/ город
339 "inn": "string", ~/~/ ИНН
340 "kpp": "string", ~/~/ КПП
341 "address": "string", ~/~/ юридический адрес
342 "addressFact": "string", ~/~/ фактический адрес
343 "email": "string", ~/~/ email
344 "director": "string", ~/~/ ФИО руководителя
345 "bankName": "string", ~/~/ банк
346 "bankBIK": "string", ~/~/ БИК
347 "bankRS": "string", ~/~/ номер счёта
348 "bankKS": "string" ~/~/ корр. счёт
349 }
350
351 Ответ:
352
353 {
354 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
355 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
356 "name": "string", ~/~/ имя
357 "fullName": "string", ~/~/ полное наименование
358 "isForeign": true, ~/~/ иностранный контрагент
359 "district": "string", ~/~/ округ
360 "region": "string", ~/~/ регион
361 "city": "string", ~/~/ город
362 "inn": "string", ~/~/ ИНН
363 "kpp": "string", ~/~/ КПП
364 "address": "string", ~/~/ юридический адрес
365 "addressFact": "string", ~/~/ фактический адрес
366 "email": "string", ~/~/ email
367 "director": "string", ~/~/ ФИО руководителя
368 "bankName": "string", ~/~/ банк
369 "bankBIK": "string", ~/~/ БИК
370 "bankRS": "string", ~/~/ номер счёта
371 "bankKS": "string" ~/~/ корр. счёт
372 }
373
374 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
375
376 (% class="box errormessage" %)
377 (((
378 **DELETE /api/v3/agents/{clientId}**
379 )))
380
381 Метод позволяет удалить клиента, указанного в строке запроса.
382
383 Метод запроса: **DELETE**
384
385 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
386
387 Параметр запроса: **{clientId}** - Guid пользователя
388
389 В заголовках запроса: X-Auth: Токен авторизации
390
391 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
392
393 == (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
394
395 (% class="box warningmessage" %)
396 (((
397 **PUT /api/v3/agents/{id}/changeStatus/{status}**
398 )))
399
400 Метод позволяет изменить статус клиента, указанного в запросе.
401
402 В пути указывается GUID клиента и статус клиента.
403
404 **status **- значение 0 - заблокирован, 1 - активен.
405
406 Ответ: Code 204
407
408 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
409
410 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
411
412 (% class="box successmessage" %)
413 (((
414 (% lang="en-US" %)**POST /api/v3/users**
415 )))
416
417 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
418
419 (% style="color:#000000" %)Метод запроса: **POST**
420
421 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
422
423 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
424
425 (% style="color:#000000" %)Параметры в теле запроса (JSON):
426
427 (% style="color:#000000" %)
428 { 
429 "lastName": "", ~/~/ фамилия
430 "firstName": "", ~/~/ имя
431 "position": "", ~/~/ должность
432 "phone": "", ~/~/ телефон
433 "organization": "", ~/~/ организация
434 "login": "", ~/~/ логин (обязателен)
435 "password": "", ~/~/ пароль (обязателен)
436 "email": "", ~/~/ email (обязателен)
437 "description": "string", ~/~/ Описание
438 "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
439 "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
440 "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
441 "parentId": "", ~/~/ Guid родительского агента
442 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
443 "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
444 "doubleAuth":
445 {
446 "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
447 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
448 },
449 "groups":
450 [
451 "string" ~/~/ группы пользователя, перечисление названия системных ролей
452 ],
453 "customGroups":
454 [
455 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
456 ],
457 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
458 }
459 {
460 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
461 "lastName": "string",
462 "firstName": "string",
463 "position": "string",
464 "phone": "string",
465 "organization": "string",
466 "login": "string",
467 "password": "string",
468 "email": "string",
469
470 (% style="text-align:left" %)
471 (% style="color:#000000; font-weight:normal" %)Ответ:
472 {     
473 "id": "" , ~/~/ ID пользователя
474 "lastName": "" , ~/~/ Фамилия ,
475 "firstName": "" , ~/~/ Имя
476 "position": "" , ~/~/ Должность
477 "phone": "" , ~/~/ Телефон
478 "organization": "" , ~/~/ Организация
479 "login": "" , ~/~/ Логин
480 "password": "" , ~/~/ Пароль
481 "email": "" , ~/~/ Email
482 "description": "" , ~/~/ Описание
483 "isEnabled": "" , ~/~/ Признак включения
484 "parentId": "" , ~/~/ Guid родительского агента
485 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
486 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
487 "kind": "" , ~/~/ тип аутентификации
488 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
489 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
490 }
491
492
493 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
494
495 (% class="box infomessage" %)
496 (((
497 (% lang="en-US" %)**POST /api/v3/users/find**
498 )))
499
500 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
501
502 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
503
504 (% style="color:#000000" %)Метод запроса: **POST**
505
506 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
507
508 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
509
510 (% style="color:#000000" %)Параметры в теле запроса (JSON):
511
512 (% style="color:#000000" %){(%%)
513 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
514 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
515 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
516 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
517 (% style="color:#000000" %)}
518
519 (% style="color:#000000" %)Ответ:
520
521 (% style="color:#000000" %){         (%%)
522 "id": "" , ~/~/ идентификатор пользователя
523 "lastName": "" , ~/~/ фамилия
524 "firstName": "" , ~/~/ имя
525 "position": "" , ~/~/ должность
526 "phone": "" , ~/~/ телефон
527 "parentId": "" , ~/~/ идентификатор клиента-родителя
528 "parentName": "" , ~/~/ наименование клиента-родителя
529 "organization": "" , ~/~/ организация
530 "login": "" , ~/~/ логин
531 "email": "" , ~/~/ E-mail
532 "sessionDuration":"", ~/~/ длительность сессии в минутах
533 "status": "1",  ~/~/ статус пользователя
534 "lastLogged": "", ~/~/ дата/время последней авторизации
535 (% style="color:#000000" %)}
536
537 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
538
539 (% class="box infomessage" %)
540 (((
541 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
542 )))
543
544 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
545
546 (% style="color:#000000" %)Метод запроса: **GET**
547
548 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
549
550 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
551
552 (% style="color:#000000" %)Ответ:
553
554 (((
555 (((
556 {
557 "id": "", ~/~/ GUID пользователя
558 "lastName": "", ~/~/ Фамилия 
559 "firstName": "", ~/~/ Имя
560 "position": "", ~/~/ Должность
561 "phone": "", ~/~/ Номер телефона
562 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
563 "parentName": "", Наименование клиента, которому принадлежит пользователь
564 "organization": "", ~/~/ Организация
565 "login": "", ~/~/ Логин пользователя
566 "email": "", ~/~/ Адрес электронной почты
567 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
568 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
569 "description": "", ~/~/ Описание
570 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
571 "doubleAuth":
572 {
573 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
574 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
575 },
576 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
577 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
578 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
579 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
580 "groups": [], ~/~/ Список ролей пользователя
581 "customGroups": [], ~/~/ Список клиентских ролей пользователя
582 "authDevices": [ ], ~/~/ Список авторизованных устройств
583 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
584 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
585 }
586 )))
587 )))
588
589 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
590
591 (% class="box warningmessage" %)
592 (((
593 (% lang="en-US" %)**PUT /api/v3/users**
594 )))
595
596 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
597
598 (% style="color:#000000" %)Метод запроса: **PUT**
599
600 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
601
602 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
603
604 (% lang="en-US" style="text-align:left" %)
605 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
606
607 (% lang="en-US" style="text-align:left" %)
608 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
609 "id": "" , ~/~/ ID пользователя 
610 "lastName": "" , ~/~/ фамилия
611 "firstName": "" , ~/~/ имя
612 "position": "" , ~/~/ должность
613 "phone": "" , ~/~/ телефон
614 "organization": "" , ~/~/ организация
615 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
616 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
617 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
618 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
619 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
620 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
621 "isEnabled": "" , ~/~/ признак включения
622 "parentId": "" , ~/~/ Guid родительского агента
623 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
624 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
625 "doubleAuth":
626 {
627 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
628 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
629 },
630 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
631 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
632 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
633
634 (% lang="en-US" style="text-align:left" %)
635 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
636
637 (% lang="en-US" style="text-align:left" %)
638 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
639 "id": "" , ~/~/ идентификатор пользователя
640 "lastName": "" , ~/~/ фамилия
641 "firstName": "" , ~/~/ имя
642 "position": "" , ~/~/ должность
643 "phone": "" , ~/~/ телефон
644 "organization": "" , ~/~/ организация
645 "login": "" , ~/~/ логин
646 "password": "" , ~/~/ пароль 
647 "email": "" , ~/~/ email
648 "description": "" , ~/~/ описание
649 "isEnabled": "" , ~/~/ признак включения
650 "parentId": "" , ~/~/ Guid родительского агента
651 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
652 "doubleAuth":
653 {
654 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
655 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
656 },
657 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
658 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
659 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
660 }
661
662 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
663
664 (% class="box warningmessage" %)
665 (((
666 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
667 )))
668
669 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
670
671 (% style="color:#000000" %)Метод запроса: **PUT**
672
673 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
674
675 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
676
677 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
678
679 (% style="color:#000000" %)Параметры в теле запроса (JSON):
680
681 (% style="color:#000000" %){(%%)
682 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
683 "description": "" , ~/~/ описание
684 "data": "" , ~/~/ данные, связанные со сменой статуса
685 (% style="color:#000000" %)}
686
687 (% style="text-align:left" %)
688 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
689
690 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
691
692 (% class="box warningmessage" %)
693 (((
694 **POST /api/v3/users/disable**
695 )))
696
697 Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
698
699 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
700
701 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
702
703 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
704
705 [ 
706 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
707 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
708 ]
709
710 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
711
712 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
713
714 (% class="box warningmessage" %)
715 (((
716 **POST /api/v3/users/enable**
717 )))
718
719 Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
720
721 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
722
723 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
724
725 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
726
727 [ 
728 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
729 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
730 ]
731
732 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
733 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
734
735 (((
736 В теле ответа:
737 {
738 "errorMessages": [
739 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
740 ],
741 "users": [
742 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
743 ]
744 }
745 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
746 "users" - массив id пользователей, которых не удалось включить или отключить.
747 )))
748
749 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
750
751 (% class="box errormessage" %)
752 (((
753 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
754 )))
755
756 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
757
758 (% style="color:#000000" %)Метод запроса: **DELETE**
759
760 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
761
762 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
763
764 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
765
766 (% style="text-align:left" %)
767 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
768
769 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
770
771 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
772
773 (% class="box infomessage" %)
774 (((
775 (% lang="en-US" %)**GET /api/v3/models/{Id}**
776 )))
777
778 Метод возвращает полную информацию о модели объекта.
779
780 (% style="color:#000000" %)Метод запроса: **GET**
781
782 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
783
784 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
785
786 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
787
788 (% style="color:#000000" %)Ответ:
789
790 (% style="color:#000000" %){
791 "parentName": "string",
792 "name": "string",
793 "picture": "string",
794 "minspeed": 0,
795 "maxspeed": 0,
796 "width": 0,
797 "imbeddedtrailer": true,
798 "hoppercapacity": 0,
799 "hopperdischargespeed": 0,
800 "modelType": 0,
801 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
802 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
803 "deleted": true
804 }
805
806 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
807 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
808 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
809 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
810 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
811 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
812 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
813 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
814 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
815 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
816 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
817 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
818 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
819 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
820
821 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
822
823 (% class="box successmessage" %)
824 (((
825 (% lang="en-US" %)**POST /api/v3/models/find**
826 )))
827
828 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
829
830 (% style="color:#000000" %)Метод запроса: **POST**
831
832 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
833
834 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
835
836 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
837
838 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
839 }
840
841 (% style="color:#000000" %)Ответ:
842
843 (% style="color:#000000" %)[
844 {
845 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
846 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
847 "parentName": "string",
848 "name": "string",
849 "modelType": 0
850 }
851 ]
852
853 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
854 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
855 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
856 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
857 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
858 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
859
860 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
861
862 (% class="box successmessage" %)
863 (((
864 (% lang="en-US" %)**POST /api/v3/models**
865 )))
866
867 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
868
869 (% style="color:#000000" %)Метод запроса: **POST**
870
871 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
872
873 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
874
875 (% style="color:#000000" %)Параметры в теле запроса (JSON):
876
877 {
878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880 "deleted": true,
881 "extId": "string",
882 "name": "string",
883 "picture": "string",
884 "minspeed": 0,
885 "maxspeed": 0,
886 "width": 0,
887 "imbeddedtrailer": true,
888 "fueloutlay": 0,
889 "hoppercapacity": 0,
890 "hopperdischargespeed": 0,
891 "modelType": 0
892 }
893
894 Ответ:
895
896 {
897 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
898 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
899 "deleted": true,
900 "extId": "string",
901 "name": "string",
902 "picture": "string",
903 "minspeed": 0,
904 "maxspeed": 0,
905 "width": 0,
906 "imbeddedtrailer": true,
907 "hoppercapacity": 0,
908 "hopperdischargespeed": 0,
909 "modelType": 0
910 }
911
912 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
913 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
914 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
915 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
916 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
917 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
918 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
919 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
920 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
921 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
922 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
923 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
924 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
925
926 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
927
928 (% class="box warningmessage" %)
929 (((
930 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
931 )))
932
933 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
934
935 (% style="color:#000000" %)Метод запроса: **PUT**
936
937 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
938
939 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
940
941 (% style="color:#000000" %)Параметры в теле запроса (JSON):
942
943 {
944 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
945 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
946 "deleted": true,
947 "extId": "string",
948 "name": "string",
949 "picture": "string",
950 "minspeed": 0,
951 "maxspeed": 0,
952 "width": 0,
953 "imbeddedtrailer": true,
954 "fueloutlay": 0,
955 "hoppercapacity": 0,
956 "hopperdischargespeed": 0,
957 "modelType": 0
958 }
959
960 Ответ:
961
962 {
963 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
964 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
965 "deleted": true,
966 "extId": "string",
967 "name": "string",
968 "picture": "string",
969 "minspeed": 0,
970 "maxspeed": 0,
971 "width": 0,
972 "imbeddedtrailer": true,
973 "fueloutlay": 0,
974 "hoppercapacity": 0,
975 "hopperdischargespeed": 0,
976 "modelType": 0
977 }
978
979 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
980 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
981 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
982 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
983 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
984 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
985 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
986 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
987 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
988 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
989 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
990 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
991 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
992
993 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
994
995 (% class="box errormessage" %)
996 (((
997 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
998 )))
999
1000 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
1001
1002 (% style="color:#000000" %)Метод запроса: **DELETE**
1003
1004 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
1005
1006 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
1007
1008 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1009
1010 Ответ: В случае успеха **Success 200**
1011
1012 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
1013
1014 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1015
1016 (% class="box infomessage" %)
1017 (((
1018 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1019 )))
1020
1021 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1022
1023 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1024
1025 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1026
1027 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1028
1029 (% style="color:#000000" %)Метод запроса: **GET**
1030
1031 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
1032
1033 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1034
1035 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1036
1037 (% style="color:#000000" %)Ответ:
1038
1039 (((
1040 {
1041
1042 (((
1043 "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1044 "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1045 )))
1046
1047 (((
1048 ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1049 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1050 )))
1051
1052 "vehicleId": "", ~/~/ ID объекта
1053 "name": "", ~/~/ Имя объекта
1054 "imei": "", ~/~/ IMEI объекта
1055 "deviceTypeId": , ~/~/ ID типа устройства
1056 "deviceTypeName": "", ~/~/ Название типа устройства
1057 "sim1": "", ~/~/ Номер SIM1
1058 "sim2": "", ~/~/ Номер SIM2
1059 "parentId": "", ~/~/ ID клиента-родителя
1060 "parentName": "", ~/~/ Наименование клиента-родителя
1061 "modelId": "", ~/~/ ID модели объекта
1062 "modelName": "", ~/~/ Имя модели объекта
1063 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1064 "unitName": "string", ~/~/ Наименование подразделения
1065 "status": 0, ~/~/ Статус объекта
1066 "createdAt": "", ~/~/ Дата создания объекта
1067 },
1068 "customFields": [ ~/~/ Произвольные поля
1069 {
1070 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1071 "name": "string", ~/~/ Имя поля
1072 "value": "string", ~/~/ Значение поля
1073 "forClient": true, ~/~/ Не используемая функция
1074 "forTooltip": true, ~/~/ Отображать в подсказке
1075 "forReport": true ~/~/ Отображать в отчете
1076 }
1077
1078 ], ~/~/ Данные с вкладки нормы
1079 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1080 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1081 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1082 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1083 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1084 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1085 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1086 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1087 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1088 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1089 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1090 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1091 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1092 "mileageCoeff": 0, ~/~/ коэффициент пробега
1093 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1094 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1095 "counters": { ~/~/ Счетчики
1096 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1097 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1098 "mileage": 0, ~/~/ Текущий пробег
1099 "motohours": 0, ~/~/ Текущие моточасы
1100 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1101 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1102 },
1103
1104 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1105 "id": "string", ~/~/ ID объекта
1106 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1107 "host": "string", ~/~/ CMSV6 Web Host
1108 "login": "string", ~/~/ CMSV6 Account
1109 "password": "string" ~/~/ CMSV6 Password
1110 },
1111
1112 "commandTemplates": [ ~/~/ Шаблоны команд
1113 {
1114 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1115 "name": "string", ~/~/ Наименование команды
1116 "command": "string", ~/~/ Текст команды
1117 "retries": 0 ~/~/ Количество попыток
1118 }
1119 ],
1120 "sensors": [ ~/~/ Датчики
1121 {
1122 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1123 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1124 "type": 0, ~/~/ Тип датчика
1125 "name": "string", ~/~/ Имя датчика
1126 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1127 "inputNumber": 0, ~/~/ Номер входа
1128 "pseudonym": "string", ~/~/ Псевдоним
1129 "medianDegree": 0, ~/~/ Медианная фильтрация
1130 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1131 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1132 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1133 "gradesTables": [ ~/~/ Массив таблиц тарировки
1134 {
1135 "grades": [ ~/~/ Таблица тарировки 1
1136 {
1137 "input": 0, ~/~/ Входящее значение
1138 "output": 0 ~/~/ Выходящее значение
1139 }
1140 ],
1141 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1142 }
1143 ],
1144 "showInTooltip": true, ~/~/ Отображать в подсказке
1145 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1146 "color": "string", ~/~/ Код цвета датчиков
1147 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1148 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1149 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1150 "expr": "string", ~/~/ Формула
1151 "children": [ ~/~/ массив дочерних датчиков
1152 "string"
1153 ],
1154 "customParams": { ~/~/ прочие произвольные параметры
1155 "additionalProp1": "string",
1156 "additionalProp2": "string",
1157 "additionalProp3": "string"
1158 },
1159
1160 ~/~/ Характерные для произвольного:
1161 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1162 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1163 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1164 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1165 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1166 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1167 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1168 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1169 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1170 ~/~/ "ValueOn": "Вкл.",
1171 ~/~/ "ValueOff": "Выкл."
1172 "summaryMaxValue": 0 ~/~/ Макс. значение
1173 }
1174 "drivers": [ ~/~/ Водители
1175 {
1176 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1177 "name": "string", ~/~/ Наименование
1178 "description": "string",
1179 "isDefault": true ~/~/ По умолчанию
1180 }
1181 ],
1182 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1183 {
1184 "id": "", ~/~/ ID  задания
1185 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1186 "name": "", ~/~/ Наименование задания
1187 "description": "", ~/~/ Описание задания
1188 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1189 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1190 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1191 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1192 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1193 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1194 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1195 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1196 }
1197 ],
1198 "statusHistory": [ ~/~/ История статусов
1199 {
1200 "status": 0,
1201 "date": "2023-05-22T09:57:39.562Z",
1202 "description": "string",
1203 "additionalInfo": "string"
1204
1205 (((
1206 }
1207 ],
1208 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1209 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1210 )))
1211
1212 (((
1213 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1214 }
1215
1216 )))
1217 )))
1218
1219 (% style="text-align:left" %)
1220 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1221
1222 (% style="text-align:left" %)
1223 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1224
1225
1226 == **Отправить команду на терминал** ==
1227
1228 (% class="box successmessage" %)
1229 (((
1230 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1231 )))
1232
1233 Команда для отправки на тс.
1234
1235 {  
1236 "id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1237 "command": "", ~/~/ Текст отправляемой команды
1238 "retries": "", ~/~/ Количество попыток отправки на терминал
1239 "idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1240 }
1241
1242 В ответ получаем cmdid
1243
1244
1245 == **Получить ответ на отправленную на ТС команду** ==
1246
1247 (% class="box infomessage" %)
1248 (((
1249 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1250 )))
1251
1252 Идентификатор команды: cmdId
1253
1254 Запрос от терминала на ответ команды
1255
1256 Пример ответ от терминала:
1257
1258 ID= "" ~/~/ идентификатор объекта
1259 Soft="" ~/~/ версия софта
1260 GPS=4 ~/~/ тип трекера
1261 Time=11:05:43 28.06.24 ~/~/ время запроса
1262 Lat=45.056221 ~/~/ широта
1263 Lon=39.035938 ~/~/ долгота
1264 Speed=0.0 ~/~/ скорость
1265 Course=181.4 ~/~/направление
1266
1267 (((
1268 == **Список отправленных объекту команд с ответами** ==
1269
1270 (% class="box infomessage" %)
1271 (((
1272 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1273 )))
1274
1275 Идентификатор ТС: vehicleId
1276
1277 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1278
1279 Пример ответа терминала
1280
1281 [ 
1282 {    
1283 "id": "", ~/~/ идентификатор пользователя
1284 "commandText": "", ~/~/Текст команды.
1285 "templateId": "", ~/~/Идентификатор шаблона
1286 "updated": "", ~/~/ Время отправки  
1287 "tryCount": 0, ~/~/ Количество попыток отправки команды
1288 "answer": "", ~/~/ Ответ терминала.
1289 "status": "" ~/~/ Статус отправки
1290 }
1291 ]
1292 )))
1293
1294 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1295
1296 (% class="box successmessage" %)
1297 (((
1298 (% lang="en-US" %)**POST /api/v3/vehicles**
1299 )))
1300
1301 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1302
1303 (% style="color:#000000" %)Метод запроса: **POST**
1304
1305 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1306
1307 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1308
1309 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1310
1311 (% style="color:#000000" %){
1312
1313
1314 (((
1315 "vehicleId": 0, ~/~/ ID ТС
1316 )))
1317
1318 "parentId": "" , ~/~/ ID клиента
1319 "name": "" , ~/~/ имя ТС
1320 "imei": "" , ~/~/ IMEI
1321 "deviceTypeId": "" , ~/~/ ID типа устройства
1322 "modelId": "" , ~/~/ ID модели
1323 "unitId": "" , ~/~/ ID подразделения
1324 "sim1": "" , ~/~/ Номер SIM 1
1325 "sim2": "" , ~/~/ Номер SIM2
1326 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1327 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1328 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1329 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1330 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1331 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1332 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1333 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1334 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1335 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1336 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1337 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1338 "mileageCalcMethod": 0,
1339 "mileageCoeff": 0,
1340 "locationByCellId": true,
1341 "dottedLineTrackWhenNoCoords": true,
1342 "counters": ~/~/ счетчики
1343 {
1344 "mileage": "" , ~/~/ пробег
1345 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1346 "motohours": "" , ~/~/ моточасы
1347 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1348 },
1349 "cmsv6Parameters": { ~/~/ параметры CMSv6
1350 "enabled": true, ~/~/ флаг включения
1351 "id": "" , ~/~/ идентификатор
1352 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1353 "login": "" , ~/~/ имя учетной записи
1354 "password": "" ~/~/ пароль учетной записи
1355 },
1356 "inspectionTasks": ~/~/ задания на ТО
1357 {
1358 "enabled": "" , ~/~/ Признак включения
1359 "name": "" , ~/~/ Имя задания
1360 "description": "" , ~/~/ Описание задания
1361 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1362 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1363 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1364 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1365 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1366 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1367 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1368 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1369 }
1370 "drivers": [ ~/~/ Водители
1371 {
1372 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1373 "isDefault": true
1374 }
1375 ],
1376 "commandTemplates": [ ~/~/ Шаблон команды
1377 {
1378 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1379 "name": "string",
1380 "command": "string",
1381 "retries": 0
1382 }
1383 ],
1384 "sensors": [ ~/~/ Датчики
1385 {
1386 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1387 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1388 "type": 0, ~/~/ Тип датчика
1389 "name": "string", ~/~/ Имя датчика
1390 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1391 "inputNumber": 0, ~/~/ Номер входа
1392 "pseudonym": "string", ~/~/ Псевдоним
1393 "medianDegree": 0, ~/~/ Медианная фильтрация
1394 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1395 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1396 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1397 "gradesTables": [ ~/~/ Массив таблиц тарировки
1398 {
1399 "grades": [ ~/~/ Таблица тарировки 1
1400 {
1401 "input": 0, ~/~/ Входящее значение
1402 "output": 0 ~/~/ Выходящее значение
1403 }
1404 ],
1405 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1406 }
1407 ],
1408 "showInTooltip": true, ~/~/ Отображать в подсказке
1409 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1410 "color": "string", ~/~/ код цвета датчиков
1411 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1412 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1413 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1414 "expr": "string", ~/~/ Формула
1415 "children": [ ~/~/ массив дочерних датчиков
1416 "string"
1417 ],
1418 "customParams": { ~/~/ прочие произвольные параметры
1419 "additionalProp1": "string",
1420 "additionalProp2": "string",
1421 "additionalProp3": "string"
1422 },
1423 ~/~/ Характерные для произвольного:
1424 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1425 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1426 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1427 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1428 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1429 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1430 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1431 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1432 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1433 ~/~/ "ValueOn": "Вкл.",
1434 ~/~/ "ValueOff": "Выкл."
1435 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1436
1437 (((
1438 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1439 {
1440 "from": 0, ~/~/ С какого значения
1441 "color": "string", ~/~/ Каким цветом
1442 "text": "string" ~/~/ Текст подписи к этому интервалу
1443 }
1444 ]
1445 }
1446 ],
1447 )))
1448
1449 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1450
1451
1452 "customFields": [ ~/~/ Произвольные поля
1453 {
1454 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1455 "name": "string", ~/~/ Наименование произвольного поля
1456 "value": "string", ~/~/ Значение произвольного поля
1457 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1458 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1459 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1460
1461 (((
1462 }
1463 ],
1464 "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1465 )))
1466
1467 (((
1468 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1469 }
1470 )))
1471
1472
1473 (% style="color:#000000" %)Ответ:
1474
1475
1476 (((
1477 (((
1478 (((
1479 {
1480 "vehicleId": 0,  ~/~/ ID ТС
1481 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1482 "name": "string", ~/~/ Имя объекта
1483 "imei": "string", ~/~/ IMEI
1484 "deviceTypeId": 0, ~/~/ ID типа устройства
1485 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1486 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1487 "sim1": "string", ~/~/ SIM1
1488 "sim2": "string", ~/~/ SIM2
1489 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1490 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1491 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1492 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1493 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1494 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1495 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1496 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1497 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1498 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1499 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1500 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1501 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1502 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1503 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1504 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1505 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1506 "counters": {  ~/~/ Dto для состояний счётчиков
1507 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1508 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1509 "mileage": 0, ~/~/ Пробег
1510 "motohours": 0 ~/~/ Моточасы
1511 },
1512 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1513 "id": "string", ~/~/ CMSV6 Идентификатор
1514 "enabled": true, ~/~/ Признак включения
1515 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1516 "login": "string", ~/~/ CMSV6 имя учетной записи
1517 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1518 },
1519 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1520 {
1521 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1522 "enabled": true, ~/~/ Признак включения
1523 "name": "string", ~/~/ Имя задания
1524 "description": "string", ~/~/ Описание задания
1525 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1526 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1527 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1528 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1529 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1530 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1531 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1532 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1533 }
1534 ],
1535 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1536 {
1537 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1538 "inputNumber": 0, ~/~/ № входа.
1539 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1540 "comment": "string", ~/~/ Комментарий
1541 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1542 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1543 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1544 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1545 }
1546 ],
1547 "commandTemplates": [  ~/~/ Список шаблонов команд
1548 {
1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1550 "name": "string", ~/~/ Название шаблона команд
1551 "command": "string", ~/~/ Команда на выполнение
1552 "retries": 0 ~/~/ Лимит попыток отправки
1553 }
1554 ],
1555 "sensors": [ ~/~/ Список датчиков
1556 {
1557 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1558 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1559 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1560 "name": "string",  ~/~/ Имя датчика
1561 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1562 "inputNumber": 0, ~/~/ Номер входа
1563 "pseudonym": "string", ~/~/ Псевдоним
1564 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1565 "isInverted": true, ~/~/  Признак инверсии
1566 "disabled": true, ~/~/ Датчик не участвует в обработке
1567 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1568 "gradesTables": [ ~/~/ Тарировка
1569 {
1570 "grades": [ ~/~/ Таблицы тарировки
1571 {
1572 "input": 0, ~/~/ Вход
1573 "output": 0 ~/~/ Выход
1574 }
1575 ],
1576 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1577 }
1578 ],
1579 "showInTooltip": true, ~/~/ Отображение в подсказке
1580 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1581 "color": "string", ~/~/ код цвета датчиков
1582 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1583 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1584 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1585 "expr": "string", ~/~/ Выражение
1586 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1587 "string"
1588 ],
1589 "customParams": {
1590 "additionalProp1": "string",
1591 "additionalProp2": "string",
1592 "additionalProp3": "string"
1593 },
1594 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1595 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1596 {
1597 "from": 0, ~/~/ С какого значения
1598 "color": "string", ~/~/ Каким цветом
1599 )))
1600
1601 (((
1602 "text": "string" ~/~/ Текст подписи к этому интервалу
1603 }
1604 ]
1605 }
1606 ],
1607 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1608 "customFields": [ ~/~/ Список произвольных полей
1609 {
1610 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1611 "name": "string", ~/~/ Наименование произвольного поля
1612 "value": "string", ~/~/ Значение произвольного поля
1613 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1614 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1615 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1616 }
1617 ],
1618 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1619 }
1620 )))
1621 )))
1622 )))
1623
1624
1625 **Валидация:**
1626 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1627 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1629
1630
1631 == **Импортировать историю ТС (Асинхронный запрос)** ==
1632
1633 (% class="box successmessage" %)
1634 (((
1635 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1636 )))
1637
1638 Метод запроса: **POST**
1639
1640 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1641
1642 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1643
1644
1645 Ответ:
1646
1647 {
1648
1649 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1650
1651 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1652
1653 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1654
1655 "Message": "string", ~/~/ Информация о выполнении запроса
1656
1657 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1658
1659 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1660
1661 "Data": "string" ~/~/ Данные
1662
1663 }
1664
1665
1666 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
1667
1668 (% class="box infomessage" %)
1669 (((
1670 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1671 )))
1672
1673 Метод запроса: **GET**
1674
1675 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1676
1677 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1678
1679
1680 Ответ:
1681
1682 {
1683
1684 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1685
1686 "Status": 0, ~/~/ Перечисление состояний выполения запроса
1687 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1688
1689 "Message": "string", ~/~/ Информация о выполнении запроса
1690
1691 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1692
1693 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1694
1695 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1696
1697 "Data": "string" ~/~/ Данные
1698
1699 }
1700
1701
1702 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1703
1704 (% class="box infomessage" %)
1705 (((
1706 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1707 )))
1708
1709 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1710
1711 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1712
1713 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1714
1715 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1716
1717 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1718
1719 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1720
1721 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1722
1723 (% style="color:#000000" %)Метод запроса: **POST**
1724
1725 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1726
1727 (% style="color:#000000" %)В заголовках запроса:
1728
1729 (% style="color:#000000" %)− Content-Type: __**application/json**__
1730
1731 (% style="color:#000000" %)− X-Auth: Токен авторизации
1732
1733 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1734
1735 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1736
1737 {
1738 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1739 "name": null, ~/~/ Имя ТС (string, опционально)
1740 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1741 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1742 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1743 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1744 "unitName": "string",  ~/~/ Название подразделения (опционально)
1745 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1746 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1747 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1748 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1749 }
1750
1751 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1752
1753 (% style="color:#000000" %)Ответ:
1754
1755 (% style="color:#000000" %)[
1756 {
1757
1758 (((
1759 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1760 )))
1761
1762 (((
1763 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1764 "name": "" ~/~/ наименование объекта
1765 "imei": "" ~/~/ IMEI объекта
1766 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1767 "deviceTypeName": "" ~/~/ наименование типа устройства
1768 "sim1": "" ~/~/ первый номер телефона
1769 "sim2": "" ~/~/ второй номер телефона
1770 "parentId": "" ~/~/ идентификатор клиента-родителя
1771 "parentName": "" ~/~/ наименование клиента-родителя
1772 "modelId": "" ~/~/ идентификатор модели объекта
1773 "modelName": "" ~/~/ наименование модели объекта
1774 "unitId": "" ~/~/ идентификатор подразделения
1775 "unitName": "" ~/~/ наименование подразделения
1776 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1777 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1778 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1779 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1780 "customFields": [ 
1781 {
1782 "id": "", ~/~/ идентификатор произвольного поля
1783 "name": "", ~/~/ имя произвольного поля
1784 "value": "", ~/~/ значение произвольного поля
1785 "forClient": true, ~/~/ право на отображение у клиента
1786 "forTooltip": false, ~/~/ право на отображение в подсказке
1787 "forReport": false ~/~/ право на отображение в отчетах
1788 )))
1789
1790 (((
1791 }
1792 ],
1793 "vehicleGroups": [  ~/~/ Группы ТС
1794 {
1795 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1796 "name": "string" ~/~/ Наименование группы ТС
1797 }
1798 ]
1799 }
1800 ]
1801 )))
1802
1803 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1804
1805 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1806
1807 (% class="box successmessage" %)
1808 (((
1809 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1810 )))
1811
1812 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1813
1814 (% style="color:#000000" %)Метод запроса: **POST**
1815
1816 (% 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}
1817
1818 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1819
1820 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1821
1822 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1823
1824 (% style="color:#000000" %){
1825
1826 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1827 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1828 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1829 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1830 "description": "", ~/~/ Описание
1831 "data": "", ~/~/ Данные
1832 "overwrite": false, ~/~/ Флаг перезаписи
1833 "stage": "", ~/~/ Состояние, может быть null
1834 (% style="color:#000000" %)}
1835
1836 (% style="color:#000000" %)Ответ:
1837
1838 (% style="color:#000000" %){(%%)
1839 "status": "", ~/~/ значение статуса
1840 "date": "", ~/~/ Дата смены статуса 
1841 "description": "", ~/~/ Описание
1842 "data": "", ~/~/ Данные
1843 "overwrite": false, ~/~/ Флаг перезаписи
1844 "stage": "", ~/~/ Состояние
1845 (% style="color:#000000" %) }
1846
1847 == ==
1848
1849 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1850
1851 (% class="box warningmessage" %)
1852 (((
1853 (% lang="en-US" %)**PUT /api/v3/vehicles**
1854 )))
1855
1856 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1857
1858 (% style="color:#000000" %)Метод запроса: **PUT**
1859
1860 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1861
1862 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1863
1864 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1865
1866 (% style="color:#000000" %){
1867 "vehicleId": , ~/~/ ID объекта
1868 "parentId": "" , ~/~/ ID клиента
1869 "name": "" , ~/~/ имя ТС
1870 "imei": "" , ~/~/ IMEI
1871 "deviceTypeId": "" , ~/~/ ID типа устройства
1872 "modelId": "" , ~/~/ ID модели
1873 "unitId": "" , ~/~/ ID подразделения
1874 "sim1": "" , ~/~/ Номер SIM 1
1875 "sim2": "" , ~/~/ Номер SIM2
1876 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1877 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1878 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1879 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1880 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1881 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1882 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1883 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1884 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1885 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1886 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1887 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1888
1889 "mileageCalcMethod": 0,
1890 "mileageCoeff": 0,
1891 "locationByCellId": true,
1892 "dottedLineTrackWhenNoCoords": true,
1893 "counters": ~/~/ счетчики
1894 {
1895 "mileage": "" , ~/~/ пробег
1896 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1897 "motohours": "" , ~/~/ моточасы
1898 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1899 },
1900 "cmsv6Parameters": { ~/~/ параметры CMSv6
1901 "enabled": true, ~/~/ флаг включения
1902 "id": "" , ~/~/ идентификатор
1903 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1904 "login": "" , ~/~/ имя учетной записи
1905 "password": "" ~/~/ пароль учетной записи
1906 },
1907 "inspectionTasks": ~/~/ задания на ТО
1908 {
1909 "enabled": "" , ~/~/ Признак включения
1910 "name": "" , ~/~/ Имя задания
1911 "description": "" , ~/~/ Описание задания
1912 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1913 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1914 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1915 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1916 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1917 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1918 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1919 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1920 }
1921
1922 "drivers": [ ~/~/ Водители
1923 {
1924
1925 (((
1926 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1927 "inputNumber": 0, ~/~/ № входа.
1928 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1929 "comment": "string", ~/~/ Комментарий.
1930 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1931 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1932 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1933 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1934 )))
1935
1936 } 
1937 ],
1938 "commandTemplates": [ ~/~/ Шаблон команды
1939 {
1940 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1941 "name": "string",
1942 "command": "string",
1943 "retries": 0
1944 }
1945 ],
1946 "sensors": [ ~/~/ Датчики
1947 {
1948 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1949 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1950 "type": 0, ~/~/ Тип датчика
1951 "name": "string", ~/~/ Имя датчика
1952 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1953 "inputNumber": 0, ~/~/ Номер входа
1954 "pseudonym": "string", ~/~/ Псевдоним
1955 "medianDegree": 0, ~/~/ Медианная фильтрация
1956 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1957 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1958 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1959 "gradesTables": [ ~/~/ Массив таблиц тарировки
1960 {
1961 "grades": [ ~/~/ Таблица тарировки 1
1962 {
1963 "input": 0, ~/~/ Входящее значение
1964 "output": 0 ~/~/ Выходящее значение
1965 }
1966 ],
1967 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1968 }
1969 ],
1970 "showInTooltip": true, ~/~/ Отображать в подсказке
1971 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1972
1973 (((
1974 "color": "string",** ~/~/ **Цвет датчика
1975 )))
1976
1977 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1978 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1979 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1980 "expr": "string", ~/~/ Формула
1981 "children": [ ~/~/ массив дочерних датчиков
1982 "string"
1983 ],
1984 "customParams": { ~/~/ прочие произвольные параметры
1985 "additionalProp1": "string",
1986 "additionalProp2": "string",
1987 "additionalProp3": "string"
1988 },
1989 ~/~/ Характерные для произвольного:
1990 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1991 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1992 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1993 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1994 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1995 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1996 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1997 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1998 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1999 ~/~/ "ValueOn": "Вкл.",
2000 ~/~/ "ValueOff": "Выкл."
2001 "summaryMaxValue": 0 ~/~/ Макс. значение
2002
2003 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2004 {
2005 "from": 0, ~/~/ С какого значения
2006 "color": "string", ~/~/ Каким цветом
2007 "text": "string" ~/~/ Текст подписи к этому интервалу
2008 }
2009 ]
2010 }
2011 ],
2012 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2013
2014 "customFields": [ ~/~/ Произвольные поля
2015 {     
2016 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
2017 "name": "string", ~/~/ Наименование произвольного поля
2018 "value": "string", ~/~/ Значение произвольного поля
2019 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2020 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2021 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2022 }
2023
2024 (((
2025 ],
2026 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
2027 )))
2028
2029 }
2030
2031
2032 (% style="color:#000000" %)Ответ:
2033
2034 (((
2035 {
2036 "vehicleId": 0, ~/~/ ID ТС
2037 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
2038 "name": "string", ~/~/ Имя объекта
2039 "imei": "string", ~/~/ IMEI
2040 "deviceTypeId": 0, ~/~/ ID типа устройства
2041 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
2042 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
2043 "sim1": "string", ~/~/ SIM1
2044 "sim2": "string", ~/~/ SIM2
2045 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
2046 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
2047 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
2048 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
2049 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
2050 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
2051 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
2052 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
2053 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
2054 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
2055 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
2056 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
2057 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
2058 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
2059 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
2060 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
2061 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
2062 "counters": { ~/~/ состояний счётчиков
2063 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
2064 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
2065 "mileage": 0, ~/~/ Пробег
2066 "motohours": 0 ~/~/ Моточасы 
2067 },
2068 "cmsv6Parameters": { ~/~/ Dto для CMSv6
2069 "id": "string", ~/~/ CMSV6 Идентификатор
2070 "enabled": true, ~/~/ Признак включения
2071 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2072 )))
2073
2074
2075 (((
2076 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2077 "login": "string", ~/~/ CMSV6 имя учетной записи
2078 "password": "string" ~/~/ CMSV6 — пароль учетной записи
2079 },
2080 "inspectionTasks": [ ~/~/ Задания на ТО
2081 {
2082 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2083 "enabled": true, ~/~/ Признак включения
2084 "name": "string", ~/~/ Имя задания
2085 "description": "string", ~/~/ Описание задания
2086 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2087 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2088 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2089 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2090 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2091 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2092 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2093 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2094 }
2095 ],
2096 "drivers": [  ~/~/ Список водителей
2097 {
2098 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2099 "inputNumber": 0, ~/~/ № входа.
2100 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2101 "comment": "string", ~/~/ Комментарий.
2102 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2103 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2104 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2105 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2106 }
2107 ],
2108 "commandTemplates": [ ~/~/ Список шаблонов команд
2109 {
2110 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2111 "name": "string", ~/~/ Название шаблона команд
2112 "command": "string", ~/~/ Команда на выполнение
2113 "retries": 0 ~/~/ Лимит попыток отправки
2114 }
2115 ],
2116 "sensors": [  ~/~/ Список датчиков 
2117 {
2118 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2119 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2120 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2121 )))
2122
2123 (((
2124 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2125 )))
2126
2127 (((
2128 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2129 )))
2130
2131 (((
2132 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2133 )))
2134
2135 (((
2136 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2137 )))
2138
2139 (((
2140 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2141 "name": "string", ~/~/ Имя датчика
2142 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2143 )))
2144
2145 (((
2146 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2147 "inputNumber": 0, ~/~/ Номер входа
2148 "pseudonym": "string", ~/~/ Псевдоним
2149 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2150 "isInverted": true, ~/~/ Признак инверсии
2151 "disabled": true, ~/~/ Датчик не участвует в обработке
2152 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2153 "gradesTables": [ ~/~/ Тарировка
2154 {
2155 "grades": [ ~/~/ Таблицы тарировки
2156 {
2157 "input": 0, ~/~/ Вход
2158 "output": 0 ~/~/ Выход
2159 }
2160 ],
2161 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2162 }
2163 ],
2164 "showInTooltip": true, ~/~/ Отображение в подсказке
2165 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2166
2167 (((
2168 "color": "string", ~/~/ цвет уведомлений
2169 )))
2170
2171 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2172 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2173 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2174 "expr": "string", ~/~/ Выражение
2175 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2176 "string" 
2177 ],
2178 "customParams": { ~/~/ Дополнительные настройки
2179 "additionalProp1": "string",
2180 "additionalProp2": "string",
2181 "additionalProp3": "string"
2182 },
2183 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2184 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2185 {
2186 "from": 0, ~/~/ С какого значения
2187 "color": "string", ~/~/ Каким цветом
2188 "text": "string" ~/~/ Текст подписи к этому интервалу
2189 }
2190 ]
2191 }
2192 ],
2193 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2194 "customFields": [ ~/~/ Список произвольных полей
2195 {
2196 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2197 "name": "string", ~/~/ Наименование произвольного поля
2198 "value": "string", ~/~/ Значение произвольного поля
2199 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2200 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2201 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2202 }
2203 ],
2204 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2205 }
2206 )))
2207
2208 **Валидация:**
2209 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2210 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2211 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2212
2213 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2214
2215 (% class="box errormessage" %)
2216 (((
2217 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2218 )))
2219
2220 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2221
2222 (% style="color:#000000" %)Метод запроса: **DELETE**
2223
2224 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2225
2226 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2227
2228 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2229
2230 (% style="text-align:left" %)
2231 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2232
2233 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2234
2235 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2236
2237 (% class="box infomessage" %)
2238 (((
2239 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2240 )))
2241
2242 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2243
2244 (% style="color:#000000" %)Метод запроса: **GET**
2245
2246 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2247
2248 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2249
2250 (% style="color:#000000" %)Ответ:
2251
2252 (% style="color:#000000" %){(%%)
2253 "deviceTypeId" : "", ~/~/ ID типа устройства
2254 "deviceTypeName" : "" ~/~/ Название типа устройства
2255 (% style="color:#000000" %)}
2256
2257 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2258
2259 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2260
2261 (% class="box infomessage" %)
2262 (((
2263 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2264 )))
2265
2266 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2267
2268 (% style="color:#000000" %)Метод запроса: **GET**
2269
2270 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2271
2272 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2273
2274 (% style="color:#000000" %)Ответ:
2275
2276 (% style="color:#000000" %){(%%)
2277 "id": "", ~/~/ ID типа датчика 
2278 "name": "", ~/~/ Название
2279 "description": "", ~/~/ Описание
2280 (% style="color:#000000" %)}
2281
2282 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2283
2284 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2285
2286 (% class="box infomessage" style="text-align: left;" %)
2287 (((
2288 **POST /api/v3/terminalMessages/count**
2289 )))
2290
2291 (% style="text-align: left;" %)
2292 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2293
2294 (% style="text-align: left;" %)
2295 Метод запроса **POST**
2296
2297 (% style="text-align: left;" %)
2298 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2299
2300 (% style="text-align: left;" %)
2301 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2302
2303 (% style="text-align: left;" %)
2304 {
2305 "vehicleIds": [
2306 id ~/~/ здесь передается список идентификаторов объектов
2307 ],
2308 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2309 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2310 }
2311
2312 (% style="text-align: left;" %)
2313 Ответ:
2314
2315 (% style="text-align: left;" %)
2316 [
2317 {
2318 "vehicleId": 0, ~/~/ идентификатор объекта
2319 "count": 0 ~/~/ количество сообщений за период
2320 }
2321 ]
2322
2323 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2324
2325 (% class="box infomessage" style="text-align: left;" %)
2326 (((
2327 **POST /api/v3/terminalMessages/mapping**
2328 )))
2329
2330 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2331
2332 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2333
2334 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2335
2336 {
2337 "protocolType": 0,
2338 "params": ["string"]
2339 }
2340
2341 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2342 |protocolType|ID типа протокола
2343 |params|(((
2344 Массив наименований параметров в сообщении
2345 )))
2346
2347 Ответ:
2348
2349 {
2350 "protocolType": 0,
2351 "mapping": {
2352 "additionalProp1": {
2353 "inputType": 0,
2354 "inputNumber": 0
2355 },
2356 "additionalProp2": {
2357 "inputType": 0,
2358 "inputNumber": 0
2359 }
2360 }
2361 }
2362
2363 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2364 |protocolType|Тип протокола
2365 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2366 |inputNumber|(((
2367 Номер входа
2368 )))
2369
2370 (% class="wikigeneratedid" %)
2371 Перечень 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/]]
2372
2373 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2374
2375 (% class="box infomessage" %)
2376 (((
2377 **POST /api/v3/terminalMessages**
2378 )))
2379
2380 Метод возвращает список сообщений терминала объекта за выбранный период.
2381
2382 (% style="text-align: left;" %)
2383 Метод запроса **POST**
2384
2385 (% style="text-align: left;" %)
2386 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2387
2388 (% style="text-align: left;" %)
2389 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2390
2391 {
2392 "vehicleId": 0, ~/~/ id объекта
2393 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2394 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2395 }
2396
2397 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2398 |vehicleId|ID объекта
2399 |from|Дата и время начала периода запроса
2400 |to|Дата и время окончания периода запроса
2401
2402 Ответ:
2403
2404 [
2405 {
2406 "messages": [
2407 {
2408 "deviceTime": "2023-11-29T07:40:44.052Z",
2409 "serverTime": "2023-11-29T07:40:44.052Z",
2410 "speed": 0,
2411 "altitude": 0,
2412 "latitude": 0,
2413 "longitude": 0,
2414 "satellites": 0,
2415 "course": 0,
2416 "voltage": 0,
2417 "parameters": {
2418 "additionalProp1": "string",
2419 "additionalProp2": "string",
2420 "additionalProp3": "string"
2421 },
2422 "photoCount": 0,
2423 "lbsCorrectedCoords": true,
2424 "protocolType": 0
2425 }
2426 ]
2427 }
2428 ]
2429
2430 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2431 |deviceTime|Время сообщения терминала
2432 |serverTime|Время когда сообщение поступило на сервер
2433 |speed|Скорость
2434 |altitude|Высота над уровнем моря
2435 |latitude|Широта
2436 |longitude|Долгота
2437 |satellites|Кол-во спутников
2438 |course|Курс
2439 |voltage|Бортовое напряжение
2440 |parameters|Список параметров и их значений
2441 |photoCount|Количество фото
2442 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2443 |protocolType|ID типа протокола
2444
2445 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2446
2447 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2448
2449 (% class="box infomessage" %)
2450 (((
2451 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2452 )))
2453
2454 (% style="color:#000000" %)Метод запроса: **POST**
2455
2456 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2457
2458 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2459
2460 (% style="text-align:left" %)
2461 Тело запроса:
2462
2463 {
2464 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2465 "vehicleIds": [0], ~/~/ Список ID объектов
2466 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2467 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2468 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2469 }
2470
2471 Ответ:
2472
2473 [
2474 {
2475 "vehicleId": 0, ~/~/ ID объекта
2476 "name": "string", ~/~/ Имя ТС
2477 "periods": [ ~/~/ Периоды
2478 {
2479 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2480 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2481 "mileage": 0, ~/~/ Пробег за период, километры
2482 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2483 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2484 "motohours": 0, ~/~/ Моточасы за период, секунды
2485 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2486 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2487 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2488
2489 }
2490 ]
2491 }
2492 ]
2493
2494 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2495
2496 (% class="box infomessage" %)
2497 (((
2498 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2499 )))
2500
2501 (% style="color:#000000" %)Метод запроса: **POST**
2502
2503 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2504
2505 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2506
2507 (% style="text-align:left" %)
2508 Тело запроса:
2509
2510 {
2511 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2512 "vehicleIds": [0], ~/~/ Список ID объектов
2513 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2514 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2515 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2516 }
2517
2518 Ответ:
2519
2520 [
2521 {
2522 "vehicleId": 0, ~/~/ ID объекта
2523 "name": "string", ~/~/ Имя ТС
2524 "periods": [ ~/~/ Периоды
2525 {
2526 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2527 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2528 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2529 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2530 "fuelConsumption": 0, ~/~/ Расход топлива
2531 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2532 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2533
2534 }
2535 ]
2536 }
2537 ]
2538
2539 (% class="box warningmessage" %)
2540 (((
2541 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2542 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2543 )))
2544
2545 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2546
2547 (% class="box infomessage" %)
2548 (((
2549 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2550 )))
2551
2552 (% style="color:#000000" %)Метод запроса: **POST**
2553
2554 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2555
2556 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2557
2558 (% style="text-align:left" %)
2559 Тело запроса:
2560
2561 {
2562 "vehicleIds": [0], ~/~/ Список ID объектов
2563 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2564 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2565 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2566 }
2567
2568 Ответ:
2569
2570 [
2571 {
2572 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2573 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2574 "vehicleId": 0, ~/~/ ID объекта
2575 "name": "string", ~/~/ Имя объекта
2576 "model": "string", ~/~/ Модель объекта
2577 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2578 {
2579 "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
2580
2581 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2582 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2583 "valueFuel": 0, ~/~/ Количество
2584 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2585 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2586 }
2587 ]
2588 }
2589 ]
2590
2591
2592 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2593
2594 (% class="box infomessage" %)
2595 (((
2596 **POST /api/v3/vehicles/moveStop**
2597 )))
2598
2599 Метод запроса: **POST**
2600
2601 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2602
2603 В заголовках запроса: X-Auth: Токен авторизации
2604
2605
2606 Тело запроса:
2607
2608 {
2609 "vehicleIds": [ ], ~/~/ Список ID объектов
2610 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2611 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2612 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2613 }
2614
2615 Ответ:
2616
2617 [ 
2618 {
2619 "vehicleId": 0, ~/~/ ID объекта
2620 "vehicleName": "string", ~/~/ Имя объекта
2621 "moves": [ ~/~/ Событие движения
2622 {
2623 "mileage": 0, ~/~/ Пробег, км
2624 "eventId": 0, ~/~/ Идентификатор события
2625 "eventName": "string", ~/~/ Название события
2626 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2627 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2628 "duration": 0 ~/~/ Продолжительность события, секунд
2629 }
2630 ],
2631 "stops": [ ~/~/ События стоянок
2632 {
2633 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2634 "eventId": 0, ~/~/ Идентификатор события
2635 "eventName": "string", ~/~/ Название события
2636 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2637 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2638 "duration": 0 ~/~/ Продолжительность события, секунд
2639 }
2640 ]
2641 }
2642 ]
2643
2644
2645 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2646
2647 (% class="box infomessage" %)
2648 (((
2649 **POST /api/v3/vehicles/getlastdata**
2650 )))
2651
2652 Метод запроса: **POST**
2653
2654 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2655
2656 В заголовках запроса: X-Auth: Токен авторизации
2657
2658
2659 В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2660
2661 Ответ:
2662 {
2663 "vehicleId": 0, ~/~/Идентификатор объекта.
2664 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2665 "vehicleNumber": "string",~/~/Номер объекта.
2666 "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2667 "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2668 "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2669 "speed": 0,~/~/Скорость объекта.
2670 "course": 0,~/~/Курс движения [0;360]
2671 "latitude": 0,~/~/Широта [-90°;90°].
2672 "longitude": 0,~/~/Долгота [-180°;180°].
2673 "address": "string",~/~/Адрес.
2674 "geozones": [ ~/~/Сведения по геозонам.
2675 {
2676 "id": 0,
2677 "name": "string"
2678 }
2679
2680
2681 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2682
2683 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2684
2685 (% class="box infomessage" %)
2686 (((
2687 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2688 )))
2689
2690 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2691
2692 (% style="color:#000000" %)Метод запроса: **POST**
2693
2694 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2695
2696 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2697
2698 (% style="text-align:left" %)
2699 Тело запроса:
2700
2701 (% style="text-align:left" %)
2702 {
2703 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2704 }
2705
2706 (% style="text-align:left" %)
2707 Ответ:
2708
2709 [
2710 {
2711 "id": 0, ~/~/ Идентификатор объекта геозоны
2712 "name": "string", ~/~/ Название объекта геозоны
2713 "type": 0, ~/~/ Тип объекта геозоны
2714 "fname": "string", ~/~/ Имя файла
2715 "parentId": "string", ~/~/ Идентификатор клиента
2716 "radius": 0, ~/~/ Радиус геообъекта
2717 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2718 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2719 "description": "string", ~/~/ Описание
2720 "area": 0, ~/~/ Площадь, м^^2^^
2721 "perimetr": 0, ~/~/ Периметр, м
2722 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2723 }
2724 ]
2725
2726 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2727
2728 (% class="box infomessage" %)
2729 (((
2730 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2731 )))
2732
2733 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2734
2735 (% style="color:#000000" %)Метод запроса: **POST**
2736
2737 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2738
2739 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2740
2741 (% style="text-align:left" %)
2742 Тело запроса:
2743
2744 {
2745 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2746 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2747 "ids": [ ], ~/~/ Массив id объектов
2748 "byTime": 0, ~/~/ Объединение событий по времени 
2749 "byDist": 0, ~/~/ Объединение событий по расстоянию
2750 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2751 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2752 }
2753
2754 Ответ:
2755 [
2756 {
2757 "geozoneId": 0, ~/~/ ID геообъекта
2758 "geozoneName": "string", ~/~/ Название геообъекта
2759 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2760 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2761 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2762 "vehicleId": 0, ~/~/ ID объекта
2763 "vehicleName": "string" ~/~/ Имя объекта
2764 }
2765 ]
2766
2767 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2768
2769 (% class="box infomessage" %)
2770 (((
2771 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2772 )))
2773
2774 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2775
2776 (% style="color:#000000" %)Метод запроса: **POST**
2777
2778 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2779
2780 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2781
2782 (% style="text-align:left" %)
2783 Тело запроса:
2784
2785 {
2786 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2787 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2788 "ids": [ ], ~/~/ Массив id геообъектов
2789 "byTime": 0, ~/~/ Объединение событий по времени 
2790 "byDist": 0, ~/~/ Объединение событий по расстоянию
2791 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2792 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2793 }
2794
2795 Ответ:
2796
2797 [
2798 {
2799 "geozoneId": 0, ~/~/ ID геообъекта
2800 "geozoneName": "string", ~/~/ Название геообъекта
2801 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2802 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2803 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2804 "vehicleId": 0, ~/~/ ID объекта
2805 "vehicleName": "string" ~/~/ Имя объекта
2806 }
2807 ]
2808
2809 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2810
2811 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2812
2813 (% class="box infomessage" %)
2814 (((
2815 **POST /api/v3/notifications/find**
2816 )))
2817
2818 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2819
2820 (% style="text-align: left;" %)
2821 Метод запроса **POST**
2822
2823 (% style="text-align: left;" %)
2824 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2825
2826 (% style="text-align: left;" %)
2827 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2828
2829 {
2830 "parentId": "" ~/~/ id клиента
2831 }
2832
2833 Ответ:
2834
2835 [
2836 {
2837 "id": 0, ~/~/ ID уведомления
2838 "name": "string", ~/~/ Название уведомления
2839 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2840 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2841 "userId": "", ~/~/ Пользователь, создавший уведомление
2842 "parentId": "", ~/~/ Идентификатор клиента
2843 "parentName": "string" ~/~/ Имя клиента
2844 }
2845 ]
2846
2847 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2848
2849 (% class="box infomessage" %)
2850 (((
2851 **GET /api/v3/notifications/{id}**
2852 )))
2853
2854 Метод возвращает данные правил формирования выбранного уведомления.
2855
2856 (% style="text-align: left;" %)
2857 Метод запроса **GET**
2858
2859 (% style="text-align: left;" %)
2860 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2861
2862 (% style="text-align: left;" %)
2863 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2864
2865 (% style="text-align: left;" %)
2866 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2867
2868 (% style="text-align: left;" %)
2869 (% style="color:#000000" %)Ответ:
2870
2871 (% style="text-align: left;" %)
2872 (% style="color:#000000" %){
2873 "id": 0, ~/~/ (%%)id уведомления
2874 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2875 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2876 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2877 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2878 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2879 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2880 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2881 (% style="color:#000000" %) 0
2882 ],
2883 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2884 (% style="color:#000000" %) 0
2885 ],
2886 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2887 (% style="color:#000000" %) 0
2888 ],
2889 "settings": { ~/~/ Список параметров уведомления
2890 "additionalProp1": "string",
2891 "additionalProp2": "string",
2892 "additionalProp3": "string"
2893 },
2894 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2895 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2896 (% style="color:#000000" %) ""
2897 ],
2898 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2899 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2900 (% style="color:#000000" %) "string"
2901 ],
2902 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2903 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2904 (% style="color:#000000" %) {
2905 "id": 0, ~/~/ (%%)Идентификатор участника чата
2906 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2907 (% style="color:#000000" %) }
2908 ],
2909 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2910 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2911 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2912 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2913 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2914 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2915 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2916 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2917 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2918 (% style="color:#000000" %)}
2919
2920 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2921
2922 (% class="box warningmessage" %)
2923 (((
2924 **PUT /api/v3/notifications/**
2925 )))
2926
2927 Метод позволяет отредактировать уведомление.
2928
2929 Метод запроса **PUT**
2930
2931 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2932
2933 В заголовках запроса: X-Auth: Токен авторизации
2934
2935 Тело запроса:
2936 {
2937 "id": 0, ~/~/ id уведомления
2938 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2939 "userId": "", ~/~/ Пользователь, создавший уведомление
2940 "parentId": "", ~/~/ Идентификатор клиента
2941 "parentName": "string", ~/~/ Имя клиента
2942 "name": "string", ~/~/ Название уведомления
2943 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2944 "vehicleIds": [ ~/~/ Список id объектов для анализа
2945 0
2946 ],
2947 "geoids": [ ~/~/ Список id геообъектов для анализа
2948 0
2949 ],
2950 "fieldids": [ ~/~/ Список id полей для анализа
2951 0
2952 ],
2953 "settings": { ~/~/ Список параметров уведомления
2954 "additionalProp1": "string",
2955 "additionalProp2": "string",
2956 "additionalProp3": "string"
2957 },
2958 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2959 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2960 ""
2961 ],
2962 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2963 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2964 "string"
2965 ],
2966 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2967 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2968 {
2969 "id": 0, ~/~/ Идентификатор участника чата
2970 "info": "string" ~/~/ Дополнительные сведения
2971 }
2972 ],
2973 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2974 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2975 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2976 "kind": 0, ~/~/ Определяет вид уведомления
2977 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2978 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2979 "timezone": 0, ~/~/ Сдвиг часового пояса
2980 "validity": 0, ~/~/ Срок действия в днях (1-90)
2981 "autoProlongation": true ~/~/ Автопродление срока действия
2982 }
2983
2984 Ответ:
2985
2986 Success
2987
2988
2989 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2990
2991 (% class="box warningmessage" %)
2992 (((
2993 **PUT** /api/v3/notifications/prolongation
2994 )))
2995
2996 Метод позволяет продлить уведомления.
2997
2998 Метод запроса **PUT**
2999
3000 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
3001
3002 В заголовках запроса: X-Auth: Токен авторизации.
3003
3004 Тело запроса:
3005
3006 [
3007
3008 0
3009
3010 ]
3011
3012 где 0 идентификатор ids.
3013
3014 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
3015
3016 (% class="box errormessage" %)
3017 (((
3018 **DELETE /api/v3/notifications/{id}**
3019 )))
3020
3021 Метод позволяет удалить выбранное уведомление.
3022
3023 Метод запроса **DELETE**
3024
3025 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3026
3027 Передаваемый параметр: {id} - id уведомления
3028
3029 В заголовках запроса: X-Auth: Токен авторизации
3030
3031 Ответ:
3032
3033 Success
3034
3035
3036 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3037
3038 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3039
3040 (% class="box infomessage" %)
3041 (((
3042 **POST /api/v3/Drivers/find**
3043 )))
3044
3045 Передается параметр: parentId - ID клиента-родителя
3046
3047 Ответ:
3048
3049 [
3050 {
3051 "name": "string", ~/~/ Определяет наименование
3052 "description": "string", ~/~/ Определяет описание
3053 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3054 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3055 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3056 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3057 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3058 "deleted": true ~/~/ Признак удаления
3059 }
3060 ]
3061
3062 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3063
3064 (% class="box infomessage" %)
3065 (((
3066 **GET /api/v3/Drivers/{driverGuid}**
3067 )))
3068
3069 Передается параметр: ID водителя
3070
3071 Ответ:
3072
3073 {
3074 "name": "string", ~/~/ Определяет наименование
3075 "description": "string", ~/~/ Определяет описание
3076 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3077 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3078 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3079 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3080 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3081 "deleted": true ~/~/ Признак удаления
3082 }
3083
3084 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3085
3086 (% class="box successmessage" %)
3087 (((
3088 **POST /api/v3/Drivers**
3089 )))
3090
3091 Запрос:
3092
3093 {
3094 "name": "string",
3095 "description": "string",
3096 "hiredate": "2023-06-30T12:50:54.020Z",
3097 "chopdate": "2023-06-30T12:50:54.020Z",
3098 "exclusive": true,
3099 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3100 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3101 "deleted": true
3102 }
3103
3104 Ответ:
3105
3106 {
3107 "name": "string",
3108 "description": "string",
3109 "hiredate": "2023-06-30T12:50:54.051Z",
3110 "chopdate": "2023-06-30T12:50:54.051Z",
3111 "exclusive": true,
3112 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3113 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3114 "deleted": true
3115 }
3116
3117
3118 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3119
3120 (% class="box warningmessage" %)
3121 (((
3122 **PUT /api/v3/Drivers**
3123 )))
3124
3125 Запрос:
3126
3127 {
3128 "name": "string",
3129 "description": "string",
3130 "hiredate": "2023-06-30T12:50:27.910Z",
3131 "chopdate": "2023-06-30T12:50:27.910Z",
3132 "exclusive": true,
3133 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3134 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3135 "deleted": true
3136 }
3137
3138 Ответ:
3139
3140 {
3141 "name": "string",
3142 "description": "string",
3143 "hiredate": "2023-06-30T12:50:27.929Z",
3144 "chopdate": "2023-06-30T12:50:27.929Z",
3145 "exclusive": true,
3146 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3147 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3148 "deleted": true
3149 }
3150
3151
3152 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3153
3154 (% class="box errormessage" %)
3155 (((
3156 **DELETE /api/v3/Drivers/{driverGuid}**
3157 )))
3158
3159 Передается параметр: ID водителя
3160
3161 Ответ:
3162
3163 Success
3164
3165
3166 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
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/DriversVehiclesAssignments/GetByDrivers**
3175 )))
3176
3177 Запрос:
3178
3179 {
3180 "Ids": [
3181 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3182 ],
3183 "BeginTime": "2023-06-30T12:49:04.365Z",
3184 "EndTime": "2023-06-30T12:49:04.365Z"
3185 }
3186
3187 Ответ:
3188
3189 [
3190 {
3191 "VehicleId": 0,
3192 "CreateTime": "2023-06-30T09:52:31.240Z",
3193 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3194 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3195 "BeginTime": "2023-06-30T09:52:31.240Z",
3196 "EndTime": "2023-06-30T09:52:31.240Z"
3197 }
3198 ]
3199
3200
3201 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3202
3203 (% class="box infomessage" %)
3204 (((
3205 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3206 )))
3207
3208 Запрос:
3209
3210 {
3211 "Ids": [
3212 0
3213 ],
3214 "BeginTime": "2023-06-30T12:48:39.419Z",
3215 "EndTime": "2023-06-30T12:48:39.419Z"
3216 }
3217
3218 Ответ:
3219
3220 [
3221 {
3222 "VehicleId": 0,
3223 "CreateTime": "2023-06-30T09:54:01.631Z",
3224 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3225 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3226 "BeginTime": "2023-06-30T09:54:01.631Z",
3227 "EndTime": "2023-06-30T09:54:01.631Z"
3228 }
3229 ]
3230
3231
3232 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3233
3234 (% class="box successmessage" %)
3235 (((
3236 **POST /api/v3/DriversVehiclesAssignments**
3237 )))
3238
3239 Передается массив назначений
3240
3241 Запрос:
3242
3243 [
3244 {
3245 "VehicleId": 0, ~/~/ Идентификатор объекта
3246 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3247 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3248 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3249 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3250 }
3251 ]
3252
3253 Ответ:
3254
3255 [
3256 {
3257 "VehicleId": 0,
3258 "CreateTime": "2023-06-30T11:04:46.903Z",
3259 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3260 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3261 "BeginTime": "2023-06-30T11:04:46.903Z",
3262 "EndTime": "2023-06-30T11:04:46.903Z"
3263 }
3264 ]
3265
3266
3267 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3268
3269 (% class="box warningmessage" %)
3270 (((
3271 **PUT /api/v3/DriversVehiclesAssignments**
3272 )))
3273
3274 Запрос:
3275
3276 [
3277 {
3278 "VehicleId": 0,
3279 "CreateTime": "2023-06-30T11:14:08.117Z",
3280 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3281 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3282 "BeginTime": "2023-06-30T11:14:08.117Z",
3283 "EndTime": "2023-06-30T11:14:08.117Z"
3284 }
3285 ]
3286
3287 Ответ:
3288
3289 [
3290 {
3291 "VehicleId": 0,
3292 "CreateTime": "2023-06-30T11:14:53.349Z",
3293 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3294 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3295 "BeginTime": "2023-06-30T11:14:53.349Z",
3296 "EndTime": "2023-06-30T11:14:53.349Z"
3297 }
3298 ]
3299
3300
3301 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3302
3303 (% class="box errormessage" %)
3304 (((
3305 **DELETE /api/v3/DriversVehiclesAssignments**
3306 )))
3307
3308 Запрос:
3309
3310 [
3311 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3312 ]
3313
3314 Ответ:
3315
3316 Success
3317
3318
3319 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3320
3321 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3322
3323 (% class="box infomessage" %)
3324 (((
3325 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3326 )))
3327
3328 Запрос:
3329
3330 {
3331 "Ids": [
3332 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3333 ],
3334 "BeginTime": "2023-06-30T12:47:12.162Z",
3335 "EndTime": "2023-06-30T12:47:12.162Z"
3336 }
3337
3338 Ответ:
3339
3340 [
3341 {
3342 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3343 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3344 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3345 "BeginTime": "2023-06-30T11:19:40.703Z",
3346 "EndTime": "2023-06-30T11:19:40.703Z"
3347 }
3348 ]
3349
3350
3351 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3352
3353 (% class="box infomessage" %)
3354 (((
3355 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3356 )))
3357
3358 Запрос:
3359
3360 {
3361 "Ids": [
3362 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3363 ],
3364 "BeginTime": "2023-06-30T12:47:12.162Z",
3365 "EndTime": "2023-06-30T12:47:12.162Z"
3366 }
3367
3368 Ответ:
3369
3370 [
3371 {
3372 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3373 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3374 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3375 "BeginTime": "2023-06-30T11:19:40.703Z",
3376 "EndTime": "2023-06-30T11:19:40.703Z"
3377 }
3378 ]
3379
3380
3381 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3382
3383 (% class="box successmessage" %)
3384 (((
3385 **POST /api/v3/DriversRfidsAssignments**
3386 )))
3387
3388 Запрос:
3389
3390 [
3391 {
3392 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3393 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3394 "BeginTime": "2023-06-30T11:27:08.635Z",
3395 "EndTime": "2023-06-30T11:27:08.635Z"
3396 }
3397 ]
3398
3399 Ответ:
3400
3401 [
3402 {
3403 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3404 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3405 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3406 "BeginTime": "2023-06-30T11:27:08.677Z",
3407 "EndTime": "2023-06-30T11:27:08.677Z"
3408 }
3409 ]
3410
3411
3412 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3413
3414 (% class="box warningmessage" %)
3415 (((
3416 **PUT /api/v3/DriversRfidsAssignments**
3417 )))
3418
3419 Запрос:
3420
3421 [
3422 {
3423 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3424 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3425 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3426 "BeginTime": "2023-06-30T11:28:43.330Z",
3427 "EndTime": "2023-06-30T11:28:43.330Z"
3428 }
3429 ]
3430
3431 Ответ:
3432
3433 [
3434 {
3435 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3436 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3437 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3438 "BeginTime": "2023-06-30T11:28:43.331Z",
3439 "EndTime": "2023-06-30T11:28:43.331Z"
3440 }
3441 ]
3442
3443
3444 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3445
3446 (% class="box errormessage" %)
3447 (((
3448 **DELETE /api/v3/DriversRfidsAssignments**
3449 )))
3450
3451 Запрос:
3452
3453 [
3454 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3455 ]
3456
3457 Ответ:
3458
3459 Success
3460
3461
3462 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3463
3464 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3465
3466 (% class="box infomessage" %)
3467 (((
3468 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3469 )))
3470
3471 Запрос:
3472
3473 {
3474 "Ids": [
3475 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3476 ],
3477 "BeginTime": "2023-06-30T12:45:10.852Z",
3478 "EndTime": "2023-06-30T12:45:10.852Z"
3479 }
3480
3481 Ответ:
3482
3483 [
3484 {
3485 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3486 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3487 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3488 "BeginTime": "2023-06-30T11:58:04.695Z",
3489 "EndTime": "2023-06-30T11:58:04.695Z"
3490 }
3491 ]
3492
3493
3494 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3495
3496 (% class="box infomessage" %)
3497 (((
3498 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3499 )))
3500
3501 Запрос:
3502
3503 {
3504 "Ids": [
3505 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3506 ],
3507 "BeginTime": "2023-06-30T12:45:10.852Z",
3508 "EndTime": "2023-06-30T12:45:10.852Z"
3509 }
3510
3511 Ответ:
3512
3513 [
3514 {
3515 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3516 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3517 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3518 "BeginTime": "2023-06-30T11:58:04.695Z",
3519 "EndTime": "2023-06-30T11:58:04.695Z"
3520 }
3521 ]
3522
3523
3524 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3525
3526 (% class="box successmessage" %)
3527 (((
3528 **POST /api/v3/DriversFuelCardsAssignments**
3529 )))
3530
3531 Запрос:
3532
3533 [
3534 {
3535 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3536 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3537 "BeginTime": "2023-06-30T12:09:53.175Z",
3538 "EndTime": "2023-06-30T12:09:53.175Z"
3539 }
3540 ]
3541
3542 Ответ:
3543
3544 [
3545 {
3546 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3547 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3548 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3549 "BeginTime": "2023-06-30T12:09:53.201Z",
3550 "EndTime": "2023-06-30T12:09:53.201Z"
3551 }
3552 ]
3553
3554
3555 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3556
3557 (% class="box warningmessage" %)
3558 (((
3559 **PUT /api/v3/DriversFuelCardsAssignments**
3560 )))
3561
3562 Запрос:
3563
3564 [
3565 {
3566 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3567 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3568 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3569 "BeginTime": "2023-06-30T12:09:53.201Z",
3570 "EndTime": "2023-06-30T12:09:53.201Z"
3571 }
3572 ]
3573
3574 Ответ:
3575
3576 [
3577 {
3578 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3579 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3580 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3581 "BeginTime": "2023-06-30T12:09:53.201Z",
3582 "EndTime": "2023-06-30T12:09:53.201Z"
3583 }
3584 ]
3585
3586
3587 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3588
3589 (% class="box errormessage" %)
3590 (((
3591 **DELETE /api/v3/DriversFuelCardsAssignments**
3592 )))
3593
3594 Запрос:
3595
3596 [
3597 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3598 ]
3599
3600 Ответ:
3601
3602 Success
3603
3604
3605 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3606
3607 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3608
3609 (% class="box infomessage" %)
3610 (((
3611 **POST /api/v3/Trailers**
3612 )))
3613
3614 Пример запроса:
3615
3616 {
3617 "startDate": "2023-11-14T10:48:03.671Z",
3618 "endDate": "2023-11-14T10:48:03.671Z",
3619 "ids": [ 0 ],
3620 "timezone": 0
3621 }
3622
3623 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3624 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3625 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3626 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3627 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3628
3629 Пример ответа:
3630
3631 [
3632 {
3633 "SD": "2023-11-14T10:48:03.717Z",
3634 "ED": "2023-11-14T10:48:03.717Z", 
3635 "id": 0,
3636 "SLat": 0,
3637 "SLon": 0,
3638 "ELat": 0,
3639 "ELon": 0,
3640 "mileage": 0
3641 "Duration": 0
3642 "Address": "string",
3643 "Address2": "string",
3644 "name": "string",
3645 "rid": "string",
3646 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3647 "trailer": {
3648 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3649 "Number": "string",
3650 "Description": "string",
3651 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3652 "ExternalID": "string",
3653 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3654 "CreateTime": "2023-11-14T10:48:03.717Z",
3655 "UpdateTime": "2023-11-14T10:48:03.717Z",
3656 "IsDeleted": true
3657 },
3658 "filesCount": 0,
3659 }
3660 ]
3661
3662 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3663 |SD|Дата и время начала события
3664 |ED|Дата и время окончания события
3665 |id|ID объекта
3666 |SLat|Широта начальной координаты
3667 |SLon|Долгота начальной координаты
3668 |ELat|Широта конечной координаты
3669 |ELon|Долгота конечной координаты
3670 |mileage|Пробег
3671 |Duration|Продолжительность
3672 |Address|Адрес начального местоположения
3673 |Address2|Адрес конечного местоположения
3674 |name|Имя радиометки
3675 |rid|Номер радиометки
3676 |rguid|ID радиометки
3677 |trailer|Информация об агрегате
3678 |ModelGuid|ID агрегата
3679 |Number|Название/номер агрегата
3680 |Description|Текст примечания агрегата
3681
3682 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3683
3684 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3685
3686 (% class="box infomessage" %)
3687 (((
3688 **POST /api/v3/Rfids/find**
3689 )))
3690
3691 Запрос:
3692
3693 {
3694 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3695 }
3696
3697 Ответ:
3698
3699 [
3700 {
3701 "name": "string",
3702 "number": 0,
3703 "period": 0,
3704 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3705 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3706 }
3707 ]
3708
3709 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3710 |parentId|ID клиента
3711 |name|Название карты-метки
3712 |number|Номер
3713 |period|Период запросов в секундах (работает только для агрегатов)
3714 |id|ID карты-метки
3715
3716 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3717
3718 (% class="box infomessage" %)
3719 (((
3720 **GET /api/v3/Rfids/{rfidGuid}**
3721 )))
3722
3723 Передаем параметр rfidGuid - идентификатор карты-метки
3724
3725 Ответ:
3726
3727 [
3728 {
3729 "name": "string",
3730 "number": 0,
3731 "period": 0,
3732 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3733 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3734 }
3735 ]
3736
3737 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3738 |name|Название карты-метки
3739 |number|Номер
3740 |period|Период запросов в секундах (работает только для агрегатов)
3741 |id|ID карты-метки
3742 |parentId|ID клиента
3743
3744 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3745
3746 (% class="box successmessage" %)
3747 (((
3748 **POST /api/v3/Rfids**
3749 )))
3750
3751 Запрос:
3752
3753 {
3754 "name": "string",
3755 "number": 0,
3756 "period": 0,
3757 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3758 }
3759
3760 Ответ:
3761
3762 {
3763 "name": "string",
3764 "number": 0,
3765 "period": 0,
3766 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3767 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3768 }
3769
3770 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3771 |name|Название карты-метки
3772 |number|Номер
3773 |period|Период запросов в секундах (работает только для агрегатов)
3774 |id|ID карты-метки
3775 |parentId|ID клиента
3776
3777 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3778
3779 (% class="box warningmessage" %)
3780 (((
3781 **PUT /api/v3/Rfids**
3782 )))
3783
3784 Запрос:
3785
3786 {
3787 "name": "string",
3788 "number": 0,
3789 "period": 0,
3790 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3791 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3792 }
3793
3794 Ответ:
3795
3796 {
3797 "name": "string",
3798 "number": 0,
3799 "period": 0,
3800 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3801 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3802 }
3803
3804 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3805 |name|Название карты-метки
3806 |number|Номер
3807 |period|Период запросов в секундах (работает только для агрегатов)
3808 |id|ID карты-метки
3809 |parentId|ID клиента
3810
3811 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3812
3813 (% class="box errormessage" %)
3814 (((
3815 **DELETE /api/v3/Rfids/{rfidGuid}**
3816 )))
3817
3818 Передаем параметр **rfidGuid** - идентификатор карты-метки
3819
3820 Ответ:
3821
3822 Success
3823
3824
3825 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3826
3827 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3828
3829 (% class="box infomessage" %)
3830 (((
3831 **GET /api/v3/Billing/client/balance/{clientId}**
3832 )))
3833
3834 Параметр запроса: **clientId **- идентификатор клиента.
3835
3836 Ответ:
3837
3838 {
3839 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3840 "Balance": 0
3841 }
3842
3843 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3844 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3845 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3846
3847 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3848
3849 (% class="box infomessage" %)
3850 (((
3851 **GET /api/v3/Billing/client/constraint/{clientId}**
3852 )))
3853
3854 Параметр запроса: **clientId **- идентификатор клиента.
3855
3856 Ответ:
3857
3858 {
3859 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3860 "CalculationType": 0,
3861 "PermissibleBalance": 0,
3862 "DefermentDays": 0,
3863 "SendUiNotifications": true,
3864 "SendEmailNotifications": true,
3865 "IsPrivate": true,
3866 }
3867
3868 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3869 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3870 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3871 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3872 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3873 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3874 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3875 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3876
3877 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3878
3879 (% class="box infomessage" %)
3880 (((
3881 **GET /api/v3/Billing/client/plan/{clientId}**
3882 )))
3883
3884 Параметры запроса:
3885
3886 **clientId **- идентификатор клиента.
3887
3888 **planId **- идентификатор тарифного плана.
3889
3890 Ответ:
3891
3892 {
3893 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3894 "Plan": { **~/~/ Описание тарифного плана**
3895 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3896 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3897 "Name": "string",
3898 "IsArchived": true,
3899 "Constraint": {
3900 "CalculationType": 0,
3901 "PermissibleBalance": 0,
3902 "DefermentDays": 0
3903 },
3904 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3905 {
3906 "Feature": "string",
3907 "IsFactual": true,
3908 "Limit": 0,
3909 "Price": 0,
3910 "PeriodValue": 0,
3911 "PeriodType": 0
3912 }
3913 ]
3914 },
3915 "DebitDate": "2023-10-18T12:46:24.213Z",
3916 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3917 {
3918 "Feature": "string",
3919 "IsEnabled": true,
3920 "IsPrivate": true,
3921 "IsFactual": true,
3922 "Limit": 0,
3923 "Price": 0,
3924 "DebitDate": "2023-10-18T12:46:24.213Z",
3925 "PeriodValue": 0,
3926 "PeriodType": 0
3927 }
3928 ]
3929 }
3930
3931 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3932 |ClientId|Идентификатор клиента
3933 |Id|Идентификатор тарифного плана
3934 |OwnerId|Идентификатор клиента-владельца
3935 |Name|Наименование тарифного плана
3936 |IsArchived|Признак, определяющий архивный тарифный план
3937 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3938 |PermissibleBalance|Допустимый баланс
3939 |DefermentDays|Отсрочка, количество дней
3940 |Feature|Код услуги
3941 |IsEnabled|Признак, определяющий активирована ли услуга
3942 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3943 |IsFactual|Признак, определяющий расчёт по факту
3944 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3945 |Price|Цена за единицу.
3946 |DebitDate|Следующий момент времени списания с баланса за услугу.
3947 |PeriodValue|Значение периода.
3948 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3949
3950 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3951
3952 (% class="box infomessage" %)
3953 (((
3954 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3955 )))
3956
3957 Параметр запроса: **clientId **- идентификатор клиента.
3958
3959 Ответ:
3960
3961 [
3962 {
3963 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3964 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3965 "Name": "string",
3966 "IsArchived": true,
3967 "Constraint": {
3968 "CalculationType": 0,
3969 "PermissibleBalance": 0,
3970 "DefermentDays": 0
3971 },
3972 "Features": [
3973 {
3974 "Feature": "string",
3975 "IsFactual": true,
3976 "Limit": 0,
3977 "Price": 0,
3978 "PeriodValue": 0,
3979 "PeriodType": 0
3980 }
3981 ]
3982 }
3983 ]
3984
3985 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3986 |ClientId|Идентификатор клиента
3987 |Id|Идентификатор тарифного плана
3988 |OwnerId|Идентификатор клиента-владельца
3989 |Name|Наименование тарифного плана
3990 |IsArchived|Признак, определяющий архивный тарифный план
3991 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3992 |PermissibleBalance|Допустимый баланс
3993 |DefermentDays|Отсрочка, количество дней
3994 |Feature|Код услуги
3995 |IsFactual|Признак, определяющий расчёт по факту
3996 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3997 |Price|Цена за единицу.
3998 |PeriodValue|Значение периода.
3999 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4000
4001 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
4002
4003 (% class="box infomessage" %)
4004 (((
4005 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4006 )))
4007
4008 Параметр запроса: **clientId **- идентификатор клиента.
4009
4010 Ответ:
4011
4012 [
4013 {
4014 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4015 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4016 "Name": "string",
4017 "IsArchived": true,
4018 "Constraint": {
4019 "CalculationType": 0,
4020 "PermissibleBalance": 0,
4021 "DefermentDays": 0
4022 },
4023 "Features": [
4024 {
4025 "Feature": "string",
4026 "IsFactual": true,
4027 "Limit": 0,
4028 "Price": 0,
4029 "PeriodValue": 0,
4030 "PeriodType": 0
4031 }
4032 ]
4033 }
4034 ]
4035
4036 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4037 |ClientId|Идентификатор клиента
4038 |Id|Идентификатор тарифного плана
4039 |OwnerId|Идентификатор клиента-владельца
4040 |Name|Наименование тарифного плана
4041 |IsArchived|Признак, определяющий архивный тарифный план
4042 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4043 |PermissibleBalance|Допустимый баланс
4044 |DefermentDays|Отсрочка, количество дней
4045 |Feature|Код услуги
4046 |IsFactual|Признак, определяющий расчёт по факту
4047 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4048 |Price|Цена за единицу.
4049 |PeriodValue|Значение периода.
4050 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4051
4052 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4053
4054 (% class="box warningmessage" %)
4055 (((
4056 **PUT /api/v3/Billing/client/balance**
4057 )))
4058
4059 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4060
4061 Тело запроса:
4062
4063 {
4064 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4065 "Balance": 0
4066 }
4067
4068 Ответ: Success
4069
4070 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4071 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4072 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4073
4074 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4075
4076 (% class="box warningmessage" %)
4077 (((
4078 **PUT /api/v3/billing/client/balance/deposit**
4079 )))
4080
4081 Создает операцию **Пополнение **с указанной суммой
4082
4083 Тело запроса:
4084
4085 {
4086 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4087 "Balance": 0
4088 }
4089
4090 Ответ: Success
4091
4092 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4093 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4094 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4095
4096 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4097
4098 Создает операцию **Списание **с указанной суммой
4099
4100 (% class="box warningmessage" %)
4101 (((
4102 **PUT /api/v3/billing/client/balance/withdraw**
4103 )))
4104
4105 Тело запроса:
4106
4107 {
4108 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4109 "Balance": 0
4110 }
4111
4112 Ответ: Success
4113
4114 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4115 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4116 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4117
4118 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4119
4120 (% class="box warningmessage" %)
4121 (((
4122 **PUT /api/v3/Billing/client/constraint**
4123 )))
4124
4125 Тело запроса:
4126
4127 {
4128 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4129 "CalculationType": 0,
4130 "PermissibleBalance": 0,
4131 "DefermentDays": 0,
4132 "SendUiNotifications": true,
4133 "SendEmailNotifications": true,
4134 "IsPrivate": true,
4135 }
4136
4137 Ответ: Success
4138
4139 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4140 |ClientId|Идентификатор клиента
4141 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4142 |PermissibleBalance|Допустимый баланс
4143 |DefermentDays|(((
4144 Отсрочка, количество дней
4145 )))
4146 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4147 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4148 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4149
4150 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4151
4152 (% class="box warningmessage" %)
4153 (((
4154 **PUT /api/v3/Billing/client/plan**
4155 )))
4156
4157 Тело запроса:
4158
4159 {
4160 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4161 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4162 "Features": [
4163 {
4164 "Feature": "string",
4165 "IsEnabled": true,
4166 "IsFactual": true,
4167 "Limit": 0,
4168 "Price": 0,
4169 "DebitDate": "2023-10-18T13:26:58.987Z",
4170 "PeriodValue": 0,
4171 "PeriodType": 0
4172 }
4173 ]
4174 }
4175
4176 Ответ: Success
4177
4178 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4179 |ClientId|Идентификатор клиента
4180 |PlanId|Идентификатор тарифного плана
4181 |Feature|Код услуги
4182 |IsEnabled|Признак, определяющий активирована ли услуга
4183 |IsFactual|Признак, определяющий расчёт по факту
4184 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4185 |Price|Цена за единицу.
4186 |DebitDate|Следующий момент времени списания с баланса за услугу.
4187 |PeriodValue|Значение периода.
4188 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4189
4190 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4191
4192 (% class="box warningmessage" %)
4193 (((
4194 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4195 )))
4196
4197 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4198
4199 (% class="box infomessage" %)
4200 (((
4201 **POST /api/v3/vehicles/import/{agentId}**
4202 )))
4203
4204 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4205
4206 В пути указывается **agentId** - id клиента.
4207
4208 **Заголовок**
4209
4210 **X-Auth: [токен авторизации]**
4211
4212 **Параметры**
4213
4214 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4215 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4216 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4217
4218 В теле использовать тип **form-data,** тип значения** file**
4219
4220 **Ключи**
4221
4222 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4223 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4224 |csv|В значении передаем файл датчиков, формат **csv**
4225
4226 Ответ:
4227
4228 {
4229 "vehicleId": 0,
4230 "name": "string",
4231 "errors": ["string"]
4232 }
4233
4234 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4235 |vehicleId|ID созданного объекта
4236 |name|Имя созданного объекта
4237 |errors|Ошибки и их описание
4238
4239 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4240
4241 (% class="box infomessage" %)
4242 (((
4243 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4244 )))
4245
4246 (% class="wikigeneratedid" %)
4247 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4248
4249 (% class="wikigeneratedid" %)
4250 В пути указывается **vehicleId **- id объекта.
4251
4252 **Заголовок**
4253
4254 **X-Auth: [токен авторизации]**
4255
4256 В теле использовать тип **form-data.**
4257
4258 Ключи:
4259
4260 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4261 |**history**|В значении передавать файл с историей
4262
4263 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4264
4265 Ответ:
4266
4267 {
4268 "results": [
4269 {
4270 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4271 "vehicleId": 0,
4272 "errors": [
4273 "string"
4274 ],
4275 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4276 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4277 "producedCount": 0,
4278 "msgCount": 0
4279 }
4280 ]
4281 }
4282
4283 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4284 |results|Результаты импорта в разрезе ТС
4285 |vehicleGuid|Guid ТС
4286 |vehicleId|ID ТС
4287 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4288 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4289 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4290 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4291 |msgCount|Кол-во обработанных сообщений всего
4292
4293 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4294
4295 (% class="box infomessage" %)
4296 (((
4297 **GET /api/v3/vehicles/import/history/status**
4298 )))
4299
4300 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4301
4302 Ответ:
4303
4304 {
4305 "activity": true,
4306 "progress": 0,
4307 "message": "string"
4308 }
4309
4310 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4311 |activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4312 |progress|Guid ТС
4313
4314 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4315
4316 (% class="box infomessage" %)
4317 (((
4318 **POST /api/v3/vehicles/export**
4319 )))
4320
4321 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4322
4323 Тело запроса:
4324
4325 [
4326 id
4327 ]
4328
4329 Ответ: Success 200, получаете файлы с настройками.
4330
4331 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4332
4333 (% class="box infomessage" %)
4334 (((
4335 **POST /api/v3/vehicles/export/history**
4336 )))
4337
4338 Метод возвращает список сообщений терминала объекта за выбранный период.
4339
4340 Тело запроса:
4341
4342 {
4343 "vehicleId": 0,
4344 "asArchive": true,
4345 "from": "2023-09-27T12:17:45.973Z",
4346 "to": "2023-09-27T12:17:45.973Z"
4347 }
4348
4349 Ответ:
4350
4351 Получаете файл. Сообщение: Code 200/Success
4352
4353 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4354 |vehicleId|ID объекта
4355 |asArchive|true - Архивировать файл, False - не архивировать
4356 |from|Дата и время начала запроса
4357 |to|Дата и время окончания запроса
4358
4359 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4360
4361 (% class="box infomessage" %)
4362 (((
4363 **GET /api/v3/vehicles/export/history/status**
4364 )))
4365
4366 Метод возвращает список сообщений терминала объекта за выбранный период.
4367
4368 Ответ:
4369
4370 {
4371 "activity": true,
4372 "progress": 0,
4373 "message": "string"
4374 }
4375
4376 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4377 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4378 |progress|Прогресс экспорта, от 0 до 100%
4379 |message|Текст описывающий статус
4380
4381 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4382
4383 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4384
4385 (% class="box infomessage" %)
4386 (((
4387 **POST /api/v3/EcoDriving/rating**
4388 )))
4389
4390 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4391
4392 Тело запроса:
4393
4394 {
4395 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4396 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4397 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4398 }
4399
4400 Ответ:
4401
4402 {
4403 "items": [  ~/~/ Список в разрезе ТС
4404 {
4405 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4406 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4407 "vehicleId": 0, ~/~/ ID ТС
4408 "vehicleName": "string", ~/~/ Название ТС
4409 "vehicleModel": "string", ~/~/ Модель ТС
4410 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4411 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4412 "totalViolations": 0, ~/~/ Нарушений всего
4413 "violationsByType": { ~/~/ Информация о нарушениях по типу
4414 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4415 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4416 "brakingViolations": 0, ~/~/ Нарушений торможения
4417 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4418 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4419 "sensorViolations": 0 ~/~/ Нарушений по датчику
4420 },
4421
4422 (((
4423
4424 )))
4425
4426 "moveTime": 0, ~/~/ Продолжительность движения, сек
4427 "mileage": 0, ~/~/ Пробег, м
4428 "tripsCount": 0, ~/~/ Кол-во рейсов
4429 "trips": [  ~/~/ Информация по рейсу
4430 {
4431 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4432 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4433 "violationsCount": 0, ~/~/ Всего нарушений
4434 "violationsByType": { ~/~/ Информация о нарушениях по типу
4435 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4436 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4437 "brakingViolations": 0, ~/~/ Нарушений торможения
4438 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4439 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4440 "sensorViolations": 0 ~/~/ Нарушений по датчику
4441 },
4442
4443 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4444 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4445 "moveTime": 0, ~/~/ Продолжительность движения, сек
4446 "mileage": 0, ~/~/ Пробег, м
4447 "motohours": 0, ~/~/ Моточасы, секунды
4448 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4449 "startAddress": "string", ~/~/ Адрес начала рейса
4450 "endAddress": "string", ~/~/ Адрес конца рейса
4451 "drivers": [  ~/~/ Список водителей
4452 {
4453 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4454 "driverName": "string", ~/~/ФИО водителя
4455 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4456 }
4457 ]
4458 }
4459 ]
4460 }
4461 ]
4462 }
4463
4464 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4465
4466 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4467
4468 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4469
4470 (% class="box infomessage" %)
4471 (((
4472 **POST /api/v3/fuelcards/transactions**
4473 )))
4474
4475 Метод запроса: POST
4476
4477 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4478 \\В заголовках запроса: X-Auth: Токен авторизации
4479
4480 Параметры в теле запроса (JSON):
4481
4482 {
4483 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4484 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4485 "ids": [ 
4486 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4487 ],
4488 "timezone": 0 ~/~/ Часовой пояс
4489 }
4490
4491
4492 Ответ:
4493 {
4494 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4495 "driver": "string", ~/~/ Водители, привязанные к ТК
4496 "object": "string", ~/~/ Наименование ТС
4497 "amount": 0, ~/~/ Количество топлива
4498 "amountDut": 0, ~/~/ Количество по ДУТ
4499 "amountDiff": 0, ~/~/ Разница, л
4500 "amountDiffPerc": 0, ~/~/ Разница, %
4501 "summa": 0, ~/~/ Стоимость, руб
4502 "serviceName": "string", ~/~/ Тип топлива
4503 "price": 0, ~/~/ Цена за литр, руб
4504 "cardName": "string", ~/~/ Наименование ТК
4505 "cardNum": "string", ~/~/ Номер ТК
4506 "operator": "string", ~/~/ Оператор ТК
4507 "address": "string" ~/~/ Адрес АЗС
4508 }
4509
4510 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4511
4512 (% class="box infomessage" %)
4513 (((
4514 **GET /api/v3/fuelcards**
4515 )))
4516
4517 Метод запроса: GET
4518
4519 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4520
4521 Ответ:
4522
4523 [
4524 {
4525 "Name": "string", ~/~/ Определяет наименование карты.
4526 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4527 "Number": "string", ~/~/ Определяет № карты.
4528 "Enabled": true, ~/~/ Определяет признак активности карты.
4529 "Description": "string", ~/~/ Определяет описание карты.
4530 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4531 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4532 "deleted": true ~/~/ Признак удаления
4533 }
4534 ]
4535
4536 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4537
4538
4539 == **Получение полных данных о ретрансляторе** ==
4540
4541 (% class="box infomessage" %)
4542 (((
4543 **GET ** **/api/v3/retranslations/{id}**
4544 )))
4545
4546 id - Идентификатор ретранслятора
4547
4548
4549 Пример ответа:
4550
4551 {  
4552 "description": "", ~/~/ Поле описания ретранслятора
4553 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4554 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4555 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4556 "address": "string", ~/~/ Адрес и порт принимающего сервера
4557 "objects": [ ~/~/ Объекты для ретрансляции
4558 {      
4559 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4560 "name": "", ~/~/ Наименование объекта ретрансляции
4561 "imei": "", ~/~/ IMEI объекта  ретрансляции
4562 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4563 }
4564 ],  
4565 "id": "", ~/~/ Идентификатор ретранслятора 
4566 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4567 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4568 }
4569
4570
4571 == **Удаление данных ретранслятора** ==
4572
4573 (% class="box infomessage" %)
4574 (((
4575 **DELETE** **/api/v3/retranslations/{id}**
4576 )))
4577
4578 id - Идентификатор ретранслятора
4579
4580
4581 == **Создание ретранслятора** ==
4582
4583 (% class="box infomessage" %)
4584 (((
4585 **POST ** **/api/v3/retranslations/{id}**
4586 )))
4587
4588 Запрос:
4589
4590 {  
4591 "description": "", ~/~/ Поле описания ретранслятора
4592 "subscriberId": "", ~/~/ Идентификатор подписчика
4593 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4594 "address": "", ~/~/ Адрес и порт принимающего сервера
4595 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4596 "objects": [ ~/~/Объекты для ретрансляции
4597 {      
4598 "id": "", ~/~/ Идентификатор ретранслятора 
4599 "imei": "", ~/~/ IMEI объекта ретрансляции
4600 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4601 }
4602 ]
4603 }
4604
4605
4606 Ответ:
4607
4608 {  
4609 "description": "", ~/~/ Поле описания ретранслятора
4610 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4611 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4612 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4613 "address": "string", ~/~/ Адрес и порт принимающего сервера
4614 "objects": [ ~/~/ Объекты для ретрансляции
4615 {      
4616 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4617 "name": "string", ~/~/ Наименование объекта ретрансляции    
4618 "imei": "", ~/~/ IMEI объекта ретрансляции
4619 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4620 }
4621 ],
4622 "id": "", ~/~/ Идентификатор ретранслятора   
4623 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4624 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4625 }
4626
4627
4628 == **Редактирование ретранслятора** ==
4629
4630 (% class="box infomessage" %)
4631 (((
4632 **PUT** **/api/v3/retranslations**
4633 )))
4634
4635 Пример запроса:
4636
4637 {  
4638 "id": "", ~/~/ Идентификатор ретранслятора   
4639 "description": "string", ~/~/ Поле описания ретранслятора
4640 "subscriberId": "", ~/~/ Идентификатор подписчика
4641 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4642 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4643 "address": "string", ~/~/ Адрес и порт принимающего сервера
4644 "objects": ~/~/ Объекты для ретрансляции
4645 [    
4646 {      
4647 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
4648 "imei": "", ~/~/ IMEI объекта ретрансляции
4649 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4650 }
4651 ]
4652 }
4653
4654
4655 Пример ответа:
4656
4657 {  
4658 "description": "", ~/~/ Поле описания ретранслятора
4659 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4660 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4661 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4662 "address": "string", ~/~/ Адрес и порт принимающего сервера
4663 "objects": [ ~/~/ Объекты для ретрансляции
4664 {      
4665 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4666 "name": "string", ~/~/ Наименование объекта ретрансляции    
4667 "imei": "", ~/~/ IMEI объекта ретрансляции
4668 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4669 }
4670 ],
4671 "id": "", ~/~/ Идентификатор ретранслятора   
4672 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4673 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4674 }
4675
4676
4677 == **Получение списка ретранслятора клиента** ==
4678
4679 (% class="box infomessage" %)
4680 (((
4681 **POST /api/v3/retranslations/find**
4682 )))
4683
4684 Пример запроса:
4685
4686 {  
4687 "id": "", ~/~/ Идентификатор ретранслятора   
4688 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4689 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4690 }
4691
4692 Ответ:
4693
4694 [ 
4695 {    
4696 "description": "", ~/~/ Поле описания ретранслятора
4697 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4698 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4699 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4700 "address": "string", ~/~/ Адрес и порт принимающего сервера
4701 "id": "", ~/~/ Идентификатор ретранслятора   
4702 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4703 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4704 }
4705 ]
4706
4707
4708 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4709
4710 == **API для отчета по выгрузке комбайнов** ==
4711
4712 (% class="box infomessage" %)
4713 (((
4714 **POST /api/v3/Reports/harvesterUnloading**
4715 )))
4716
4717 Пример запроса:
4718
4719 {
4720 "byTime": 0, ~/~/ Объединение событий по времени
4721 "byDist": 0, ~/~/ Объединение событий по расстоянию
4722 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4723 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4724 "showNearestObjects": true, ~/~/Показывать объекты рядом?
4725 "vehicleIds": [ ~/~/ Список id объектов для анализа
4726 0
4727 ],
4728 "from": "", ~/~/ Дата и время начало запроса
4729 "to": "", ~/~/ Дата и время окончания запроса
4730 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4731 }
4732
4733 Пример ответа:
4734
4735 [ 
4736 {
4737 "harvesterName": "", ~/~/Комбайн, номер
4738 "harvesterId": 0, ~/~/Комбайн, id
4739 "harvesterModel": "", ~/~/ Модель комбайна
4740 "hopperCapacity": 0, ~/~/ Объем бункера м3
4741 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4742 "events": [ ~/~/Список событий в разрезе комбайна
4743 {
4744 "driverId": "", ~/~/Идентификатор водителя
4745 "driverName": "", ~/~/Водитель комбайна, ФИО
4746 "RFID": "", ~/~/ идентификатор карты-метки
4747 "rfidName": "", ~/~/Водитель комбайна, имя метки
4748 "vehicleId": 0, ~/~/идентификатор объекта
4749 "vehicleName": "string", ~/~/ Имя объекта
4750 "modelName": "string", ~/~/ Имя модели объекта
4751 "nearestVehicles": [ ~/~/Объекты рядом
4752 {
4753 "vehicleId": 0, ~/~/идентификатор объекта
4754 "vehicleName": "string" ~/~/ Имя объекта
4755 }
4756 ],
4757 "fields": [ ~/~/Поля, где происходила выгрузка
4758 {
4759 "id": 0, ~/~/ идентификатор пользователя 
4760 "name": "string" ~/~/ имя пользователя 
4761 }
4762 ],
4763 "event": "string", ~/~/Событие
4764 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4765 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4766 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4767 "cultureName": "string", ~/~/ название культуры
4768 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4769 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4770 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4771 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4772 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4773 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4774 "issued": 0, ~/~/Выдано, бункеров
4775 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4776 "latitude": 0, ~/~/Широта
4777 "longitude": 0, ~/~/ Долгота
4778 "litresAway": 0, ~/~/Отдано, л
4779 "m3Away": 0 ~/~/Отдано, м3
4780 }
4781 ]
4782 }
4783 ]
4784
4785
4786 == **Отчет трек-датчики** ==
4787
4788 (% class="box infomessage" %)
4789 (((
4790 **POST /api/v3/Reports/sensorsWorks**
4791 )))
4792
4793 **Пример запроса:**
4794
4795 {
4796 "vehicleIds": [ ~/~/ Список ID объектов
4797 0
4798 ],
4799 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4800 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4801 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4802 }
4803
4804 **Пример ответа:**
4805
4806 (((
4807 {
4808 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4809 {
4810 "vehicleId": 0, ~/~/ Идентификатор ТС
4811 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4812 {
4813 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4814 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4815 "duration": 0, ~/~/  Продолжительность интервала в секундах.
4816 "name": "string", ~/~/ Наименование оборудования.
4817 "mileage": 0, ~/~/ Пробег за время работы оборудования.
4818 "totalMileage": 0, ~/~/ Общий пробег.
4819 "avgSpeed": 0 ~/~/ Средняя скорость.
4820 }
4821 ]
4822 }
4823 ]
4824 }
4825 )))
4826
4827 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4828
4829
4830 == **Запрос списка полей** ==
4831
4832 (% class="box successmessage" %)
4833 (((
4834 **POST /api/v3/agroLands/find**
4835 )))
4836
4837 Пример запроса:
4838
4839 (((
4840 (((
4841 (((
4842 {
4843 "year": 0, ~/~/ Фильтр по году
4844 "name": "string", ~/~/ Фильтр по названию
4845 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4846 }
4847 )))
4848 )))
4849
4850
4851 )))
4852
4853 Пример ответа:
4854
4855 (((
4856 [
4857 {
4858 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4859 "year": 0, ~/~/ Год поля
4860 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4861 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4862 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4863 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4864 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4865 "counts": { ~/~/ Счётчики с/х поля 
4866 "fieldOperations": 0, ~/~/ Количество операций на поле
4867 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4868 "facts": 0 ~/~/ Счётчик факта
4869 },
4870 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4871 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4872 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4873 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4874 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4875 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4876 "planComment": "string", ~/~/ Комментарий к полю
4877 "productivity": 0, ~/~/ Урожайность.
4878 "id": 0, ~/~/ Идентификатор объекта геозоны
4879 "name": "string", ~/~/ Название объекта геозоны
4880 "type": 0, ~/~/ Тип объекта геозоны
4881 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4882 "fname": "string", ~/~/ Имя файла
4883 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4884 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4885 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4886 "description": "string", ~/~/ Описание объекта геозоны
4887 "area": 0, ~/~/ Площадь, м2
4888 "perimetr": 0, ~/~/ Периметр, м
4889 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4890 }
4891 ]
4892
4893
4894 == **Создание нового поля ** ==
4895
4896 (% class="box successmessage" %)
4897 (((
4898 **POST /api/v3/agroLands**
4899 )))
4900
4901 Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
4902 X-agent  - ID клиента
4903
4904 Пример запроса:
4905
4906 (((
4907 {
4908 "extId": "string", 
4909 "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
4910 "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
4911 "display": "string", ~/~/ Настройки отображения
4912 "year": 0, ~/~/ Год поля
4913 "name": "string", ~/~/ Наименование
4914 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4915 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4916 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4917 "planComment": "string", ~/~/ Комментарий к полю
4918 "cropRotations": [ ~/~/ Данные по севообороту
4919 {
4920 "landId": 0, ~/~/ ID поля
4921 "landName": "string", ~/~/ Название поля
4922 "year": 0, ~/~/ Год урожая
4923 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4924 "cultureName": "string", ~/~/ Название культуры
4925 "productivity": 0, ~/~/ Урожайность
4926 "area": 0, ~/~/ Площадь поля, Га
4927 "total": 0, ~/~/ Валовый сбор
4928 "productivityFact": 0, ~/~/ Фактическая урожайность
4929 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4930 "totalFact": 0, ~/~/ Фактический валовый сбор
4931 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4932 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4933 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4934 "isyearplan": true, ~/~/ Годовой план 
4935 "comment": "string" ~/~/ Комментарий
4936 }
4937 ]
4938 }
4939 )))
4940
4941 (((
4942
4943 )))
4944
4945 Пример ответа:
4946
4947 (((
4948 (((
4949 {
4950 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4951 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4952 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4953 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4954 "cropRotations": [ ~/~/ Данные по севообороту
4955 {
4956 "landId": 0, ~/~/ ID поля
4957 "landName": "string", ~/~/ Название поля
4958 "year": 0, ~/~/ Год урожая 
4959 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4960 "cultureName": "string", ~/~/ Название культуры
4961 "productivity": 0, ~/~/ Урожайность
4962 "area": 0, ~/~/ Площадь поля, Га.
4963 "total": 0, ~/~/ Валовый сбор
4964 "productivityFact": 0, ~/~/ Фактическая урожайность
4965 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4966 "totalFact": 0, ~/~/ Фактический валовый сбор
4967 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
4968 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
4969 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
4970 "isyearplan": true, ~/~/ годовой план 
4971 "comment": "string" ~/~/ Комментарий
4972 }
4973 ],
4974 "cropVegetation": [ ~/~/ История вегетации поля
4975 {
4976 "values": [  ~/~/ Данные вегетации и состояния посева
4977 {
4978 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4979 "ndvi": 0 ~/~/ Индекс вегетации
4980 }
4981 ],
4982 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
4983 {
4984 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4985 "type": "string", ~/~/ Тип
4986 "pictureid": "string" ~/~/ Идентификатор ресурса
4987 }
4988 ],
4989 "states": [ ~/~/ Ключевые даты развития поля
4990 {
4991 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4992 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
4993 }
4994 ]
4995 }
4996 ],
4997 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
4998 "counts": {
4999 "fieldOperations": 0, ~/~/ Количество операций на поле
5000 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5001 "facts": 0 ~/~/ Счётчик факта
5002 },
5003 "planComment": "string", ~/~/ Комментарий к полю
5004 )))
5005
5006 (((
5007 "productivity": 0, ~/~/ Урожайность.
5008 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5009 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5010 "year": 0, ~/~/ Год поля
5011 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5012 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5013 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5014 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5015 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5016 "id": 0, ~/~/ Идентификатор объекта геозоны
5017 "name": "string", ~/~/ Название объекта геозоны
5018 "type": 0, ~/~/ Тип объекта геозоны
5019 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5020 "fname": "string", ~/~/ Имя файла
5021 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5022 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5023 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5024 "description": "string", ~/~/ Описание объекта геозоны
5025 "area": 0, ~/~/ Площадь, м2
5026 "perimetr": 0, ~/~/ Периметр, м
5027 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5028 }
5029
5030
5031 )))
5032 )))
5033 )))
5034
5035 == **Получение поля по id** ==
5036
5037 (% class="box infomessage" %)
5038 (((
5039 **GET /api/v3/agroLands/{id}**
5040 )))
5041
5042 Пример запроса:
5043 id  ~/~/ Идентификатор поля
5044
5045 Пример ответа:
5046
5047 (((
5048 {
5049 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5050 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5051 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5052 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5053 "cropRotations": [ ~/~/ Данные по севообороту
5054 {
5055 "landId": 0, ~/~/ ID поля
5056 "landName": "string", ~/~/ Название поля
5057 "year": 0, ~/~/ Год урожая
5058 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5059 "cultureName": "string", ~/~/ Название культуры
5060 "productivity": 0, ~/~/ Урожайность
5061 "area": 0, ~/~/ Площадь поля, Га
5062 "total": 0, ~/~/ Валовый сбор
5063 "productivityFact": 0, ~/~/ Фактическая урожайность
5064 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5065 "totalFact": 0, ~/~/ Фактический валовый сбор
5066 "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5067 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5068 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5069 "isyearplan": true, ~/~/ План года 
5070 "comment": "string" ~/~/ Комментарий
5071 }
5072 ],
5073 "cropVegetation": [ ~/~/ История вегетации поля
5074 {
5075 "values": [ ~/~/ Данные вегетации и состояния посева
5076 {
5077 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5078 "ndvi": 0 ~/~/ Индекс вегетации
5079 }
5080 ],
5081 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5082 {
5083 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5084 "type": "string", ~/~/ Тип 
5085 "pictureid": "string" ~/~/ Идентификатор ресурса
5086 }
5087 ],
5088 "states": [ ~/~/ Ключевые даты развития поля
5089 {
5090 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5091 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5092 }
5093 ]
5094 }
5095 ],
5096 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5097 "counts": {
5098 "fieldOperations": 0, ~/~/ Количество операций на поле
5099 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5100 "facts": 0 ~/~/ Счётчик факта
5101 },
5102 "planComment": "string", ~/~/ Комментарий к полю
5103 "productivity": 0, ~/~/ Урожайность.
5104 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5105 )))
5106
5107 (((
5108 (((
5109 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5110 "year": 0, ~/~/ Год поля
5111 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5112 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5113 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5114 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5115 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5116 "id": 0, ~/~/ Идентификатор объекта геозоны
5117 "name": "string", ~/~/ Название объекта геозоны
5118 "type": 0, ~/~/ Тип объекта геозоны 
5119 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5120 "fname": "string", ~/~/ Имя файла
5121 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5122 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5123 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5124 "description": "string", ~/~/ Описание объекта геозоны
5125 "area": 0, ~/~/ Площадь, м2
5126 "perimetr": 0, ~/~/ Периметр, м
5127 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5128 }
5129 )))
5130
5131
5132 == **Удаление существующего поля** ==
5133
5134 (% class="box errormessage" %)
5135 (((
5136 **DELETE /api/v3/agroLands/{id}**
5137 )))
5138
5139 Пример запроса:
5140 id  ~/~/ Идентификатор поля
5141
5142 Пример ответа:
5143
5144 (((
5145 200 ~/~/ Успех
5146 )))
5147
5148 (((
5149
5150 )))
5151
5152 (((
5153 (((
5154 (((
5155
5156 )))
5157
5158 (((
5159 == **Изменение поля** ==
5160
5161 (% class="box infomessage" %)
5162 (((
5163 **PUT /api/v3/agroLands**
5164 )))
5165
5166 Пример запроса:
5167
5168 (((
5169 (((
5170 {
5171 "id": 0, ~/~/ Идентификатор поля
5172 "extId": "string", ~/~/ ExtId
5173 "shape": "string", ~/~/ Форма поля
5174 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5175 "display": "string", ~/~/ Настройки отображения
5176 "year": 0, ~/~/ Год поля
5177 "name": "string", ~/~/ Наименование
5178 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5179 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5180 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5181 "planComment": "string", ~/~/Комментарий к полю
5182 "cropRotations": [  ~/~/ Данные по севообороту
5183 {
5184 "landId": 0, ~/~/ ID поля
5185 "landName": "string", ~/~/ Название поля
5186 "year": 0, ~/~/ Год урожая
5187 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5188 "cultureName": "string", ~/~/ Название культуры
5189 "productivity": 0, ~/~/ Урожайность
5190 "area": 0, ~/~/ Площадь поля, Га.
5191 "total": 0, ~/~/ Валовый сбор
5192 "productivityFact": 0, ~/~/ Фактическая урожайность
5193 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5194 "totalFact": 0, ~/~/ Фактический валовый сбор
5195 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5196 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5197 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5198 "isyearplan": true, 
5199 "comment": "string" ~/~/ Комментарий
5200 }
5201 ],
5202 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5203 }
5204 )))
5205 )))
5206
5207 (((
5208
5209 )))
5210
5211 Пример ответа:
5212
5213 (((
5214 (((
5215 (((
5216 {
5217 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5218 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5219 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5220 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5221 "cropRotations": [ ~/~/ Данные по севообороту
5222 {
5223 "landId": 0, ~/~/ ID поля
5224 "landName": "string", ~/~/ Название поля
5225 "year": 0, ~/~/  Год урожая
5226 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5227 "cultureName": "string", ~/~/ Название культуры
5228 "productivity": 0, ~/~/ Урожайность
5229 "area": 0, ~/~/ Площадь поля, Га
5230 "total": 0, ~/~/ Валовый сбор
5231 "productivityFact": 0, ~/~/ Фактическая урожайность
5232 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5233 "totalFact": 0, ~/~/ Фактический валовый сбор
5234 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5235 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5236 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5237 "isyearplan": true, ~/~/ 
5238 "comment": "string" ~/~/ Комментарий
5239 }
5240 ],
5241 "cropVegetation": [ ~/~/ История вегетации поля
5242 {
5243 "values": [ ~/~/ Данные вегетации и состояния посева
5244 {
5245 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5246 "ndvi": 0 ~/~/ Индекс вегетации
5247 }
5248 ],
5249 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5250 {
5251 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5252 "type": "string", ~/~/ Тип
5253 "pictureid": "string" ~/~/ Идентификатор ресурса
5254 }
5255 ],
5256 "states": [ ~/~/ Ключевые даты развития поля 
5257 {
5258 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5259 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5260 }
5261 ]
5262 }
5263 ],
5264 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5265 "counts": { 
5266 "fieldOperations": 0, ~/~/ Количество операций на поле
5267 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5268 "facts": 0 ~/~/ Счётчик факта
5269 },
5270 "planComment": "string", ~/~/ Комментарий к полю
5271 "productivity": 0, ~/~/ Урожайность.
5272 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5273 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5274 "year": 0, ~/~/ Год поля
5275 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5276 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5277 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5278 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5279 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5280 "id": 0, ~/~/ Идентификатор объекта геозоны
5281 "name": "string", ~/~/ Название объекта геозоны
5282 "type": 0, ~/~/ Тип объекта геозоны
5283 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5284 "fname": "string", ~/~/ Имя файла
5285 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5286 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5287 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5288 "description": "string", ~/~/ Описание объекта геозоны
5289 "area": 0, ~/~/ Площадь, м2
5290 "perimetr": 0, ~/~/ Периметр, м
5291 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5292 }
5293 )))
5294 )))
5295 )))
5296 )))
5297 )))
5298
5299
5300 == **Редактирование года урожая ** ==
5301
5302 (% class="box successmessage" %)
5303 (((
5304 **POST /api/v3/agroLands/updateOpenCloseYear**
5305 )))
5306
5307 Пример запроса:
5308
5309 (((
5310 (((
5311 {
5312 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5313 0
5314 ],
5315 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5316 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5317 }
5318 )))
5319
5320
5321 )))
5322
5323 Пример ответа:
5324
5325 (((
5326 (((
5327 {
5328 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5329 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5330 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5331 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5332 "cropRotations": [ ~/~/ Данные по севообороту
5333 {
5334 "landId": 0, ~/~/ ID поля
5335 "landName": "string", ~/~/ Название поля
5336 "year": 0, ~/~/ Год урожая
5337 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5338 "cultureName": "string", ~/~/ Название культуры
5339 "productivity": 0, ~/~/ Урожайность
5340 "area": 0, ~/~/ Площадь поля, Га.
5341 "total": 0, ~/~/ Валовый сбор
5342 "productivityFact": 0, ~/~/ Фактическая урожайность
5343 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5344 "totalFact": 0, ~/~/ Фактический валовый сбор
5345 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5346 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5347 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5348 "isyearplan": true, ~/~/ 
5349 "comment": "string" ~/~/ Комментарий
5350 }
5351 ],
5352 "cropVegetation": [ ~/~/ История вегетации поля
5353 {
5354 "values": [ ~/~/ Данные вегетации и состояния посева
5355 {
5356 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5357 "ndvi": 0 ~/~/ Индекс вегетации
5358 }
5359 ],
5360 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5361 {
5362 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5363 "type": "string", ~/~/ Тип
5364 "pictureid": "string" ~/~/ Идентификатор ресурса
5365 }
5366 ],
5367 "states": [ ~/~/ Ключевые даты развития поля
5368 {
5369 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5370 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5371 }
5372 ]
5373 }
5374 ],
5375 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5376 "counts": { 
5377 "fieldOperations": 0, ~/~/ Количество операций на поле
5378 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5379 "facts": 0 ~/~/ Счётчик факта
5380 },
5381 "planComment": "string", ~/~/ Комментарий к полю
5382 "productivity": 0, ~/~/ Урожайность.
5383 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5384 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5385 "year": 0, ~/~/ Год поля
5386 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5387 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5388 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5389 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5390 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5391 "id": 0, ~/~/ Идентификатор объекта геозоны
5392 "name": "string", ~/~/ Название объекта геозоны
5393 "type": 0, ~/~/ Тип объекта геозоны
5394 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5395 "fname": "string", ~/~/ Имя файла
5396 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5397 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5398 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5399 "description": "string", ~/~/ Описание объекта геозоны
5400 "area": 0, ~/~/ Площадь, м2
5401 "perimetr": 0, ~/~/ ериметр, м
5402 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5403 }
5404 )))
5405
5406
5407 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5408 )))
5409 )))
5410 )))
5411
5412 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5413
5414
5415 (% class="box infomessage" %)
5416 (((
5417 **GET api/v3/Vehicles/recyclebin/all**
5418 )))
5419
5420 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5421
5422 Параметр запроса: {parentId} - идентификатор агента
5423
5424 В заголовках запроса: X-Auth: Токен авторизации
5425
5426 Ответ:
5427
5428 [ 
5429 {
5430 "recordTime": "", ~/~/Время записи
5431 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5432 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5433 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5434 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5435 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5436 "details": { ~/~/Список деталей объекта, помещённого в корзину
5437 "items": [ ~/~/ 
5438 nullable: true ~/~/Детали
5439 {
5440 "name": "string", ~/~/наименование столбца
5441 "value": "string" ~/~/содержание столбца
5442 }
5443 ]
5444 },
5445 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5446 "string"
5447 ]
5448 }
5449 ]
5450
5451
5452 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5453
5454 (% class="box infomessage" %)
5455 (((
5456 **POST api/v3/Vehicles/recyclebin/erase**
5457 )))
5458
5459 В заголовках запроса: X-Auth: Токен авторизации
5460
5461 Пример запроса:
5462
5463 [
5464 0
5465 ]
5466
5467
5468 Пример ответа:
5469
5470 [ 
5471 {
5472 "recordTime": "", ~/~/Время записи
5473 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5474 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5475 "objectId": 0, ~/~/ID объекта, помещённого в корзин
5476 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5477 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5478 "details": { ~/~/Список деталей объекта, помещённого в корзину
5479 "items": [ ~/~/Детали
5480 {
5481 "name": "", ~/~/Имя свойства
5482 "value": "" ~/~/Значение свойства
5483 }
5484 ]
5485 },
5486 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5487 ""
5488 ]
5489 }
5490 ]
5491
5492 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5493
5494 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5495
5496 (% class="box infomessage" %)
5497 (((
5498 **POST api/v3/Vehicles/recyclebin/restore**
5499 )))
5500
5501 В заголовках запроса: X-Auth: Токен авторизации
5502
5503 Параметры в теле запроса (JSON):
5504
5505 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5506
5507 В заголовках запроса: X-Auth: Токен авторизации
5508
5509
5510 Пример запроса:
5511
5512 (((
5513 [
5514 )))
5515
5516 (((
5517 0
5518 )))
5519
5520 (((
5521 ]
5522 )))
5523
5524
5525 Пример ответа:
5526
5527 [
5528 {
5529 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5530 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5531 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5532 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5533 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5534 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5535 "details": { ~/~/Список деталей объекта, помещённого в корзину
5536 "items": [ ~/~/Детали
5537 {
5538 "name": "string", ~/~/Имя свойства
5539 "value": "string" ~/~/Значение свойства
5540 }
5541 ]
5542 },
5543 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5544 "string"
5545 ]
5546 }
5547 ]
5548
5549
5550 = **Раздел: Журнал заданий ** =
5551
5552
5553 == **Создание задания в Журнале заданий** ==
5554
5555 (% class="box infomessage" %)
5556 (((
5557 **POST /api/v3/vehicletasks**
5558 )))
5559
5560 Пример запроса:
5561
5562 (((
5563 {
5564 "vehicleId": 0, ~/~/ Идентификатор ТС
5565 "description": "string", ~/~/ Описание
5566 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5567 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5568 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5569 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5570 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5571 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5572 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5573 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5574 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5575 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5576 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5577 "cost": { 
5578 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5579 "Name": "string", ~/~/ Наименование
5580 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5581 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5582 "Norm": 0 ~/~/ Норма внесения
5583 },
5584 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5585 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5586 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5587 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5588 "deleted": true, ~/~/ Признак удаления
5589 "extId": "string", 
5590 "GeoIds": [ ~/~/ Cвязанные поля
5591 0
5592 ]
5593 }
5594 )))
5595
5596
5597 Пример ответа:
5598
5599 {
5600 "vehicleId": 0, ~/~/ Идентификатор ТС
5601 "description": "string", ~/~/ Описание
5602 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5603 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5604 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5605 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5606 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5607 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5608 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5609 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5610 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5611 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5612 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5613 "cost": { 
5614 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5615 "Name": "string", ~/~/ Наименование
5616 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5617 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5618 "Norm": 0 ~/~/ Норма внесения
5619 },
5620 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5621 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5622 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5623 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5624 "deleted": true, ~/~/ Признак удаления
5625 "extId": "string", ~/~/ ExtId
5626 "GeoIds": [ ~/~/ Связанные поля
5627 0
5628 ]
5629 }
5630
5631
5632 == **Редактирование задания в Журнале заданий** ==
5633
5634 (% class="box successmessage" %)
5635 (((
5636 **PUT /api/v3/vehicletasks**
5637 )))
5638
5639 Пример запроса:
5640
5641 (((
5642 {
5643 "vehicleId": 0, ~/~/ Идентификатор ТС
5644 "description": "string", ~/~/ Описание
5645 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5646 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5647 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5648 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5649 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5650 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5651 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5652 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5653 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5654 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5655 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5656 "cost": { 
5657 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5658 "Name": "string", ~/~/ Наименование
5659 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5660 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5661 "Norm": 0 ~/~/ Норма внесения
5662 },
5663 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5664 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5665 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5666 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5667 "deleted": true, ~/~/ Признак удаления
5668 "extId": "string", ~/~/ ExtId
5669 "GeoIds": [ ~/~/ Связанные поля
5670 0
5671 ]
5672 }
5673 )))
5674
5675
5676 Пример ответа:
5677
5678 {
5679 "vehicleId": 0, ~/~/ Идентификатор ТС
5680 "description": "string", ~/~/ Описание
5681 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5682 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5683 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5684 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5685 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5686 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5687 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5688 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5689 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5690 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5691 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5692 "cost": { 
5693 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5694 "Name": "string", ~/~/ Наименование
5695 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5696 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5697 "Norm": 0 ~/~/ Норма внесения
5698 },
5699 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5700 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5701 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5702 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5703 "deleted": true, ~/~/ Признак удаления
5704 "extId": "string", ~/~/ ExtId
5705 "GeoIds": [ ~/~/ Связанные поля
5706 0
5707 ]
5708 }
5709
5710
5711 == **Удаление задания в Журнале заданий** ==
5712
5713 (% class="box warningmessage" %)
5714 (((
5715 **DELETE /api/v3/vehicletasks**
5716 )))
5717
5718 Пример запроса:
5719
5720 (((
5721 [
5722 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5723 ]
5724 )))
5725
5726 (((
5727
5728 )))
5729
5730 Пример ответа:
5731
5732 {
5733 "vehicleId": 0, ~/~/ Идентификатор ТС
5734 "description": "string", ~/~/ Описание
5735 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5736 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5737 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5738 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5739 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5740 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5741 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5742 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5743 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5744 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5745 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5746 "cost": { 
5747 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5748 "Name": "string", ~/~/ Наименование
5749 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5750 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5751 "Norm": 0 ~/~/ Норма внесения
5752 },
5753 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5754 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5755 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5756 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5757 "deleted": true, ~/~/ Признак удаления
5758 "extId": "string", ~/~/ ExtId
5759 "GeoIds": [ ~/~/ Связанные поля
5760 0
5761 ]
5762 }
5763
5764
5765 == **Получение списка Журнала заданий** ==
5766
5767 (% class="box infomessage" %)
5768 (((
5769 **POST /api/v3/vehicletasks/getbyperiod**
5770 )))
5771
5772 Пример запроса:
5773
5774 (((
5775 {
5776 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
5777 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
5778 "TimeZone": 0, ~/~/ Часовой пояс.
5779 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
5780 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
5781 ],
5782 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
5783 0
5784 ],
5785 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
5786 0
5787 ],
5788 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
5789 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
5790 }
5791 )))
5792
5793
5794 Пример ответа:
5795
5796 (((
5797 {
5798 "total": 0,  ~/~/ Общее количество записей
5799 "pages": 0,  ~/~/ Общее количество страниц
5800 "currentPage": 0, ~/~/ Текущая страница
5801 "items": [  ~/~/ Записи 
5802 {
5803 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5804 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
5805 "name": "string", ~/~/ Название задания.
5806 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
5807 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
5808 "workKind": "string", ~/~/ Вид работ
5809 "techOp": "string", ~/~/ Тех. операция
5810 "trailerModel": "string", ~/~/ Модель агрегата
5811 "width": "string", ~/~/ Ширина, м
5812 "speed": "string", ~/~/ Тех. скорость
5813 "fields": "string", ~/~/ Поля
5814 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
5815 "vehicles": "string", ~/~/ Объект-модель
5816 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
5817 "drivers": "string", ~/~/ Водители
5818 "tmc": "string", ~/~/ ТМЦ
5819 "client": "string", ~/~/  Клиент
5820 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5821 "dep": "string", ~/~/ Подразделение
5822 "geoIds": [ ~/~/  Связанные поля
5823 0
5824 ]
5825 }
5826 ]
5827 }
5828 )))
5829
5830
5831 = **Раздел: Локатор ** =
5832
5833
5834 == **Получение списка локаторов, доступных пользователю ** ==
5835
5836 (% class="box infomessage" %)
5837 (((
5838 **GET /api/v3/locators**
5839 )))
5840
5841 В заголовках запроса: X-Auth: Токен авторизации
5842
5843
5844 Пример ответа:
5845
5846 (((
5847 [
5848 {
5849 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5850 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5851 "agentName": "string", ~/~/ Наименование агента.
5852 "isEnabled": true, ~/~/ Активен 
5853 "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5854 "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5855 "name": "string", ~/~/ Наименование
5856 "status": 0, ~/~/ 
5857 "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5858 "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5859 "validity": 0, ~/~/ Срок действия в днях (1-90).
5860 "autoProlongation": true, ~/~/ Автопродление срока действия.
5861 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5862 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5863 "url": "string", ~/~/ Ссылка
5864 "language": 0, ~/~/ Язык.
5865 "vehiclesCount": 0, ~/~/ Количество объектов.
5866 "geozonesCount": 0, ~/~/ Количество геозон.
5867 "fieldsCount": 0 ~/~/ Количество полей.
5868 }
5869 ]
5870 )))
5871
5872
5873
5874 == **Создание локатора** ==
5875
5876 (% class="box successmessage" %)
5877 (((
5878 **POST /api/v3/locators**
5879 )))
5880
5881 Пример запроса:
5882
5883 (((
5884 {
5885 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5886 "isEnabled": true, ~/~/ Активность
5887 "name": "string", ~/~/ Наименование локатора
5888 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
5889 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5890 "validity": 0, ~/~/ Срок действия в днях (1-90)
5891 "autoProlongation": true, ~/~/ Автопродление срока действия.
5892 "url": "string", ~/~/ Ссылка
5893 "language": 0 ~/~/ Язык
5894 }
5895 )))
5896
5897
5898 Пример ответа:
5899
5900 (((
5901 3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
5902 )))
5903
5904
5905
5906 == **Изменение локатора** ==
5907
5908 (% class="box infomessage" %)
5909 (((
5910 **PUT /api/v3/locators**
5911 )))
5912
5913 Пример запроса:
5914
5915 (((
5916 {
5917 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5918 "isEnabled": true, ~/~/ Активность 
5919 "name": "string", ~/~/ Наименование
5920 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
5921 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
5922 "validity": 0, ~/~/ Срок действия в днях (1-90)
5923 "autoProlongation": true, ~/~/ Автопродление срока действия
5924 "url": "string", ~/~/ Ссылка
5925 "language": 0 ~/~/ Язык
5926 }
5927 )))
5928
5929
5930 Пример ответа:
5931
5932 200 ~/~/ Success
5933
5934
5935 == **Удалить локатор** ==
5936
5937 (% class="box warningmessage" %)
5938 (((
5939 **DELETE /api/v3/locators**
5940 )))
5941
5942 Пример запроса:
5943
5944 (((
5945 [
5946 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
5947 ]
5948 )))
5949
5950
5951
5952 = **Раздел: Яндекс Маршруты** =
5953
5954
5955 == **Возвращение списка маршрутов** ==
5956
5957 (% class="box infomessage" %)
5958 (((
5959 **GET /api/v3/TransportRoutes**
5960 )))
5961
5962 Пример запроса:
5963 Id  ~/~/ Идентификатор поля
5964
5965
5966 Пример ответа:
5967
5968 (((
5969 [
5970 {
5971 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
5972 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
5973 "name": "string", ~/~/ Наименование маршрута.
5974 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
5975 "vehicles": [  ~/~/ Определяет список ТС для маршрута
5976 0
5977 ]
5978 }
5979 ]
5980 )))
5981
5982
5983
5984 == **Добавить маршрут** ==
5985
5986 (% class="box infomessage" %)
5987 (((
5988 **POST /api/v3/TransportRoutes**
5989 )))
5990
5991 Пример запроса: 
5992 {
5993 "name": "string",  ~/~/  Опредлеляет наименование маршрута.
5994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
5995 "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
5996 "vehicles": [  ~/~/ Определяет список ТС для маршрута
5997 0
5998 ]
5999 }
6000
6001
6002 Пример ответа:
6003
6004 (((
6005 {
6006 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6007 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6008 "name": "string", ~/~/ Определяет наименование маршрута 
6009 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6010 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6011 0
6012 ]
6013 }
6014 )))
6015
6016
6017 == **Обновление маршрута** ==
6018
6019 (% class="box successmessage" %)
6020 (((
6021 **PUT /api/v3/TransportRoutes**
6022 )))
6023
6024 Пример запроса:
6025
6026 (((
6027 {
6028 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6029 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6030 "name": "string", ~/~/ Опредлеляет наименование маршрута.
6031 "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6032 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6033 0
6034 ]
6035 }
6036 )))
6037
6038
6039 Пример ответа:
6040
6041 (((
6042 {
6043 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6044 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6045 "name": "string", ~/~/ Определяет наименование маршрута 
6046 "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6047 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6048 0
6049 ]
6050 }
6051 )))
6052
6053
6054 == **Получить связки маршрутов ТС** ==
6055
6056 (% class="box infomessage" %)
6057 (((
6058 **POST /api/v3/TransportRoutes/getroutesvehicles**
6059 )))
6060
6061 Пример запроса:
6062
6063 (((
6064 [
6065 "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6066 ]
6067 )))
6068
6069
6070 Пример ответа:
6071
6072 (((
6073 [
6074 {
6075 "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6076 "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6077 }
6078 ]
6079 )))
6080
6081
6082 == **Удалить маршрут** ==
6083
6084 (% class="box warningmessage" %)
6085 (((
6086 **DELETE /api/v3/TransportRoutes/{id}**
6087 )))
6088
6089 Пример запроса:
6090 Id  ~/~/ Идентификатор поля
6091
6092
6093
6094 (% class="box" lang="en-US" style="text-align: center;" %)
6095 (((
6096 (% 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]] **
6097 )))

Меню

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