Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 205.1 >
edited by Андрей Калиновский
on 2025/01/14 11:58
To version < 78.1 >
edited by Илья Крайнов
on 2023/03/14 14:59
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Content
... ... @@ -1,17 +1,5 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 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 -
15 15  **Содержание страницы:**
16 16  )))
17 17  
... ... @@ -26,22 +26,13 @@
26 26  
27 27  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
28 28  
29 -(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
30 30  
31 -
32 -(% style="color:#000000; font-size:16px" %)**Рекомендации**
33 -
34 -- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
35 -
36 36  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
37 37  
38 -(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
39 -(((
40 -(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
41 -(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
42 -)))
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
43 43  
44 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
45 45  (((
46 46  (% lang="en-US" %)**POST /api/v3/auth/login**
47 47  )))
... ... @@ -52,7 +52,7 @@
52 52  
53 53  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
54 54  
55 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
56 56  
57 57  (% style="color:#000000" %)Параметры в теле запроса (JSON):
58 58  
... ... @@ -61,25 +61,21 @@
61 61   "password": "testuser"
62 62  }
63 63  
43 +
64 64  (% style="color:#000000" %)**Ответ:**
65 65  
66 66  (% lang="en-US" %)
67 67  (% style="color:#000000" %){
68 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
69 - "User": "testuser" , ~/~/ имя пользователя(%%)
48 +
49 +(% lang="en-US" %)
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
52 +
53 +(% lang="en-US" %)
70 70  }
71 71  
72 72  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
73 73  
74 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
75 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
76 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
77 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
78 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
79 -
80 -(% class="wikigeneratedid" %)
81 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
82 -
83 83  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
84 84  
85 85  (% class="box infomessage" %)
... ... @@ -87,7 +87,7 @@
87 87  (% lang="en-US" %)**GET /api/v3/auth/check**
88 88  )))
89 89  
90 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
91 91  
92 92  (% style="color:#000000" %)Метод запроса: **GET**
93 93  
... ... @@ -107,7 +107,7 @@
107 107  **GET api/v3/agents/{id}**
108 108  )))
109 109  
110 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
111 111  
112 112  (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
113 113  
... ... @@ -118,51 +118,30 @@
118 118  Запрос должен содержать данные параметра "**agentId**"
119 119  
120 120  (% style="color:#000000" %)Ответ:
96 +А
121 121  {
122 - "agentId": "",  (%%)
123 - "parentId": "",
124 - "parentName": "string",
125 - "name": "string",
126 - "fullName": "string",
127 - "agentInfoType": 0,
128 - "isForeign": true/false,
129 - "district": "string", 
130 - "region": "string",
131 - "city": "string",
132 - "inn": "string",
133 - "kpp": "string",
134 - "address": "string",
135 - "addressFact": "string",
136 - "email": "string",
137 - "director": "string",
138 - "bankName": "string",
139 - "bankBIK": "string",
140 - "bankRS": "string",
141 - "bankKS": "string"
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
142 142   }
143 143  
144 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
145 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
146 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
147 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
148 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
149 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
150 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
151 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
152 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
153 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
154 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
155 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
156 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
157 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
158 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
159 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
160 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
161 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
162 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
163 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
164 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
165 -
166 166  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
167 167  
168 168  (% class="box infomessage" %)
... ... @@ -170,13 +170,13 @@
170 170  (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
171 171  )))
172 172  
173 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
174 174  
175 175  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
176 176  
177 177  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
178 178  
179 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
180 180  
181 181  (% style="color:#000000" %)Метод запроса: **POST**
182 182  
... ... @@ -191,23 +191,15 @@
191 191  (% style="color:#000000" %)Ответ:
192 192  
193 193  {
194 - "agentId": "",(% style="color:#000000" %)   (%%)
195 - "parentId": "",
196 - "name": "string",
197 - "fullName": "string",
198 - "agentInfoType": 0,
199 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
200 200  }
201 201  
202 -
203 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
204 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
205 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
206 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
207 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
208 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
209 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
210 -
211 211  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
212 212  
213 213  (% class="box successmessage" %)
... ... @@ -215,7 +215,7 @@
215 215  **POST /api/v3/agents **
216 216  )))
217 217  
218 -Метод позволяет добавить клиента, указанного в запросе.
164 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
219 219  
220 220  Метод запроса: **POST**
221 221  
... ... @@ -226,7 +226,7 @@
226 226  Параметры в теле запроса (JSON):
227 227  
228 228  {
229 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
230 230   "name": "string", ~/~/ имя
231 231   "fullName": "string", ~/~/ полное наименование
232 232   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -246,6 +246,7 @@
246 246   "bankKS": "string" ~/~/ корр. счёт
247 247  }
248 248  
195 +
249 249  Ответ:
250 250  
251 251  {
... ... @@ -270,28 +270,6 @@
270 270   "bankKS": "string" ~/~/ корр. счёт
271 271  }
272 272  
273 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
274 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
275 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
276 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
277 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
278 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
279 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
280 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
281 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
282 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
283 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
284 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
285 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
286 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
287 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
288 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
289 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
290 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
291 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
292 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
293 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
294 -
295 295  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
296 296  
297 297  (% class="box warningmessage" %)
... ... @@ -299,7 +299,7 @@
299 299  **PUT /api/v3/agents**
300 300  )))
301 301  
302 -Метод позволяет отредактировать клиента, указанного в запросе.
227 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
303 303  
304 304  Метод запроса: **PUT**
305 305  
... ... @@ -307,6 +307,7 @@
307 307  
308 308  В заголовках запроса: X-Auth: Токен авторизации
309 309  
235 +
310 310  Параметры в теле запроса (JSON):
311 311  
312 312  {
... ... @@ -331,6 +331,7 @@
331 331   "bankKS": "string" ~/~/ корр. счёт
332 332  }
333 333  
260 +
334 334  Ответ:
335 335  
336 336  {
... ... @@ -361,7 +361,7 @@
361 361  **DELETE /api/v3/agents/{clientId}**
362 362  )))
363 363  
364 -Метод позволяет удалить клиента, указанного в строке запроса.
291 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
365 365  
366 366  Метод запроса: **DELETE**
367 367  
... ... @@ -373,21 +373,6 @@
373 373  
374 374  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
375 375  
376 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
377 -
378 -(% class="box warningmessage" %)
379 -(((
380 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
381 -)))
382 -
383 -Метод позволяет изменить статус клиента, указанного в запросе.
384 -
385 -В пути указывается GUID клиента и статус клиента.
386 -
387 -**status **- значение 0 - заблокирован, 1 - активен.
388 -
389 -Ответ: Code 204
390 -
391 391  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
392 392  
393 393  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -397,7 +397,7 @@
397 397  (% lang="en-US" %)**POST /api/v3/users**
398 398  )))
399 399  
400 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
401 401  
402 402  (% style="color:#000000" %)Метод запроса: **POST**
403 403  
... ... @@ -424,21 +424,22 @@
424 424   "parentId": "", ~/~/ Guid родительского агента
425 425   "leaderId": "", ~/~/ Guid руководителя (null - не задан)
426 426   "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
427 - "doubleAuth":
339 + "doubleAuth":
428 428   {
429 429   "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
430 430   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
431 431   },
432 - "groups":
344 + "groups":
433 433   [
434 434   "string" ~/~/ группы пользователя, перечисление названия системных ролей
435 435   ],
436 - "customGroups":
348 + "customGroups":
437 437   [
438 438   "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
439 439   ],
440 440   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
441 441  }
354 +
442 442  {
443 443   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
444 444   "lastName": "string",
... ... @@ -450,10 +450,15 @@
450 450   "password": "string",
451 451   "email": "string",
452 452  
366 +
453 453  (% style="text-align:left" %)
454 454  (% style="color:#000000; font-weight:normal" %)Ответ:
455 -{     
456 - "id": "" , ~/~/ ID пользователя
369 +
370 +(% style="text-align:left" %)
371 +(% style="color:#000000; font-weight:normal" %){    
372 +
373 +(% style="text-align:left" %)
374 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
457 457   "lastName": "" , ~/~/ Фамилия ,
458 458   "firstName": "" , ~/~/ Имя
459 459   "position": "" , ~/~/ Должность
... ... @@ -470,8 +470,9 @@
470 470   "kind": "" , ~/~/ тип аутентификации
471 471   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
472 472   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
473 -}
474 474  
392 +(% style="text-align:left" %)
393 +(% style="color:#000000; font-weight:normal" %)}
475 475  
476 476  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
477 477  
... ... @@ -492,16 +492,19 @@
492 492  
493 493  (% style="color:#000000" %)Параметры в теле запроса (JSON):
494 494  
495 -(% style="color:#000000" %){(%%)
414 +(% style="color:#000000" %){
415 +
496 496   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
497 497   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
498 498   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
499 499   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 +
500 500  (% style="color:#000000" %)}
501 501  
502 502  (% style="color:#000000" %)Ответ:
503 503  
504 504  (% style="color:#000000" %){         (%%)
426 +
505 505   "id": "" , ~/~/ идентификатор пользователя
506 506   "lastName": "" , ~/~/ фамилия
507 507   "firstName": "" , ~/~/ имя
... ... @@ -514,7 +514,8 @@
514 514   "email": "" , ~/~/ E-mail
515 515   "sessionDuration":"", ~/~/ длительность сессии в минутах
516 516   "status": "1",  ~/~/ статус пользователя
517 - "lastLogged": "", ~/~/ дата/время последней авторизации
439 + "astLogged": "", ~/~/ дата/время последней авторизации
440 +
518 518  (% style="color:#000000" %)}
519 519  
520 520  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -576,7 +576,7 @@
576 576  (% lang="en-US" %)**PUT /api/v3/users**
577 577  )))
578 578  
579 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
580 580  
581 581  (% style="color:#000000" %)Метод запроса: **PUT**
582 582  
... ... @@ -588,8 +588,10 @@
588 588  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
589 589  
590 590  (% lang="en-US" style="text-align:left" %)
591 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
592 - "id": "" , ~/~/ ID пользователя 
514 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 +
516 +(% lang="en-US" style="text-align:left" %)
517 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
593 593   "lastName": "" , ~/~/ фамилия
594 594   "firstName": "" , ~/~/ имя
595 595   "position": "" , ~/~/ должность
... ... @@ -611,7 +611,9 @@
611 611   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
612 612   },
613 613   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
614 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 +
541 +(% lang="en-US" style="text-align:left" %)
615 615  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
616 616  
617 617  (% lang="en-US" style="text-align:left" %)
... ... @@ -618,8 +618,10 @@
618 618  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
619 619  
620 620  (% lang="en-US" style="text-align:left" %)
621 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
622 - "id": "" , ~/~/ идентификатор пользователя
548 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
549 +
550 +(% lang="en-US" style="text-align:left" %)
551 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
623 623   "lastName": "" , ~/~/ фамилия
624 624   "firstName": "" , ~/~/ имя
625 625   "position": "" , ~/~/ должность
... ... @@ -640,8 +640,10 @@
640 640   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
641 641   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
642 642   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
643 -}
644 644  
573 +(% lang="en-US" style="text-align:left" %)
574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 +
645 645  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
646 646  
647 647  (% class="box warningmessage" %)
... ... @@ -649,7 +649,7 @@
649 649  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
650 650  )))
651 651  
652 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
653 653  
654 654  (% style="color:#000000" %)Метод запроса: **PUT**
655 655  
... ... @@ -661,10 +661,12 @@
661 661  
662 662  (% style="color:#000000" %)Параметры в теле запроса (JSON):
663 663  
664 -(% style="color:#000000" %){(%%)
595 +(% style="color:#000000" %){
596 +
665 665   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
666 666   "description": "" , ~/~/ описание
667 667   "data": "" , ~/~/ данные, связанные со сменой статуса
600 +
668 668  (% style="color:#000000" %)}
669 669  
670 670  (% style="text-align:left" %)
... ... @@ -677,7 +677,7 @@
677 677  **POST /api/v3/users/disable**
678 678  )))
679 679  
680 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
613 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
681 681  
682 682  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
683 683  
... ... @@ -686,7 +686,7 @@
686 686  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
687 687  
688 688   [ 
689 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
690 690   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
691 691   ]
692 692  
... ... @@ -699,7 +699,7 @@
699 699  **POST /api/v3/users/enable**
700 700  )))
701 701  
702 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
635 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
703 703  
704 704  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
705 705  
... ... @@ -736,7 +736,7 @@
736 736  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
737 737  )))
738 738  
739 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
740 740  
741 741  (% style="color:#000000" %)Метод запроса: **DELETE**
742 742  
... ... @@ -749,251 +749,8 @@
749 749  (% style="text-align:left" %)
750 750  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
751 751  
752 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
753 753  
754 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
755 -
756 -(% class="box infomessage" %)
757 -(((
758 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
759 -)))
760 -
761 -Метод возвращает полную информацию о модели объекта.
762 -
763 -(% style="color:#000000" %)Метод запроса: **GET**
764 -
765 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
766 -
767 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
768 -
769 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
770 -
771 -(% style="color:#000000" %)Ответ:
772 -
773 -(% style="color:#000000" %){
774 - "parentName": "string",
775 - "name": "string",
776 - "picture": "string",
777 - "minspeed": 0,
778 - "maxspeed": 0,
779 - "width": 0,
780 - "imbeddedtrailer": true,
781 - "hoppercapacity": 0,
782 - "hopperdischargespeed": 0,
783 - "modelType": 0,
784 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
785 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
786 - "deleted": true
787 -}
788 -
789 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
790 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
791 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
792 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
793 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
794 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
795 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
796 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
797 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
798 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
799 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
800 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
801 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
802 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
803 -
804 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
805 -
806 -(% class="box successmessage" %)
807 -(((
808 -(% lang="en-US" %)**POST /api/v3/models/find**
809 -)))
810 -
811 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
812 -
813 -(% style="color:#000000" %)Метод запроса: **POST**
814 -
815 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
816 -
817 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
818 -
819 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
820 -
821 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
822 -}
823 -
824 -(% style="color:#000000" %)Ответ:
825 -
826 -(% style="color:#000000" %)[
827 - {
828 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
829 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
830 - "parentName": "string",
831 - "name": "string",
832 - "modelType": 0
833 - }
834 -]
835 -
836 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
837 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
838 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
839 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
840 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
841 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
842 -
843 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
844 -
845 -(% class="box successmessage" %)
846 -(((
847 -(% lang="en-US" %)**POST /api/v3/models**
848 -)))
849 -
850 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
851 -
852 -(% style="color:#000000" %)Метод запроса: **POST**
853 -
854 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
855 -
856 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
857 -
858 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
859 -
860 -{
861 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 - "deleted": true,
864 - "extId": "string",
865 - "name": "string",
866 - "picture": "string",
867 - "minspeed": 0,
868 - "maxspeed": 0,
869 - "width": 0,
870 - "imbeddedtrailer": true,
871 - "fueloutlay": 0,
872 - "hoppercapacity": 0,
873 - "hopperdischargespeed": 0,
874 - "modelType": 0
875 -}
876 -
877 -Ответ:
878 -
879 -{
880 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 - "deleted": true,
883 - "extId": "string",
884 - "name": "string",
885 - "picture": "string",
886 - "minspeed": 0,
887 - "maxspeed": 0,
888 - "width": 0,
889 - "imbeddedtrailer": true,
890 - "hoppercapacity": 0,
891 - "hopperdischargespeed": 0,
892 - "modelType": 0
893 -}
894 -
895 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
896 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
897 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
898 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
899 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
900 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
901 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
902 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
903 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
904 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
905 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
906 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
907 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
908 -
909 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
910 -
911 -(% class="box warningmessage" %)
912 -(((
913 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 -)))
915 -
916 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
917 -
918 -(% style="color:#000000" %)Метод запроса: **PUT**
919 -
920 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
921 -
922 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
923 -
924 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
925 -
926 -{
927 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
928 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
929 - "deleted": true,
930 - "extId": "string",
931 - "name": "string",
932 - "picture": "string",
933 - "minspeed": 0,
934 - "maxspeed": 0,
935 - "width": 0,
936 - "imbeddedtrailer": true,
937 - "fueloutlay": 0,
938 - "hoppercapacity": 0,
939 - "hopperdischargespeed": 0,
940 - "modelType": 0
941 -}
942 -
943 -Ответ:
944 -
945 -{
946 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
947 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
948 - "deleted": true,
949 - "extId": "string",
950 - "name": "string",
951 - "picture": "string",
952 - "minspeed": 0,
953 - "maxspeed": 0,
954 - "width": 0,
955 - "imbeddedtrailer": true,
956 - "fueloutlay": 0,
957 - "hoppercapacity": 0,
958 - "hopperdischargespeed": 0,
959 - "modelType": 0
960 -}
961 -
962 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
963 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
964 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
965 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
966 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
967 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
968 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
969 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
970 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
971 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
972 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
973 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
974 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
975 -
976 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
977 -
978 -(% class="box errormessage" %)
979 -(((
980 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 -)))
982 -
983 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
984 -
985 -(% style="color:#000000" %)Метод запроса: **DELETE**
986 -
987 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
988 -
989 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
990 -
991 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
992 -
993 -Ответ: В случае успеха **Success 200**
994 -
995 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
996 -
997 997  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
998 998  
999 999  (% class="box infomessage" %)
... ... @@ -1003,7 +1003,7 @@
1003 1003  
1004 1004  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1005 1005  
1006 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1007 1007  
1008 1008  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1009 1009  
... ... @@ -1011,9 +1011,9 @@
1011 1011  
1012 1012  (% style="color:#000000" %)Метод запроса: **GET**
1013 1013  
1014 -(% 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}
704 +(% 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>
1015 1015  
1016 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
706 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
1017 1017  
1018 1018  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1019 1019  
... ... @@ -1021,17 +1021,6 @@
1021 1021  
1022 1022  (((
1023 1023  {
1024 -
1025 -(((
1026 - "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1027 - "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1028 -)))
1029 -
1030 -(((
1031 - ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1032 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1033 -)))
1034 -
1035 1035   "vehicleId": "", ~/~/ ID объекта
1036 1036   "name": "", ~/~/ Имя объекта
1037 1037   "imei": "", ~/~/ IMEI объекта
... ... @@ -1038,130 +1038,20 @@
1038 1038   "deviceTypeId": , ~/~/ ID типа устройства
1039 1039   "deviceTypeName": "", ~/~/ Название типа устройства
1040 1040   "sim1": "", ~/~/ Номер SIM1
1041 - "sim2": "", ~/~/ Номер SIM2
1042 - "parentId": "", ~/~/ ID клиента-родителя
1043 - "parentName": "", ~/~/ Наименование клиента-родителя
1044 - "modelId": "", ~/~/ ID модели объекта
1045 - "modelName": "", ~/~/ Имя модели объекта
1046 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1047 - "unitName": "string", ~/~/ Наименование подразделения
1048 - "status": 0, ~/~/ Статус объекта
1049 - "createdAt": "", ~/~/ Дата создания объекта
720 + "parentId": "", Номер SIM2
721 + "parentName": "", Наименование клиента-родителя
722 + "modelId": "", ID модели объекта
723 + "modelName": "", Имя модели объекта
724 + "createdAt": "", Дата создания объекта
725 + "mileageCalcMethod": "", Выбранный метод расчета пробега
726 + "counters": { ~/~/ Нормы
727 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
728 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
729 + "mileage": "", ~/~/ Пробег по нормам в метрах
730 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
1050 1050   },
1051 -"customFields": [ ~/~/ Произвольные поля
1052 - {
1053 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1054 - "name": "string", ~/~/ Имя поля
1055 - "value": "string", ~/~/ Значение поля
1056 - "forClient": true, ~/~/ Не используемая функция
1057 - "forTooltip": true, ~/~/ Отображать в подсказке
1058 - "forReport": true ~/~/ Отображать в отчете
1059 - }
1060 -
1061 -], ~/~/ Данные с вкладки нормы
1062 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1063 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1064 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1065 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1066 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1067 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1068 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1069 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1070 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1071 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1072 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1073 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1074 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1075 - "mileageCoeff": 0, ~/~/ коэффициент пробега
1076 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1077 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1078 - "counters": { ~/~/ Счетчики
1079 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1080 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1081 - "mileage": 0, ~/~/ Текущий пробег
1082 - "motohours": 0, ~/~/ Текущие моточасы
1083 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1084 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1085 - },
1086 -
1087 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1088 - "id": "string", ~/~/ ID объекта
1089 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
1090 - "host": "string", ~/~/ CMSV6 Web Host
1091 - "login": "string", ~/~/ CMSV6 Account
1092 - "password": "string" ~/~/ CMSV6 Password
1093 - },
1094 -
1095 -"commandTemplates": [ ~/~/ Шаблоны команд
1096 - {
1097 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1098 - "name": "string", ~/~/ Наименование команды
1099 - "command": "string", ~/~/ Текст команды
1100 - "retries": 0 ~/~/ Количество попыток
1101 - }
1102 - ],
1103 - "sensors": [ ~/~/ Датчики
1104 - {
1105 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1106 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1107 - "type": 0, ~/~/ Тип датчика
1108 - "name": "string", ~/~/ Имя датчика
1109 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1110 - "inputNumber": 0, ~/~/ Номер входа
1111 - "pseudonym": "string", ~/~/ Псевдоним
1112 - "medianDegree": 0, ~/~/ Медианная фильтрация
1113 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1114 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1115 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1116 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1117 - {
1118 - "grades": [ ~/~/ Таблица тарировки 1
1119 - {
1120 - "input": 0, ~/~/ Входящее значение
1121 - "output": 0 ~/~/ Выходящее значение
1122 - }
1123 - ],
1124 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1125 - }
1126 - ],
1127 - "showInTooltip": true, ~/~/ Отображать в подсказке
1128 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1129 - "color": "string", ~/~/ Код цвета датчиков
1130 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1131 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1132 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1133 - "expr": "string", ~/~/ Формула
1134 - "children": [ ~/~/ массив дочерних датчиков
1135 - "string"
1136 - ],
1137 - "customParams": { ~/~/ прочие произвольные параметры
1138 - "additionalProp1": "string",
1139 - "additionalProp2": "string",
1140 - "additionalProp3": "string"
1141 - },
1142 -
1143 -~/~/ Характерные для произвольного:
1144 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1145 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1146 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1147 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1149 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1150 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1151 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1152 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1153 -~/~/ "ValueOn": "Вкл.",
1154 -~/~/ "ValueOff": "Выкл."
1155 - "summaryMaxValue": 0 ~/~/ Макс. значение
1156 - }
1157 - "drivers": [ ~/~/ Водители
1158 - {
1159 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1160 - "name": "string", ~/~/ Наименование
1161 - "description": "string",
1162 - "isDefault": true ~/~/ По умолчанию
1163 - }
1164 - ],
1165 1165   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1166 1166   {
1167 1167   "id": "", ~/~/ ID  задания
... ... @@ -1177,28 +1177,10 @@
1177 1177   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1178 1178   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1179 1179   }
1180 - ],
1181 -"statusHistory": [ ~/~/ История статусов
1182 - {
1183 - "status": 0,
1184 - "date": "2023-05-22T09:57:39.562Z",
1185 - "description": "string",
1186 - "additionalInfo": "string"
1187 -
1188 -(((
749 + ]
1189 1189  }
1190 - ],
1191 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1192 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1193 1193  )))
1194 1194  
1195 -(((
1196 - ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1197 -}
1198 -
1199 -)))
1200 -)))
1201 -
1202 1202  (% style="text-align:left" %)
1203 1203  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1204 1204  
... ... @@ -1205,75 +1205,6 @@
1205 1205  (% style="text-align:left" %)
1206 1206  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1207 1207  
1208 -
1209 -== **Отправить команду на терминал** ==
1210 -
1211 -(% class="box successmessage" %)
1212 -(((
1213 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1214 -)))
1215 -
1216 -Команда для отправки на тс.
1217 -
1218 -{  
1219 -"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1220 -"command": "", ~/~/ Текст отправляемой команды
1221 -"retries": "", ~/~/ Количество попыток отправки на терминал
1222 -"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1223 -}
1224 -
1225 -В ответ получаем cmdid
1226 -
1227 -
1228 -== **Получить ответ на отправленную на ТС команду** ==
1229 -
1230 -(% class="box infomessage" %)
1231 -(((
1232 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1233 -)))
1234 -
1235 -Идентификатор команды: cmdId
1236 -
1237 -Запрос от терминала на ответ команды
1238 -
1239 -Пример ответ от терминала:
1240 -
1241 -ID= "" ~/~/ идентификатор объекта
1242 -Soft="" ~/~/ версия софта
1243 -GPS=4 ~/~/ тип трекера
1244 -Time=11:05:43 28.06.24 ~/~/ время запроса
1245 -Lat=45.056221 ~/~/ широта
1246 -Lon=39.035938 ~/~/ долгота
1247 -Speed=0.0 ~/~/ скорость
1248 -Course=181.4 ~/~/направление
1249 -
1250 -(((
1251 -== **Список отправленных объекту команд с ответами** ==
1252 -
1253 -(% class="box infomessage" %)
1254 -(((
1255 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1256 -)))
1257 -
1258 -Идентификатор ТС: vehicleId
1259 -
1260 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1261 -
1262 -Пример ответа терминала
1263 -
1264 -[ 
1265 -{    
1266 -"id": "", ~/~/ идентификатор пользователя
1267 -"commandText": "", ~/~/Текст команды.
1268 -"templateId": "", ~/~/Идентификатор шаблона
1269 -"updated": "", ~/~/ Время отправки  
1270 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1271 -"answer": "", ~/~/ Ответ терминала.
1272 -"status": "" ~/~/ Статус отправки
1273 -}
1274 -]
1275 -)))
1276 -
1277 1277  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1278 1278  
1279 1279  (% class="box successmessage" %)
... ... @@ -1281,7 +1281,7 @@
1281 1281  (% lang="en-US" %)**POST /api/v3/vehicles**
1282 1282  )))
1283 1283  
1284 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
1285 1285  
1286 1286  (% style="color:#000000" %)Метод запроса: **POST**
1287 1287  
... ... @@ -1293,11 +1293,6 @@
1293 1293  
1294 1294  (% style="color:#000000" %){
1295 1295  
1296 -
1297 -(((
1298 - "vehicleId": 0, ~/~/ ID ТС
1299 -)))
1300 -
1301 1301   "parentId": "" , ~/~/ ID клиента
1302 1302   "name": "" , ~/~/ имя ТС
1303 1303   "imei": "" , ~/~/ IMEI
... ... @@ -1318,10 +1318,6 @@
1318 1318   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1319 1319   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1320 1320   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1321 - "mileageCalcMethod": 0,
1322 - "mileageCoeff": 0,
1323 - "locationByCellId": true,
1324 - "dottedLineTrackWhenNoCoords": true,
1325 1325   "counters": ~/~/ счетчики
1326 1326   {
1327 1327   "mileage": "" , ~/~/ пробег
... ... @@ -1350,348 +1350,69 @@
1350 1350   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1351 1351   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1352 1352   }
1353 -"drivers": [ ~/~/ Водители
1354 - {
1355 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1356 - "isDefault": true
1357 - }
1358 - ],
1359 - "commandTemplates": [ ~/~/ Шаблон команды
1360 - {
1361 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1362 - "name": "string",
1363 - "command": "string",
1364 - "retries": 0
1365 - }
1366 - ],
1367 -"sensors": [ ~/~/ Датчики
1368 - {
1369 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1370 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1371 - "type": 0, ~/~/ Тип датчика
1372 - "name": "string", ~/~/ Имя датчика
1373 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1374 - "inputNumber": 0, ~/~/ Номер входа
1375 - "pseudonym": "string", ~/~/ Псевдоним
1376 - "medianDegree": 0, ~/~/ Медианная фильтрация
1377 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1378 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1379 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1380 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1381 - {
1382 - "grades": [ ~/~/ Таблица тарировки 1
1383 - {
1384 - "input": 0, ~/~/ Входящее значение
1385 - "output": 0 ~/~/ Выходящее значение
1386 - }
1387 - ],
1388 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1389 - }
1390 - ],
1391 - "showInTooltip": true, ~/~/ Отображать в подсказке
1392 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1393 - "color": "string", ~/~/ код цвета датчиков
1394 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1395 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1396 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1397 - "expr": "string", ~/~/ Формула
1398 - "children": [ ~/~/ массив дочерних датчиков
1399 - "string"
1400 - ],
1401 - "customParams": { ~/~/ прочие произвольные параметры
1402 - "additionalProp1": "string",
1403 - "additionalProp2": "string",
1404 - "additionalProp3": "string"
1405 - },
1406 -~/~/ Характерные для произвольного:
1407 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1408 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1409 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1410 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1411 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1412 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1413 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1414 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1415 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1416 -~/~/ "ValueOn": "Вкл.",
1417 -~/~/ "ValueOff": "Выкл."
1418 - "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1419 1419  
1420 -(((
1421 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1422 - {
1423 - "from": 0, ~/~/ С какого значения
1424 - "color": "string", ~/~/ Каким цветом
1425 - "text": "string" ~/~/ Текст подписи к этому интервалу
1426 - }
1427 - ]
1428 - }
1429 - ],
1430 -)))
827 +(% style="color:#000000" %) }
1431 1431  
1432 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1433 -
1434 -
1435 - "customFields": [ ~/~/ Произвольные поля
1436 - {
1437 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1438 - "name": "string", ~/~/ Наименование произвольного поля
1439 - "value": "string", ~/~/ Значение произвольного поля
1440 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1441 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1442 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1443 -
1444 -(((
1445 - }
1446 - ],
1447 - "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1448 -)))
1449 -
1450 -(((
1451 - ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1452 -}
1453 -)))
1454 -
1455 -
1456 1456  (% style="color:#000000" %)Ответ:
1457 1457  
831 +(% style="color:#000000" %){
1458 1458  
1459 -(((
1460 -(((
1461 -(((
1462 -{
1463 - "vehicleId": 0,  ~/~/ ID ТС
1464 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1465 - "name": "string", ~/~/ Имя объекта
1466 - "imei": "string", ~/~/ IMEI
1467 - "deviceTypeId": 0, ~/~/ ID типа устройства
1468 - "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1469 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1470 - "sim1": "string", ~/~/ SIM1
1471 - "sim2": "string", ~/~/ SIM2
1472 - "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1473 - "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1474 - "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1475 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1476 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1477 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1478 - "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1479 - "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1480 - "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1481 - "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1482 - "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1483 - "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1484 - "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1485 - "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1486 - "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1487 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1488 - "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1489 - "counters": {  ~/~/ Dto для состояний счётчиков
1490 - "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1491 - "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1492 - "mileage": 0, ~/~/ Пробег
1493 - "motohours": 0 ~/~/ Моточасы
1494 - },
1495 - "cmsv6Parameters": { ~/~/ Dto для CMSv6
1496 - "id": "string", ~/~/ CMSV6 Идентификатор
1497 - "enabled": true, ~/~/ Признак включения
1498 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1499 - "login": "string", ~/~/ CMSV6 имя учетной записи
1500 - "password": "string" ~/~/ CMSV6 — пароль учетной записи
1501 - },
1502 - "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1503 - {
1504 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1505 - "enabled": true, ~/~/ Признак включения
1506 - "name": "string", ~/~/ Имя задания
1507 - "description": "string", ~/~/ Описание задания
1508 - "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1509 - "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1510 - "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1511 - "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1512 - "periodicCondition": 0, ~/~/ Условие периодичности по времени
1513 - "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1514 - "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1515 - "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
833 + "vehicleId": "", ~/~/ID ТС 
834 + "parentId": "", ~/~/Guid владельца ТС
835 + "name": "", ~/~/Имя объекта
836 + "imei": "", ~/~/IMEI
837 + "deviceTypeId": "", ~/~/ID типа устройства
838 + "modelId": "", ~/~/ID модели
839 + "unitId": "", ~/~/ID подразделения
840 + "sim1": "", ~/~/SIM1
841 + "sim2": "", ~/~/SIM2
842 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
843 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
844 + "counters": { ~/~/Счётчики
845 + "mileageEnabled": true,
846 + "motohoursEnabled": true,
847 + "mileage": "",
848 + "motohours": 345.0
849 + },
850 + "cmsv6Parameters": { ~/~/Параметры CmsV6
851 + "id": null,
852 + "enabled": true, ~/~/флаг включения
853 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
854 + "login": "", ~/~/ имя учетной записи
855 + "password": "" ~/~/ пароль учетной записи
856 + },
857 + "inspectionTasks": { ~/~/ задания на ТО
858 + "id": "", ~/~/ ID задачи
859 + "enabled": false, ~/~/ Признак включения
860 + "name": "", ~/~/ Имя задания
861 + "description": "", ~/~/ Описание задания
862 + "mileageCondition": "", ~/~/ Условие по пробегу
863 + "lastMileage": "", ~/~/ Пробег (в метрах)
864 + "motohoursCondition": "", ~/~/ Условие по моточасам
865 + "lastMotohours": "", ~/~/ Моточасы
866 + "periodicCondition": "", ~/~/ Условие периодичности по времени
867 + "kind": "", ~/~/ Вид периодичности по времени 
868 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1516 1516   }
1517 - ],
1518 - "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1519 - {
1520 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1521 - "inputNumber": 0, ~/~/ № входа.
1522 - "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1523 - "comment": "string", ~/~/ Комментарий
1524 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1525 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1526 - "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1527 - "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1528 - }
1529 - ],
1530 - "commandTemplates": [  ~/~/ Список шаблонов команд
1531 - {
1532 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1533 - "name": "string", ~/~/ Название шаблона команд
1534 - "command": "string", ~/~/ Команда на выполнение
1535 - "retries": 0 ~/~/ Лимит попыток отправки
1536 - }
1537 - ],
1538 - "sensors": [ ~/~/ Список датчиков
1539 - {
1540 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1541 - "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1542 - "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
1543 - "name": "string",  ~/~/ Имя датчика
1544 - "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1545 - "inputNumber": 0, ~/~/ Номер входа
1546 - "pseudonym": "string", ~/~/ Псевдоним
1547 - "medianDegree": 0, ~/~/ Степень медианной фильтрации
1548 - "isInverted": true, ~/~/  Признак инверсии
1549 - "disabled": true, ~/~/ Датчик не участвует в обработке
1550 - "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1551 - "gradesTables": [ ~/~/ Тарировка
1552 - {
1553 - "grades": [ ~/~/ Таблицы тарировки
1554 - {
1555 - "input": 0, ~/~/ Вход
1556 - "output": 0 ~/~/ Выход
1557 - }
1558 - ],
1559 - "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1560 - }
1561 - ],
1562 - "showInTooltip": true, ~/~/ Отображение в подсказке
1563 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1564 - "color": "string", ~/~/ код цвета датчиков
1565 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1566 - "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1567 - "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1568 - "expr": "string", ~/~/ Выражение
1569 - "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1570 - "string"
1571 - ],
1572 - "customParams": {
1573 - "additionalProp1": "string",
1574 - "additionalProp2": "string",
1575 - "additionalProp3": "string"
1576 - },
1577 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1578 - "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1579 - {
1580 - "from": 0, ~/~/ С какого значения
1581 - "color": "string", ~/~/ Каким цветом
1582 -)))
1583 1583  
1584 -(((
1585 - "text": "string" ~/~/ Текст подписи к этому интервалу
1586 - }
1587 - ]
1588 - }
1589 - ],
1590 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1591 - "customFields": [ ~/~/ Список произвольных полей
1592 - {
1593 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1594 - "name": "string", ~/~/ Наименование произвольного поля
1595 - "value": "string", ~/~/ Значение произвольного поля
1596 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1597 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1598 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1599 - }
1600 - ],
1601 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1602 -}
1603 -)))
1604 -)))
1605 -)))
871 +(% style="text-align:left" %)
872 +(% style="color:#000000" %)}
1606 1606  
1607 -
1608 1608  **Валидация:**
1609 1609  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1610 1610  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1611 1611  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1612 1612  
879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1613 1613  
1614 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1615 -
1616 -(% class="box successmessage" %)
1617 -(((
1618 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1619 -)))
1620 -
1621 -Метод запроса: **POST**
1622 -
1623 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1624 -
1625 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1626 -
1627 -
1628 -Ответ:
1629 -
1630 -{
1631 -
1632 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1633 -
1634 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1635 -
1636 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1637 -
1638 - "Message": "string", ~/~/ Информация о выполнении запроса
1639 -
1640 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1641 -
1642 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1643 -
1644 - "Data": "string" ~/~/ Данные
1645 -
1646 -}
1647 -
1648 -
1649 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1650 -
1651 1651  (% class="box infomessage" %)
1652 1652  (((
1653 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1654 -)))
1655 -
1656 -Метод запроса: **GET**
1657 -
1658 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1659 -
1660 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1661 -
1662 -
1663 -Ответ:
1664 -
1665 -{
1666 -
1667 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1668 -
1669 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1670 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1671 -
1672 - "Message": "string", ~/~/ Информация о выполнении запроса
1673 -
1674 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1675 -
1676 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1677 -
1678 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1679 -
1680 - "Data": "string" ~/~/ Данные
1681 -
1682 -}
1683 -
1684 -
1685 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1686 -
1687 -(% class="box infomessage" %)
1688 -(((
1689 1689  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1690 1690  )))
1691 1691  
1692 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
886 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1693 1693  
1694 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1695 1695  
1696 1696  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1697 1697  
... ... @@ -1723,12 +1723,9 @@
1723 1723   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1724 1724   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1725 1725   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1726 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1727 - "unitName": "string",  ~/~/ Название подразделения (опционально)
1728 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1729 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1730 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1731 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
920 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
921 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
922 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1732 1732  }
1733 1733  
1734 1734  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1735,14 +1735,8 @@
1735 1735  
1736 1736  (% style="color:#000000" %)Ответ:
1737 1737  
1738 -(% style="color:#000000" %)[
1739 -{
929 +(% style="color:#000000" %){
1740 1740  
1741 -(((
1742 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1743 -)))
1744 -
1745 -(((
1746 1746  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1747 1747   "name": "" ~/~/ наименование объекта
1748 1748   "imei": "" ~/~/ IMEI объекта
... ... @@ -1768,21 +1768,9 @@
1768 1768   "forClient": true, ~/~/ право на отображение у клиента
1769 1769   "forTooltip": false, ~/~/ право на отображение в подсказке
1770 1770   "forReport": false ~/~/ право на отображение в отчетах
1771 -)))
956 + }(%%)
957 +(% style="color:#000000" %)}
1772 1772  
1773 -(((
1774 - }
1775 - ],
1776 - "vehicleGroups": [  ~/~/ Группы ТС
1777 - {
1778 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1779 - "name": "string" ~/~/ Наименование группы ТС
1780 - }
1781 - ]
1782 - }
1783 -]
1784 -)))
1785 -
1786 1786  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1787 1787  
1788 1788  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -1792,7 +1792,7 @@
1792 1792  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1793 1793  )))
1794 1794  
1795 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1796 1796  
1797 1797  (% style="color:#000000" %)Метод запроса: **POST**
1798 1798  
... ... @@ -1814,11 +1814,13 @@
1814 1814   "data": "", ~/~/ Данные
1815 1815   "overwrite": false, ~/~/ Флаг перезаписи
1816 1816   "stage": "", ~/~/ Состояние, может быть null
990 +
1817 1817  (% style="color:#000000" %)}
1818 1818  
1819 1819  (% style="color:#000000" %)Ответ:
1820 1820  
1821 -(% style="color:#000000" %){(%%)
995 +(% style="color:#000000" %){
996 +
1822 1822   "status": "", ~/~/ значение статуса
1823 1823   "date": "", ~/~/ Дата смены статуса 
1824 1824   "description": "", ~/~/ Описание
... ... @@ -1825,10 +1825,10 @@
1825 1825   "data": "", ~/~/ Данные
1826 1826   "overwrite": false, ~/~/ Флаг перезаписи
1827 1827   "stage": "", ~/~/ Состояние
1003 +
1004 +(% style="text-align:left" %)
1828 1828  (% style="color:#000000" %) }
1829 1829  
1830 -== ==
1831 -
1832 1832  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1833 1833  
1834 1834  (% class="box warningmessage" %)
... ... @@ -1836,7 +1836,7 @@
1836 1836  (% lang="en-US" %)**PUT /api/v3/vehicles**
1837 1837  )))
1838 1838  
1839 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1840 1840  
1841 1841  (% style="color:#000000" %)Метод запроса: **PUT**
1842 1842  
... ... @@ -1846,16 +1846,18 @@
1846 1846  
1847 1847  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1848 1848  
1849 -(% style="color:#000000" %){
1850 - "vehicleId": , ~/~/ ID объекта
1851 - "parentId": "" , ~/~/ ID клиента
1852 - "name": "" , ~/~/ имя ТС
1853 - "imei": "" , ~/~/ IMEI
1854 - "deviceTypeId": "" , ~/~/ ID типа устройства
1855 - "modelId": "" , ~/~/ ID модели
1856 - "unitId": "" , ~/~/ ID подразделения
1857 - "sim1": "" , ~/~/ Номер SIM 1
1858 - "sim2": "" , ~/~/ Номер SIM2
1024 +(% style="color:#000000" %){    
1025 +
1026 +(((
1027 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1028 + "parentId": "", ~/~/ ID клиента
1029 + "name": "", ~/~/ имя ТС
1030 + "imei": "", ~/~/ IMEI
1031 + "deviceTypeId": "", ~/~/ ID типа устройства
1032 + "modelId": "", ~/~/ , ID модели    
1033 + "unitId": "", ~/~/ подразделения
1034 + "sim1": "", ~/~/ SIM 1
1035 + "sim2": "", ~/~/ SIM2     (%%)
1859 1859   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1860 1860   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1861 1861   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -1868,327 +1868,90 @@
1868 1868   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1869 1869   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1870 1870   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1871 -
1872 - "mileageCalcMethod": 0,
1873 - "mileageCoeff": 0,
1874 - "locationByCellId": true,
1875 - "dottedLineTrackWhenNoCoords": true,
1876 - "counters": ~/~/ счетчики
1877 - {
1878 - "mileage": "" , ~/~/ пробег
1879 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1880 - "motohours": "" , ~/~/ моточасы
1881 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1882 - },
1883 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1884 - "enabled": true, ~/~/ флаг включения
1885 - "id": "" , ~/~/ идентификатор
1886 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1887 - "login": "" , ~/~/ имя учетной записи
1888 - "password": "" ~/~/ пароль учетной записи
1889 - },
1890 - "inspectionTasks": ~/~/ задания на ТО
1891 - {
1892 - "enabled": "" , ~/~/ Признак включения
1893 - "name": "" , ~/~/ Имя задания
1894 - "description": "" , ~/~/ Описание задания
1895 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1896 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1897 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1898 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1899 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1900 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1901 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1902 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1903 - }
1904 -
1905 -"drivers": [ ~/~/ Водители
1906 - {
1907 -
1908 -(((
1909 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1910 - "inputNumber": 0, ~/~/ № входа.
1911 - "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1912 - "comment": "string", ~/~/ Комментарий.
1913 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1914 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1915 - "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1916 - "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1048 +(% style="color:#000000" %) "counters": 
1049 + {
1050 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1051 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1052 + "mileage": "", ~/~/ пробег, в метрах 
1053 + "motohours": "" ~/~/ моточасы, в секундах
1054 + }
1055 + "cmsv6Parameters": ~/~/ параметры CMSv6
1056 + {       
1057 + "id": "", ~/~/ идентификатор
1058 + "enabled": true, ~/~/ флаг включения
1059 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1060 + "login": "", ~/~/ имя учетной записи
1061 + "password": "", ~/~/ пароль учетной записи
1062 + }
1063 + "inspectionTasks": ~/~/ задания на ТО
1064 + {
1065 + "id": "", ~/~/ ID задания
1066 + "enabled": false, ~/~/ Признак включения
1067 + "name": "", ~/~/ Имя задания
1068 + "description": "", ~/~/ Описание задания
1069 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1070 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1071 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1072 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1073 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1074 + "kind": "", ~/~/ Вид периодичности по времени
1075 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1076 + } 
1917 1917  )))
1918 1918  
1919 - } 
1920 - ],
1921 - "commandTemplates": [ ~/~/ Шаблон команды
1922 - {
1923 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1924 - "name": "string",
1925 - "command": "string",
1926 - "retries": 0
1927 - }
1928 - ],
1929 -"sensors": [ ~/~/ Датчики
1930 - {
1931 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1932 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1933 - "type": 0, ~/~/ Тип датчика
1934 - "name": "string", ~/~/ Имя датчика
1935 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1936 - "inputNumber": 0, ~/~/ Номер входа
1937 - "pseudonym": "string", ~/~/ Псевдоним
1938 - "medianDegree": 0, ~/~/ Медианная фильтрация
1939 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1940 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1941 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1942 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1943 - {
1944 - "grades": [ ~/~/ Таблица тарировки 1
1945 - {
1946 - "input": 0, ~/~/ Входящее значение
1947 - "output": 0 ~/~/ Выходящее значение
1948 - }
1949 - ],
1950 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1951 - }
1952 - ],
1953 - "showInTooltip": true, ~/~/ Отображать в подсказке
1954 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1079 +(% style="color:#000000" %)}
1955 1955  
1956 -(((
1957 - "color": "string",** ~/~/ **Цвет датчика
1958 -)))
1959 -
1960 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1961 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1962 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1963 - "expr": "string", ~/~/ Формула
1964 - "children": [ ~/~/ массив дочерних датчиков
1965 - "string"
1966 - ],
1967 - "customParams": { ~/~/ прочие произвольные параметры
1968 - "additionalProp1": "string",
1969 - "additionalProp2": "string",
1970 - "additionalProp3": "string"
1971 - },
1972 -~/~/ Характерные для произвольного:
1973 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1974 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1975 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1976 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1977 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1978 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1979 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1980 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1981 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1982 -~/~/ "ValueOn": "Вкл.",
1983 -~/~/ "ValueOff": "Выкл."
1984 - "summaryMaxValue": 0 ~/~/ Макс. значение
1985 -
1986 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1987 - {
1988 - "from": 0, ~/~/ С какого значения
1989 - "color": "string", ~/~/ Каким цветом
1990 - "text": "string" ~/~/ Текст подписи к этому интервалу
1991 - }
1992 - ]
1993 - }
1994 - ],
1995 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1996 -
1997 - "customFields": [ ~/~/ Произвольные поля
1998 - {     
1999 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
2000 - "name": "string", ~/~/ Наименование произвольного поля
2001 - "value": "string", ~/~/ Значение произвольного поля
2002 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2003 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2004 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
2005 - }
2006 -
2007 -(((
2008 - ],
2009 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
2010 -)))
2011 -
2012 -}
2013 -
2014 -
2015 2015  (% style="color:#000000" %)Ответ:
2016 2016  
2017 -(((
2018 -{
2019 - "vehicleId": 0, ~/~/ ID ТС
2020 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
2021 - "name": "string", ~/~/ Имя объекта
2022 - "imei": "string", ~/~/ IMEI
2023 - "deviceTypeId": 0, ~/~/ ID типа устройства
2024 - "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
2025 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
2026 - "sim1": "string", ~/~/ SIM1
2027 - "sim2": "string", ~/~/ SIM2
2028 - "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
2029 - "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
2030 - "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
2031 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
2032 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
2033 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
2034 - "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
2035 - "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
2036 - "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
2037 - "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
2038 - "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
2039 - "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
2040 - "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
2041 - "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
2042 - "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
2043 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
2044 - "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
2045 - "counters": { ~/~/ состояний счётчиков
2046 - "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
2047 - "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
2048 - "mileage": 0, ~/~/ Пробег
2049 - "motohours": 0 ~/~/ Моточасы 
2050 - },
2051 - "cmsv6Parameters": { ~/~/ Dto для CMSv6
2052 - "id": "string", ~/~/ CMSV6 Идентификатор
2053 - "enabled": true, ~/~/ Признак включения
2054 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2055 -)))
1083 +(% lang="en-US" style="text-align:left" %)
1084 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
2056 2056  
2057 -
2058 -(((
2059 -~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2060 - "login": "string", ~/~/ CMSV6 имя учетной записи
2061 - "password": "string" ~/~/ CMSV6 — пароль учетной записи
2062 - },
2063 - "inspectionTasks": [ ~/~/ Задания на ТО
2064 - {
2065 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2066 - "enabled": true, ~/~/ Признак включения
2067 - "name": "string", ~/~/ Имя задания
2068 - "description": "string", ~/~/ Описание задания
2069 - "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2070 - "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2071 - "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2072 - "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2073 - "periodicCondition": 0, ~/~/ Условие периодичности по времени
2074 - "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2075 - "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2076 - "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2077 - }
2078 - ],
2079 - "drivers": [  ~/~/ Список водителей
2080 - {
2081 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2082 - "inputNumber": 0, ~/~/ № входа.
2083 - "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2084 - "comment": "string", ~/~/ Комментарий.
2085 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2086 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2087 - "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2088 - "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2089 - }
2090 - ],
2091 - "commandTemplates": [ ~/~/ Список шаблонов команд
2092 - {
2093 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2094 - "name": "string", ~/~/ Название шаблона команд
2095 - "command": "string", ~/~/ Команда на выполнение
2096 - "retries": 0 ~/~/ Лимит попыток отправки
2097 - }
2098 - ],
2099 - "sensors": [  ~/~/ Список датчиков 
2100 - {
2101 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2102 - "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2103 - "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2104 -)))
2105 -
2106 -(((
2107 -~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2108 -)))
2109 -
2110 -(((
2111 -~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2112 -)))
2113 -
2114 -(((
2115 -~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2116 -)))
2117 -
2118 -(((
2119 -~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2120 -)))
2121 -
2122 -(((
2123 -~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2124 - "name": "string", ~/~/ Имя датчика
2125 - "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2126 -)))
2127 -
2128 -(((
2129 -~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2130 - "inputNumber": 0, ~/~/ Номер входа
2131 - "pseudonym": "string", ~/~/ Псевдоним
2132 - "medianDegree": 0, ~/~/ Степень медианной фильтрации
2133 - "isInverted": true, ~/~/ Признак инверсии
2134 - "disabled": true, ~/~/ Датчик не участвует в обработке
2135 - "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2136 - "gradesTables": [ ~/~/ Тарировка
1086 +(% lang="en-US" style="text-align:left" %)
1087 + "vehicleId": "", ~/~/ ID ТС
1088 + "parentId": "", ~/~/ ID клиента
1089 + "name": "", ~/~/ имя ТС
1090 + "imei": "", ~/~/ IMEI
1091 + "deviceTypeId": "", ~/~/ типа устройства
1092 + "modelId": "", ~/~/ ID модели
1093 + "unitId": "", ~/~/ ID подразделения
1094 + "sim1": "", ~/~/ SIM 1
1095 + "sim2": "", ~/~/ SIM2
1096 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1097 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1098 + "counters": 
1099 + {
1100 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1101 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1102 + "mileage": "", ~/~/ пробег
1103 + "motohours": "", ~/~/ моточасы
1104 + }
1105 + "cmsv6Parameters": ~/~/ параметры CMSv6
2137 2137   {
2138 - "grades": [ ~/~/ Таблицы тарировки
2139 - {
2140 - "input": 0, ~/~/ Вход
2141 - "output": 0 ~/~/ Выход
2142 - }
2143 - ],
2144 - "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2145 - }
2146 - ],
2147 - "showInTooltip": true, ~/~/ Отображение в подсказке
2148 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
2149 -
2150 -(((
2151 - "color": "string", ~/~/ цвет уведомлений
2152 -)))
2153 -
2154 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2155 - "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2156 - "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2157 - "expr": "string", ~/~/ Выражение
2158 - "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2159 - "string" 
2160 - ],
2161 - "customParams": { ~/~/ Дополнительные настройки
2162 - "additionalProp1": "string",
2163 - "additionalProp2": "string",
2164 - "additionalProp3": "string"
2165 - },
2166 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2167 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1107 + "id": ~/~/ идентификатор
1108 + "enabled": true, ~/~/ флаг включения
1109 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1110 + "login": "", ~/~/ имя учетной записи
1111 + "password": "", ~/~/ пароль учетной записи
1112 + }
1113 + "inspectionTasks": ~/~/ задания на ТО
2168 2168   {
2169 - "from": 0, ~/~/ С какого значения
2170 - "color": "string", ~/~/ Каким цветом
2171 - "text": "string" ~/~/ Текст подписи к этому интервалу
1115 + "id": "", ~/~/ ID задания
1116 + "enabled": false, ~/~/ Признак включения
1117 + "name": "", ~/~/ Имя задания
1118 + "description": "", ~/~/ Описание задания
1119 + "mileageCondition": "", ~/~/ Условие по пробегу
1120 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1121 + "motohoursCondition": "", ~/~/ Условие по моточасам
1122 + "lastMotohours": "", ~/~/ Моточасы
1123 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1124 + "kind": "", ~/~/ Вид периодичности по времени
1125 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2172 2172   }
2173 - ]
2174 - }
2175 - ],
2176 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2177 - "customFields": [ ~/~/ Список произвольных полей
2178 - {
2179 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2180 - "name": "string", ~/~/ Наименование произвольного поля
2181 - "value": "string", ~/~/ Значение произвольного поля
2182 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2183 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2184 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
2185 - }
2186 - ],
2187 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2188 -}
2189 -)))
2190 2190  
2191 -**Валидация:**
1128 +(% lang="en-US" style="text-align:left" %)
1129 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1130 +
1131 +**валидация:**
2192 2192  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2193 2193  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2194 2194  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
... ... @@ -2200,7 +2200,7 @@
2200 2200  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2201 2201  )))
2202 2202  
2203 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2204 2204  
2205 2205  (% style="color:#000000" %)Метод запроса: **DELETE**
2206 2206  
... ... @@ -2222,19 +2222,22 @@
2222 2222  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2223 2223  )))
2224 2224  
2225 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2226 2226  
2227 2227  (% style="color:#000000" %)Метод запроса: **GET**
2228 2228  
2229 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1169 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
2230 2230  
2231 2231  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2232 2232  
2233 2233  (% style="color:#000000" %)Ответ:
2234 2234  
2235 -(% style="color:#000000" %){(%%)
1175 +(% style="color:#000000" %){
1176 +
2236 2236   "deviceTypeId" : "", ~/~/ ID типа устройства
2237 2237   "deviceTypeName" : "" ~/~/ Название типа устройства
1179 +
1180 +(% style="text-align:left" %)
2238 2238  (% style="color:#000000" %)}
2239 2239  
2240 2240  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -2246,7 +2246,7 @@
2246 2246  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2247 2247  )))
2248 2248  
2249 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2250 2250  
2251 2251  (% style="color:#000000" %)Метод запроса: **GET**
2252 2252  
... ... @@ -2256,13 +2256,16 @@
2256 2256  
2257 2257  (% style="color:#000000" %)Ответ:
2258 2258  
2259 -(% style="color:#000000" %){(%%)
1202 +(% style="color:#000000" %){
1203 +
2260 2260   "id": "", ~/~/ ID типа датчика 
2261 2261   "name": "", ~/~/ Название
2262 2262   "description": "", ~/~/ Описание
1207 +
1208 +(% style="text-align:left" %)
2263 2263  (% style="color:#000000" %)}
2264 2264  
2265 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
2266 2266  
2267 2267  == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2268 2268  
... ... @@ -2272,7 +2272,7 @@
2272 2272  )))
2273 2273  
2274 2274  (% style="text-align: left;" %)
2275 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2276 2276  
2277 2277  (% style="text-align: left;" %)
2278 2278  Метод запроса **POST**
... ... @@ -2303,3160 +2303,7 @@
2303 2303   }
2304 2304  ]
2305 2305  
2306 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2307 2307  
2308 -(% class="box infomessage" style="text-align: left;" %)
2309 -(((
2310 -**POST /api/v3/terminalMessages/mapping**
2311 -)))
2312 -
2313 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2314 -
2315 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2316 -
2317 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2318 -
2319 -{
2320 - "protocolType": 0,
2321 - "params": ["string"]
2322 -}
2323 -
2324 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2325 -|protocolType|ID типа протокола
2326 -|params|(((
2327 -Массив наименований параметров в сообщении
2328 -)))
2329 -
2330 -Ответ:
2331 -
2332 -{
2333 - "protocolType": 0,
2334 - "mapping": {
2335 - "additionalProp1": {
2336 - "inputType": 0,
2337 - "inputNumber": 0
2338 - },
2339 - "additionalProp2": {
2340 - "inputType": 0,
2341 - "inputNumber": 0
2342 - }
2343 - }
2344 -}
2345 -
2346 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2347 -|protocolType|Тип протокола
2348 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2349 -|inputNumber|(((
2350 -Номер входа
2351 -)))
2352 -
2353 -(% class="wikigeneratedid" %)
2354 -Перечень 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/]]
2355 -
2356 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2357 -
2358 -(% class="box infomessage" %)
2359 -(((
2360 -**POST /api/v3/terminalMessages**
2361 -)))
2362 -
2363 -Метод возвращает список сообщений терминала объекта за выбранный период.
2364 -
2365 -(% style="text-align: left;" %)
2366 -Метод запроса **POST**
2367 -
2368 -(% style="text-align: left;" %)
2369 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2370 -
2371 -(% style="text-align: left;" %)
2372 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2373 -
2374 -{
2375 - "vehicleId": 0, ~/~/ id объекта
2376 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2377 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2378 -}
2379 -
2380 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2381 -|vehicleId|ID объекта
2382 -|from|Дата и время начала периода запроса
2383 -|to|Дата и время окончания периода запроса
2384 -
2385 -Ответ:
2386 -
2387 -[
2388 - {
2389 - "messages": [
2390 - {
2391 - "deviceTime": "2023-11-29T07:40:44.052Z",
2392 - "serverTime": "2023-11-29T07:40:44.052Z",
2393 - "speed": 0,
2394 - "altitude": 0,
2395 - "latitude": 0,
2396 - "longitude": 0,
2397 - "satellites": 0,
2398 - "course": 0,
2399 - "voltage": 0,
2400 - "parameters": {
2401 - "additionalProp1": "string",
2402 - "additionalProp2": "string",
2403 - "additionalProp3": "string"
2404 - },
2405 - "photoCount": 0,
2406 - "lbsCorrectedCoords": true,
2407 - "protocolType": 0
2408 - }
2409 - ]
2410 - }
2411 -]
2412 -
2413 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2414 -|deviceTime|Время сообщения терминала
2415 -|serverTime|Время когда сообщение поступило на сервер
2416 -|speed|Скорость
2417 -|altitude|Высота над уровнем моря
2418 -|latitude|Широта
2419 -|longitude|Долгота
2420 -|satellites|Кол-во спутников
2421 -|course|Курс
2422 -|voltage|Бортовое напряжение
2423 -|parameters|Список параметров и их значений
2424 -|photoCount|Количество фото
2425 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2426 -|protocolType|ID типа протокола
2427 -
2428 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2429 -
2430 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2431 -
2432 -(% class="box infomessage" %)
2433 -(((
2434 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2435 -)))
2436 -
2437 -(% style="color:#000000" %)Метод запроса: **POST**
2438 -
2439 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2440 -
2441 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2442 -
2443 -(% style="text-align:left" %)
2444 -Тело запроса:
2445 -
2446 -{
2447 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2448 - "vehicleIds": [0], ~/~/ Список ID объектов
2449 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2450 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2451 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2452 -}
2453 -
2454 -Ответ:
2455 -
2456 -[
2457 - {
2458 - "vehicleId": 0, ~/~/ ID объекта
2459 - "name": "string", ~/~/ Имя ТС
2460 - "periods": [ ~/~/ Периоды
2461 - {
2462 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2463 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2464 - "mileage": 0, ~/~/ Пробег за период, километры
2465 - "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2466 - "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2467 - "motohours": 0, ~/~/ Моточасы за период, секунды
2468 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2469 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2470 - }
2471 - ]
2472 - }
2473 -]
2474 -
2475 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2476 -
2477 -(% class="box infomessage" %)
2478 -(((
2479 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2480 -)))
2481 -
2482 -(% style="color:#000000" %)Метод запроса: **POST**
2483 -
2484 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2485 -
2486 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2487 -
2488 -(% style="text-align:left" %)
2489 -Тело запроса:
2490 -
2491 -{
2492 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2493 - "vehicleIds": [0], ~/~/ Список ID объектов
2494 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2495 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2496 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2497 -}
2498 -
2499 -Ответ:
2500 -
2501 -[
2502 - {
2503 - "vehicleId": 0, ~/~/ ID объекта
2504 - "name": "string", ~/~/ Имя ТС
2505 - "periods": [ ~/~/ Периоды
2506 - {
2507 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2508 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2509 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2510 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2511 - "fuelConsumption": 0, ~/~/ Расход топлива
2512 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2513 - }
2514 - ]
2515 - }
2516 -]
2517 -
2518 -(% class="box warningmessage" %)
2519 -(((
2520 -Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2521 -\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2522 -)))
2523 -
2524 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2525 -
2526 -(% class="box infomessage" %)
2527 -(((
2528 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2529 -)))
2530 -
2531 -(% style="color:#000000" %)Метод запроса: **POST**
2532 -
2533 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2534 -
2535 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2536 -
2537 -(% style="text-align:left" %)
2538 -Тело запроса:
2539 -
2540 -{
2541 - "vehicleIds": [0], ~/~/ Список ID объектов
2542 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2543 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2544 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2545 -}
2546 -
2547 -Ответ:
2548 -
2549 -[
2550 - {
2551 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2552 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2553 - "vehicleId": 0, ~/~/ ID объекта
2554 - "name": "string", ~/~/ Имя объекта
2555 - "model": "string", ~/~/ Модель объекта
2556 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2557 - {
2558 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2559 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2560 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2561 - "valueFuel": 0, ~/~/ Количество
2562 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2563 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2564 - }
2565 - ]
2566 - }
2567 -]
2568 -
2569 -
2570 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2571 -
2572 -(% class="box infomessage" %)
2573 -(((
2574 -**POST /api/v3/vehicles/moveStop**
2575 -)))
2576 -
2577 -Метод запроса: **POST**
2578 -
2579 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2580 -
2581 -В заголовках запроса: X-Auth: Токен авторизации
2582 -
2583 -
2584 -Тело запроса:
2585 -
2586 -{
2587 - "vehicleIds": [ ], ~/~/ Список ID объектов
2588 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2589 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2590 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2591 -}
2592 -
2593 -Ответ:
2594 -
2595 -[ 
2596 - {
2597 - "vehicleId": 0, ~/~/ ID объекта
2598 - "vehicleName": "string", ~/~/ Имя объекта
2599 - "moves": [ ~/~/ Событие движения
2600 - {
2601 - "mileage": 0, ~/~/ Пробег, км
2602 - "eventId": 0, ~/~/ Идентификатор события
2603 - "eventName": "string", ~/~/ Название события
2604 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2605 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2606 - "duration": 0 ~/~/ Продолжительность события, секунд
2607 - }
2608 - ],
2609 - "stops": [ ~/~/ События стоянок
2610 - {
2611 - "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2612 - "eventId": 0, ~/~/ Идентификатор события
2613 - "eventName": "string", ~/~/ Название события
2614 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2615 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2616 - "duration": 0 ~/~/ Продолжительность события, секунд
2617 - }
2618 - ]
2619 - }
2620 -]
2621 -
2622 -
2623 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2624 -
2625 -(% class="box infomessage" %)
2626 -(((
2627 -**POST /api/v3/vehicles/getlastdata**
2628 -)))
2629 -
2630 -Метод запроса: **POST**
2631 -
2632 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2633 -
2634 -В заголовках запроса: X-Auth: Токен авторизации
2635 -
2636 -
2637 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2638 -
2639 -Ответ:
2640 - {
2641 - "vehicleId": 0, ~/~/Идентификатор объекта.
2642 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2643 - "vehicleNumber": "string",~/~/Номер объекта.
2644 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2645 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2646 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2647 - "speed": 0,~/~/Скорость объекта.
2648 - "course": 0,~/~/Курс движения [0;360]
2649 - "latitude": 0,~/~/Широта [-90°;90°].
2650 - "longitude": 0,~/~/Долгота [-180°;180°].
2651 - "address": "string",~/~/Адрес.
2652 - "geozones": [ ~/~/Сведения по геозонам.
2653 - {
2654 - "id": 0,
2655 - "name": "string"
2656 - }
2657 -
2658 -
2659 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2660 -
2661 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2662 -
2663 -(% class="box infomessage" %)
2664 -(((
2665 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2666 -)))
2667 -
2668 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2669 -
2670 -(% style="color:#000000" %)Метод запроса: **POST**
2671 -
2672 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2673 -
2674 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2675 -
2676 -(% style="text-align:left" %)
2677 -Тело запроса:
2678 -
2679 -(% style="text-align:left" %)
2680 -{
2681 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2682 -}
2683 -
2684 -(% style="text-align:left" %)
2685 -Ответ:
2686 -
2687 -[
2688 - {
2689 - "id": 0, ~/~/ Идентификатор объекта геозоны
2690 - "name": "string", ~/~/ Название объекта геозоны
2691 - "type": 0, ~/~/ Тип объекта геозоны
2692 - "fname": "string", ~/~/ Имя файла
2693 - "parentId": "string", ~/~/ Идентификатор клиента
2694 - "radius": 0, ~/~/ Радиус геообъекта
2695 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2696 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2697 - "description": "string", ~/~/ Описание
2698 - "area": 0, ~/~/ Площадь, м^^2^^
2699 - "perimetr": 0, ~/~/ Периметр, м
2700 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2701 - }
2702 -]
2703 -
2704 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2705 -
2706 -(% class="box infomessage" %)
2707 -(((
2708 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2709 -)))
2710 -
2711 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2712 -
2713 -(% style="color:#000000" %)Метод запроса: **POST**
2714 -
2715 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2716 -
2717 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2718 -
2719 -(% style="text-align:left" %)
2720 -Тело запроса:
2721 -
2722 -{
2723 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2724 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2725 - "ids": [ ], ~/~/ Массив id объектов
2726 - "byTime": 0, ~/~/ Объединение событий по времени 
2727 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2728 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2729 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2730 -}
2731 -
2732 -Ответ:
2733 -[
2734 - {
2735 - "geozoneId": 0, ~/~/ ID геообъекта
2736 - "geozoneName": "string", ~/~/ Название геообъекта
2737 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2738 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2739 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2740 - "vehicleId": 0, ~/~/ ID объекта
2741 - "vehicleName": "string" ~/~/ Имя объекта
2742 - }
2743 -]
2744 -
2745 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2746 -
2747 -(% class="box infomessage" %)
2748 -(((
2749 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2750 -)))
2751 -
2752 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2753 -
2754 -(% style="color:#000000" %)Метод запроса: **POST**
2755 -
2756 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2757 -
2758 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2759 -
2760 -(% style="text-align:left" %)
2761 -Тело запроса:
2762 -
2763 -{
2764 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2765 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2766 - "ids": [ ], ~/~/ Массив id геообъектов
2767 - "byTime": 0, ~/~/ Объединение событий по времени 
2768 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2769 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2770 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2771 -}
2772 -
2773 -Ответ:
2774 -
2775 -[
2776 - {
2777 - "geozoneId": 0, ~/~/ ID геообъекта
2778 - "geozoneName": "string", ~/~/ Название геообъекта
2779 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2780 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2781 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2782 - "vehicleId": 0, ~/~/ ID объекта
2783 - "vehicleName": "string" ~/~/ Имя объекта
2784 - }
2785 -]
2786 -
2787 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2788 -
2789 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2790 -
2791 -(% class="box infomessage" %)
2792 -(((
2793 -**POST /api/v3/notifications/find**
2794 -)))
2795 -
2796 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2797 -
2798 -(% style="text-align: left;" %)
2799 -Метод запроса **POST**
2800 -
2801 -(% style="text-align: left;" %)
2802 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2803 -
2804 -(% style="text-align: left;" %)
2805 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2806 -
2807 -{
2808 - "parentId": "" ~/~/ id клиента
2809 -}
2810 -
2811 -Ответ:
2812 -
2813 -[
2814 - {
2815 - "id": 0, ~/~/ ID уведомления
2816 - "name": "string", ~/~/ Название уведомления
2817 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2818 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2819 - "userId": "", ~/~/ Пользователь, создавший уведомление
2820 - "parentId": "", ~/~/ Идентификатор клиента
2821 - "parentName": "string" ~/~/ Имя клиента
2822 - }
2823 -]
2824 -
2825 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2826 -
2827 -(% class="box infomessage" %)
2828 -(((
2829 -**GET /api/v3/notifications/{id}**
2830 -)))
2831 -
2832 -Метод возвращает данные правил формирования выбранного уведомления.
2833 -
2834 -(% style="text-align: left;" %)
2835 -Метод запроса **GET**
2836 -
2837 -(% style="text-align: left;" %)
2838 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2839 -
2840 -(% style="text-align: left;" %)
2841 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2842 -
2843 -(% style="text-align: left;" %)
2844 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2845 -
2846 -(% style="text-align: left;" %)
2847 -(% style="color:#000000" %)Ответ:
2848 -
2849 -(% style="text-align: left;" %)
2850 -(% style="color:#000000" %){
2851 - "id": 0, ~/~/ (%%)id уведомления
2852 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2853 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2854 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2855 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2856 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2857 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2858 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2859 -(% style="color:#000000" %) 0
2860 - ],
2861 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2862 -(% style="color:#000000" %) 0
2863 - ],
2864 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
2865 -(% style="color:#000000" %) 0
2866 - ],
2867 - "settings": { ~/~/ Список параметров уведомления
2868 - "additionalProp1": "string",
2869 - "additionalProp2": "string",
2870 - "additionalProp3": "string"
2871 - },
2872 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2873 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2874 -(% style="color:#000000" %) ""
2875 - ],
2876 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2877 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2878 -(% style="color:#000000" %) "string"
2879 - ],
2880 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2881 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2882 -(% style="color:#000000" %) {
2883 - "id": 0, ~/~/ (%%)Идентификатор участника чата
2884 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2885 -(% style="color:#000000" %) }
2886 - ],
2887 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2888 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2889 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2890 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2891 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2892 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2893 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2894 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2895 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2896 -(% style="color:#000000" %)}
2897 -
2898 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2899 -
2900 -(% class="box warningmessage" %)
2901 -(((
2902 -**PUT /api/v3/notifications/**
2903 -)))
2904 -
2905 -Метод позволяет отредактировать уведомление.
2906 -
2907 -Метод запроса **PUT**
2908 -
2909 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2910 -
2911 -В заголовках запроса: X-Auth: Токен авторизации
2912 -
2913 -Тело запроса:
2914 -{
2915 - "id": 0, ~/~/ id уведомления
2916 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2917 - "userId": "", ~/~/ Пользователь, создавший уведомление
2918 - "parentId": "", ~/~/ Идентификатор клиента
2919 - "parentName": "string", ~/~/ Имя клиента
2920 - "name": "string", ~/~/ Название уведомления
2921 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2922 - "vehicleIds": [ ~/~/ Список id объектов для анализа
2923 - 0
2924 - ],
2925 - "geoids": [ ~/~/ Список id геообъектов для анализа
2926 - 0
2927 - ],
2928 - "fieldids": [ ~/~/ Список id полей для анализа
2929 - 0
2930 - ],
2931 - "settings": { ~/~/ Список параметров уведомления
2932 - "additionalProp1": "string",
2933 - "additionalProp2": "string",
2934 - "additionalProp3": "string"
2935 - },
2936 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2937 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2938 - ""
2939 - ],
2940 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2941 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2942 - "string"
2943 - ],
2944 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2945 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2946 - {
2947 - "id": 0, ~/~/ Идентификатор участника чата
2948 - "info": "string" ~/~/ Дополнительные сведения
2949 - }
2950 - ],
2951 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2952 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2953 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2954 - "kind": 0, ~/~/ Определяет вид уведомления
2955 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2956 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2957 - "timezone": 0, ~/~/ Сдвиг часового пояса
2958 - "validity": 0, ~/~/ Срок действия в днях (1-90)
2959 - "autoProlongation": true ~/~/ Автопродление срока действия
2960 -}
2961 -
2962 -Ответ:
2963 -
2964 -Success
2965 -
2966 -
2967 -== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2968 -
2969 -(% class="box warningmessage" %)
2970 -(((
2971 -**PUT** /api/v3/notifications/prolongation
2972 -)))
2973 -
2974 -Метод позволяет продлить уведомления.
2975 -
2976 -Метод запроса **PUT**
2977 -
2978 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2979 -
2980 -В заголовках запроса: X-Auth: Токен авторизации.
2981 -
2982 -Тело запроса:
2983 -
2984 -[
2985 -
2986 -0
2987 -
2988 -]
2989 -
2990 -где 0 идентификатор ids.
2991 -
2992 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2993 -
2994 -(% class="box errormessage" %)
2995 -(((
2996 -**DELETE /api/v3/notifications/{id}**
2997 -)))
2998 -
2999 -Метод позволяет удалить выбранное уведомление.
3000 -
3001 -Метод запроса **DELETE**
3002 -
3003 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3004 -
3005 -Передаваемый параметр: {id} - id уведомления
3006 -
3007 -В заголовках запроса: X-Auth: Токен авторизации
3008 -
3009 -Ответ:
3010 -
3011 -Success
3012 -
3013 -
3014 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3015 -
3016 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3017 -
3018 -(% class="box infomessage" %)
3019 -(((
3020 -**POST /api/v3/Drivers/find**
3021 -)))
3022 -
3023 -Передается параметр: parentId - ID клиента-родителя
3024 -
3025 -Ответ:
3026 -
3027 -[
3028 - {
3029 - "name": "string", ~/~/ Определяет наименование
3030 - "description": "string", ~/~/ Определяет описание
3031 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3032 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3033 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
3034 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3035 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3036 - "deleted": true ~/~/ Признак удаления
3037 - }
3038 -]
3039 -
3040 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3041 -
3042 -(% class="box infomessage" %)
3043 -(((
3044 -**GET /api/v3/Drivers/{driverGuid}**
3045 -)))
3046 -
3047 -Передается параметр: ID водителя
3048 -
3049 -Ответ:
3050 -
3051 -{
3052 - "name": "string", ~/~/ Определяет наименование
3053 - "description": "string", ~/~/ Определяет описание
3054 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3055 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3056 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
3057 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3058 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3059 - "deleted": true ~/~/ Признак удаления
3060 -}
3061 -
3062 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3063 -
3064 -(% class="box successmessage" %)
3065 -(((
3066 -**POST /api/v3/Drivers**
3067 -)))
3068 -
3069 -Запрос:
3070 -
3071 -{
3072 - "name": "string",
3073 - "description": "string",
3074 - "hiredate": "2023-06-30T12:50:54.020Z",
3075 - "chopdate": "2023-06-30T12:50:54.020Z",
3076 - "exclusive": true,
3077 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3078 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3079 - "deleted": true
3080 -}
3081 -
3082 -Ответ:
3083 -
3084 -{
3085 - "name": "string",
3086 - "description": "string",
3087 - "hiredate": "2023-06-30T12:50:54.051Z",
3088 - "chopdate": "2023-06-30T12:50:54.051Z",
3089 - "exclusive": true,
3090 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3091 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3092 - "deleted": true
3093 -}
3094 -
3095 -
3096 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3097 -
3098 -(% class="box warningmessage" %)
3099 -(((
3100 -**PUT /api/v3/Drivers**
3101 -)))
3102 -
3103 -Запрос:
3104 -
3105 -{
3106 - "name": "string",
3107 - "description": "string",
3108 - "hiredate": "2023-06-30T12:50:27.910Z",
3109 - "chopdate": "2023-06-30T12:50:27.910Z",
3110 - "exclusive": true,
3111 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3112 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3113 - "deleted": true
3114 -}
3115 -
3116 -Ответ:
3117 -
3118 -{
3119 - "name": "string",
3120 - "description": "string",
3121 - "hiredate": "2023-06-30T12:50:27.929Z",
3122 - "chopdate": "2023-06-30T12:50:27.929Z",
3123 - "exclusive": true,
3124 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3125 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3126 - "deleted": true
3127 -}
3128 -
3129 -
3130 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3131 -
3132 -(% class="box errormessage" %)
3133 -(((
3134 -**DELETE /api/v3/Drivers/{driverGuid}**
3135 -)))
3136 -
3137 -Передается параметр: ID водителя
3138 -
3139 -Ответ:
3140 -
3141 -Success
3142 -
3143 -
3144 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3145 -
3146 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3147 -
3148 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3149 -
3150 -(% class="box infomessage" %)
3151 -(((
3152 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3153 -)))
3154 -
3155 -Запрос:
3156 -
3157 -{
3158 - "Ids": [
3159 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3160 - ],
3161 - "BeginTime": "2023-06-30T12:49:04.365Z",
3162 - "EndTime": "2023-06-30T12:49:04.365Z"
3163 -}
3164 -
3165 -Ответ:
3166 -
3167 -[
3168 - {
3169 - "VehicleId": 0,
3170 - "CreateTime": "2023-06-30T09:52:31.240Z",
3171 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3172 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3173 - "BeginTime": "2023-06-30T09:52:31.240Z",
3174 - "EndTime": "2023-06-30T09:52:31.240Z"
3175 - }
3176 -]
3177 -
3178 -
3179 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3180 -
3181 -(% class="box infomessage" %)
3182 -(((
3183 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3184 -)))
3185 -
3186 -Запрос:
3187 -
3188 -{
3189 - "Ids": [
3190 - 0
3191 - ],
3192 - "BeginTime": "2023-06-30T12:48:39.419Z",
3193 - "EndTime": "2023-06-30T12:48:39.419Z"
3194 -}
3195 -
3196 -Ответ:
3197 -
3198 -[
3199 - {
3200 - "VehicleId": 0,
3201 - "CreateTime": "2023-06-30T09:54:01.631Z",
3202 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3203 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3204 - "BeginTime": "2023-06-30T09:54:01.631Z",
3205 - "EndTime": "2023-06-30T09:54:01.631Z"
3206 - }
3207 -]
3208 -
3209 -
3210 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3211 -
3212 -(% class="box successmessage" %)
3213 -(((
3214 -**POST /api/v3/DriversVehiclesAssignments**
3215 -)))
3216 -
3217 -Передается массив назначений
3218 -
3219 -Запрос:
3220 -
3221 -[
3222 - {
3223 - "VehicleId": 0, ~/~/ Идентификатор объекта
3224 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3225 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3226 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3227 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3228 - }
3229 -]
3230 -
3231 -Ответ:
3232 -
3233 -[
3234 - {
3235 - "VehicleId": 0,
3236 - "CreateTime": "2023-06-30T11:04:46.903Z",
3237 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3238 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3239 - "BeginTime": "2023-06-30T11:04:46.903Z",
3240 - "EndTime": "2023-06-30T11:04:46.903Z"
3241 - }
3242 -]
3243 -
3244 -
3245 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3246 -
3247 -(% class="box warningmessage" %)
3248 -(((
3249 -**PUT /api/v3/DriversVehiclesAssignments**
3250 -)))
3251 -
3252 -Запрос:
3253 -
3254 -[
3255 - {
3256 - "VehicleId": 0,
3257 - "CreateTime": "2023-06-30T11:14:08.117Z",
3258 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3259 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3260 - "BeginTime": "2023-06-30T11:14:08.117Z",
3261 - "EndTime": "2023-06-30T11:14:08.117Z"
3262 - }
3263 -]
3264 -
3265 -Ответ:
3266 -
3267 -[
3268 - {
3269 - "VehicleId": 0,
3270 - "CreateTime": "2023-06-30T11:14:53.349Z",
3271 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3272 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3273 - "BeginTime": "2023-06-30T11:14:53.349Z",
3274 - "EndTime": "2023-06-30T11:14:53.349Z"
3275 - }
3276 -]
3277 -
3278 -
3279 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3280 -
3281 -(% class="box errormessage" %)
3282 -(((
3283 -**DELETE /api/v3/DriversVehiclesAssignments**
3284 -)))
3285 -
3286 -Запрос:
3287 -
3288 -[
3289 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3290 -]
3291 -
3292 -Ответ:
3293 -
3294 -Success
3295 -
3296 -
3297 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3298 -
3299 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3300 -
3301 -(% class="box infomessage" %)
3302 -(((
3303 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3304 -)))
3305 -
3306 -Запрос:
3307 -
3308 -{
3309 - "Ids": [
3310 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3311 - ],
3312 - "BeginTime": "2023-06-30T12:47:12.162Z",
3313 - "EndTime": "2023-06-30T12:47:12.162Z"
3314 -}
3315 -
3316 -Ответ:
3317 -
3318 -[
3319 - {
3320 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3321 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3322 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3323 - "BeginTime": "2023-06-30T11:19:40.703Z",
3324 - "EndTime": "2023-06-30T11:19:40.703Z"
3325 - }
3326 -]
3327 -
3328 -
3329 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3330 -
3331 -(% class="box infomessage" %)
3332 -(((
3333 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3334 -)))
3335 -
3336 -Запрос:
3337 -
3338 -{
3339 - "Ids": [
3340 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3341 - ],
3342 - "BeginTime": "2023-06-30T12:47:12.162Z",
3343 - "EndTime": "2023-06-30T12:47:12.162Z"
3344 -}
3345 -
3346 -Ответ:
3347 -
3348 -[
3349 - {
3350 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3351 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3352 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3353 - "BeginTime": "2023-06-30T11:19:40.703Z",
3354 - "EndTime": "2023-06-30T11:19:40.703Z"
3355 - }
3356 -]
3357 -
3358 -
3359 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3360 -
3361 -(% class="box successmessage" %)
3362 -(((
3363 -**POST /api/v3/DriversRfidsAssignments**
3364 -)))
3365 -
3366 -Запрос:
3367 -
3368 -[
3369 - {
3370 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3371 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3372 - "BeginTime": "2023-06-30T11:27:08.635Z",
3373 - "EndTime": "2023-06-30T11:27:08.635Z"
3374 - }
3375 -]
3376 -
3377 -Ответ:
3378 -
3379 -[
3380 - {
3381 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3382 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3383 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3384 - "BeginTime": "2023-06-30T11:27:08.677Z",
3385 - "EndTime": "2023-06-30T11:27:08.677Z"
3386 - }
3387 -]
3388 -
3389 -
3390 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3391 -
3392 -(% class="box warningmessage" %)
3393 -(((
3394 -**PUT /api/v3/DriversRfidsAssignments**
3395 -)))
3396 -
3397 -Запрос:
3398 -
3399 -[
3400 - {
3401 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3402 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3403 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3404 - "BeginTime": "2023-06-30T11:28:43.330Z",
3405 - "EndTime": "2023-06-30T11:28:43.330Z"
3406 - }
3407 -]
3408 -
3409 -Ответ:
3410 -
3411 -[
3412 - {
3413 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3414 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3415 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3416 - "BeginTime": "2023-06-30T11:28:43.331Z",
3417 - "EndTime": "2023-06-30T11:28:43.331Z"
3418 - }
3419 -]
3420 -
3421 -
3422 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3423 -
3424 -(% class="box errormessage" %)
3425 -(((
3426 -**DELETE /api/v3/DriversRfidsAssignments**
3427 -)))
3428 -
3429 -Запрос:
3430 -
3431 -[
3432 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3433 -]
3434 -
3435 -Ответ:
3436 -
3437 -Success
3438 -
3439 -
3440 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3441 -
3442 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3443 -
3444 -(% class="box infomessage" %)
3445 -(((
3446 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3447 -)))
3448 -
3449 -Запрос:
3450 -
3451 -{
3452 - "Ids": [
3453 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3454 - ],
3455 - "BeginTime": "2023-06-30T12:45:10.852Z",
3456 - "EndTime": "2023-06-30T12:45:10.852Z"
3457 -}
3458 -
3459 -Ответ:
3460 -
3461 -[
3462 - {
3463 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3464 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3466 - "BeginTime": "2023-06-30T11:58:04.695Z",
3467 - "EndTime": "2023-06-30T11:58:04.695Z"
3468 - }
3469 -]
3470 -
3471 -
3472 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3473 -
3474 -(% class="box infomessage" %)
3475 -(((
3476 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3477 -)))
3478 -
3479 -Запрос:
3480 -
3481 -{
3482 - "Ids": [
3483 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3484 - ],
3485 - "BeginTime": "2023-06-30T12:45:10.852Z",
3486 - "EndTime": "2023-06-30T12:45:10.852Z"
3487 -}
3488 -
3489 -Ответ:
3490 -
3491 -[
3492 - {
3493 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3494 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3495 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3496 - "BeginTime": "2023-06-30T11:58:04.695Z",
3497 - "EndTime": "2023-06-30T11:58:04.695Z"
3498 - }
3499 -]
3500 -
3501 -
3502 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3503 -
3504 -(% class="box successmessage" %)
3505 -(((
3506 -**POST /api/v3/DriversFuelCardsAssignments**
3507 -)))
3508 -
3509 -Запрос:
3510 -
3511 -[
3512 - {
3513 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3514 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3515 - "BeginTime": "2023-06-30T12:09:53.175Z",
3516 - "EndTime": "2023-06-30T12:09:53.175Z"
3517 - }
3518 -]
3519 -
3520 -Ответ:
3521 -
3522 -[
3523 - {
3524 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3525 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3526 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3527 - "BeginTime": "2023-06-30T12:09:53.201Z",
3528 - "EndTime": "2023-06-30T12:09:53.201Z"
3529 - }
3530 -]
3531 -
3532 -
3533 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3534 -
3535 -(% class="box warningmessage" %)
3536 -(((
3537 -**PUT /api/v3/DriversFuelCardsAssignments**
3538 -)))
3539 -
3540 -Запрос:
3541 -
3542 -[
3543 - {
3544 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3545 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3546 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3547 - "BeginTime": "2023-06-30T12:09:53.201Z",
3548 - "EndTime": "2023-06-30T12:09:53.201Z"
3549 - }
3550 -]
3551 -
3552 -Ответ:
3553 -
3554 -[
3555 - {
3556 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3557 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3558 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3559 - "BeginTime": "2023-06-30T12:09:53.201Z",
3560 - "EndTime": "2023-06-30T12:09:53.201Z"
3561 - }
3562 -]
3563 -
3564 -
3565 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3566 -
3567 -(% class="box errormessage" %)
3568 -(((
3569 -**DELETE /api/v3/DriversFuelCardsAssignments**
3570 -)))
3571 -
3572 -Запрос:
3573 -
3574 -[
3575 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3576 -]
3577 -
3578 -Ответ:
3579 -
3580 -Success
3581 -
3582 -
3583 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3584 -
3585 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3586 -
3587 -(% class="box infomessage" %)
3588 -(((
3589 -**POST /api/v3/Trailers**
3590 -)))
3591 -
3592 -Пример запроса:
3593 -
3594 -{
3595 - "startDate": "2023-11-14T10:48:03.671Z",
3596 - "endDate": "2023-11-14T10:48:03.671Z",
3597 - "ids": [ 0 ],
3598 - "timezone": 0
3599 -}
3600 -
3601 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3602 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3603 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3604 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3605 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3606 -
3607 -Пример ответа:
3608 -
3609 -[
3610 - {
3611 - "SD": "2023-11-14T10:48:03.717Z",
3612 - "ED": "2023-11-14T10:48:03.717Z", 
3613 - "id": 0,
3614 - "SLat": 0,
3615 - "SLon": 0,
3616 - "ELat": 0,
3617 - "ELon": 0,
3618 - "mileage": 0
3619 - "Duration": 0
3620 - "Address": "string",
3621 - "Address2": "string",
3622 - "name": "string",
3623 - "rid": "string",
3624 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3625 - "trailer": {
3626 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3627 - "Number": "string",
3628 - "Description": "string",
3629 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3630 - "ExternalID": "string",
3631 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3632 - "CreateTime": "2023-11-14T10:48:03.717Z",
3633 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3634 - "IsDeleted": true
3635 - },
3636 - "filesCount": 0,
3637 - }
3638 -]
3639 -
3640 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3641 -|SD|Дата и время начала события
3642 -|ED|Дата и время окончания события
3643 -|id|ID объекта
3644 -|SLat|Широта начальной координаты
3645 -|SLon|Долгота начальной координаты
3646 -|ELat|Широта конечной координаты
3647 -|ELon|Долгота конечной координаты
3648 -|mileage|Пробег
3649 -|Duration|Продолжительность
3650 -|Address|Адрес начального местоположения
3651 -|Address2|Адрес конечного местоположения
3652 -|name|Имя радиометки
3653 -|rid|Номер радиометки
3654 -|rguid|ID радиометки
3655 -|trailer|Информация об агрегате
3656 -|ModelGuid|ID агрегата
3657 -|Number|Название/номер агрегата
3658 -|Description|Текст примечания агрегата
3659 -
3660 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3661 -
3662 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3663 -
3664 -(% class="box infomessage" %)
3665 -(((
3666 -**POST /api/v3/Rfids/find**
3667 -)))
3668 -
3669 -Запрос:
3670 -
3671 -{
3672 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3673 -}
3674 -
3675 -Ответ:
3676 -
3677 -[
3678 - {
3679 - "name": "string",
3680 - "number": 0,
3681 - "period": 0,
3682 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3683 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3684 - }
3685 -]
3686 -
3687 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3688 -|parentId|ID клиента
3689 -|name|Название карты-метки
3690 -|number|Номер
3691 -|period|Период запросов в секундах (работает только для агрегатов)
3692 -|id|ID карты-метки
3693 -
3694 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3695 -
3696 -(% class="box infomessage" %)
3697 -(((
3698 -**GET /api/v3/Rfids/{rfidGuid}**
3699 -)))
3700 -
3701 -Передаем параметр rfidGuid - идентификатор карты-метки
3702 -
3703 -Ответ:
3704 -
3705 -[
3706 - {
3707 - "name": "string",
3708 - "number": 0,
3709 - "period": 0,
3710 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3711 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3712 - }
3713 -]
3714 -
3715 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3716 -|name|Название карты-метки
3717 -|number|Номер
3718 -|period|Период запросов в секундах (работает только для агрегатов)
3719 -|id|ID карты-метки
3720 -|parentId|ID клиента
3721 -
3722 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3723 -
3724 -(% class="box successmessage" %)
3725 -(((
3726 -**POST /api/v3/Rfids**
3727 -)))
3728 -
3729 -Запрос:
3730 -
3731 -{
3732 - "name": "string",
3733 - "number": 0,
3734 - "period": 0,
3735 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3736 -}
3737 -
3738 -Ответ:
3739 -
3740 -{
3741 - "name": "string",
3742 - "number": 0,
3743 - "period": 0,
3744 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3745 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3746 -}
3747 -
3748 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3749 -|name|Название карты-метки
3750 -|number|Номер
3751 -|period|Период запросов в секундах (работает только для агрегатов)
3752 -|id|ID карты-метки
3753 -|parentId|ID клиента
3754 -
3755 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3756 -
3757 -(% class="box warningmessage" %)
3758 -(((
3759 -**PUT /api/v3/Rfids**
3760 -)))
3761 -
3762 -Запрос:
3763 -
3764 -{
3765 - "name": "string",
3766 - "number": 0,
3767 - "period": 0,
3768 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3769 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3770 -}
3771 -
3772 -Ответ:
3773 -
3774 -{
3775 - "name": "string",
3776 - "number": 0,
3777 - "period": 0,
3778 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3779 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3780 -}
3781 -
3782 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3783 -|name|Название карты-метки
3784 -|number|Номер
3785 -|period|Период запросов в секундах (работает только для агрегатов)
3786 -|id|ID карты-метки
3787 -|parentId|ID клиента
3788 -
3789 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3790 -
3791 -(% class="box errormessage" %)
3792 -(((
3793 -**DELETE /api/v3/Rfids/{rfidGuid}**
3794 -)))
3795 -
3796 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3797 -
3798 -Ответ:
3799 -
3800 -Success
3801 -
3802 -
3803 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3804 -
3805 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3806 -
3807 -(% class="box infomessage" %)
3808 -(((
3809 -**GET /api/v3/Billing/client/balance/{clientId}**
3810 -)))
3811 -
3812 -Параметр запроса: **clientId **- идентификатор клиента.
3813 -
3814 -Ответ:
3815 -
3816 -{
3817 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3818 - "Balance": 0
3819 -}
3820 -
3821 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3822 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3823 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3824 -
3825 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3826 -
3827 -(% class="box infomessage" %)
3828 -(((
3829 -**GET /api/v3/Billing/client/constraint/{clientId}**
3830 -)))
3831 -
3832 -Параметр запроса: **clientId **- идентификатор клиента.
3833 -
3834 -Ответ:
3835 -
3836 -{
3837 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3838 - "CalculationType": 0,
3839 - "PermissibleBalance": 0,
3840 - "DefermentDays": 0,
3841 - "SendUiNotifications": true,
3842 - "SendEmailNotifications": true,
3843 - "IsPrivate": true,
3844 -}
3845 -
3846 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3847 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3848 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3849 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3850 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3851 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3852 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3853 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3854 -
3855 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3856 -
3857 -(% class="box infomessage" %)
3858 -(((
3859 -**GET /api/v3/Billing/client/plan/{clientId}**
3860 -)))
3861 -
3862 -Параметры запроса:
3863 -
3864 -**clientId **- идентификатор клиента.
3865 -
3866 -**planId **- идентификатор тарифного плана.
3867 -
3868 -Ответ:
3869 -
3870 -{
3871 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3872 - "Plan": { **~/~/ Описание тарифного плана**
3873 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3874 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3875 - "Name": "string",
3876 - "IsArchived": true,
3877 - "Constraint": {
3878 - "CalculationType": 0,
3879 - "PermissibleBalance": 0,
3880 - "DefermentDays": 0
3881 - },
3882 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3883 - {
3884 - "Feature": "string",
3885 - "IsFactual": true,
3886 - "Limit": 0,
3887 - "Price": 0,
3888 - "PeriodValue": 0,
3889 - "PeriodType": 0
3890 - }
3891 - ]
3892 - },
3893 - "DebitDate": "2023-10-18T12:46:24.213Z",
3894 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3895 - {
3896 - "Feature": "string",
3897 - "IsEnabled": true,
3898 - "IsPrivate": true,
3899 - "IsFactual": true,
3900 - "Limit": 0,
3901 - "Price": 0,
3902 - "DebitDate": "2023-10-18T12:46:24.213Z",
3903 - "PeriodValue": 0,
3904 - "PeriodType": 0
3905 - }
3906 - ]
3907 -}
3908 -
3909 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3910 -|ClientId|Идентификатор клиента
3911 -|Id|Идентификатор тарифного плана
3912 -|OwnerId|Идентификатор клиента-владельца
3913 -|Name|Наименование тарифного плана
3914 -|IsArchived|Признак, определяющий архивный тарифный план
3915 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3916 -|PermissibleBalance|Допустимый баланс
3917 -|DefermentDays|Отсрочка, количество дней
3918 -|Feature|Код услуги
3919 -|IsEnabled|Признак, определяющий активирована ли услуга
3920 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3921 -|IsFactual|Признак, определяющий расчёт по факту
3922 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3923 -|Price|Цена за единицу.
3924 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3925 -|PeriodValue|Значение периода.
3926 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3927 -
3928 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3929 -
3930 -(% class="box infomessage" %)
3931 -(((
3932 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3933 -)))
3934 -
3935 -Параметр запроса: **clientId **- идентификатор клиента.
3936 -
3937 -Ответ:
3938 -
3939 -[
3940 - {
3941 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3942 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3943 - "Name": "string",
3944 - "IsArchived": true,
3945 - "Constraint": {
3946 - "CalculationType": 0,
3947 - "PermissibleBalance": 0,
3948 - "DefermentDays": 0
3949 - },
3950 - "Features": [
3951 - {
3952 - "Feature": "string",
3953 - "IsFactual": true,
3954 - "Limit": 0,
3955 - "Price": 0,
3956 - "PeriodValue": 0,
3957 - "PeriodType": 0
3958 - }
3959 - ]
3960 - }
3961 -]
3962 -
3963 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3964 -|ClientId|Идентификатор клиента
3965 -|Id|Идентификатор тарифного плана
3966 -|OwnerId|Идентификатор клиента-владельца
3967 -|Name|Наименование тарифного плана
3968 -|IsArchived|Признак, определяющий архивный тарифный план
3969 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3970 -|PermissibleBalance|Допустимый баланс
3971 -|DefermentDays|Отсрочка, количество дней
3972 -|Feature|Код услуги
3973 -|IsFactual|Признак, определяющий расчёт по факту
3974 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3975 -|Price|Цена за единицу.
3976 -|PeriodValue|Значение периода.
3977 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3978 -
3979 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3980 -
3981 -(% class="box infomessage" %)
3982 -(((
3983 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3984 -)))
3985 -
3986 -Параметр запроса: **clientId **- идентификатор клиента.
3987 -
3988 -Ответ:
3989 -
3990 -[
3991 - {
3992 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3993 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3994 - "Name": "string",
3995 - "IsArchived": true,
3996 - "Constraint": {
3997 - "CalculationType": 0,
3998 - "PermissibleBalance": 0,
3999 - "DefermentDays": 0
4000 - },
4001 - "Features": [
4002 - {
4003 - "Feature": "string",
4004 - "IsFactual": true,
4005 - "Limit": 0,
4006 - "Price": 0,
4007 - "PeriodValue": 0,
4008 - "PeriodType": 0
4009 - }
4010 - ]
4011 - }
4012 -]
4013 -
4014 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4015 -|ClientId|Идентификатор клиента
4016 -|Id|Идентификатор тарифного плана
4017 -|OwnerId|Идентификатор клиента-владельца
4018 -|Name|Наименование тарифного плана
4019 -|IsArchived|Признак, определяющий архивный тарифный план
4020 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4021 -|PermissibleBalance|Допустимый баланс
4022 -|DefermentDays|Отсрочка, количество дней
4023 -|Feature|Код услуги
4024 -|IsFactual|Признак, определяющий расчёт по факту
4025 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4026 -|Price|Цена за единицу.
4027 -|PeriodValue|Значение периода.
4028 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4029 -
4030 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4031 -
4032 -(% class="box warningmessage" %)
4033 -(((
4034 -**PUT /api/v3/Billing/client/balance**
4035 -)))
4036 -
4037 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4038 -
4039 -Тело запроса:
4040 -
4041 -{
4042 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4043 - "Balance": 0
4044 -}
4045 -
4046 -Ответ: Success
4047 -
4048 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4049 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4050 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4051 -
4052 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4053 -
4054 -(% class="box warningmessage" %)
4055 -(((
4056 -**PUT /api/v3/billing/client/balance/deposit**
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 -Создает операцию **Списание **с указанной суммой
4077 -
4078 -(% class="box warningmessage" %)
4079 -(((
4080 -**PUT /api/v3/billing/client/balance/withdraw**
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 -(% class="box warningmessage" %)
4099 -(((
4100 -**PUT /api/v3/Billing/client/constraint**
4101 -)))
4102 -
4103 -Тело запроса:
4104 -
4105 -{
4106 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4107 - "CalculationType": 0,
4108 - "PermissibleBalance": 0,
4109 - "DefermentDays": 0,
4110 - "SendUiNotifications": true,
4111 - "SendEmailNotifications": true,
4112 - "IsPrivate": true,
4113 -}
4114 -
4115 -Ответ: Success
4116 -
4117 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4118 -|ClientId|Идентификатор клиента
4119 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4120 -|PermissibleBalance|Допустимый баланс
4121 -|DefermentDays|(((
4122 -Отсрочка, количество дней
4123 -)))
4124 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4125 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4126 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4127 -
4128 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4129 -
4130 -(% class="box warningmessage" %)
4131 -(((
4132 -**PUT /api/v3/Billing/client/plan**
4133 -)))
4134 -
4135 -Тело запроса:
4136 -
4137 -{
4138 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4139 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4140 - "Features": [
4141 - {
4142 - "Feature": "string",
4143 - "IsEnabled": true,
4144 - "IsFactual": true,
4145 - "Limit": 0,
4146 - "Price": 0,
4147 - "DebitDate": "2023-10-18T13:26:58.987Z",
4148 - "PeriodValue": 0,
4149 - "PeriodType": 0
4150 - }
4151 - ]
4152 -}
4153 -
4154 -Ответ: Success
4155 -
4156 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4157 -|ClientId|Идентификатор клиента
4158 -|PlanId|Идентификатор тарифного плана
4159 -|Feature|Код услуги
4160 -|IsEnabled|Признак, определяющий активирована ли услуга
4161 -|IsFactual|Признак, определяющий расчёт по факту
4162 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4163 -|Price|Цена за единицу.
4164 -|DebitDate|Следующий момент времени списания с баланса за услугу.
4165 -|PeriodValue|Значение периода.
4166 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4167 -
4168 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4169 -
4170 -(% class="box warningmessage" %)
4171 -(((
4172 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4173 -)))
4174 -
4175 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4176 -
4177 -(% class="box infomessage" %)
4178 -(((
4179 -**POST /api/v3/vehicles/import/{agentId}**
4180 -)))
4181 -
4182 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4183 -
4184 -В пути указывается **agentId** - id клиента.
4185 -
4186 -**Заголовок**
4187 -
4188 -**X-Auth: [токен авторизации]**
4189 -
4190 -**Параметры**
4191 -
4192 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4193 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4194 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4195 -
4196 -В теле использовать тип **form-data,** тип значения** file**
4197 -
4198 -**Ключи**
4199 -
4200 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4201 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
4202 -|csv|В значении передаем файл датчиков, формат **csv**
4203 -
4204 -Ответ:
4205 -
4206 -{
4207 - "vehicleId": 0,
4208 - "name": "string",
4209 - "errors": ["string"]
4210 -}
4211 -
4212 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4213 -|vehicleId|ID созданного объекта
4214 -|name|Имя созданного объекта
4215 -|errors|Ошибки и их описание
4216 -
4217 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4218 -
4219 -(% class="box infomessage" %)
4220 -(((
4221 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4222 -)))
4223 -
4224 -(% class="wikigeneratedid" %)
4225 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4226 -
4227 -(% class="wikigeneratedid" %)
4228 -В пути указывается **vehicleId **- id объекта.
4229 -
4230 -**Заголовок**
4231 -
4232 -**X-Auth: [токен авторизации]**
4233 -
4234 -В теле использовать тип **form-data.**
4235 -
4236 -Ключи:
4237 -
4238 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4239 -|**history**|В значении передавать файл с историей
4240 -
4241 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4242 -
4243 -Ответ:
4244 -
4245 -{
4246 - "results": [
4247 - {
4248 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4249 - "vehicleId": 0,
4250 - "errors": [
4251 - "string"
4252 - ],
4253 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
4254 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
4255 - "producedCount": 0,
4256 - "msgCount": 0
4257 - }
4258 - ]
4259 -}
4260 -
4261 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4262 -|results|Результаты импорта в разрезе ТС
4263 -|vehicleGuid|Guid ТС
4264 -|vehicleId|ID ТС
4265 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4266 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
4267 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4268 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
4269 -|msgCount|Кол-во обработанных сообщений всего
4270 -
4271 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4272 -
4273 -(% class="box infomessage" %)
4274 -(((
4275 -**GET /api/v3/vehicles/import/history/status**
4276 -)))
4277 -
4278 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4279 -
4280 -Ответ:
4281 -
4282 -{
4283 - "activity": true,
4284 - "progress": 0,
4285 - "message": "string"
4286 -}
4287 -
4288 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4289 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4290 -|progress|Guid ТС
4291 -
4292 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4293 -
4294 -(% class="box infomessage" %)
4295 -(((
4296 -**POST /api/v3/vehicles/export**
4297 -)))
4298 -
4299 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4300 -
4301 -Тело запроса:
4302 -
4303 -[
4304 - id
4305 -]
4306 -
4307 -Ответ: Success 200, получаете файлы с настройками.
4308 -
4309 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4310 -
4311 -(% class="box infomessage" %)
4312 -(((
4313 -**POST /api/v3/vehicles/export/history**
4314 -)))
4315 -
4316 -Метод возвращает список сообщений терминала объекта за выбранный период.
4317 -
4318 -Тело запроса:
4319 -
4320 -{
4321 - "vehicleId": 0,
4322 - "asArchive": true,
4323 - "from": "2023-09-27T12:17:45.973Z",
4324 - "to": "2023-09-27T12:17:45.973Z"
4325 -}
4326 -
4327 -Ответ:
4328 -
4329 -Получаете файл. Сообщение: Code 200/Success
4330 -
4331 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4332 -|vehicleId|ID объекта
4333 -|asArchive|true - Архивировать файл, False - не архивировать
4334 -|from|Дата и время начала запроса
4335 -|to|Дата и время окончания запроса
4336 -
4337 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4338 -
4339 -(% class="box infomessage" %)
4340 -(((
4341 -**GET /api/v3/vehicles/export/history/status**
4342 -)))
4343 -
4344 -Метод возвращает список сообщений терминала объекта за выбранный период.
4345 -
4346 -Ответ:
4347 -
4348 -{
4349 - "activity": true,
4350 - "progress": 0,
4351 - "message": "string"
4352 -}
4353 -
4354 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4355 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4356 -|progress|Прогресс экспорта, от 0 до 100%
4357 -|message|Текст описывающий статус
4358 -
4359 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4360 -
4361 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4362 -
4363 -(% class="box infomessage" %)
4364 -(((
4365 -**POST /api/v3/EcoDriving/rating**
4366 -)))
4367 -
4368 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4369 -
4370 -Тело запроса:
4371 -
4372 -{
4373 - "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4374 - "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4375 - "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4376 -}
4377 -
4378 -Ответ:
4379 -
4380 -{
4381 - "items": [  ~/~/ Список в разрезе ТС
4382 - {
4383 - "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4384 - "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4385 - "vehicleId": 0, ~/~/ ID ТС
4386 - "vehicleName": "string", ~/~/ Название ТС
4387 - "vehicleModel": "string", ~/~/ Модель ТС
4388 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4389 - "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4390 - "totalViolations": 0, ~/~/ Нарушений всего
4391 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4392 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4393 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4394 - "brakingViolations": 0, ~/~/ Нарушений торможения
4395 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4396 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4397 - "sensorViolations": 0 ~/~/ Нарушений по датчику
4398 - },
4399 -
4400 -(((
4401 -
4402 -)))
4403 -
4404 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4405 - "mileage": 0, ~/~/ Пробег, м
4406 - "tripsCount": 0, ~/~/ Кол-во рейсов
4407 - "trips": [  ~/~/ Информация по рейсу
4408 - {
4409 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4410 - "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4411 - "violationsCount": 0, ~/~/ Всего нарушений
4412 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4413 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4414 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4415 - "brakingViolations": 0, ~/~/ Нарушений торможения
4416 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4417 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4418 - "sensorViolations": 0 ~/~/ Нарушений по датчику
4419 - },
4420 -
4421 - "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4422 - "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4423 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4424 - "mileage": 0, ~/~/ Пробег, м
4425 - "motohours": 0, ~/~/ Моточасы, секунды
4426 - "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4427 - "startAddress": "string", ~/~/ Адрес начала рейса
4428 - "endAddress": "string", ~/~/ Адрес конца рейса
4429 - "drivers": [  ~/~/ Список водителей
4430 - {
4431 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4432 - "driverName": "string", ~/~/ФИО водителя
4433 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4434 - }
4435 - ]
4436 - }
4437 - ]
4438 - }
4439 - ]
4440 -}
4441 -
4442 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4443 -
4444 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4445 -
4446 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4447 -
4448 -(% class="box infomessage" %)
4449 -(((
4450 -POST /api/v3/fuelcards/transactions
4451 -)))
4452 -
4453 -Метод запроса: POST
4454 -
4455 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4456 -\\В заголовках запроса: X-Auth: Токен авторизации
4457 -
4458 -Параметры в теле запроса (JSON):
4459 -
4460 -{
4461 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4462 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4463 - "ids": [ 
4464 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4465 - ],
4466 - "timezone": 0 ~/~/ Часовой пояс
4467 -}
4468 -
4469 -
4470 -Ответ:
4471 - {
4472 - "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4473 - "driver": "string", ~/~/ Водители, привязанные к ТК
4474 - "object": "string", ~/~/ Наименование ТС
4475 - "amount": 0, ~/~/ Количество топлива
4476 - "amountDut": 0, ~/~/ Количество по ДУТ
4477 - "amountDiff": 0, ~/~/ Разница, л
4478 - "amountDiffPerc": 0, ~/~/ Разница, %
4479 - "summa": 0, ~/~/ Стоимость, руб
4480 - "serviceName": "string", ~/~/ Тип топлива
4481 - "price": 0, ~/~/ Цена за литр, руб
4482 - "cardName": "string", ~/~/ Наименование ТК
4483 - "cardNum": "string", ~/~/ Номер ТК
4484 - "operator": "string", ~/~/ Оператор ТК
4485 - "address": "string" ~/~/ Адрес АЗС
4486 - }
4487 -
4488 -
4489 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4490 -
4491 -
4492 -== **Получение полных данных о ретрансляторе** ==
4493 -
4494 -(% class="box infomessage" %)
4495 -(((
4496 -**GET ** **/api/v3/retranslations/{id}**
4497 -)))
4498 -
4499 -id - Идентификатор ретранслятора
4500 -
4501 -
4502 -Пример ответа:
4503 -
4504 -{  
4505 -"description": "", ~/~/ Поле описания ретранслятора
4506 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4507 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4508 -"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4509 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4510 -"objects": [ ~/~/ Объекты для ретрансляции
4511 -{      
4512 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4513 -"name": "", ~/~/ Наименование объекта ретрансляции
4514 -"imei": "", ~/~/ IMEI объекта  ретрансляции
4515 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4516 -}
4517 - ],  
4518 -"id": "", ~/~/ Идентификатор ретранслятора 
4519 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4520 -"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4521 -}
4522 -
4523 -
4524 -== **Удаление данных ретранслятора** ==
4525 -
4526 -(% class="box infomessage" %)
4527 -(((
4528 -**DELETE** **/api/v3/retranslations/{id}**
4529 -)))
4530 -
4531 -id - Идентификатор ретранслятора
4532 -
4533 -
4534 -== **Создание ретранслятора** ==
4535 -
4536 -(% class="box infomessage" %)
4537 -(((
4538 -**POST ** **/api/v3/retranslations/{id}**
4539 -)))
4540 -
4541 -Запрос:
4542 -
4543 -{  
4544 -"description": "", ~/~/ Поле описания ретранслятора
4545 -"subscriberId": "", ~/~/ Идентификатор подписчика
4546 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4547 -"address": "", ~/~/ Адрес и порт принимающего сервера
4548 -"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4549 -"objects": [ ~/~/Объекты для ретрансляции
4550 -{      
4551 -"id": "", ~/~/ Идентификатор ретранслятора 
4552 -"imei": "", ~/~/ IMEI объекта ретрансляции
4553 -"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4554 -}
4555 - ]
4556 -}
4557 -
4558 -
4559 -Ответ:
4560 -
4561 -{  
4562 -"description": "", ~/~/ Поле описания ретранслятора
4563 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4564 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4565 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4566 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4567 -"objects": [ ~/~/ Объекты для ретрансляции
4568 -{      
4569 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4570 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4571 -"imei": "", ~/~/ IMEI объекта ретрансляции
4572 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4573 -}
4574 - ],
4575 -"id": "", ~/~/ Идентификатор ретранслятора   
4576 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4577 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4578 -}
4579 -
4580 -
4581 -== **Редактирование ретранслятора** ==
4582 -
4583 -(% class="box infomessage" %)
4584 -(((
4585 -**PUT** **/api/v3/retranslations**
4586 -)))
4587 -
4588 -Пример запроса:
4589 -
4590 -{  
4591 -"id": "", ~/~/ Идентификатор ретранслятора   
4592 -"description": "string", ~/~/ Поле описания ретранслятора
4593 -"subscriberId": "", ~/~/ Идентификатор подписчика
4594 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4595 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4596 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4597 -"objects": ~/~/ Объекты для ретрансляции
4598 -[    
4599 -{      
4600 -"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4601 -"imei": "", ~/~/ IMEI объекта ретрансляции
4602 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4603 -}
4604 - ]
4605 -}
4606 -
4607 -
4608 -Пример ответа:
4609 -
4610 -{  
4611 -"description": "", ~/~/ Поле описания ретранслятора
4612 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4613 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4614 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4615 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4616 -"objects": [ ~/~/ Объекты для ретрансляции
4617 -{      
4618 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4619 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4620 -"imei": "", ~/~/ IMEI объекта ретрансляции
4621 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4622 -}
4623 - ],
4624 -"id": "", ~/~/ Идентификатор ретранслятора   
4625 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4626 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4627 -}
4628 -
4629 -
4630 -== **Получение списка ретранслятора клиента** ==
4631 -
4632 -(% class="box infomessage" %)
4633 -(((
4634 -**POST /api/v3/retranslations/find**
4635 -)))
4636 -
4637 -Пример запроса:
4638 -
4639 -{  
4640 -"id": "", ~/~/ Идентификатор ретранслятора   
4641 -"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4642 -"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4643 -}
4644 -
4645 -Ответ:
4646 -
4647 -[ 
4648 -{    
4649 -"description": "", ~/~/ Поле описания ретранслятора
4650 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4651 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4652 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4653 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4654 -"id": "", ~/~/ Идентификатор ретранслятора   
4655 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4656 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4657 -}
4658 -]
4659 -
4660 -
4661 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4662 -
4663 -== **API для отчета по выгрузке комбайнов** ==
4664 -
4665 -(% class="box infomessage" %)
4666 -(((
4667 -**POST /api/v3/Reports/harvesterUnloading**
4668 -)))
4669 -
4670 -Пример запроса:
4671 -
4672 -{
4673 - "byTime": 0, ~/~/ Объединение событий по времени
4674 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4675 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4676 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4677 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4678 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4679 - 0
4680 - ],
4681 - "from": "", ~/~/ Дата и время начало запроса
4682 - "to": "", ~/~/ Дата и время окончания запроса
4683 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4684 -}
4685 -
4686 -Пример ответа:
4687 -
4688 -[ 
4689 - {
4690 - "harvesterName": "", ~/~/Комбайн, номер
4691 - "harvesterId": 0, ~/~/Комбайн, id
4692 -"harvesterModel": "", ~/~/ Модель комбайна
4693 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4694 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4695 - "events": [ ~/~/Список событий в разрезе комбайна
4696 - {
4697 - "driverId": "", ~/~/Идентификатор водителя
4698 - "driverName": "", ~/~/Водитель комбайна, ФИО
4699 - "RFID": "", ~/~/ идентификатор карты-метки
4700 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4701 - "vehicleId": 0, ~/~/идентификатор объекта
4702 - "vehicleName": "string", ~/~/ Имя объекта
4703 - "modelName": "string", ~/~/ Имя модели объекта
4704 - "nearestVehicles": [ ~/~/Объекты рядом
4705 - {
4706 - "vehicleId": 0, ~/~/идентификатор объекта
4707 - "vehicleName": "string" ~/~/ Имя объекта
4708 - }
4709 - ],
4710 - "fields": [ ~/~/Поля, где происходила выгрузка
4711 - {
4712 - "id": 0, ~/~/ идентификатор пользователя 
4713 - "name": "string" ~/~/ имя пользователя 
4714 - }
4715 - ],
4716 - "event": "string", ~/~/Событие
4717 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4718 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4719 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4720 - "cultureName": "string", ~/~/ название культуры
4721 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4722 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4723 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4724 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4725 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4726 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4727 - "issued": 0, ~/~/Выдано, бункеров
4728 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4729 - "latitude": 0, ~/~/Широта
4730 - "longitude": 0, ~/~/ Долгота
4731 - "litresAway": 0, ~/~/Отдано, л
4732 - "m3Away": 0 ~/~/Отдано, м3
4733 - }
4734 - ]
4735 - }
4736 -]
4737 -
4738 -
4739 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4740 -
4741 -
4742 -== **Запрос списка полей** ==
4743 -
4744 -(% class="box successmessage" %)
4745 -(((
4746 -**POST /api/v3/agroLands/find**
4747 -)))
4748 -
4749 -Пример запроса:
4750 -
4751 -(((
4752 -(((
4753 -(((
4754 -{
4755 - "year": 0, ~/~/ Фильтр по году
4756 - "name": "string", ~/~/ Фильтр по названию
4757 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4758 -}
4759 -)))
4760 -)))
4761 -
4762 -
4763 -)))
4764 -
4765 -Пример ответа:
4766 -
4767 -(((
4768 -[
4769 - {
4770 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4771 - "year": 0, ~/~/ Год поля
4772 - "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4773 - "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4774 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4775 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4776 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4777 - "counts": { ~/~/ Счётчики с/х поля 
4778 - "fieldOperations": 0, ~/~/ Количество операций на поле
4779 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4780 - "facts": 0 ~/~/ Счётчик факта
4781 - },
4782 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4783 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4784 - "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4785 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4786 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4787 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4788 - "planComment": "string", ~/~/ Комментарий к полю
4789 - "productivity": 0, ~/~/ Урожайность.
4790 - "id": 0, ~/~/ Идентификатор объекта геозоны
4791 - "name": "string", ~/~/ Название объекта геозоны
4792 - "type": 0, ~/~/ Тип объекта геозоны
4793 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4794 - "fname": "string", ~/~/ Имя файла
4795 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4796 - "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4797 - "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4798 - "description": "string", ~/~/ Описание объекта геозоны
4799 - "area": 0, ~/~/ Площадь, м2
4800 - "perimetr": 0, ~/~/ Периметр, м
4801 - "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4802 - }
4803 -]
4804 -
4805 -
4806 -== **Создание нового поля ** ==
4807 -
4808 -(% class="box successmessage" %)
4809 -(((
4810 -**POST /api/v3/agroLands**
4811 -)))
4812 -
4813 -Пример запроса:
4814 -
4815 -(((
4816 -{
4817 - "extId": "string", 
4818 - "shape": "string", ~/~/ Форма поля
4819 - "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
4820 - "display": "string", ~/~/ Настройки отображения
4821 - "year": 0, ~/~/ Год поля
4822 - "name": "string", ~/~/ Наименование
4823 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4824 - "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4825 - "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4826 - "planComment": "string", ~/~/ Комментарий к полю
4827 - "cropRotations": [ ~/~/ Данные по севообороту
4828 - {
4829 - "landId": 0, ~/~/ ID поля
4830 - "landName": "string", ~/~/ Название поля
4831 - "year": 0, ~/~/ Год урожая
4832 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4833 - "cultureName": "string", ~/~/ Название культуры
4834 - "productivity": 0, ~/~/ Урожайность
4835 - "area": 0, ~/~/ Площадь поля, Га
4836 - "total": 0, ~/~/ Валовый сбор
4837 - "productivityFact": 0, ~/~/ Фактическая урожайность
4838 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4839 - "totalFact": 0, ~/~/ Фактический валовый сбор
4840 - "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4841 - "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4842 - "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4843 - "isyearplan": true, ~/~/ Годовой план 
4844 - "comment": "string" ~/~/ Комментарий
4845 - }
4846 - ]
4847 -}
4848 -)))
4849 -
4850 -(((
4851 -
4852 -)))
4853 -
4854 -Пример ответа:
4855 -
4856 -(((
4857 -(((
4858 -{
4859 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4860 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4861 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4862 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4863 - "cropRotations": [ ~/~/ Данные по севообороту
4864 - {
4865 - "landId": 0, ~/~/ ID поля
4866 - "landName": "string", ~/~/ Название поля
4867 - "year": 0, ~/~/ Год урожая 
4868 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4869 - "cultureName": "string", ~/~/ Название культуры
4870 - "productivity": 0, ~/~/ Урожайность
4871 - "area": 0, ~/~/ Площадь поля, Га.
4872 - "total": 0, ~/~/ Валовый сбор
4873 - "productivityFact": 0, ~/~/ Фактическая урожайность
4874 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4875 - "totalFact": 0, ~/~/ Фактический валовый сбор
4876 - "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
4877 - "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
4878 - "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
4879 - "isyearplan": true, ~/~/ годовой план 
4880 - "comment": "string" ~/~/ Комментарий
4881 - }
4882 - ],
4883 - "cropVegetation": [ ~/~/ История вегетации поля
4884 - {
4885 - "values": [  ~/~/ Данные вегетации и состояния посева
4886 - {
4887 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4888 - "ndvi": 0 ~/~/ Индекс вегетации
4889 - }
4890 - ],
4891 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
4892 - {
4893 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4894 - "type": "string", ~/~/ Тип
4895 - "pictureid": "string" ~/~/ Идентификатор ресурса
4896 - }
4897 - ],
4898 - "states": [ ~/~/ Ключевые даты развития поля
4899 - {
4900 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4901 - "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
4902 - }
4903 - ]
4904 - }
4905 - ],
4906 - "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
4907 - "counts": {
4908 - "fieldOperations": 0, ~/~/ Количество операций на поле
4909 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4910 - "facts": 0 ~/~/ Счётчик факта
4911 - },
4912 - "planComment": "string", ~/~/ Комментарий к полю
4913 -)))
4914 -
4915 -(((
4916 - "productivity": 0, ~/~/ Урожайность.
4917 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4918 - "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
4919 - "year": 0, ~/~/ Год поля
4920 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4921 - "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4922 - "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4923 - "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4924 - "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
4925 - "id": 0, ~/~/ Идентификатор объекта геозоны
4926 - "name": "string", ~/~/ Название объекта геозоны
4927 - "type": 0, ~/~/ Тип объекта геозоны
4928 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4929 - "fname": "string", ~/~/ Имя файла
4930 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4931 - "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
4932 - "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
4933 - "description": "string", ~/~/ Описание объекта геозоны
4934 - "area": 0, ~/~/ Площадь, м2
4935 - "perimetr": 0, ~/~/ Периметр, м
4936 - "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
4937 -}
4938 -
4939 -
4940 -)))
4941 -)))
4942 -)))
4943 -
4944 -== **Получение поля по id** ==
4945 -
4946 -(% class="box infomessage" %)
4947 -(((
4948 -**GET /api/v3/agroLands/{id}**
4949 -)))
4950 -
4951 -Пример запроса:
4952 -id  ~/~/ Идентификатор поля
4953 -
4954 -Пример ответа:
4955 -
4956 -(((
4957 -{
4958 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4959 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4960 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4961 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4962 - "cropRotations": [ ~/~/ Данные по севообороту
4963 - {
4964 - "landId": 0, ~/~/ ID поля
4965 - "landName": "string", ~/~/ Название поля
4966 - "year": 0, ~/~/ Год урожая
4967 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4968 - "cultureName": "string", ~/~/ Название культуры
4969 - "productivity": 0, ~/~/ Урожайность
4970 - "area": 0, ~/~/ Площадь поля, Га
4971 - "total": 0, ~/~/ Валовый сбор
4972 - "productivityFact": 0, ~/~/ Фактическая урожайность
4973 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4974 - "totalFact": 0, ~/~/ Фактический валовый сбор
4975 - "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
4976 - "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
4977 - "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
4978 - "isyearplan": true, ~/~/ План года 
4979 - "comment": "string" ~/~/ Комментарий
4980 - }
4981 - ],
4982 - "cropVegetation": [ ~/~/ История вегетации поля
4983 - {
4984 - "values": [ ~/~/ Данные вегетации и состояния посева
4985 - {
4986 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
4987 - "ndvi": 0 ~/~/ Индекс вегетации
4988 - }
4989 - ],
4990 - "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
4991 - {
4992 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
4993 - "type": "string", ~/~/ Тип 
4994 - "pictureid": "string" ~/~/ Идентификатор ресурса
4995 - }
4996 - ],
4997 - "states": [ ~/~/ Ключевые даты развития поля
4998 - {
4999 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5000 - "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5001 - }
5002 - ]
5003 - }
5004 - ],
5005 - "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5006 - "counts": {
5007 - "fieldOperations": 0, ~/~/ Количество операций на поле
5008 - "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5009 - "facts": 0 ~/~/ Счётчик факта
5010 - },
5011 - "planComment": "string", ~/~/ Комментарий к полю
5012 - "productivity": 0, ~/~/ Урожайность.
5013 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5014 -)))
5015 -
5016 -(((
5017 -(((
5018 - "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5019 - "year": 0, ~/~/ Год поля
5020 - "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5021 - "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5022 - "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5023 - "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5024 - "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5025 - "id": 0, ~/~/ Идентификатор объекта геозоны
5026 - "name": "string", ~/~/ Название объекта геозоны
5027 - "type": 0, ~/~/ Тип объекта геозоны 
5028 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5029 - "fname": "string", ~/~/ Имя файла
5030 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5031 - "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5032 - "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5033 - "description": "string", ~/~/ Описание объекта геозоны
5034 - "area": 0, ~/~/ Площадь, м2
5035 - "perimetr": 0, ~/~/ Периметр, м
5036 - "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5037 -}
5038 -)))
5039 -
5040 -
5041 -== **Удаление существующего поля** ==
5042 -
5043 -(% class="box errormessage" %)
5044 -(((
5045 -**DELETE /api/v3/agroLands/{id}**
5046 -)))
5047 -
5048 -Пример запроса:
5049 -id  ~/~/ Идентификатор поля
5050 -
5051 -Пример ответа:
5052 -
5053 -(((
5054 -200 ~/~/ Успех
5055 -)))
5056 -
5057 -(((
5058 -
5059 -)))
5060 -
5061 -(((
5062 -(((
5063 -(((
5064 -
5065 -)))
5066 -
5067 -(((
5068 -== **Изменение поля** ==
5069 -
5070 -(% class="box infomessage" %)
5071 -(((
5072 -**PUT /api/v3/agroLands**
5073 -)))
5074 -
5075 -Пример запроса:
5076 -
5077 -(((
5078 -(((
5079 -{
5080 - "id": 0, ~/~/ Идентификатор поля
5081 - "extId": "string", ~/~/ ExtId
5082 - "shape": "string", ~/~/ Форма поля
5083 - "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5084 - "display": "string", ~/~/ Настройки отображения
5085 - "year": 0, ~/~/ Год поля
5086 - "name": "string", ~/~/ Наименование
5087 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5088 - "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5089 - "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5090 - "planComment": "string", ~/~/Комментарий к полю
5091 - "cropRotations": [  ~/~/ Данные по севообороту
5092 - {
5093 - "landId": 0, ~/~/ ID поля
5094 - "landName": "string", ~/~/ Название поля
5095 - "year": 0, ~/~/ Год урожая
5096 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5097 - "cultureName": "string", ~/~/ Название культуры
5098 - "productivity": 0, ~/~/ Урожайность
5099 - "area": 0, ~/~/ Площадь поля, Га.
5100 - "total": 0, ~/~/ Валовый сбор
5101 - "productivityFact": 0, ~/~/ Фактическая урожайность
5102 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5103 - "totalFact": 0, ~/~/ Фактический валовый сбор
5104 - "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5105 - "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5106 - "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5107 - "isyearplan": true, 
5108 - "comment": "string" ~/~/ Комментарий
5109 - }
5110 - ],
5111 - "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5112 -}
5113 -)))
5114 -)))
5115 -
5116 -(((
5117 -
5118 -)))
5119 -
5120 -Пример ответа:
5121 -
5122 -(((
5123 -(((
5124 -(((
5125 -{
5126 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5127 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5128 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5129 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5130 - "cropRotations": [ ~/~/ Данные по севообороту
5131 - {
5132 - "landId": 0, ~/~/ ID поля
5133 - "landName": "string", ~/~/ Название поля
5134 - "year": 0, ~/~/  Год урожая
5135 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5136 - "cultureName": "string", ~/~/ Название культуры
5137 - "productivity": 0, ~/~/ Урожайность
5138 - "area": 0, ~/~/ Площадь поля, Га
5139 - "total": 0, ~/~/ Валовый сбор
5140 - "productivityFact": 0, ~/~/ Фактическая урожайность
5141 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5142 - "totalFact": 0, ~/~/ Фактический валовый сбор
5143 - "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5144 - "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5145 - "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5146 - "isyearplan": true, ~/~/ 
5147 - "comment": "string" ~/~/ Комментарий
5148 - }
5149 - ],
5150 - "cropVegetation": [ ~/~/ История вегетации поля
5151 - {
5152 - "values": [ ~/~/ Данные вегетации и состояния посева
5153 - {
5154 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5155 - "ndvi": 0 ~/~/ Индекс вегетации
5156 - }
5157 - ],
5158 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5159 - {
5160 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5161 - "type": "string", ~/~/ Тип
5162 - "pictureid": "string" ~/~/ Идентификатор ресурса
5163 - }
5164 - ],
5165 - "states": [ ~/~/ Ключевые даты развития поля 
5166 - {
5167 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5168 - "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5169 - }
5170 - ]
5171 - }
5172 - ],
5173 - "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5174 - "counts": { 
5175 - "fieldOperations": 0, ~/~/ Количество операций на поле
5176 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5177 - "facts": 0 ~/~/ Счётчик факта
5178 - },
5179 - "planComment": "string", ~/~/ Комментарий к полю
5180 - "productivity": 0, ~/~/ Урожайность.
5181 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5182 - "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5183 - "year": 0, ~/~/ Год поля
5184 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5185 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5186 - "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5187 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5188 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5189 - "id": 0, ~/~/ Идентификатор объекта геозоны
5190 - "name": "string", ~/~/ Название объекта геозоны
5191 - "type": 0, ~/~/ Тип объекта геозоны
5192 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5193 - "fname": "string", ~/~/ Имя файла
5194 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5195 - "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5196 - "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5197 - "description": "string", ~/~/ Описание объекта геозоны
5198 - "area": 0, ~/~/ Площадь, м2
5199 - "perimetr": 0, ~/~/ Периметр, м
5200 - "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5201 -}
5202 -)))
5203 -)))
5204 -)))
5205 -)))
5206 -)))
5207 -
5208 -
5209 -== **Редактирование года урожая ** ==
5210 -
5211 -(% class="box successmessage" %)
5212 -(((
5213 -**POST /api/v3/agroLands/updateOpenCloseYear**
5214 -)))
5215 -
5216 -Пример запроса:
5217 -
5218 -(((
5219 -(((
5220 -{
5221 - "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5222 - 0
5223 - ],
5224 - "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5225 - "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5226 -}
5227 -)))
5228 -
5229 -
5230 -)))
5231 -
5232 -Пример ответа:
5233 -
5234 -(((
5235 -(((
5236 -{
5237 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5238 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5239 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5240 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5241 - "cropRotations": [ ~/~/ Данные по севообороту
5242 - {
5243 - "landId": 0, ~/~/ ID поля
5244 - "landName": "string", ~/~/ Название поля
5245 - "year": 0, ~/~/ Год урожая
5246 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5247 - "cultureName": "string", ~/~/ Название культуры
5248 - "productivity": 0, ~/~/ Урожайность
5249 - "area": 0, ~/~/ Площадь поля, Га.
5250 - "total": 0, ~/~/ Валовый сбор
5251 - "productivityFact": 0, ~/~/ Фактическая урожайность
5252 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5253 - "totalFact": 0, ~/~/ Фактический валовый сбор
5254 - "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5255 - "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5256 - "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5257 - "isyearplan": true, ~/~/ 
5258 - "comment": "string" ~/~/ Комментарий
5259 - }
5260 - ],
5261 - "cropVegetation": [ ~/~/ История вегетации поля
5262 - {
5263 - "values": [ ~/~/ Данные вегетации и состояния посева
5264 - {
5265 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5266 - "ndvi": 0 ~/~/ Индекс вегетации
5267 - }
5268 - ],
5269 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5270 - {
5271 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5272 - "type": "string", ~/~/ Тип
5273 - "pictureid": "string" ~/~/ Идентификатор ресурса
5274 - }
5275 - ],
5276 - "states": [ ~/~/ Ключевые даты развития поля
5277 - {
5278 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5279 - "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5280 - }
5281 - ]
5282 - }
5283 - ],
5284 - "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5285 - "counts": { 
5286 - "fieldOperations": 0, ~/~/ Количество операций на поле
5287 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5288 - "facts": 0 ~/~/ Счётчик факта
5289 - },
5290 - "planComment": "string", ~/~/ Комментарий к полю
5291 - "productivity": 0, ~/~/ Урожайность.
5292 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5293 - "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5294 - "year": 0, ~/~/ Год поля
5295 - "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5296 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5297 - "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5298 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5299 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5300 - "id": 0, ~/~/ Идентификатор объекта геозоны
5301 - "name": "string", ~/~/ Название объекта геозоны
5302 - "type": 0, ~/~/ Тип объекта геозоны
5303 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5304 - "fname": "string", ~/~/ Имя файла
5305 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5306 - "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5307 - "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5308 - "description": "string", ~/~/ Описание объекта геозоны
5309 - "area": 0, ~/~/ Площадь, м2
5310 - "perimetr": 0, ~/~/ ериметр, м
5311 - "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5312 -}
5313 -)))
5314 -
5315 -
5316 -== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==
5317 -)))
5318 -)))
5319 -)))
5320 -
5321 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5322 -
5323 -
5324 -(% class="box infomessage" %)
5325 -(((
5326 -**GET api/v3/Vehicles/recyclebin/all**
5327 -)))
5328 -
5329 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5330 -
5331 -Параметр запроса: {parentId} - идентификатор агента
5332 -
5333 -В заголовках запроса: X-Auth: Токен авторизации
5334 -
5335 -Ответ:
5336 -
5337 -[ 
5338 - {
5339 - "recordTime": "", ~/~/Время записи
5340 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5341 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5342 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
5343 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5344 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5345 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5346 - "items": [ ~/~/ 
5347 -nullable: true ~/~/Детали
5348 - {
5349 - "name": "string", ~/~/наименование столбца
5350 - "value": "string" ~/~/содержание столбца
5351 - }
5352 - ]
5353 - },
5354 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5355 - "string"
5356 - ]
5357 - }
5358 -]
5359 -
5360 -
5361 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
5362 -
5363 -(% class="box infomessage" %)
5364 -(((
5365 -**POST api/v3/Vehicles/recyclebin/erase**
5366 -)))
5367 -
5368 -В заголовках запроса: X-Auth: Токен авторизации
5369 -
5370 -Пример запроса:
5371 -
5372 -[
5373 -0
5374 -]
5375 -
5376 -
5377 -Пример ответа:
5378 -
5379 -[ 
5380 -{
5381 - "recordTime": "", ~/~/Время записи
5382 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5383 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5384 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
5385 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5386 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5387 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5388 - "items": [ ~/~/Детали
5389 - {
5390 - "name": "", ~/~/Имя свойства
5391 - "value": "" ~/~/Значение свойства
5392 - }
5393 - ]
5394 - },
5395 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5396 - ""
5397 - ]
5398 - }
5399 -]
5400 -
5401 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5402 -
5403 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5404 -
5405 -(% class="box infomessage" %)
5406 -(((
5407 -**POST api/v3/Vehicles/recyclebin/restore**
5408 -)))
5409 -
5410 -В заголовках запроса: X-Auth: Токен авторизации
5411 -
5412 -Параметры в теле запроса (JSON):
5413 -
5414 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5415 -
5416 -В заголовках запроса: X-Auth: Токен авторизации
5417 -
5418 -
5419 -Пример запроса:
5420 -
5421 -(((
5422 -[
5423 -)))
5424 -
5425 -(((
5426 - 0
5427 -)))
5428 -
5429 -(((
5430 -]
5431 -)))
5432 -
5433 -
5434 -Пример ответа:
5435 -
5436 -[
5437 -{
5438 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5439 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5440 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5441 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
5442 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5443 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5444 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5445 - "items": [ ~/~/Детали
5446 - {
5447 - "name": "string", ~/~/Имя свойства
5448 - "value": "string" ~/~/Значение свойства
5449 - }
5450 - ]
5451 - },
5452 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5453 - "string"
5454 - ]
5455 - }
5456 -]
5457 -
5458 -
5459 -
5460 5460  (% class="box" lang="en-US" style="text-align: center;" %)
5461 5461  (((
5462 5462  (% 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]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

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