Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 213.2 >
edited by Андрей Калиновский
on 2025/03/19 13:56
To version < 66.3 >
edited by Илья Крайнов
on 2022/11/24 13:29
>
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,53 +1,28 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -(% class="box warningmessage" %)
4 -(((
5 -(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 -просим вас соблюдать несколько простых правил при использовании API-команд:##
7 -)))
2 += Описание ГЛОНАССSoft Public API 3.0 =
8 8  
9 -* Формировать не более 3 отчётов одновременно.
10 -* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11 11  
12 -В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13 -
14 -(% class="box infomessage" %)
15 -(((
16 -**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в пользовательских настройках. 
17 -\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 -)))
19 -
20 -**Содержание страницы:**
21 -)))
22 -
23 23  {{toc/}}
24 24  
25 25  
26 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
8 += (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) =
27 27  
28 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
10 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
29 29  
30 30  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
31 31  
32 32  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
33 33  
34 -(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
16 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
35 35  
36 36  
37 -(% style="color:#000000; font-size:16px" %)**Рекомендации**
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
38 38  
39 -- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
40 40  
41 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
22 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
42 42  
43 -(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
24 +(% class="box infomessage" %)
44 44  (((
45 -(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
46 -(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
47 -)))
48 -
49 -(% class="box successmessage" %)
50 -(((
51 51  (% lang="en-US" %)**POST /api/v3/auth/login**
52 52  )))
53 53  
... ... @@ -57,7 +57,7 @@
57 57  
58 58  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
59 59  
60 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
61 61  
62 62  (% style="color:#000000" %)Параметры в теле запроса (JSON):
63 63  
... ... @@ -64,35 +64,32 @@
64 64  (% style="color:#000000" %){
65 65   "login": "testuser",
66 66   "password": "testuser"
67 -}
42 +}(%%)
43 +
68 68  
69 69  (% style="color:#000000" %)**Ответ:**
70 70  
71 71  (% lang="en-US" %)
72 72  (% style="color:#000000" %){
73 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
74 - "User": "testuser" , ~/~/ имя пользователя(%%)
49 +
50 +(% lang="en-US" %)
51 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
52 + "User": "testuser" , ~/~/ имя пользователя
53 +
54 +(% lang="en-US" %)
75 75  }
76 76  
77 77  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
78 78  
79 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
80 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
81 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
82 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
83 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
84 84  
85 -(% class="wikigeneratedid" %)
86 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
60 +== (% style="color:#000000; font-size:14px" %)**Проверка авторизации**(%%) ==
87 87  
88 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
89 -
90 90  (% class="box infomessage" %)
91 91  (((
92 92  (% lang="en-US" %)**GET /api/v3/auth/check**
93 93  )))
94 94  
95 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
67 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
96 96  
97 97  (% style="color:#000000" %)Метод запроса: **GET**
98 98  
... ... @@ -103,124 +103,53 @@
103 103  (% lang="en-US" %)
104 104  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
105 105  
78 +
106 106  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
107 107  
108 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
109 109  
110 -(% class="box infomessage" %)
111 -(((
112 -**GET api/v3/agents/{id}**
113 -)))
82 +== (% style="color:#000000, font-size:14px" %)**Получение основных параметров клиента**(%%) ==
114 114  
115 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
116 -
117 -(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
118 -
119 -(% style="color:#000000" %)Метод запроса: **GET**
120 -
121 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
122 -
123 -Запрос должен содержать данные параметра "**agentId**"
124 -
125 -(% style="color:#000000" %)Ответ:
126 -{
127 - "agentId": "",  (%%)
128 - "parentId": "",
129 - "parentName": "string",
130 - "name": "string",
131 - "fullName": "string",
132 - "agentInfoType": 0,
133 - "isForeign": true/false,
134 - "district": "string", 
135 - "region": "string",
136 - "city": "string",
137 - "inn": "string",
138 - "kpp": "string",
139 - "address": "string",
140 - "addressFact": "string",
141 - "email": "string",
142 - "director": "string",
143 - "bankName": "string",
144 - "bankBIK": "string",
145 - "bankRS": "string",
146 - "bankKS": "string"
147 - }
148 -
149 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
150 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
151 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
152 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
153 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
154 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
155 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
156 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
157 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
158 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
159 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
160 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
161 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
162 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
163 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
164 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
165 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
166 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
167 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
168 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
169 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
170 -
171 -== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
172 -
173 173  (% class="box infomessage" %)
174 174  (((
175 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
86 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
176 176  )))
177 177  
178 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
89 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
179 179  
180 180  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
181 181  
182 182  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
183 183  
184 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
95 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
185 185  
186 -(% style="color:#000000" %)Метод запроса: **POST**
97 +(% style="color:#000000" %)Метод запроса: **GET**
187 187  
188 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
99 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
189 189  
190 -(% style="color:#000000" %)Параметр запроса:
101 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
191 191  
192 -(% style="color:#000000" %){
193 - "parentId": "string"
194 -}
103 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
195 195  
196 196  (% style="color:#000000" %)Ответ:
197 197  
198 -{
199 - "agentId": "",(% style="color:#000000" %)   (%%)
200 - "parentId": "",
201 - "name": "string",
202 - "fullName": "string",
203 - "agentInfoType": 0,
204 -(% style="color:#000000" %) "status": "",
107 +(% style="color:#000000" %){
108 + "agentId": "", ~/~/ идентификатор клиента
109 + "parentId": "", ~/~/ идентификатор клиента-родителя
110 + "name": "", ~/~/ наименование клиента
111 + "fullName": "", ~/~/ полное наименование клиента
112 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
113 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
205 205  }
206 206  
207 207  
208 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
209 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
210 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
211 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
212 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
213 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
214 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
117 +== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
215 215  
216 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
217 -
218 218  (% class="box successmessage" %)
219 219  (((
220 220  **POST /api/v3/agents **
221 221  )))
222 222  
223 -Метод позволяет добавить клиента, указанного в запросе.
124 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
224 224  
225 225  Метод запроса: **POST**
226 226  
... ... @@ -231,10 +231,9 @@
231 231  Параметры в теле запроса (JSON):
232 232  
233 233  {
234 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
135 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
235 235   "name": "string", ~/~/ имя
236 236   "fullName": "string", ~/~/ полное наименование
237 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
238 238   "isForeign": true, ~/~/ иностранный контрагент
239 239   "district": "string", ~/~/ округ
240 240   "region": "string", ~/~/ регион
... ... @@ -251,6 +251,7 @@
251 251   "bankKS": "string" ~/~/ корр. счёт
252 252  }
253 253  
154 +
254 254  Ответ:
255 255  
256 256  {
... ... @@ -258,7 +258,6 @@
258 258   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
259 259   "name": "string", ~/~/ имя
260 260   "fullName": "string", ~/~/ полное наименование
261 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
262 262   "isForeign": true, ~/~/ иностранный контрагент
263 263   "district": "string", ~/~/ округ
264 264   "region": "string", ~/~/ регион
... ... @@ -275,29 +275,8 @@
275 275   "bankKS": "string" ~/~/ корр. счёт
276 276  }
277 277  
278 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
279 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
280 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
281 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
282 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
283 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
284 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
285 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
286 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
287 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
288 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
289 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
290 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
291 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
292 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
293 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
294 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
295 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
296 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
297 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
298 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
299 299  
300 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
179 +== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
301 301  
302 302  (% class="box warningmessage" %)
303 303  (((
... ... @@ -304,7 +304,7 @@
304 304  **PUT /api/v3/agents**
305 305  )))
306 306  
307 -Метод позволяет отредактировать клиента, указанного в запросе.
186 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
308 308  
309 309  Метод запроса: **PUT**
310 310  
... ... @@ -312,6 +312,7 @@
312 312  
313 313  В заголовках запроса: X-Auth: Токен авторизации
314 314  
194 +
315 315  Параметры в теле запроса (JSON):
316 316  
317 317  {
... ... @@ -319,7 +319,6 @@
319 319   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
320 320   "name": "string", ~/~/ имя
321 321   "fullName": "string", ~/~/ полное наименование
322 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
323 323   "isForeign": true, ~/~/ иностранный контрагент
324 324   "district": "string", ~/~/ округ
325 325   "region": "string", ~/~/ регион
... ... @@ -336,6 +336,7 @@
336 336   "bankKS": "string" ~/~/ корр. счёт
337 337  }
338 338  
218 +
339 339  Ответ:
340 340  
341 341  {
... ... @@ -359,14 +359,15 @@
359 359   "bankKS": "string" ~/~/ корр. счёт
360 360  }
361 361  
362 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
363 363  
243 +== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
244 +
364 364  (% class="box errormessage" %)
365 365  (((
366 366  **DELETE /api/v3/agents/{clientId}**
367 367  )))
368 368  
369 -Метод позволяет удалить клиента, указанного в строке запроса.
250 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
370 370  
371 371  Метод запроса: **DELETE**
372 372  
... ... @@ -378,31 +378,18 @@
378 378  
379 379  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
380 380  
381 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
382 382  
383 -(% class="box warningmessage" %)
384 -(((
385 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
386 -)))
387 -
388 -Метод позволяет изменить статус клиента, указанного в запросе.
389 -
390 -В пути указывается GUID клиента и статус клиента.
391 -
392 -**status **- значение 0 - заблокирован, 1 - активен.
393 -
394 -Ответ: Code 204
395 -
396 396  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
397 397  
398 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
399 399  
266 +== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
267 +
400 400  (% class="box successmessage" %)
401 401  (((
402 402  (% lang="en-US" %)**POST /api/v3/users**
403 403  )))
404 404  
405 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
273 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
406 406  
407 407  (% style="color:#000000" %)Метод запроса: **POST**
408 408  
... ... @@ -412,8 +412,7 @@
412 412  
413 413  (% style="color:#000000" %)Параметры в теле запроса (JSON):
414 414  
415 -(% style="color:#000000" %)
416 -{ 
283 +(% style="color:#000000" %){ 
417 417   "lastName": "", ~/~/ фамилия
418 418   "firstName": "", ~/~/ имя
419 419   "position": "", ~/~/ должность
... ... @@ -422,43 +422,25 @@
422 422   "login": "", ~/~/ логин (обязателен)
423 423   "password": "", ~/~/ пароль (обязателен)
424 424   "email": "", ~/~/ email (обязателен)
425 - "description": "string", ~/~/ Описание
426 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
427 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
428 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
292 + "description": "", ~/~/ описание
293 + "isEnabled": "", ~/~/ признак включения
429 429   "parentId": "", ~/~/ Guid родительского агента
430 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
431 - "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
432 - "doubleAuth":
433 - {
434 - "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
435 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
436 - },
437 - "groups":
438 - [
439 - "string" ~/~/ группы пользователя, перечисление названия системных ролей
440 - ],
441 - "customGroups":
442 - [
443 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
444 - ],
445 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
295 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
296 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
297 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
298 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
299 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
300 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
446 446  }
447 -{
448 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
449 - "lastName": "string",
450 - "firstName": "string",
451 - "position": "string",
452 - "phone": "string",
453 - "organization": "string",
454 - "login": "string",
455 - "password": "string",
456 - "email": "string",
457 457  
458 458  (% style="text-align:left" %)
459 459  (% style="color:#000000; font-weight:normal" %)Ответ:
460 -{     
461 - "id": "" , ~/~/ ID пользователя
305 +
306 +(% style="text-align:left" %)
307 +(% style="color:#000000; font-weight:normal" %){    
308 +
309 +(% style="text-align:left" %)
310 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
462 462   "lastName": "" , ~/~/ Фамилия ,
463 463   "firstName": "" , ~/~/ Имя
464 464   "position": "" , ~/~/ Должность
... ... @@ -475,12 +475,14 @@
475 475   "kind": "" , ~/~/ тип аутентификации
476 476   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
477 477   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
478 -}
479 479  
328 +(% style="text-align:left" %)
329 +(% style="color:#000000; font-weight:normal" %)}
480 480  
481 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
482 482  
483 -(% class="box infomessage" %)
332 +== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
333 +
334 +(% class="box successmessage" %)
484 484  (((
485 485  (% lang="en-US" %)**POST /api/v3/users/find**
486 486  )))
... ... @@ -497,16 +497,19 @@
497 497  
498 498  (% style="color:#000000" %)Параметры в теле запроса (JSON):
499 499  
500 -(% style="color:#000000" %){(%%)
351 +(% style="color:#000000" %){
352 +
501 501   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
502 502   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
503 503   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
504 504   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
357 +
505 505  (% style="color:#000000" %)}
506 506  
507 507  (% style="color:#000000" %)Ответ:
508 508  
509 509  (% style="color:#000000" %){         (%%)
363 +
510 510   "id": "" , ~/~/ идентификатор пользователя
511 511   "lastName": "" , ~/~/ фамилия
512 512   "firstName": "" , ~/~/ имя
... ... @@ -519,12 +519,14 @@
519 519   "email": "" , ~/~/ E-mail
520 520   "sessionDuration":"", ~/~/ длительность сессии в минутах
521 521   "status": "1",  ~/~/ статус пользователя
522 - "lastLogged": "", ~/~/ дата/время последней авторизации
376 + "astLogged": "", ~/~/ дата/время последней авторизации
377 +
523 523  (% style="color:#000000" %)}
524 524  
525 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
526 526  
527 -(% class="box infomessage" %)
381 +== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
382 +
383 +(% class="box successmessage" %)
528 528  (((
529 529  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
530 530  )))
... ... @@ -556,11 +556,8 @@
556 556   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
557 557   "description": "", ~/~/ Описание
558 558   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
559 - "doubleAuth":
560 - {
561 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
562 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
563 - },
415 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
416 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
564 564   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
565 565   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
566 566   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -574,14 +574,15 @@
574 574  )))
575 575  )))
576 576  
577 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
578 578  
431 +== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
432 +
579 579  (% class="box warningmessage" %)
580 580  (((
581 581  (% lang="en-US" %)**PUT /api/v3/users**
582 582  )))
583 583  
584 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
438 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
585 585  
586 586  (% style="color:#000000" %)Метод запроса: **PUT**
587 587  
... ... @@ -593,8 +593,10 @@
593 593  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
594 594  
595 595  (% lang="en-US" style="text-align:left" %)
596 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
597 - "id": "" , ~/~/ ID пользователя 
450 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
451 +
452 +(% lang="en-US" style="text-align:left" %)
453 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
598 598   "lastName": "" , ~/~/ фамилия
599 599   "firstName": "" , ~/~/ имя
600 600   "position": "" , ~/~/ должность
... ... @@ -601,9 +601,7 @@
601 601   "phone": "" , ~/~/ телефон
602 602   "organization": "" , ~/~/ организация
603 603   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
604 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
605 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
606 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
460 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
607 607   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
608 608  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
609 609   "isEnabled": "" , ~/~/ признак включения
... ... @@ -610,13 +610,12 @@
610 610   "parentId": "" , ~/~/ Guid родительского агента
611 611   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
612 612   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
613 - "doubleAuth":
614 - {
615 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
616 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
617 - },
618 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
619 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
467 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
468 + "kind": "" , ~/~/ тип аутентификации
469 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
470 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
471 +
472 +(% lang="en-US" style="text-align:left" %)
620 620  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
621 621  
622 622  (% lang="en-US" style="text-align:left" %)
... ... @@ -623,8 +623,10 @@
623 623  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
624 624  
625 625  (% lang="en-US" style="text-align:left" %)
626 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
627 - "id": "" , ~/~/ идентификатор пользователя
479 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
480 +
481 +(% lang="en-US" style="text-align:left" %)
482 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
628 628   "lastName": "" , ~/~/ фамилия
629 629   "firstName": "" , ~/~/ имя
630 630   "position": "" , ~/~/ должность
... ... @@ -637,24 +637,23 @@
637 637   "isEnabled": "" , ~/~/ признак включения
638 638   "parentId": "" , ~/~/ Guid родительского агента
639 639   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
640 - "doubleAuth":
641 - {
642 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
643 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
644 - },
645 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
495 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
496 + "kind": "" , ~/~/ тип аутентификации
646 646   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
647 647   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
648 -}
649 649  
650 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
500 +(% lang="en-US" style="text-align:left" %)
501 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
651 651  
503 +
504 +== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
505 +
652 652  (% class="box warningmessage" %)
653 653  (((
654 654  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
655 655  )))
656 656  
657 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
511 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
658 658  
659 659  (% style="color:#000000" %)Метод запроса: **PUT**
660 660  
... ... @@ -666,23 +666,26 @@
666 666  
667 667  (% style="color:#000000" %)Параметры в теле запроса (JSON):
668 668  
669 -(% style="color:#000000" %){(%%)
523 +(% style="color:#000000" %){
524 +
670 670   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
671 671   "description": "" , ~/~/ описание
672 672   "data": "" , ~/~/ данные, связанные со сменой статуса
528 +
673 673  (% style="color:#000000" %)}
674 674  
675 675  (% style="text-align:left" %)
676 676  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
677 677  
678 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
679 679  
535 +== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
536 +
680 680  (% class="box warningmessage" %)
681 681  (((
682 682  **POST /api/v3/users/disable**
683 683  )))
684 684  
685 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
542 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
686 686  
687 687  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
688 688  
... ... @@ -691,20 +691,21 @@
691 691  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
692 692  
693 693   [ 
694 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
551 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
695 695   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
696 696   ]
697 697  
698 698  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
699 699  
700 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
701 701  
558 +== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
559 +
702 702  (% class="box warningmessage" %)
703 703  (((
704 704  **POST /api/v3/users/enable**
705 705  )))
706 706  
707 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
565 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
708 708  
709 709  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
710 710  
... ... @@ -732,16 +732,17 @@
732 732  }
733 733  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
734 734  "users" - массив id пользователей, которых не удалось включить или отключить.
593 +
594 +
595 +== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
735 735  )))
736 736  
737 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
738 -
739 739  (% class="box errormessage" %)
740 740  (((
741 741  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
742 742  )))
743 743  
744 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
603 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
745 745  
746 746  (% style="color:#000000" %)Метод запроса: **DELETE**
747 747  
... ... @@ -754,253 +754,12 @@
754 754  (% style="text-align:left" %)
755 755  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
756 756  
757 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
758 758  
759 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
617 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
760 760  
761 -(% class="box infomessage" %)
762 -(((
763 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
764 -)))
765 765  
766 -Метод возвращает полную информацию о модели объекта.
620 +== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
767 767  
768 -(% style="color:#000000" %)Метод запроса: **GET**
769 -
770 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
771 -
772 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
773 -
774 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
775 -
776 -(% style="color:#000000" %)Ответ:
777 -
778 -(% style="color:#000000" %){
779 - "parentName": "string",
780 - "name": "string",
781 - "picture": "string",
782 - "minspeed": 0,
783 - "maxspeed": 0,
784 - "width": 0,
785 - "imbeddedtrailer": true,
786 - "hoppercapacity": 0,
787 - "hopperdischargespeed": 0,
788 - "modelType": 0,
789 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
790 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
791 - "deleted": true
792 -}
793 -
794 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
795 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
796 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
797 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
798 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
799 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
800 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
801 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
802 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
803 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
804 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
805 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
806 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
807 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
808 -
809 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
810 -
811 -(% class="box successmessage" %)
812 -(((
813 -(% lang="en-US" %)**POST /api/v3/models/find**
814 -)))
815 -
816 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
817 -
818 -(% style="color:#000000" %)Метод запроса: **POST**
819 -
820 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
821 -
822 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
823 -
824 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
825 -
826 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
827 -}
828 -
829 -(% style="color:#000000" %)Ответ:
830 -
831 -(% style="color:#000000" %)[
832 - {
833 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
834 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
835 - "parentName": "string",
836 - "name": "string",
837 - "modelType": 0
838 - }
839 -]
840 -
841 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
842 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
843 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
844 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
845 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
846 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
847 -
848 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
849 -
850 -(% class="box successmessage" %)
851 -(((
852 -(% lang="en-US" %)**POST /api/v3/models**
853 -)))
854 -
855 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
856 -
857 -(% style="color:#000000" %)Метод запроса: **POST**
858 -
859 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
860 -
861 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
862 -
863 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
864 -
865 -{
866 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
867 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
868 - "deleted": true,
869 - "extId": "string",
870 - "name": "string",
871 - "picture": "string",
872 - "minspeed": 0,
873 - "maxspeed": 0,
874 - "width": 0,
875 - "imbeddedtrailer": true,
876 - "fueloutlay": 0,
877 - "hoppercapacity": 0,
878 - "hopperdischargespeed": 0,
879 - "modelType": 0
880 -}
881 -
882 -Ответ:
883 -
884 -{
885 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
886 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
887 - "deleted": true,
888 - "extId": "string",
889 - "name": "string",
890 - "picture": "string",
891 - "minspeed": 0,
892 - "maxspeed": 0,
893 - "width": 0,
894 - "imbeddedtrailer": true,
895 - "hoppercapacity": 0,
896 - "hopperdischargespeed": 0,
897 - "modelType": 0
898 -}
899 -
900 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
901 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
902 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
903 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
904 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
905 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
906 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
907 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
908 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
909 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
910 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
911 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
912 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
913 -
914 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
915 -
916 -(% class="box warningmessage" %)
917 -(((
918 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
919 -)))
920 -
921 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
922 -
923 -(% style="color:#000000" %)Метод запроса: **PUT**
924 -
925 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
926 -
927 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
928 -
929 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
930 -
931 -{
932 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
933 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
934 - "deleted": true,
935 - "extId": "string",
936 - "name": "string",
937 - "picture": "string",
938 - "minspeed": 0,
939 - "maxspeed": 0,
940 - "width": 0,
941 - "imbeddedtrailer": true,
942 - "fueloutlay": 0,
943 - "hoppercapacity": 0,
944 - "hopperdischargespeed": 0,
945 - "modelType": 0
946 -}
947 -
948 -Ответ:
949 -
950 -{
951 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
952 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
953 - "deleted": true,
954 - "extId": "string",
955 - "name": "string",
956 - "picture": "string",
957 - "minspeed": 0,
958 - "maxspeed": 0,
959 - "width": 0,
960 - "imbeddedtrailer": true,
961 - "fueloutlay": 0,
962 - "hoppercapacity": 0,
963 - "hopperdischargespeed": 0,
964 - "modelType": 0
965 -}
966 -
967 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
968 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
969 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
970 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
971 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
972 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
973 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
974 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
975 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
976 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
977 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
978 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
979 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
980 -
981 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
982 -
983 -(% class="box errormessage" %)
984 -(((
985 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
986 -)))
987 -
988 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
989 -
990 -(% style="color:#000000" %)Метод запроса: **DELETE**
991 -
992 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
993 -
994 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
995 -
996 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
997 -
998 -Ответ: В случае успеха **Success 200**
999 -
1000 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
1001 -
1002 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1003 -
1004 1004  (% class="box infomessage" %)
1005 1005  (((
1006 1006  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -1008,7 +1008,7 @@
1008 1008  
1009 1009  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1010 1010  
1011 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
629 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1012 1012  
1013 1013  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1014 1014  
... ... @@ -1016,9 +1016,9 @@
1016 1016  
1017 1017  (% style="color:#000000" %)Метод запроса: **GET**
1018 1018  
1019 -(% 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}
637 +(% 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>
1020 1020  
1021 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
639 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
1022 1022  
1023 1023  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1024 1024  
... ... @@ -1026,17 +1026,6 @@
1026 1026  
1027 1027  (((
1028 1028  {
1029 -
1030 -(((
1031 - "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1032 - "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1033 -)))
1034 -
1035 -(((
1036 - ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1037 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1038 -)))
1039 -
1040 1040   "vehicleId": "", ~/~/ ID объекта
1041 1041   "name": "", ~/~/ Имя объекта
1042 1042   "imei": "", ~/~/ IMEI объекта
... ... @@ -1043,130 +1043,18 @@
1043 1043   "deviceTypeId": , ~/~/ ID типа устройства
1044 1044   "deviceTypeName": "", ~/~/ Название типа устройства
1045 1045   "sim1": "", ~/~/ Номер SIM1
1046 - "sim2": "", ~/~/ Номер SIM2
1047 - "parentId": "", ~/~/ ID клиента-родителя
1048 - "parentName": "", ~/~/ Наименование клиента-родителя
1049 - "modelId": "", ~/~/ ID модели объекта
1050 - "modelName": "", ~/~/ Имя модели объекта
1051 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1052 - "unitName": "string", ~/~/ Наименование подразделения
1053 - "status": 0, ~/~/ Статус объекта
1054 - "createdAt": "", ~/~/ Дата создания объекта
653 + "parentId": "", Номер SIM2
654 + "parentName": "", Наименование клиента-родителя
655 + "modelId": "", ID модели объекта
656 + "modelName": "", Имя модели объекта
657 + "createdAt": "", Дата создания объекта
658 + "mileageCalcMethod": "", Выбранный метод расчета пробега
659 + "counters": { ~/~/ Нормы
660 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
661 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
662 + "mileage": "", ~/~/ Пробег по нормам в метрах
663 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
1055 1055   },
1056 -"customFields": [ ~/~/ Произвольные поля
1057 - {
1058 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1059 - "name": "string", ~/~/ Имя поля
1060 - "value": "string", ~/~/ Значение поля
1061 - "forClient": true, ~/~/ Не используемая функция
1062 - "forTooltip": true, ~/~/ Отображать в подсказке
1063 - "forReport": true ~/~/ Отображать в отчете
1064 - }
1065 -
1066 -], ~/~/ Данные с вкладки нормы
1067 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1068 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1069 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1070 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1071 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1072 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1073 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1074 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1075 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1076 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1077 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1078 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1079 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1080 - "mileageCoeff": 0, ~/~/ коэффициент пробега
1081 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1082 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1083 - "counters": { ~/~/ Счетчики
1084 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1085 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1086 - "mileage": 0, ~/~/ Текущий пробег
1087 - "motohours": 0, ~/~/ Текущие моточасы
1088 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1089 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1090 - },
1091 -
1092 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1093 - "id": "string", ~/~/ ID объекта
1094 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
1095 - "host": "string", ~/~/ CMSV6 Web Host
1096 - "login": "string", ~/~/ CMSV6 Account
1097 - "password": "string" ~/~/ CMSV6 Password
1098 - },
1099 -
1100 -"commandTemplates": [ ~/~/ Шаблоны команд
1101 - {
1102 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1103 - "name": "string", ~/~/ Наименование команды
1104 - "command": "string", ~/~/ Текст команды
1105 - "retries": 0 ~/~/ Количество попыток
1106 - }
1107 - ],
1108 - "sensors": [ ~/~/ Датчики
1109 - {
1110 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1111 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1112 - "type": 0, ~/~/ Тип датчика
1113 - "name": "string", ~/~/ Имя датчика
1114 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1115 - "inputNumber": 0, ~/~/ Номер входа
1116 - "pseudonym": "string", ~/~/ Псевдоним
1117 - "medianDegree": 0, ~/~/ Медианная фильтрация
1118 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1119 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1120 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1121 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1122 - {
1123 - "grades": [ ~/~/ Таблица тарировки 1
1124 - {
1125 - "input": 0, ~/~/ Входящее значение
1126 - "output": 0 ~/~/ Выходящее значение
1127 - }
1128 - ],
1129 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1130 - }
1131 - ],
1132 - "showInTooltip": true, ~/~/ Отображать в подсказке
1133 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1134 - "color": "string", ~/~/ Код цвета датчиков
1135 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1136 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1137 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1138 - "expr": "string", ~/~/ Формула
1139 - "children": [ ~/~/ массив дочерних датчиков
1140 - "string"
1141 - ],
1142 - "customParams": { ~/~/ прочие произвольные параметры
1143 - "additionalProp1": "string",
1144 - "additionalProp2": "string",
1145 - "additionalProp3": "string"
1146 - },
1147 -
1148 -~/~/ Характерные для произвольного:
1149 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1150 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1151 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1152 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1153 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1154 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1155 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1156 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1157 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1158 -~/~/ "ValueOn": "Вкл.",
1159 -~/~/ "ValueOff": "Выкл."
1160 - "summaryMaxValue": 0 ~/~/ Макс. значение
1161 - }
1162 - "drivers": [ ~/~/ Водители
1163 - {
1164 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1165 - "name": "string", ~/~/ Наименование
1166 - "description": "string",
1167 - "isDefault": true ~/~/ По умолчанию
1168 - }
1169 - ],
1170 1170   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1171 1171   {
1172 1172   "id": "", ~/~/ ID  задания
... ... @@ -1182,28 +1182,10 @@
1182 1182   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1183 1183   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1184 1184   }
1185 - ],
1186 -"statusHistory": [ ~/~/ История статусов
1187 - {
1188 - "status": 0,
1189 - "date": "2023-05-22T09:57:39.562Z",
1190 - "description": "string",
1191 - "additionalInfo": "string"
1192 -
1193 -(((
680 + ]
1194 1194  }
1195 - ],
1196 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1197 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1198 1198  )))
1199 1199  
1200 -(((
1201 - ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1202 -}
1203 -
1204 -)))
1205 -)))
1206 -
1207 1207  (% style="text-align:left" %)
1208 1208  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1209 1209  
... ... @@ -1211,82 +1211,14 @@
1211 1211  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1212 1212  
1213 1213  
1214 -== **Отправить команду на терминал** ==
691 +== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
1215 1215  
1216 1216  (% class="box successmessage" %)
1217 1217  (((
1218 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1219 -)))
1220 -
1221 -Команда для отправки на тс.
1222 -
1223 -{  
1224 -"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1225 -"command": "", ~/~/ Текст отправляемой команды
1226 -"retries": "", ~/~/ Количество попыток отправки на терминал
1227 -"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1228 -}
1229 -
1230 -В ответ получаем cmdid
1231 -
1232 -
1233 -== **Получить ответ на отправленную на ТС команду** ==
1234 -
1235 -(% class="box infomessage" %)
1236 -(((
1237 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1238 -)))
1239 -
1240 -Идентификатор команды: cmdId
1241 -
1242 -Запрос от терминала на ответ команды
1243 -
1244 -Пример ответ от терминала:
1245 -
1246 -ID= "" ~/~/ идентификатор объекта
1247 -Soft="" ~/~/ версия софта
1248 -GPS=4 ~/~/ тип трекера
1249 -Time=11:05:43 28.06.24 ~/~/ время запроса
1250 -Lat=45.056221 ~/~/ широта
1251 -Lon=39.035938 ~/~/ долгота
1252 -Speed=0.0 ~/~/ скорость
1253 -Course=181.4 ~/~/направление
1254 -
1255 -(((
1256 -== **Список отправленных объекту команд с ответами** ==
1257 -
1258 -(% class="box infomessage" %)
1259 -(((
1260 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1261 -)))
1262 -
1263 -Идентификатор ТС: vehicleId
1264 -
1265 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1266 -
1267 -Пример ответа терминала
1268 -
1269 -[ 
1270 -{    
1271 -"id": "", ~/~/ идентификатор пользователя
1272 -"commandText": "", ~/~/Текст команды.
1273 -"templateId": "", ~/~/Идентификатор шаблона
1274 -"updated": "", ~/~/ Время отправки  
1275 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1276 -"answer": "", ~/~/ Ответ терминала.
1277 -"status": "" ~/~/ Статус отправки
1278 -}
1279 -]
1280 -)))
1281 -
1282 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1283 -
1284 -(% class="box successmessage" %)
1285 -(((
1286 1286  (% lang="en-US" %)**POST /api/v3/vehicles**
1287 1287  )))
1288 1288  
1289 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
698 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
1290 1290  
1291 1291  (% style="color:#000000" %)Метод запроса: **POST**
1292 1292  
... ... @@ -1298,11 +1298,6 @@
1298 1298  
1299 1299  (% style="color:#000000" %){
1300 1300  
1301 -
1302 -(((
1303 - "vehicleId": 0, ~/~/ ID ТС
1304 -)))
1305 -
1306 1306   "parentId": "" , ~/~/ ID клиента
1307 1307   "name": "" , ~/~/ имя ТС
1308 1308   "imei": "" , ~/~/ IMEI
... ... @@ -1323,10 +1323,6 @@
1323 1323   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1324 1324   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1325 1325   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1326 - "mileageCalcMethod": 0,
1327 - "mileageCoeff": 0,
1328 - "locationByCellId": true,
1329 - "dottedLineTrackWhenNoCoords": true,
1330 1330   "counters": ~/~/ счетчики
1331 1331   {
1332 1332   "mileage": "" , ~/~/ пробег
... ... @@ -1355,261 +1355,54 @@
1355 1355   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1356 1356   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1357 1357   }
1358 -"drivers": [ ~/~/ Водители
1359 - {
1360 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1361 - "isDefault": true
1362 - }
1363 - ],
1364 - "commandTemplates": [ ~/~/ Шаблон команды
1365 - {
1366 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1367 - "name": "string",
1368 - "command": "string",
1369 - "retries": 0
1370 - }
1371 - ],
1372 -"sensors": [ ~/~/ Датчики
1373 - {
1374 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1375 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1376 - "type": 0, ~/~/ Тип датчика
1377 - "name": "string", ~/~/ Имя датчика
1378 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1379 - "inputNumber": 0, ~/~/ Номер входа
1380 - "pseudonym": "string", ~/~/ Псевдоним
1381 - "medianDegree": 0, ~/~/ Медианная фильтрация
1382 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1383 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1384 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1385 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1386 - {
1387 - "grades": [ ~/~/ Таблица тарировки 1
1388 - {
1389 - "input": 0, ~/~/ Входящее значение
1390 - "output": 0 ~/~/ Выходящее значение
1391 - }
1392 - ],
1393 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1394 - }
1395 - ],
1396 - "showInTooltip": true, ~/~/ Отображать в подсказке
1397 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1398 - "color": "string", ~/~/ код цвета датчиков
1399 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1400 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1401 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1402 - "expr": "string", ~/~/ Формула
1403 - "children": [ ~/~/ массив дочерних датчиков
1404 - "string"
1405 - ],
1406 - "customParams": { ~/~/ прочие произвольные параметры
1407 - "additionalProp1": "string",
1408 - "additionalProp2": "string",
1409 - "additionalProp3": "string"
1410 - },
1411 -~/~/ Характерные для произвольного:
1412 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1413 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1414 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1415 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1416 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1417 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1418 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1419 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1420 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1421 -~/~/ "ValueOn": "Вкл.",
1422 -~/~/ "ValueOff": "Выкл."
1423 - "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1424 1424  
1425 -(((
1426 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1427 - {
1428 - "from": 0, ~/~/ С какого значения
1429 - "color": "string", ~/~/ Каким цветом
1430 - "text": "string" ~/~/ Текст подписи к этому интервалу
1431 - }
1432 - ]
1433 - }
1434 - ],
1435 -)))
759 +(% style="color:#000000" %) }
1436 1436  
1437 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1438 -
1439 -
1440 - "customFields": [ ~/~/ Произвольные поля
1441 - {
1442 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1443 - "name": "string", ~/~/ Наименование произвольного поля
1444 - "value": "string", ~/~/ Значение произвольного поля
1445 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1446 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1447 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1448 -
1449 -(((
1450 - }
1451 - ],
1452 - "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1453 -)))
1454 -
1455 -(((
1456 - ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1457 -}
1458 -)))
1459 -
1460 -
1461 1461  (% style="color:#000000" %)Ответ:
1462 1462  
763 +(% style="color:#000000" %){
1463 1463  
1464 -(((
1465 -(((
1466 -(((
1467 -{
1468 - "vehicleId": 0,  ~/~/ ID ТС
1469 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1470 - "name": "string", ~/~/ Имя объекта
1471 - "imei": "string", ~/~/ IMEI
1472 - "deviceTypeId": 0, ~/~/ ID типа устройства
1473 - "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1474 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1475 - "sim1": "string", ~/~/ SIM1
1476 - "sim2": "string", ~/~/ SIM2
1477 - "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1478 - "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1479 - "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1480 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1481 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1482 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1483 - "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1484 - "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1485 - "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1486 - "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1487 - "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1488 - "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1489 - "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1490 - "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1491 - "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1492 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1493 - "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1494 - "counters": {  ~/~/ Dto для состояний счётчиков
1495 - "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1496 - "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1497 - "mileage": 0, ~/~/ Пробег
1498 - "motohours": 0 ~/~/ Моточасы
1499 - },
1500 - "cmsv6Parameters": { ~/~/ Dto для CMSv6
1501 - "id": "string", ~/~/ CMSV6 Идентификатор
1502 - "enabled": true, ~/~/ Признак включения
1503 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1504 - "login": "string", ~/~/ CMSV6 имя учетной записи
1505 - "password": "string" ~/~/ CMSV6 — пароль учетной записи
1506 - },
1507 - "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1508 - {
1509 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1510 - "enabled": true, ~/~/ Признак включения
1511 - "name": "string", ~/~/ Имя задания
1512 - "description": "string", ~/~/ Описание задания
1513 - "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1514 - "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1515 - "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1516 - "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1517 - "periodicCondition": 0, ~/~/ Условие периодичности по времени
1518 - "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1519 - "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1520 - "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
765 + "vehicleId": "", ~/~/ID ТС 
766 + "parentId": "", ~/~/Guid владельца ТС
767 + "name": "", ~/~/Имя объекта
768 + "imei": "", ~/~/IMEI
769 + "deviceTypeId": "", ~/~/ID типа устройства
770 + "modelId": "", ~/~/ID модели
771 + "unitId": "", ~/~/ID подразделения
772 + "sim1": "", ~/~/SIM1
773 + "sim2": "", ~/~/SIM2
774 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
775 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
776 + "counters": { ~/~/Счётчики
777 + "mileageEnabled": true,
778 + "motohoursEnabled": true,
779 + "mileage": "",
780 + "motohours": 345.0
781 + },
782 + "cmsv6Parameters": { ~/~/Параметры CmsV6
783 + "id": null,
784 + "enabled": true, ~/~/флаг включения
785 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
786 + "login": "", ~/~/ имя учетной записи
787 + "password": "" ~/~/ пароль учетной записи
788 + },
789 + "inspectionTasks": { ~/~/ задания на ТО
790 + "id": "", ~/~/ ID задачи
791 + "enabled": false, ~/~/ Признак включения
792 + "name": "", ~/~/ Имя задания
793 + "description": "", ~/~/ Описание задания
794 + "mileageCondition": "", ~/~/ Условие по пробегу
795 + "lastMileage": "", ~/~/ Пробег (в метрах)
796 + "motohoursCondition": "", ~/~/ Условие по моточасам
797 + "lastMotohours": "", ~/~/ Моточасы
798 + "periodicCondition": "", ~/~/ Условие периодичности по времени
799 + "kind": "", ~/~/ Вид периодичности по времени 
800 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1521 1521   }
1522 - ],
1523 - "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1524 - {
1525 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1526 - "inputNumber": 0, ~/~/ № входа.
1527 - "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1528 - "comment": "string", ~/~/ Комментарий
1529 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1530 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1531 - "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1532 - "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1533 - }
1534 - ],
1535 - "commandTemplates": [  ~/~/ Список шаблонов команд
1536 - {
1537 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1538 - "name": "string", ~/~/ Название шаблона команд
1539 - "command": "string", ~/~/ Команда на выполнение
1540 - "retries": 0 ~/~/ Лимит попыток отправки
1541 - }
1542 - ],
1543 - "sensors": [ ~/~/ Список датчиков
1544 - {
1545 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1546 - "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1547 - "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
1548 - "name": "string",  ~/~/ Имя датчика
1549 - "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1550 - "inputNumber": 0, ~/~/ Номер входа
1551 - "pseudonym": "string", ~/~/ Псевдоним
1552 - "medianDegree": 0, ~/~/ Степень медианной фильтрации
1553 - "isInverted": true, ~/~/  Признак инверсии
1554 - "disabled": true, ~/~/ Датчик не участвует в обработке
1555 - "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1556 - "gradesTables": [ ~/~/ Тарировка
1557 - {
1558 - "grades": [ ~/~/ Таблицы тарировки
1559 - {
1560 - "input": 0, ~/~/ Вход
1561 - "output": 0 ~/~/ Выход
1562 - }
1563 - ],
1564 - "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1565 - }
1566 - ],
1567 - "showInTooltip": true, ~/~/ Отображение в подсказке
1568 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1569 - "color": "string", ~/~/ код цвета датчиков
1570 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1571 - "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1572 - "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1573 - "expr": "string", ~/~/ Выражение
1574 - "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1575 - "string"
1576 - ],
1577 - "customParams": {
1578 - "additionalProp1": "string",
1579 - "additionalProp2": "string",
1580 - "additionalProp3": "string"
1581 - },
1582 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1583 - "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1584 - {
1585 - "from": 0, ~/~/ С какого значения
1586 - "color": "string", ~/~/ Каким цветом
1587 -)))
1588 1588  
1589 -(((
1590 - "text": "string" ~/~/ Текст подписи к этому интервалу
1591 - }
1592 - ]
1593 - }
1594 - ],
1595 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1596 - "customFields": [ ~/~/ Список произвольных полей
1597 - {
1598 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1599 - "name": "string", ~/~/ Наименование произвольного поля
1600 - "value": "string", ~/~/ Значение произвольного поля
1601 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1602 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1603 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1604 - }
1605 - ],
1606 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1607 -}
1608 -)))
1609 -)))
1610 -)))
803 +(% style="text-align:left" %)
804 +(% style="color:#000000" %)}
1611 1611  
1612 -
1613 1613  **Валидация:**
1614 1614  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1615 1615  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
... ... @@ -1616,87 +1616,16 @@
1616 1616  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1617 1617  
1618 1618  
1619 -== **Импортировать историю ТС (Асинхронный запрос)** ==
812 +== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
1620 1620  
1621 1621  (% class="box successmessage" %)
1622 1622  (((
1623 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1624 -)))
1625 -
1626 -Метод запроса: **POST**
1627 -
1628 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1629 -
1630 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1631 -
1632 -
1633 -Ответ:
1634 -
1635 -{
1636 -
1637 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1638 -
1639 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1640 -
1641 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1642 -
1643 - "Message": "string", ~/~/ Информация о выполнении запроса
1644 -
1645 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1646 -
1647 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1648 -
1649 - "Data": "string" ~/~/ Данные
1650 -
1651 -}
1652 -
1653 -
1654 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1655 -
1656 -(% class="box infomessage" %)
1657 -(((
1658 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1659 -)))
1660 -
1661 -Метод запроса: **GET**
1662 -
1663 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1664 -
1665 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1666 -
1667 -
1668 -Ответ:
1669 -
1670 -{
1671 -
1672 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1673 -
1674 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1675 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1676 -
1677 - "Message": "string", ~/~/ Информация о выполнении запроса
1678 -
1679 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1680 -
1681 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1682 -
1683 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1684 -
1685 - "Data": "string" ~/~/ Данные
1686 -
1687 -}
1688 -
1689 -
1690 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1691 -
1692 -(% class="box infomessage" %)
1693 -(((
1694 1694  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1695 1695  )))
1696 1696  
1697 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
819 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1698 1698  
1699 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
821 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1700 1700  
1701 1701  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1702 1702  
... ... @@ -1728,12 +1728,9 @@
1728 1728   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1729 1729   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1730 1730   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1731 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1732 - "unitName": "string",  ~/~/ Название подразделения (опционально)
1733 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1734 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1735 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1736 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
853 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
854 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
855 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1737 1737  }
1738 1738  
1739 1739  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1740,14 +1740,8 @@
1740 1740  
1741 1741  (% style="color:#000000" %)Ответ:
1742 1742  
1743 -(% style="color:#000000" %)[
1744 -{
862 +(% style="color:#000000" %){
1745 1745  
1746 -(((
1747 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1748 -)))
1749 -
1750 -(((
1751 1751  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1752 1752   "name": "" ~/~/ наименование объекта
1753 1753   "imei": "" ~/~/ IMEI объекта
... ... @@ -1773,31 +1773,20 @@
1773 1773   "forClient": true, ~/~/ право на отображение у клиента
1774 1774   "forTooltip": false, ~/~/ право на отображение в подсказке
1775 1775   "forReport": false ~/~/ право на отображение в отчетах
1776 -)))
889 + }(%%)
890 +(% style="color:#000000" %)}
1777 1777  
1778 -(((
1779 - }
1780 - ],
1781 - "vehicleGroups": [  ~/~/ Группы ТС
1782 - {
1783 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1784 - "name": "string" ~/~/ Наименование группы ТС
1785 - }
1786 - ]
1787 - }
1788 -]
1789 -)))
1790 -
1791 1791  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1792 1792  
1793 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1794 1794  
895 +== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
896 +
1795 1795  (% class="box successmessage" %)
1796 1796  (((
1797 1797  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1798 1798  )))
1799 1799  
1800 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
902 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1801 1801  
1802 1802  (% style="color:#000000" %)Метод запроса: **POST**
1803 1803  
... ... @@ -1819,11 +1819,13 @@
1819 1819   "data": "", ~/~/ Данные
1820 1820   "overwrite": false, ~/~/ Флаг перезаписи
1821 1821   "stage": "", ~/~/ Состояние, может быть null
924 +
1822 1822  (% style="color:#000000" %)}
1823 1823  
1824 1824  (% style="color:#000000" %)Ответ:
1825 1825  
1826 -(% style="color:#000000" %){(%%)
929 +(% style="color:#000000" %){
930 +
1827 1827   "status": "", ~/~/ значение статуса
1828 1828   "date": "", ~/~/ Дата смены статуса 
1829 1829   "description": "", ~/~/ Описание
... ... @@ -1830,11 +1830,12 @@
1830 1830   "data": "", ~/~/ Данные
1831 1831   "overwrite": false, ~/~/ Флаг перезаписи
1832 1832   "stage": "", ~/~/ Состояние
937 +
938 +(% style="text-align:left" %)
1833 1833  (% style="color:#000000" %) }
1834 1834  
1835 -== ==
1836 1836  
1837 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
942 +== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
1838 1838  
1839 1839  (% class="box warningmessage" %)
1840 1840  (((
... ... @@ -1841,7 +1841,7 @@
1841 1841  (% lang="en-US" %)**PUT /api/v3/vehicles**
1842 1842  )))
1843 1843  
1844 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
949 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1845 1845  
1846 1846  (% style="color:#000000" %)Метод запроса: **PUT**
1847 1847  
... ... @@ -1851,16 +1851,18 @@
1851 1851  
1852 1852  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1853 1853  
1854 -(% style="color:#000000" %){
1855 - "vehicleId": , ~/~/ ID объекта
1856 - "parentId": "" , ~/~/ ID клиента
1857 - "name": "" , ~/~/ имя ТС
1858 - "imei": "" , ~/~/ IMEI
1859 - "deviceTypeId": "" , ~/~/ ID типа устройства
1860 - "modelId": "" , ~/~/ ID модели
1861 - "unitId": "" , ~/~/ ID подразделения
1862 - "sim1": "" , ~/~/ Номер SIM 1
1863 - "sim2": "" , ~/~/ Номер SIM2
959 +(% style="color:#000000" %){    
960 +
961 +(((
962 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
963 + "parentId": "", ~/~/ ID клиента
964 + "name": "", ~/~/ имя ТС
965 + "imei": "", ~/~/ IMEI
966 + "deviceTypeId": "", ~/~/ ID типа устройства
967 + "modelId": "", ~/~/ , ID модели    
968 + "unitId": "", ~/~/ подразделения
969 + "sim1": "", ~/~/ SIM 1
970 + "sim2": "", ~/~/ SIM2     (%%)
1864 1864   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1865 1865   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1866 1866   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -1873,339 +1873,103 @@
1873 1873   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1874 1874   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1875 1875   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1876 -
1877 - "mileageCalcMethod": 0,
1878 - "mileageCoeff": 0,
1879 - "locationByCellId": true,
1880 - "dottedLineTrackWhenNoCoords": true,
1881 - "counters": ~/~/ счетчики
1882 - {
1883 - "mileage": "" , ~/~/ пробег
1884 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1885 - "motohours": "" , ~/~/ моточасы
1886 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1887 - },
1888 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1889 - "enabled": true, ~/~/ флаг включения
1890 - "id": "" , ~/~/ идентификатор
1891 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1892 - "login": "" , ~/~/ имя учетной записи
1893 - "password": "" ~/~/ пароль учетной записи
1894 - },
1895 - "inspectionTasks": ~/~/ задания на ТО
1896 - {
1897 - "enabled": "" , ~/~/ Признак включения
1898 - "name": "" , ~/~/ Имя задания
1899 - "description": "" , ~/~/ Описание задания
1900 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1901 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1902 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1903 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1904 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1905 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1906 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1907 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1908 - }
1909 -
1910 -"drivers": [ ~/~/ Водители
1911 - {
1912 -
1913 -(((
1914 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1915 - "inputNumber": 0, ~/~/ № входа.
1916 - "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1917 - "comment": "string", ~/~/ Комментарий.
1918 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1919 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1920 - "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1921 - "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
983 +(% style="color:#000000" %) "counters": 
984 + {
985 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
986 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
987 + "mileage": "", ~/~/ пробег, в метрах 
988 + "motohours": "" ~/~/ моточасы, в секундах
989 + }
990 + "cmsv6Parameters": ~/~/ параметры CMSv6
991 + {       
992 + "id": "", ~/~/ идентификатор
993 + "enabled": true, ~/~/ флаг включения
994 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
995 + "login": "", ~/~/ имя учетной записи
996 + "password": "", ~/~/ пароль учетной записи
997 + }
998 + "inspectionTasks": ~/~/ задания на ТО
999 + {
1000 + "id": "", ~/~/ ID задания
1001 + "enabled": false, ~/~/ Признак включения
1002 + "name": "", ~/~/ Имя задания
1003 + "description": "", ~/~/ Описание задания
1004 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1005 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1006 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1007 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1008 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1009 + "kind": "", ~/~/ Вид периодичности по времени
1010 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1011 + } 
1922 1922  )))
1923 1923  
1924 - } 
1925 - ],
1926 - "commandTemplates": [ ~/~/ Шаблон команды
1927 - {
1928 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1929 - "name": "string",
1930 - "command": "string",
1931 - "retries": 0
1932 - }
1933 - ],
1934 -"sensors": [ ~/~/ Датчики
1935 - {
1936 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1937 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1938 - "type": 0, ~/~/ Тип датчика
1939 - "name": "string", ~/~/ Имя датчика
1940 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1941 - "inputNumber": 0, ~/~/ Номер входа
1942 - "pseudonym": "string", ~/~/ Псевдоним
1943 - "medianDegree": 0, ~/~/ Медианная фильтрация
1944 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1945 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1946 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1947 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1948 - {
1949 - "grades": [ ~/~/ Таблица тарировки 1
1950 - {
1951 - "input": 0, ~/~/ Входящее значение
1952 - "output": 0 ~/~/ Выходящее значение
1953 - }
1954 - ],
1955 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1956 - }
1957 - ],
1958 - "showInTooltip": true, ~/~/ Отображать в подсказке
1959 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1014 +(% style="color:#000000" %)}
1960 1960  
1961 -(((
1962 - "color": "string",** ~/~/ **Цвет датчика
1963 -)))
1964 -
1965 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1966 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1967 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1968 - "expr": "string", ~/~/ Формула
1969 - "children": [ ~/~/ массив дочерних датчиков
1970 - "string"
1971 - ],
1972 - "customParams": { ~/~/ прочие произвольные параметры
1973 - "additionalProp1": "string",
1974 - "additionalProp2": "string",
1975 - "additionalProp3": "string"
1976 - },
1977 -~/~/ Характерные для произвольного:
1978 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1979 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1980 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1981 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1982 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1983 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1984 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1985 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1986 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1987 -~/~/ "ValueOn": "Вкл.",
1988 -~/~/ "ValueOff": "Выкл."
1989 - "summaryMaxValue": 0 ~/~/ Макс. значение
1990 -
1991 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1992 - {
1993 - "from": 0, ~/~/ С какого значения
1994 - "color": "string", ~/~/ Каким цветом
1995 - "text": "string" ~/~/ Текст подписи к этому интервалу
1996 - }
1997 - ]
1998 - }
1999 - ],
2000 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2001 -
2002 - "customFields": [ ~/~/ Произвольные поля
2003 - {     
2004 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
2005 - "name": "string", ~/~/ Наименование произвольного поля
2006 - "value": "string", ~/~/ Значение произвольного поля
2007 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2008 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2009 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
2010 - }
2011 -
2012 -(((
2013 - ],
2014 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
2015 -)))
2016 -
2017 -}
2018 -
2019 -
2020 2020  (% style="color:#000000" %)Ответ:
2021 2021  
2022 -(((
2023 -{
2024 - "vehicleId": 0, ~/~/ ID ТС
2025 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
2026 - "name": "string", ~/~/ Имя объекта
2027 - "imei": "string", ~/~/ IMEI
2028 - "deviceTypeId": 0, ~/~/ ID типа устройства
2029 - "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
2030 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
2031 - "sim1": "string", ~/~/ SIM1
2032 - "sim2": "string", ~/~/ SIM2
2033 - "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
2034 - "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
2035 - "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
2036 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
2037 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
2038 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
2039 - "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
2040 - "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
2041 - "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
2042 - "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
2043 - "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
2044 - "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
2045 - "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
2046 - "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
2047 - "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
2048 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
2049 - "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
2050 - "counters": { ~/~/ состояний счётчиков
2051 - "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
2052 - "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
2053 - "mileage": 0, ~/~/ Пробег
2054 - "motohours": 0 ~/~/ Моточасы 
2055 - },
2056 - "cmsv6Parameters": { ~/~/ Dto для CMSv6
2057 - "id": "string", ~/~/ CMSV6 Идентификатор
2058 - "enabled": true, ~/~/ Признак включения
2059 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2060 -)))
1018 +(% lang="en-US" style="text-align:left" %)
1019 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
2061 2061  
2062 -
2063 -(((
2064 -~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2065 - "login": "string", ~/~/ CMSV6 имя учетной записи
2066 - "password": "string" ~/~/ CMSV6 — пароль учетной записи
2067 - },
2068 - "inspectionTasks": [ ~/~/ Задания на ТО
2069 - {
2070 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2071 - "enabled": true, ~/~/ Признак включения
2072 - "name": "string", ~/~/ Имя задания
2073 - "description": "string", ~/~/ Описание задания
2074 - "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2075 - "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2076 - "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2077 - "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2078 - "periodicCondition": 0, ~/~/ Условие периодичности по времени
2079 - "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2080 - "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2081 - "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2082 - }
2083 - ],
2084 - "drivers": [  ~/~/ Список водителей
2085 - {
2086 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2087 - "inputNumber": 0, ~/~/ № входа.
2088 - "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2089 - "comment": "string", ~/~/ Комментарий.
2090 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2091 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2092 - "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2093 - "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2094 - }
2095 - ],
2096 - "commandTemplates": [ ~/~/ Список шаблонов команд
2097 - {
2098 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2099 - "name": "string", ~/~/ Название шаблона команд
2100 - "command": "string", ~/~/ Команда на выполнение
2101 - "retries": 0 ~/~/ Лимит попыток отправки
2102 - }
2103 - ],
2104 - "sensors": [  ~/~/ Список датчиков 
2105 - {
2106 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2107 - "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2108 - "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2109 -)))
2110 -
2111 -(((
2112 -~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2113 -)))
2114 -
2115 -(((
2116 -~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2117 -)))
2118 -
2119 -(((
2120 -~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2121 -)))
2122 -
2123 -(((
2124 -~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2125 -)))
2126 -
2127 -(((
2128 -~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2129 - "name": "string", ~/~/ Имя датчика
2130 - "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2131 -)))
2132 -
2133 -(((
2134 -~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2135 - "inputNumber": 0, ~/~/ Номер входа
2136 - "pseudonym": "string", ~/~/ Псевдоним
2137 - "medianDegree": 0, ~/~/ Степень медианной фильтрации
2138 - "isInverted": true, ~/~/ Признак инверсии
2139 - "disabled": true, ~/~/ Датчик не участвует в обработке
2140 - "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2141 - "gradesTables": [ ~/~/ Тарировка
1021 +(% lang="en-US" style="text-align:left" %)
1022 + "vehicleId": "", ~/~/ ID ТС
1023 + "parentId": "", ~/~/ ID клиента
1024 + "name": "", ~/~/ имя ТС
1025 + "imei": "", ~/~/ IMEI
1026 + "deviceTypeId": "", ~/~/ типа устройства
1027 + "modelId": "", ~/~/ ID модели
1028 + "unitId": "", ~/~/ ID подразделения
1029 + "sim1": "", ~/~/ SIM 1
1030 + "sim2": "", ~/~/ SIM2
1031 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1032 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1033 + "counters": 
1034 + {
1035 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1036 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1037 + "mileage": "", ~/~/ пробег
1038 + "motohours": "", ~/~/ моточасы
1039 + }
1040 + "cmsv6Parameters": ~/~/ параметры CMSv6
2142 2142   {
2143 - "grades": [ ~/~/ Таблицы тарировки
2144 - {
2145 - "input": 0, ~/~/ Вход
2146 - "output": 0 ~/~/ Выход
2147 - }
2148 - ],
2149 - "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2150 - }
2151 - ],
2152 - "showInTooltip": true, ~/~/ Отображение в подсказке
2153 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
2154 -
2155 -(((
2156 - "color": "string", ~/~/ цвет уведомлений
2157 -)))
2158 -
2159 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2160 - "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2161 - "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2162 - "expr": "string", ~/~/ Выражение
2163 - "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2164 - "string" 
2165 - ],
2166 - "customParams": { ~/~/ Дополнительные настройки
2167 - "additionalProp1": "string",
2168 - "additionalProp2": "string",
2169 - "additionalProp3": "string"
2170 - },
2171 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2172 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1042 + "id": ~/~/ идентификатор
1043 + "enabled": true, ~/~/ флаг включения
1044 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1045 + "login": "", ~/~/ имя учетной записи
1046 + "password": "", ~/~/ пароль учетной записи
1047 + }
1048 + "inspectionTasks": ~/~/ задания на ТО
2173 2173   {
2174 - "from": 0, ~/~/ С какого значения
2175 - "color": "string", ~/~/ Каким цветом
2176 - "text": "string" ~/~/ Текст подписи к этому интервалу
1050 + "id": "", ~/~/ ID задания
1051 + "enabled": false, ~/~/ Признак включения
1052 + "name": "", ~/~/ Имя задания
1053 + "description": "", ~/~/ Описание задания
1054 + "mileageCondition": "", ~/~/ Условие по пробегу
1055 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1056 + "motohoursCondition": "", ~/~/ Условие по моточасам
1057 + "lastMotohours": "", ~/~/ Моточасы
1058 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1059 + "kind": "", ~/~/ Вид периодичности по времени
1060 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2177 2177   }
2178 - ]
2179 - }
2180 - ],
2181 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2182 - "customFields": [ ~/~/ Список произвольных полей
2183 - {
2184 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2185 - "name": "string", ~/~/ Наименование произвольного поля
2186 - "value": "string", ~/~/ Значение произвольного поля
2187 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2188 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2189 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
2190 - }
2191 - ],
2192 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2193 -}
2194 -)))
2195 2195  
2196 -**Валидация:**
1063 +(% lang="en-US" style="text-align:left" %)
1064 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1065 +
1066 +**валидация:**
2197 2197  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2198 2198  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2199 2199  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2200 2200  
2201 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2202 2202  
1072 +== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1073 +
2203 2203  (% class="box errormessage" %)
2204 2204  (((
2205 2205  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2206 2206  )))
2207 2207  
2208 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1079 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2209 2209  
2210 2210  (% style="color:#000000" %)Метод запроса: **DELETE**
2211 2211  
... ... @@ -2218,3723 +2218,66 @@
2218 2218  (% style="text-align:left" %)
2219 2219  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2220 2220  
2221 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2222 2222  
2223 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1093 +(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
2224 2224  
1095 +
1096 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1097 +
2225 2225  (% class="box infomessage" %)
2226 2226  (((
2227 2227  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2228 2228  )))
2229 2229  
2230 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1103 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2231 2231  
2232 2232  (% style="color:#000000" %)Метод запроса: **GET**
2233 2233  
2234 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1107 +(% 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]]
2235 2235  
2236 2236  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2237 2237  
2238 2238  (% style="color:#000000" %)Ответ:
2239 2239  
2240 -(% style="color:#000000" %){(%%)
1113 +(% style="color:#000000" %){
1114 +
2241 2241   "deviceTypeId" : "", ~/~/ ID типа устройства
2242 2242   "deviceTypeName" : "" ~/~/ Название типа устройства
1117 +
1118 +(% style="text-align:left" %)
2243 2243  (% style="color:#000000" %)}
2244 2244  
2245 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2246 2246  
2247 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1122 += (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
2248 2248  
1124 +
1125 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1126 +
2249 2249  (% class="box infomessage" %)
2250 2250  (((
2251 2251  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2252 2252  )))
2253 2253  
2254 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1132 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
2255 2255  
2256 2256  (% style="color:#000000" %)Метод запроса: **GET**
2257 2257  
2258 2258  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2259 2259  
2260 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1138 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
2261 2261  
2262 2262  (% style="color:#000000" %)Ответ:
2263 2263  
2264 -(% style="color:#000000" %){(%%)
1142 +(% style="color:#000000" %){
1143 +
2265 2265   "id": "", ~/~/ ID типа датчика 
2266 2266   "name": "", ~/~/ Название
2267 2267   "description": "", ~/~/ Описание
2268 -(% style="color:#000000" %)}
2269 2269  
2270 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2271 -
2272 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2273 -
2274 -(% class="box infomessage" style="text-align: left;" %)
2275 -(((
2276 -**POST /api/v3/terminalMessages/count**
2277 -)))
2278 -
2279 -(% style="text-align: left;" %)
2280 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2281 -
2282 -(% style="text-align: left;" %)
2283 -Метод запроса **POST**
2284 -
2285 -(% style="text-align: left;" %)
2286 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2287 -
2288 -(% style="text-align: left;" %)
2289 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2290 -
2291 -(% style="text-align: left;" %)
2292 -{
2293 - "vehicleIds": [
2294 - id ~/~/ здесь передается список идентификаторов объектов
2295 - ],
2296 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2297 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2298 -}
2299 -
2300 -(% style="text-align: left;" %)
2301 -Ответ:
2302 -
2303 -(% style="text-align: left;" %)
2304 -[
2305 - {
2306 - "vehicleId": 0, ~/~/ идентификатор объекта
2307 - "count": 0 ~/~/ количество сообщений за период
2308 - }
2309 -]
2310 -
2311 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2312 -
2313 -(% class="box infomessage" style="text-align: left;" %)
2314 -(((
2315 -**POST /api/v3/terminalMessages/mapping**
2316 -)))
2317 -
2318 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2319 -
2320 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2321 -
2322 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2323 -
2324 -{
2325 - "protocolType": 0,
2326 - "params": ["string"]
2327 -}
2328 -
2329 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2330 -|protocolType|ID типа протокола
2331 -|params|(((
2332 -Массив наименований параметров в сообщении
2333 -)))
2334 -
2335 -Ответ:
2336 -
2337 -{
2338 - "protocolType": 0,
2339 - "mapping": {
2340 - "additionalProp1": {
2341 - "inputType": 0,
2342 - "inputNumber": 0
2343 - },
2344 - "additionalProp2": {
2345 - "inputType": 0,
2346 - "inputNumber": 0
2347 - }
2348 - }
2349 -}
2350 -
2351 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2352 -|protocolType|Тип протокола
2353 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2354 -|inputNumber|(((
2355 -Номер входа
2356 -)))
2357 -
2358 -(% class="wikigeneratedid" %)
2359 -Перечень 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/]]
2360 -
2361 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2362 -
2363 -(% class="box infomessage" %)
2364 -(((
2365 -**POST /api/v3/terminalMessages**
2366 -)))
2367 -
2368 -Метод возвращает список сообщений терминала объекта за выбранный период.
2369 -
2370 -(% style="text-align: left;" %)
2371 -Метод запроса **POST**
2372 -
2373 -(% style="text-align: left;" %)
2374 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2375 -
2376 -(% style="text-align: left;" %)
2377 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2378 -
2379 -{
2380 - "vehicleId": 0, ~/~/ id объекта
2381 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2382 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2383 -}
2384 -
2385 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2386 -|vehicleId|ID объекта
2387 -|from|Дата и время начала периода запроса
2388 -|to|Дата и время окончания периода запроса
2389 -
2390 -Ответ:
2391 -
2392 -[
2393 - {
2394 - "messages": [
2395 - {
2396 - "deviceTime": "2023-11-29T07:40:44.052Z",
2397 - "serverTime": "2023-11-29T07:40:44.052Z",
2398 - "speed": 0,
2399 - "altitude": 0,
2400 - "latitude": 0,
2401 - "longitude": 0,
2402 - "satellites": 0,
2403 - "course": 0,
2404 - "voltage": 0,
2405 - "parameters": {
2406 - "additionalProp1": "string",
2407 - "additionalProp2": "string",
2408 - "additionalProp3": "string"
2409 - },
2410 - "photoCount": 0,
2411 - "lbsCorrectedCoords": true,
2412 - "protocolType": 0
2413 - }
2414 - ]
2415 - }
2416 -]
2417 -
2418 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2419 -|deviceTime|Время сообщения терминала
2420 -|serverTime|Время когда сообщение поступило на сервер
2421 -|speed|Скорость
2422 -|altitude|Высота над уровнем моря
2423 -|latitude|Широта
2424 -|longitude|Долгота
2425 -|satellites|Кол-во спутников
2426 -|course|Курс
2427 -|voltage|Бортовое напряжение
2428 -|parameters|Список параметров и их значений
2429 -|photoCount|Количество фото
2430 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2431 -|protocolType|ID типа протокола
2432 -
2433 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2434 -
2435 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2436 -
2437 -(% class="box infomessage" %)
2438 -(((
2439 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2440 -)))
2441 -
2442 -(% style="color:#000000" %)Метод запроса: **POST**
2443 -
2444 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2445 -
2446 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2447 -
2448 2448  (% style="text-align:left" %)
2449 -Тело запроса:
2450 -
2451 -{
2452 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2453 - "vehicleIds": [0], ~/~/ Список ID объектов
2454 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2455 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2456 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2457 -}
2458 -
2459 -Ответ:
2460 -
2461 -[
2462 - {
2463 - "vehicleId": 0, ~/~/ ID объекта
2464 - "name": "string", ~/~/ Имя ТС
2465 - "periods": [ ~/~/ Периоды
2466 - {
2467 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2468 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2469 - "mileage": 0, ~/~/ Пробег за период, километры
2470 - "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2471 - "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2472 - "motohours": 0, ~/~/ Моточасы за период, секунды
2473 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2474 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2475 - "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2476 -
2477 - }
2478 - ]
2479 - }
2480 -]
2481 -
2482 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2483 -
2484 -(% class="box infomessage" %)
2485 -(((
2486 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2487 -)))
2488 -
2489 -(% style="color:#000000" %)Метод запроса: **POST**
2490 -
2491 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2492 -
2493 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2494 -
2495 -(% style="text-align:left" %)
2496 -Тело запроса:
2497 -
2498 -{
2499 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2500 - "vehicleIds": [0], ~/~/ Список ID объектов
2501 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2502 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2503 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2504 -}
2505 -
2506 -Ответ:
2507 -
2508 -[
2509 - {
2510 - "vehicleId": 0, ~/~/ ID объекта
2511 - "name": "string", ~/~/ Имя ТС
2512 - "periods": [ ~/~/ Периоды
2513 - {
2514 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2515 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2516 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2517 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2518 - "fuelConsumption": 0, ~/~/ Расход топлива
2519 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2520 - }
2521 - ]
2522 - }
2523 -]
2524 -
2525 -(% class="box warningmessage" %)
2526 -(((
2527 -Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2528 -\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2529 -)))
2530 -
2531 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2532 -
2533 -(% class="box infomessage" %)
2534 -(((
2535 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2536 -)))
2537 -
2538 -(% style="color:#000000" %)Метод запроса: **POST**
2539 -
2540 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2541 -
2542 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2543 -
2544 -(% style="text-align:left" %)
2545 -Тело запроса:
2546 -
2547 -{
2548 - "vehicleIds": [0], ~/~/ Список ID объектов
2549 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2550 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2551 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2552 -}
2553 -
2554 -Ответ:
2555 -
2556 -[
2557 - {
2558 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2559 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2560 - "vehicleId": 0, ~/~/ ID объекта
2561 - "name": "string", ~/~/ Имя объекта
2562 - "model": "string", ~/~/ Модель объекта
2563 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2564 - {
2565 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2566 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2567 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2568 - "valueFuel": 0, ~/~/ Количество
2569 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2570 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2571 - }
2572 - ]
2573 - }
2574 -]
2575 -
2576 -
2577 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2578 -
2579 -(% class="box infomessage" %)
2580 -(((
2581 -**POST /api/v3/vehicles/moveStop**
2582 -)))
2583 -
2584 -Метод запроса: **POST**
2585 -
2586 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2587 -
2588 -В заголовках запроса: X-Auth: Токен авторизации
2589 -
2590 -
2591 -Тело запроса:
2592 -
2593 -{
2594 - "vehicleIds": [ ], ~/~/ Список ID объектов
2595 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2596 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2597 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2598 -}
2599 -
2600 -Ответ:
2601 -
2602 -[ 
2603 - {
2604 - "vehicleId": 0, ~/~/ ID объекта
2605 - "vehicleName": "string", ~/~/ Имя объекта
2606 - "moves": [ ~/~/ Событие движения
2607 - {
2608 - "mileage": 0, ~/~/ Пробег, км
2609 - "eventId": 0, ~/~/ Идентификатор события
2610 - "eventName": "string", ~/~/ Название события
2611 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2612 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2613 - "duration": 0 ~/~/ Продолжительность события, секунд
2614 - }
2615 - ],
2616 - "stops": [ ~/~/ События стоянок
2617 - {
2618 - "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2619 - "eventId": 0, ~/~/ Идентификатор события
2620 - "eventName": "string", ~/~/ Название события
2621 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2622 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2623 - "duration": 0 ~/~/ Продолжительность события, секунд
2624 - }
2625 - ]
2626 - }
2627 -]
2628 -
2629 -
2630 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2631 -
2632 -(% class="box infomessage" %)
2633 -(((
2634 -**POST /api/v3/vehicles/getlastdata**
2635 -)))
2636 -
2637 -Метод запроса: **POST**
2638 -
2639 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2640 -
2641 -В заголовках запроса: X-Auth: Токен авторизации
2642 -
2643 -
2644 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2645 -
2646 -Ответ:
2647 - {
2648 - "vehicleId": 0, ~/~/Идентификатор объекта.
2649 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2650 - "vehicleNumber": "string",~/~/Номер объекта.
2651 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2652 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2653 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2654 - "speed": 0,~/~/Скорость объекта.
2655 - "course": 0,~/~/Курс движения [0;360]
2656 - "latitude": 0,~/~/Широта [-90°;90°].
2657 - "longitude": 0,~/~/Долгота [-180°;180°].
2658 - "address": "string",~/~/Адрес.
2659 - "geozones": [ ~/~/Сведения по геозонам.
2660 - {
2661 - "id": 0,
2662 - "name": "string"
2663 - }
2664 -
2665 -
2666 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2667 -
2668 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2669 -
2670 -(% class="box infomessage" %)
2671 -(((
2672 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2673 -)))
2674 -
2675 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2676 -
2677 -(% style="color:#000000" %)Метод запроса: **POST**
2678 -
2679 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2680 -
2681 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2682 -
2683 -(% style="text-align:left" %)
2684 -Тело запроса:
2685 -
2686 -(% style="text-align:left" %)
2687 -{
2688 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2689 -}
2690 -
2691 -(% style="text-align:left" %)
2692 -Ответ:
2693 -
2694 -[
2695 - {
2696 - "id": 0, ~/~/ Идентификатор объекта геозоны
2697 - "name": "string", ~/~/ Название объекта геозоны
2698 - "type": 0, ~/~/ Тип объекта геозоны
2699 - "fname": "string", ~/~/ Имя файла
2700 - "parentId": "string", ~/~/ Идентификатор клиента
2701 - "radius": 0, ~/~/ Радиус геообъекта
2702 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2703 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2704 - "description": "string", ~/~/ Описание
2705 - "area": 0, ~/~/ Площадь, м^^2^^
2706 - "perimetr": 0, ~/~/ Периметр, м
2707 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2708 - }
2709 -]
2710 -
2711 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2712 -
2713 -(% class="box infomessage" %)
2714 -(((
2715 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2716 -)))
2717 -
2718 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2719 -
2720 -(% style="color:#000000" %)Метод запроса: **POST**
2721 -
2722 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2723 -
2724 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2725 -
2726 -(% style="text-align:left" %)
2727 -Тело запроса:
2728 -
2729 -{
2730 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2731 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2732 - "ids": [ ], ~/~/ Массив id объектов
2733 - "byTime": 0, ~/~/ Объединение событий по времени 
2734 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2735 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2736 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2737 -}
2738 -
2739 -Ответ:
2740 -[
2741 - {
2742 - "geozoneId": 0, ~/~/ ID геообъекта
2743 - "geozoneName": "string", ~/~/ Название геообъекта
2744 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2745 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2746 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2747 - "vehicleId": 0, ~/~/ ID объекта
2748 - "vehicleName": "string" ~/~/ Имя объекта
2749 - }
2750 -]
2751 -
2752 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2753 -
2754 -(% class="box infomessage" %)
2755 -(((
2756 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2757 -)))
2758 -
2759 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2760 -
2761 -(% style="color:#000000" %)Метод запроса: **POST**
2762 -
2763 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2764 -
2765 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2766 -
2767 -(% style="text-align:left" %)
2768 -Тело запроса:
2769 -
2770 -{
2771 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2772 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2773 - "ids": [ ], ~/~/ Массив id геообъектов
2774 - "byTime": 0, ~/~/ Объединение событий по времени 
2775 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2776 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2777 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2778 -}
2779 -
2780 -Ответ:
2781 -
2782 -[
2783 - {
2784 - "geozoneId": 0, ~/~/ ID геообъекта
2785 - "geozoneName": "string", ~/~/ Название геообъекта
2786 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2787 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2788 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2789 - "vehicleId": 0, ~/~/ ID объекта
2790 - "vehicleName": "string" ~/~/ Имя объекта
2791 - }
2792 -]
2793 -
2794 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2795 -
2796 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2797 -
2798 -(% class="box infomessage" %)
2799 -(((
2800 -**POST /api/v3/notifications/find**
2801 -)))
2802 -
2803 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2804 -
2805 -(% style="text-align: left;" %)
2806 -Метод запроса **POST**
2807 -
2808 -(% style="text-align: left;" %)
2809 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2810 -
2811 -(% style="text-align: left;" %)
2812 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2813 -
2814 -{
2815 - "parentId": "" ~/~/ id клиента
2816 -}
2817 -
2818 -Ответ:
2819 -
2820 -[
2821 - {
2822 - "id": 0, ~/~/ ID уведомления
2823 - "name": "string", ~/~/ Название уведомления
2824 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2825 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2826 - "userId": "", ~/~/ Пользователь, создавший уведомление
2827 - "parentId": "", ~/~/ Идентификатор клиента
2828 - "parentName": "string" ~/~/ Имя клиента
2829 - }
2830 -]
2831 -
2832 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2833 -
2834 -(% class="box infomessage" %)
2835 -(((
2836 -**GET /api/v3/notifications/{id}**
2837 -)))
2838 -
2839 -Метод возвращает данные правил формирования выбранного уведомления.
2840 -
2841 -(% style="text-align: left;" %)
2842 -Метод запроса **GET**
2843 -
2844 -(% style="text-align: left;" %)
2845 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2846 -
2847 -(% style="text-align: left;" %)
2848 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2849 -
2850 -(% style="text-align: left;" %)
2851 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2852 -
2853 -(% style="text-align: left;" %)
2854 -(% style="color:#000000" %)Ответ:
2855 -
2856 -(% style="text-align: left;" %)
2857 -(% style="color:#000000" %){
2858 - "id": 0, ~/~/ (%%)id уведомления
2859 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2860 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2861 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2862 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2863 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2864 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2865 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2866 -(% style="color:#000000" %) 0
2867 - ],
2868 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2869 -(% style="color:#000000" %) 0
2870 - ],
2871 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
2872 -(% style="color:#000000" %) 0
2873 - ],
2874 - "settings": { ~/~/ Список параметров уведомления
2875 - "additionalProp1": "string",
2876 - "additionalProp2": "string",
2877 - "additionalProp3": "string"
2878 - },
2879 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2880 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2881 -(% style="color:#000000" %) ""
2882 - ],
2883 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2884 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2885 -(% style="color:#000000" %) "string"
2886 - ],
2887 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2888 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2889 -(% style="color:#000000" %) {
2890 - "id": 0, ~/~/ (%%)Идентификатор участника чата
2891 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2892 -(% style="color:#000000" %) }
2893 - ],
2894 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2895 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2896 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2897 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2898 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2899 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2900 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2901 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2902 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2903 2903  (% style="color:#000000" %)}
2904 2904  
2905 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2906 2906  
2907 -(% class="box warningmessage" %)
2908 -(((
2909 -**PUT /api/v3/notifications/**
2910 -)))
2911 -
2912 -Метод позволяет отредактировать уведомление.
2913 -
2914 -Метод запроса **PUT**
2915 -
2916 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2917 -
2918 -В заголовках запроса: X-Auth: Токен авторизации
2919 -
2920 -Тело запроса:
2921 -{
2922 - "id": 0, ~/~/ id уведомления
2923 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2924 - "userId": "", ~/~/ Пользователь, создавший уведомление
2925 - "parentId": "", ~/~/ Идентификатор клиента
2926 - "parentName": "string", ~/~/ Имя клиента
2927 - "name": "string", ~/~/ Название уведомления
2928 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2929 - "vehicleIds": [ ~/~/ Список id объектов для анализа
2930 - 0
2931 - ],
2932 - "geoids": [ ~/~/ Список id геообъектов для анализа
2933 - 0
2934 - ],
2935 - "fieldids": [ ~/~/ Список id полей для анализа
2936 - 0
2937 - ],
2938 - "settings": { ~/~/ Список параметров уведомления
2939 - "additionalProp1": "string",
2940 - "additionalProp2": "string",
2941 - "additionalProp3": "string"
2942 - },
2943 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2944 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2945 - ""
2946 - ],
2947 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2948 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2949 - "string"
2950 - ],
2951 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2952 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2953 - {
2954 - "id": 0, ~/~/ Идентификатор участника чата
2955 - "info": "string" ~/~/ Дополнительные сведения
2956 - }
2957 - ],
2958 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2959 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2960 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2961 - "kind": 0, ~/~/ Определяет вид уведомления
2962 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2963 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2964 - "timezone": 0, ~/~/ Сдвиг часового пояса
2965 - "validity": 0, ~/~/ Срок действия в днях (1-90)
2966 - "autoProlongation": true ~/~/ Автопродление срока действия
2967 -}
2968 -
2969 -Ответ:
2970 -
2971 -Success
2972 -
2973 -
2974 -== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2975 -
2976 -(% class="box warningmessage" %)
2977 -(((
2978 -**PUT** /api/v3/notifications/prolongation
2979 -)))
2980 -
2981 -Метод позволяет продлить уведомления.
2982 -
2983 -Метод запроса **PUT**
2984 -
2985 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2986 -
2987 -В заголовках запроса: X-Auth: Токен авторизации.
2988 -
2989 -Тело запроса:
2990 -
2991 -[
2992 -
2993 -0
2994 -
2995 -]
2996 -
2997 -где 0 идентификатор ids.
2998 -
2999 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
3000 -
3001 -(% class="box errormessage" %)
3002 -(((
3003 -**DELETE /api/v3/notifications/{id}**
3004 -)))
3005 -
3006 -Метод позволяет удалить выбранное уведомление.
3007 -
3008 -Метод запроса **DELETE**
3009 -
3010 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3011 -
3012 -Передаваемый параметр: {id} - id уведомления
3013 -
3014 -В заголовках запроса: X-Auth: Токен авторизации
3015 -
3016 -Ответ:
3017 -
3018 -Success
3019 -
3020 -
3021 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3022 -
3023 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3024 -
3025 -(% class="box infomessage" %)
3026 -(((
3027 -**POST /api/v3/Drivers/find**
3028 -)))
3029 -
3030 -Передается параметр: parentId - ID клиента-родителя
3031 -
3032 -Ответ:
3033 -
3034 -[
3035 - {
3036 - "name": "string", ~/~/ Определяет наименование
3037 - "description": "string", ~/~/ Определяет описание
3038 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3039 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3040 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
3041 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3042 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3043 - "deleted": true ~/~/ Признак удаления
3044 - }
3045 -]
3046 -
3047 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3048 -
3049 -(% class="box infomessage" %)
3050 -(((
3051 -**GET /api/v3/Drivers/{driverGuid}**
3052 -)))
3053 -
3054 -Передается параметр: ID водителя
3055 -
3056 -Ответ:
3057 -
3058 -{
3059 - "name": "string", ~/~/ Определяет наименование
3060 - "description": "string", ~/~/ Определяет описание
3061 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3062 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3063 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
3064 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3065 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3066 - "deleted": true ~/~/ Признак удаления
3067 -}
3068 -
3069 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3070 -
3071 -(% class="box successmessage" %)
3072 -(((
3073 -**POST /api/v3/Drivers**
3074 -)))
3075 -
3076 -Запрос:
3077 -
3078 -{
3079 - "name": "string",
3080 - "description": "string",
3081 - "hiredate": "2023-06-30T12:50:54.020Z",
3082 - "chopdate": "2023-06-30T12:50:54.020Z",
3083 - "exclusive": true,
3084 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3086 - "deleted": true
3087 -}
3088 -
3089 -Ответ:
3090 -
3091 -{
3092 - "name": "string",
3093 - "description": "string",
3094 - "hiredate": "2023-06-30T12:50:54.051Z",
3095 - "chopdate": "2023-06-30T12:50:54.051Z",
3096 - "exclusive": true,
3097 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3098 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3099 - "deleted": true
3100 -}
3101 -
3102 -
3103 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3104 -
3105 -(% class="box warningmessage" %)
3106 -(((
3107 -**PUT /api/v3/Drivers**
3108 -)))
3109 -
3110 -Запрос:
3111 -
3112 -{
3113 - "name": "string",
3114 - "description": "string",
3115 - "hiredate": "2023-06-30T12:50:27.910Z",
3116 - "chopdate": "2023-06-30T12:50:27.910Z",
3117 - "exclusive": true,
3118 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3119 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3120 - "deleted": true
3121 -}
3122 -
3123 -Ответ:
3124 -
3125 -{
3126 - "name": "string",
3127 - "description": "string",
3128 - "hiredate": "2023-06-30T12:50:27.929Z",
3129 - "chopdate": "2023-06-30T12:50:27.929Z",
3130 - "exclusive": true,
3131 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3132 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3133 - "deleted": true
3134 -}
3135 -
3136 -
3137 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3138 -
3139 -(% class="box errormessage" %)
3140 -(((
3141 -**DELETE /api/v3/Drivers/{driverGuid}**
3142 -)))
3143 -
3144 -Передается параметр: ID водителя
3145 -
3146 -Ответ:
3147 -
3148 -Success
3149 -
3150 -
3151 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3152 -
3153 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3154 -
3155 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3156 -
3157 -(% class="box infomessage" %)
3158 -(((
3159 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3160 -)))
3161 -
3162 -Запрос:
3163 -
3164 -{
3165 - "Ids": [
3166 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3167 - ],
3168 - "BeginTime": "2023-06-30T12:49:04.365Z",
3169 - "EndTime": "2023-06-30T12:49:04.365Z"
3170 -}
3171 -
3172 -Ответ:
3173 -
3174 -[
3175 - {
3176 - "VehicleId": 0,
3177 - "CreateTime": "2023-06-30T09:52:31.240Z",
3178 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3179 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3180 - "BeginTime": "2023-06-30T09:52:31.240Z",
3181 - "EndTime": "2023-06-30T09:52:31.240Z"
3182 - }
3183 -]
3184 -
3185 -
3186 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3187 -
3188 -(% class="box infomessage" %)
3189 -(((
3190 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3191 -)))
3192 -
3193 -Запрос:
3194 -
3195 -{
3196 - "Ids": [
3197 - 0
3198 - ],
3199 - "BeginTime": "2023-06-30T12:48:39.419Z",
3200 - "EndTime": "2023-06-30T12:48:39.419Z"
3201 -}
3202 -
3203 -Ответ:
3204 -
3205 -[
3206 - {
3207 - "VehicleId": 0,
3208 - "CreateTime": "2023-06-30T09:54:01.631Z",
3209 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3210 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 - "BeginTime": "2023-06-30T09:54:01.631Z",
3212 - "EndTime": "2023-06-30T09:54:01.631Z"
3213 - }
3214 -]
3215 -
3216 -
3217 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3218 -
3219 -(% class="box successmessage" %)
3220 -(((
3221 -**POST /api/v3/DriversVehiclesAssignments**
3222 -)))
3223 -
3224 -Передается массив назначений
3225 -
3226 -Запрос:
3227 -
3228 -[
3229 - {
3230 - "VehicleId": 0, ~/~/ Идентификатор объекта
3231 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3232 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3233 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3234 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3235 - }
3236 -]
3237 -
3238 -Ответ:
3239 -
3240 -[
3241 - {
3242 - "VehicleId": 0,
3243 - "CreateTime": "2023-06-30T11:04:46.903Z",
3244 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3245 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3246 - "BeginTime": "2023-06-30T11:04:46.903Z",
3247 - "EndTime": "2023-06-30T11:04:46.903Z"
3248 - }
3249 -]
3250 -
3251 -
3252 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3253 -
3254 -(% class="box warningmessage" %)
3255 -(((
3256 -**PUT /api/v3/DriversVehiclesAssignments**
3257 -)))
3258 -
3259 -Запрос:
3260 -
3261 -[
3262 - {
3263 - "VehicleId": 0,
3264 - "CreateTime": "2023-06-30T11:14:08.117Z",
3265 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3266 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3267 - "BeginTime": "2023-06-30T11:14:08.117Z",
3268 - "EndTime": "2023-06-30T11:14:08.117Z"
3269 - }
3270 -]
3271 -
3272 -Ответ:
3273 -
3274 -[
3275 - {
3276 - "VehicleId": 0,
3277 - "CreateTime": "2023-06-30T11:14:53.349Z",
3278 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3279 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3280 - "BeginTime": "2023-06-30T11:14:53.349Z",
3281 - "EndTime": "2023-06-30T11:14:53.349Z"
3282 - }
3283 -]
3284 -
3285 -
3286 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3287 -
3288 -(% class="box errormessage" %)
3289 -(((
3290 -**DELETE /api/v3/DriversVehiclesAssignments**
3291 -)))
3292 -
3293 -Запрос:
3294 -
3295 -[
3296 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3297 -]
3298 -
3299 -Ответ:
3300 -
3301 -Success
3302 -
3303 -
3304 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3305 -
3306 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3307 -
3308 -(% class="box infomessage" %)
3309 -(((
3310 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3311 -)))
3312 -
3313 -Запрос:
3314 -
3315 -{
3316 - "Ids": [
3317 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3318 - ],
3319 - "BeginTime": "2023-06-30T12:47:12.162Z",
3320 - "EndTime": "2023-06-30T12:47:12.162Z"
3321 -}
3322 -
3323 -Ответ:
3324 -
3325 -[
3326 - {
3327 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3328 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3329 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3330 - "BeginTime": "2023-06-30T11:19:40.703Z",
3331 - "EndTime": "2023-06-30T11:19:40.703Z"
3332 - }
3333 -]
3334 -
3335 -
3336 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3337 -
3338 -(% class="box infomessage" %)
3339 -(((
3340 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3341 -)))
3342 -
3343 -Запрос:
3344 -
3345 -{
3346 - "Ids": [
3347 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3348 - ],
3349 - "BeginTime": "2023-06-30T12:47:12.162Z",
3350 - "EndTime": "2023-06-30T12:47:12.162Z"
3351 -}
3352 -
3353 -Ответ:
3354 -
3355 -[
3356 - {
3357 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3358 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3359 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3360 - "BeginTime": "2023-06-30T11:19:40.703Z",
3361 - "EndTime": "2023-06-30T11:19:40.703Z"
3362 - }
3363 -]
3364 -
3365 -
3366 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3367 -
3368 -(% class="box successmessage" %)
3369 -(((
3370 -**POST /api/v3/DriversRfidsAssignments**
3371 -)))
3372 -
3373 -Запрос:
3374 -
3375 -[
3376 - {
3377 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3378 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3379 - "BeginTime": "2023-06-30T11:27:08.635Z",
3380 - "EndTime": "2023-06-30T11:27:08.635Z"
3381 - }
3382 -]
3383 -
3384 -Ответ:
3385 -
3386 -[
3387 - {
3388 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3389 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3390 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3391 - "BeginTime": "2023-06-30T11:27:08.677Z",
3392 - "EndTime": "2023-06-30T11:27:08.677Z"
3393 - }
3394 -]
3395 -
3396 -
3397 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3398 -
3399 -(% class="box warningmessage" %)
3400 -(((
3401 -**PUT /api/v3/DriversRfidsAssignments**
3402 -)))
3403 -
3404 -Запрос:
3405 -
3406 -[
3407 - {
3408 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3409 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3410 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3411 - "BeginTime": "2023-06-30T11:28:43.330Z",
3412 - "EndTime": "2023-06-30T11:28:43.330Z"
3413 - }
3414 -]
3415 -
3416 -Ответ:
3417 -
3418 -[
3419 - {
3420 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3421 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3422 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3423 - "BeginTime": "2023-06-30T11:28:43.331Z",
3424 - "EndTime": "2023-06-30T11:28:43.331Z"
3425 - }
3426 -]
3427 -
3428 -
3429 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3430 -
3431 -(% class="box errormessage" %)
3432 -(((
3433 -**DELETE /api/v3/DriversRfidsAssignments**
3434 -)))
3435 -
3436 -Запрос:
3437 -
3438 -[
3439 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3440 -]
3441 -
3442 -Ответ:
3443 -
3444 -Success
3445 -
3446 -
3447 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3448 -
3449 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3450 -
3451 -(% class="box infomessage" %)
3452 -(((
3453 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3454 -)))
3455 -
3456 -Запрос:
3457 -
3458 -{
3459 - "Ids": [
3460 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3461 - ],
3462 - "BeginTime": "2023-06-30T12:45:10.852Z",
3463 - "EndTime": "2023-06-30T12:45:10.852Z"
3464 -}
3465 -
3466 -Ответ:
3467 -
3468 -[
3469 - {
3470 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3471 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3472 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3473 - "BeginTime": "2023-06-30T11:58:04.695Z",
3474 - "EndTime": "2023-06-30T11:58:04.695Z"
3475 - }
3476 -]
3477 -
3478 -
3479 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3480 -
3481 -(% class="box infomessage" %)
3482 -(((
3483 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3484 -)))
3485 -
3486 -Запрос:
3487 -
3488 -{
3489 - "Ids": [
3490 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3491 - ],
3492 - "BeginTime": "2023-06-30T12:45:10.852Z",
3493 - "EndTime": "2023-06-30T12:45:10.852Z"
3494 -}
3495 -
3496 -Ответ:
3497 -
3498 -[
3499 - {
3500 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3501 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3502 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3503 - "BeginTime": "2023-06-30T11:58:04.695Z",
3504 - "EndTime": "2023-06-30T11:58:04.695Z"
3505 - }
3506 -]
3507 -
3508 -
3509 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3510 -
3511 -(% class="box successmessage" %)
3512 -(((
3513 -**POST /api/v3/DriversFuelCardsAssignments**
3514 -)))
3515 -
3516 -Запрос:
3517 -
3518 -[
3519 - {
3520 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3521 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3522 - "BeginTime": "2023-06-30T12:09:53.175Z",
3523 - "EndTime": "2023-06-30T12:09:53.175Z"
3524 - }
3525 -]
3526 -
3527 -Ответ:
3528 -
3529 -[
3530 - {
3531 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3532 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3533 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3534 - "BeginTime": "2023-06-30T12:09:53.201Z",
3535 - "EndTime": "2023-06-30T12:09:53.201Z"
3536 - }
3537 -]
3538 -
3539 -
3540 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3541 -
3542 -(% class="box warningmessage" %)
3543 -(((
3544 -**PUT /api/v3/DriversFuelCardsAssignments**
3545 -)))
3546 -
3547 -Запрос:
3548 -
3549 -[
3550 - {
3551 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3552 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3553 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3554 - "BeginTime": "2023-06-30T12:09:53.201Z",
3555 - "EndTime": "2023-06-30T12:09:53.201Z"
3556 - }
3557 -]
3558 -
3559 -Ответ:
3560 -
3561 -[
3562 - {
3563 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3564 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3565 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3566 - "BeginTime": "2023-06-30T12:09:53.201Z",
3567 - "EndTime": "2023-06-30T12:09:53.201Z"
3568 - }
3569 -]
3570 -
3571 -
3572 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3573 -
3574 -(% class="box errormessage" %)
3575 -(((
3576 -**DELETE /api/v3/DriversFuelCardsAssignments**
3577 -)))
3578 -
3579 -Запрос:
3580 -
3581 -[
3582 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3583 -]
3584 -
3585 -Ответ:
3586 -
3587 -Success
3588 -
3589 -
3590 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3591 -
3592 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3593 -
3594 -(% class="box infomessage" %)
3595 -(((
3596 -**POST /api/v3/Trailers**
3597 -)))
3598 -
3599 -Пример запроса:
3600 -
3601 -{
3602 - "startDate": "2023-11-14T10:48:03.671Z",
3603 - "endDate": "2023-11-14T10:48:03.671Z",
3604 - "ids": [ 0 ],
3605 - "timezone": 0
3606 -}
3607 -
3608 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3609 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3610 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3611 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3612 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3613 -
3614 -Пример ответа:
3615 -
3616 -[
3617 - {
3618 - "SD": "2023-11-14T10:48:03.717Z",
3619 - "ED": "2023-11-14T10:48:03.717Z", 
3620 - "id": 0,
3621 - "SLat": 0,
3622 - "SLon": 0,
3623 - "ELat": 0,
3624 - "ELon": 0,
3625 - "mileage": 0
3626 - "Duration": 0
3627 - "Address": "string",
3628 - "Address2": "string",
3629 - "name": "string",
3630 - "rid": "string",
3631 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3632 - "trailer": {
3633 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3634 - "Number": "string",
3635 - "Description": "string",
3636 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3637 - "ExternalID": "string",
3638 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3639 - "CreateTime": "2023-11-14T10:48:03.717Z",
3640 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3641 - "IsDeleted": true
3642 - },
3643 - "filesCount": 0,
3644 - }
3645 -]
3646 -
3647 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3648 -|SD|Дата и время начала события
3649 -|ED|Дата и время окончания события
3650 -|id|ID объекта
3651 -|SLat|Широта начальной координаты
3652 -|SLon|Долгота начальной координаты
3653 -|ELat|Широта конечной координаты
3654 -|ELon|Долгота конечной координаты
3655 -|mileage|Пробег
3656 -|Duration|Продолжительность
3657 -|Address|Адрес начального местоположения
3658 -|Address2|Адрес конечного местоположения
3659 -|name|Имя радиометки
3660 -|rid|Номер радиометки
3661 -|rguid|ID радиометки
3662 -|trailer|Информация об агрегате
3663 -|ModelGuid|ID агрегата
3664 -|Number|Название/номер агрегата
3665 -|Description|Текст примечания агрегата
3666 -
3667 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3668 -
3669 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3670 -
3671 -(% class="box infomessage" %)
3672 -(((
3673 -**POST /api/v3/Rfids/find**
3674 -)))
3675 -
3676 -Запрос:
3677 -
3678 -{
3679 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3680 -}
3681 -
3682 -Ответ:
3683 -
3684 -[
3685 - {
3686 - "name": "string",
3687 - "number": 0,
3688 - "period": 0,
3689 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3690 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3691 - }
3692 -]
3693 -
3694 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3695 -|parentId|ID клиента
3696 -|name|Название карты-метки
3697 -|number|Номер
3698 -|period|Период запросов в секундах (работает только для агрегатов)
3699 -|id|ID карты-метки
3700 -
3701 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3702 -
3703 -(% class="box infomessage" %)
3704 -(((
3705 -**GET /api/v3/Rfids/{rfidGuid}**
3706 -)))
3707 -
3708 -Передаем параметр rfidGuid - идентификатор карты-метки
3709 -
3710 -Ответ:
3711 -
3712 -[
3713 - {
3714 - "name": "string",
3715 - "number": 0,
3716 - "period": 0,
3717 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3718 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3719 - }
3720 -]
3721 -
3722 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3723 -|name|Название карты-метки
3724 -|number|Номер
3725 -|period|Период запросов в секундах (работает только для агрегатов)
3726 -|id|ID карты-метки
3727 -|parentId|ID клиента
3728 -
3729 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3730 -
3731 -(% class="box successmessage" %)
3732 -(((
3733 -**POST /api/v3/Rfids**
3734 -)))
3735 -
3736 -Запрос:
3737 -
3738 -{
3739 - "name": "string",
3740 - "number": 0,
3741 - "period": 0,
3742 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3743 -}
3744 -
3745 -Ответ:
3746 -
3747 -{
3748 - "name": "string",
3749 - "number": 0,
3750 - "period": 0,
3751 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3752 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3753 -}
3754 -
3755 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3756 -|name|Название карты-метки
3757 -|number|Номер
3758 -|period|Период запросов в секундах (работает только для агрегатов)
3759 -|id|ID карты-метки
3760 -|parentId|ID клиента
3761 -
3762 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3763 -
3764 -(% class="box warningmessage" %)
3765 -(((
3766 -**PUT /api/v3/Rfids**
3767 -)))
3768 -
3769 -Запрос:
3770 -
3771 -{
3772 - "name": "string",
3773 - "number": 0,
3774 - "period": 0,
3775 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3776 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3777 -}
3778 -
3779 -Ответ:
3780 -
3781 -{
3782 - "name": "string",
3783 - "number": 0,
3784 - "period": 0,
3785 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3786 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3787 -}
3788 -
3789 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3790 -|name|Название карты-метки
3791 -|number|Номер
3792 -|period|Период запросов в секундах (работает только для агрегатов)
3793 -|id|ID карты-метки
3794 -|parentId|ID клиента
3795 -
3796 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3797 -
3798 -(% class="box errormessage" %)
3799 -(((
3800 -**DELETE /api/v3/Rfids/{rfidGuid}**
3801 -)))
3802 -
3803 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3804 -
3805 -Ответ:
3806 -
3807 -Success
3808 -
3809 -
3810 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3811 -
3812 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3813 -
3814 -(% class="box infomessage" %)
3815 -(((
3816 -**GET /api/v3/Billing/client/balance/{clientId}**
3817 -)))
3818 -
3819 -Параметр запроса: **clientId **- идентификатор клиента.
3820 -
3821 -Ответ:
3822 -
3823 -{
3824 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3825 - "Balance": 0
3826 -}
3827 -
3828 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3829 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3830 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3831 -
3832 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3833 -
3834 -(% class="box infomessage" %)
3835 -(((
3836 -**GET /api/v3/Billing/client/constraint/{clientId}**
3837 -)))
3838 -
3839 -Параметр запроса: **clientId **- идентификатор клиента.
3840 -
3841 -Ответ:
3842 -
3843 -{
3844 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3845 - "CalculationType": 0,
3846 - "PermissibleBalance": 0,
3847 - "DefermentDays": 0,
3848 - "SendUiNotifications": true,
3849 - "SendEmailNotifications": true,
3850 - "IsPrivate": true,
3851 -}
3852 -
3853 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3854 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3855 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3856 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3857 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3858 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3859 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3860 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3861 -
3862 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3863 -
3864 -(% class="box infomessage" %)
3865 -(((
3866 -**GET /api/v3/Billing/client/plan/{clientId}**
3867 -)))
3868 -
3869 -Параметры запроса:
3870 -
3871 -**clientId **- идентификатор клиента.
3872 -
3873 -**planId **- идентификатор тарифного плана.
3874 -
3875 -Ответ:
3876 -
3877 -{
3878 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3879 - "Plan": { **~/~/ Описание тарифного плана**
3880 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3881 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3882 - "Name": "string",
3883 - "IsArchived": true,
3884 - "Constraint": {
3885 - "CalculationType": 0,
3886 - "PermissibleBalance": 0,
3887 - "DefermentDays": 0
3888 - },
3889 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3890 - {
3891 - "Feature": "string",
3892 - "IsFactual": true,
3893 - "Limit": 0,
3894 - "Price": 0,
3895 - "PeriodValue": 0,
3896 - "PeriodType": 0
3897 - }
3898 - ]
3899 - },
3900 - "DebitDate": "2023-10-18T12:46:24.213Z",
3901 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3902 - {
3903 - "Feature": "string",
3904 - "IsEnabled": true,
3905 - "IsPrivate": true,
3906 - "IsFactual": true,
3907 - "Limit": 0,
3908 - "Price": 0,
3909 - "DebitDate": "2023-10-18T12:46:24.213Z",
3910 - "PeriodValue": 0,
3911 - "PeriodType": 0
3912 - }
3913 - ]
3914 -}
3915 -
3916 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3917 -|ClientId|Идентификатор клиента
3918 -|Id|Идентификатор тарифного плана
3919 -|OwnerId|Идентификатор клиента-владельца
3920 -|Name|Наименование тарифного плана
3921 -|IsArchived|Признак, определяющий архивный тарифный план
3922 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3923 -|PermissibleBalance|Допустимый баланс
3924 -|DefermentDays|Отсрочка, количество дней
3925 -|Feature|Код услуги
3926 -|IsEnabled|Признак, определяющий активирована ли услуга
3927 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3928 -|IsFactual|Признак, определяющий расчёт по факту
3929 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3930 -|Price|Цена за единицу.
3931 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3932 -|PeriodValue|Значение периода.
3933 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3934 -
3935 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3936 -
3937 -(% class="box infomessage" %)
3938 -(((
3939 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3940 -)))
3941 -
3942 -Параметр запроса: **clientId **- идентификатор клиента.
3943 -
3944 -Ответ:
3945 -
3946 -[
3947 - {
3948 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3949 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3950 - "Name": "string",
3951 - "IsArchived": true,
3952 - "Constraint": {
3953 - "CalculationType": 0,
3954 - "PermissibleBalance": 0,
3955 - "DefermentDays": 0
3956 - },
3957 - "Features": [
3958 - {
3959 - "Feature": "string",
3960 - "IsFactual": true,
3961 - "Limit": 0,
3962 - "Price": 0,
3963 - "PeriodValue": 0,
3964 - "PeriodType": 0
3965 - }
3966 - ]
3967 - }
3968 -]
3969 -
3970 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3971 -|ClientId|Идентификатор клиента
3972 -|Id|Идентификатор тарифного плана
3973 -|OwnerId|Идентификатор клиента-владельца
3974 -|Name|Наименование тарифного плана
3975 -|IsArchived|Признак, определяющий архивный тарифный план
3976 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3977 -|PermissibleBalance|Допустимый баланс
3978 -|DefermentDays|Отсрочка, количество дней
3979 -|Feature|Код услуги
3980 -|IsFactual|Признак, определяющий расчёт по факту
3981 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3982 -|Price|Цена за единицу.
3983 -|PeriodValue|Значение периода.
3984 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3985 -
3986 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3987 -
3988 -(% class="box infomessage" %)
3989 -(((
3990 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3991 -)))
3992 -
3993 -Параметр запроса: **clientId **- идентификатор клиента.
3994 -
3995 -Ответ:
3996 -
3997 -[
3998 - {
3999 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4000 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4001 - "Name": "string",
4002 - "IsArchived": true,
4003 - "Constraint": {
4004 - "CalculationType": 0,
4005 - "PermissibleBalance": 0,
4006 - "DefermentDays": 0
4007 - },
4008 - "Features": [
4009 - {
4010 - "Feature": "string",
4011 - "IsFactual": true,
4012 - "Limit": 0,
4013 - "Price": 0,
4014 - "PeriodValue": 0,
4015 - "PeriodType": 0
4016 - }
4017 - ]
4018 - }
4019 -]
4020 -
4021 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4022 -|ClientId|Идентификатор клиента
4023 -|Id|Идентификатор тарифного плана
4024 -|OwnerId|Идентификатор клиента-владельца
4025 -|Name|Наименование тарифного плана
4026 -|IsArchived|Признак, определяющий архивный тарифный план
4027 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4028 -|PermissibleBalance|Допустимый баланс
4029 -|DefermentDays|Отсрочка, количество дней
4030 -|Feature|Код услуги
4031 -|IsFactual|Признак, определяющий расчёт по факту
4032 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4033 -|Price|Цена за единицу.
4034 -|PeriodValue|Значение периода.
4035 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4036 -
4037 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4038 -
4039 -(% class="box warningmessage" %)
4040 -(((
4041 -**PUT /api/v3/Billing/client/balance**
4042 -)))
4043 -
4044 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4045 -
4046 -Тело запроса:
4047 -
4048 -{
4049 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4050 - "Balance": 0
4051 -}
4052 -
4053 -Ответ: Success
4054 -
4055 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4056 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4057 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4058 -
4059 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4060 -
4061 -(% class="box warningmessage" %)
4062 -(((
4063 -**PUT /api/v3/billing/client/balance/deposit**
4064 -)))
4065 -
4066 -Создает операцию **Пополнение **с указанной суммой
4067 -
4068 -Тело запроса:
4069 -
4070 -{
4071 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4072 - "Balance": 0
4073 -}
4074 -
4075 -Ответ: Success
4076 -
4077 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4078 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4079 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4080 -
4081 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4082 -
4083 -Создает операцию **Списание **с указанной суммой
4084 -
4085 -(% class="box warningmessage" %)
4086 -(((
4087 -**PUT /api/v3/billing/client/balance/withdraw**
4088 -)))
4089 -
4090 -Тело запроса:
4091 -
4092 -{
4093 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4094 - "Balance": 0
4095 -}
4096 -
4097 -Ответ: Success
4098 -
4099 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4100 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4101 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4102 -
4103 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4104 -
4105 -(% class="box warningmessage" %)
4106 -(((
4107 -**PUT /api/v3/Billing/client/constraint**
4108 -)))
4109 -
4110 -Тело запроса:
4111 -
4112 -{
4113 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4114 - "CalculationType": 0,
4115 - "PermissibleBalance": 0,
4116 - "DefermentDays": 0,
4117 - "SendUiNotifications": true,
4118 - "SendEmailNotifications": true,
4119 - "IsPrivate": true,
4120 -}
4121 -
4122 -Ответ: Success
4123 -
4124 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4125 -|ClientId|Идентификатор клиента
4126 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4127 -|PermissibleBalance|Допустимый баланс
4128 -|DefermentDays|(((
4129 -Отсрочка, количество дней
4130 -)))
4131 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4132 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4133 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4134 -
4135 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4136 -
4137 -(% class="box warningmessage" %)
4138 -(((
4139 -**PUT /api/v3/Billing/client/plan**
4140 -)))
4141 -
4142 -Тело запроса:
4143 -
4144 -{
4145 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4146 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4147 - "Features": [
4148 - {
4149 - "Feature": "string",
4150 - "IsEnabled": true,
4151 - "IsFactual": true,
4152 - "Limit": 0,
4153 - "Price": 0,
4154 - "DebitDate": "2023-10-18T13:26:58.987Z",
4155 - "PeriodValue": 0,
4156 - "PeriodType": 0
4157 - }
4158 - ]
4159 -}
4160 -
4161 -Ответ: Success
4162 -
4163 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4164 -|ClientId|Идентификатор клиента
4165 -|PlanId|Идентификатор тарифного плана
4166 -|Feature|Код услуги
4167 -|IsEnabled|Признак, определяющий активирована ли услуга
4168 -|IsFactual|Признак, определяющий расчёт по факту
4169 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4170 -|Price|Цена за единицу.
4171 -|DebitDate|Следующий момент времени списания с баланса за услугу.
4172 -|PeriodValue|Значение периода.
4173 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4174 -
4175 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4176 -
4177 -(% class="box warningmessage" %)
4178 -(((
4179 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4180 -)))
4181 -
4182 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4183 -
4184 -(% class="box infomessage" %)
4185 -(((
4186 -**POST /api/v3/vehicles/import/{agentId}**
4187 -)))
4188 -
4189 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4190 -
4191 -В пути указывается **agentId** - id клиента.
4192 -
4193 -**Заголовок**
4194 -
4195 -**X-Auth: [токен авторизации]**
4196 -
4197 -**Параметры**
4198 -
4199 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4200 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4201 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4202 -
4203 -В теле использовать тип **form-data,** тип значения** file**
4204 -
4205 -**Ключи**
4206 -
4207 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4208 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
4209 -|csv|В значении передаем файл датчиков, формат **csv**
4210 -
4211 -Ответ:
4212 -
4213 -{
4214 - "vehicleId": 0,
4215 - "name": "string",
4216 - "errors": ["string"]
4217 -}
4218 -
4219 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4220 -|vehicleId|ID созданного объекта
4221 -|name|Имя созданного объекта
4222 -|errors|Ошибки и их описание
4223 -
4224 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4225 -
4226 -(% class="box infomessage" %)
4227 -(((
4228 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4229 -)))
4230 -
4231 -(% class="wikigeneratedid" %)
4232 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4233 -
4234 -(% class="wikigeneratedid" %)
4235 -В пути указывается **vehicleId **- id объекта.
4236 -
4237 -**Заголовок**
4238 -
4239 -**X-Auth: [токен авторизации]**
4240 -
4241 -В теле использовать тип **form-data.**
4242 -
4243 -Ключи:
4244 -
4245 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4246 -|**history**|В значении передавать файл с историей
4247 -
4248 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4249 -
4250 -Ответ:
4251 -
4252 -{
4253 - "results": [
4254 - {
4255 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4256 - "vehicleId": 0,
4257 - "errors": [
4258 - "string"
4259 - ],
4260 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
4261 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
4262 - "producedCount": 0,
4263 - "msgCount": 0
4264 - }
4265 - ]
4266 -}
4267 -
4268 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4269 -|results|Результаты импорта в разрезе ТС
4270 -|vehicleGuid|Guid ТС
4271 -|vehicleId|ID ТС
4272 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4273 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
4274 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4275 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
4276 -|msgCount|Кол-во обработанных сообщений всего
4277 -
4278 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4279 -
4280 -(% class="box infomessage" %)
4281 -(((
4282 -**GET /api/v3/vehicles/import/history/status**
4283 -)))
4284 -
4285 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4286 -
4287 -Ответ:
4288 -
4289 -{
4290 - "activity": true,
4291 - "progress": 0,
4292 - "message": "string"
4293 -}
4294 -
4295 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4296 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4297 -|progress|Guid ТС
4298 -
4299 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4300 -
4301 -(% class="box infomessage" %)
4302 -(((
4303 -**POST /api/v3/vehicles/export**
4304 -)))
4305 -
4306 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4307 -
4308 -Тело запроса:
4309 -
4310 -[
4311 - id
4312 -]
4313 -
4314 -Ответ: Success 200, получаете файлы с настройками.
4315 -
4316 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4317 -
4318 -(% class="box infomessage" %)
4319 -(((
4320 -**POST /api/v3/vehicles/export/history**
4321 -)))
4322 -
4323 -Метод возвращает список сообщений терминала объекта за выбранный период.
4324 -
4325 -Тело запроса:
4326 -
4327 -{
4328 - "vehicleId": 0,
4329 - "asArchive": true,
4330 - "from": "2023-09-27T12:17:45.973Z",
4331 - "to": "2023-09-27T12:17:45.973Z"
4332 -}
4333 -
4334 -Ответ:
4335 -
4336 -Получаете файл. Сообщение: Code 200/Success
4337 -
4338 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4339 -|vehicleId|ID объекта
4340 -|asArchive|true - Архивировать файл, False - не архивировать
4341 -|from|Дата и время начала запроса
4342 -|to|Дата и время окончания запроса
4343 -
4344 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4345 -
4346 -(% class="box infomessage" %)
4347 -(((
4348 -**GET /api/v3/vehicles/export/history/status**
4349 -)))
4350 -
4351 -Метод возвращает список сообщений терминала объекта за выбранный период.
4352 -
4353 -Ответ:
4354 -
4355 -{
4356 - "activity": true,
4357 - "progress": 0,
4358 - "message": "string"
4359 -}
4360 -
4361 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4362 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4363 -|progress|Прогресс экспорта, от 0 до 100%
4364 -|message|Текст описывающий статус
4365 -
4366 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4367 -
4368 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4369 -
4370 -(% class="box infomessage" %)
4371 -(((
4372 -**POST /api/v3/EcoDriving/rating**
4373 -)))
4374 -
4375 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4376 -
4377 -Тело запроса:
4378 -
4379 -{
4380 - "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4381 - "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4382 - "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4383 -}
4384 -
4385 -Ответ:
4386 -
4387 -{
4388 - "items": [  ~/~/ Список в разрезе ТС
4389 - {
4390 - "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4391 - "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4392 - "vehicleId": 0, ~/~/ ID ТС
4393 - "vehicleName": "string", ~/~/ Название ТС
4394 - "vehicleModel": "string", ~/~/ Модель ТС
4395 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4396 - "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4397 - "totalViolations": 0, ~/~/ Нарушений всего
4398 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4399 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4400 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4401 - "brakingViolations": 0, ~/~/ Нарушений торможения
4402 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4403 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4404 - "sensorViolations": 0 ~/~/ Нарушений по датчику
4405 - },
4406 -
4407 -(((
4408 -
4409 -)))
4410 -
4411 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4412 - "mileage": 0, ~/~/ Пробег, м
4413 - "tripsCount": 0, ~/~/ Кол-во рейсов
4414 - "trips": [  ~/~/ Информация по рейсу
4415 - {
4416 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4417 - "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4418 - "violationsCount": 0, ~/~/ Всего нарушений
4419 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4420 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4421 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4422 - "brakingViolations": 0, ~/~/ Нарушений торможения
4423 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4424 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4425 - "sensorViolations": 0 ~/~/ Нарушений по датчику
4426 - },
4427 -
4428 - "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4429 - "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4430 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4431 - "mileage": 0, ~/~/ Пробег, м
4432 - "motohours": 0, ~/~/ Моточасы, секунды
4433 - "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4434 - "startAddress": "string", ~/~/ Адрес начала рейса
4435 - "endAddress": "string", ~/~/ Адрес конца рейса
4436 - "drivers": [  ~/~/ Список водителей
4437 - {
4438 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4439 - "driverName": "string", ~/~/ФИО водителя
4440 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4441 - }
4442 - ]
4443 - }
4444 - ]
4445 - }
4446 - ]
4447 -}
4448 -
4449 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4450 -
4451 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4452 -
4453 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4454 -
4455 -(% class="box infomessage" %)
4456 -(((
4457 -**POST /api/v3/fuelcards/transactions**
4458 -)))
4459 -
4460 -Метод запроса: POST
4461 -
4462 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4463 -\\В заголовках запроса: X-Auth: Токен авторизации
4464 -
4465 -Параметры в теле запроса (JSON):
4466 -
4467 -{
4468 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4469 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4470 - "ids": [ 
4471 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4472 - ],
4473 - "timezone": 0 ~/~/ Часовой пояс
4474 -}
4475 -
4476 -
4477 -Ответ:
4478 - {
4479 - "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4480 - "driver": "string", ~/~/ Водители, привязанные к ТК
4481 - "object": "string", ~/~/ Наименование ТС
4482 - "amount": 0, ~/~/ Количество топлива
4483 - "amountDut": 0, ~/~/ Количество по ДУТ
4484 - "amountDiff": 0, ~/~/ Разница, л
4485 - "amountDiffPerc": 0, ~/~/ Разница, %
4486 - "summa": 0, ~/~/ Стоимость, руб
4487 - "serviceName": "string", ~/~/ Тип топлива
4488 - "price": 0, ~/~/ Цена за литр, руб
4489 - "cardName": "string", ~/~/ Наименование ТК
4490 - "cardNum": "string", ~/~/ Номер ТК
4491 - "operator": "string", ~/~/ Оператор ТК
4492 - "address": "string" ~/~/ Адрес АЗС
4493 - }
4494 -
4495 -== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4496 -
4497 -(% class="box infomessage" %)
4498 -(((
4499 -**GET /api/v3/fuelcards**
4500 -)))
4501 -
4502 -Метод запроса: GET
4503 -
4504 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4505 -
4506 -Ответ:
4507 -
4508 -[
4509 - {
4510 - "Name": "string", ~/~/ Определяет наименование карты.
4511 - "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4512 - "Number": "string", ~/~/ Определяет № карты.
4513 - "Enabled": true, ~/~/ Определяет признак активности карты.
4514 - "Description": "string", ~/~/ Определяет описание карты.
4515 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4516 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4517 - "deleted": true ~/~/ Признак удаления
4518 - }
4519 -]
4520 -
4521 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4522 -
4523 -
4524 -== **Получение полных данных о ретрансляторе** ==
4525 -
4526 -(% class="box infomessage" %)
4527 -(((
4528 -**GET ** **/api/v3/retranslations/{id}**
4529 -)))
4530 -
4531 -id - Идентификатор ретранслятора
4532 -
4533 -
4534 -Пример ответа:
4535 -
4536 -{  
4537 -"description": "", ~/~/ Поле описания ретранслятора
4538 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4539 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4540 -"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4541 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4542 -"objects": [ ~/~/ Объекты для ретрансляции
4543 -{      
4544 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4545 -"name": "", ~/~/ Наименование объекта ретрансляции
4546 -"imei": "", ~/~/ IMEI объекта  ретрансляции
4547 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4548 -}
4549 - ],  
4550 -"id": "", ~/~/ Идентификатор ретранслятора 
4551 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4552 -"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4553 -}
4554 -
4555 -
4556 -== **Удаление данных ретранслятора** ==
4557 -
4558 -(% class="box infomessage" %)
4559 -(((
4560 -**DELETE** **/api/v3/retranslations/{id}**
4561 -)))
4562 -
4563 -id - Идентификатор ретранслятора
4564 -
4565 -
4566 -== **Создание ретранслятора** ==
4567 -
4568 -(% class="box infomessage" %)
4569 -(((
4570 -**POST ** **/api/v3/retranslations/{id}**
4571 -)))
4572 -
4573 -Запрос:
4574 -
4575 -{  
4576 -"description": "", ~/~/ Поле описания ретранслятора
4577 -"subscriberId": "", ~/~/ Идентификатор подписчика
4578 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4579 -"address": "", ~/~/ Адрес и порт принимающего сервера
4580 -"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4581 -"objects": [ ~/~/Объекты для ретрансляции
4582 -{      
4583 -"id": "", ~/~/ Идентификатор ретранслятора 
4584 -"imei": "", ~/~/ IMEI объекта ретрансляции
4585 -"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4586 -}
4587 - ]
4588 -}
4589 -
4590 -
4591 -Ответ:
4592 -
4593 -{  
4594 -"description": "", ~/~/ Поле описания ретранслятора
4595 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4596 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4597 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4598 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4599 -"objects": [ ~/~/ Объекты для ретрансляции
4600 -{      
4601 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4602 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4603 -"imei": "", ~/~/ IMEI объекта ретрансляции
4604 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4605 -}
4606 - ],
4607 -"id": "", ~/~/ Идентификатор ретранслятора   
4608 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4609 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4610 -}
4611 -
4612 -
4613 -== **Редактирование ретранслятора** ==
4614 -
4615 -(% class="box infomessage" %)
4616 -(((
4617 -**PUT** **/api/v3/retranslations**
4618 -)))
4619 -
4620 -Пример запроса:
4621 -
4622 -{  
4623 -"id": "", ~/~/ Идентификатор ретранслятора   
4624 -"description": "string", ~/~/ Поле описания ретранслятора
4625 -"subscriberId": "", ~/~/ Идентификатор подписчика
4626 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4627 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4628 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4629 -"objects": ~/~/ Объекты для ретрансляции
4630 -[    
4631 -{      
4632 -"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4633 -"imei": "", ~/~/ IMEI объекта ретрансляции
4634 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4635 -}
4636 - ]
4637 -}
4638 -
4639 -
4640 -Пример ответа:
4641 -
4642 -{  
4643 -"description": "", ~/~/ Поле описания ретранслятора
4644 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4645 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4646 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4647 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4648 -"objects": [ ~/~/ Объекты для ретрансляции
4649 -{      
4650 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4651 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4652 -"imei": "", ~/~/ IMEI объекта ретрансляции
4653 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4654 -}
4655 - ],
4656 -"id": "", ~/~/ Идентификатор ретранслятора   
4657 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4658 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4659 -}
4660 -
4661 -
4662 -== **Получение списка ретранслятора клиента** ==
4663 -
4664 -(% class="box infomessage" %)
4665 -(((
4666 -**POST /api/v3/retranslations/find**
4667 -)))
4668 -
4669 -Пример запроса:
4670 -
4671 -{  
4672 -"id": "", ~/~/ Идентификатор ретранслятора   
4673 -"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4674 -"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4675 -}
4676 -
4677 -Ответ:
4678 -
4679 -[ 
4680 -{    
4681 -"description": "", ~/~/ Поле описания ретранслятора
4682 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4683 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4684 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4685 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4686 -"id": "", ~/~/ Идентификатор ретранслятора   
4687 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4688 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4689 -}
4690 -]
4691 -
4692 -
4693 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4694 -
4695 -== **API для отчета по выгрузке комбайнов** ==
4696 -
4697 -(% class="box infomessage" %)
4698 -(((
4699 -**POST /api/v3/Reports/harvesterUnloading**
4700 -)))
4701 -
4702 -Пример запроса:
4703 -
4704 -{
4705 - "byTime": 0, ~/~/ Объединение событий по времени
4706 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4707 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4708 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4709 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4710 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4711 - 0
4712 - ],
4713 - "from": "", ~/~/ Дата и время начало запроса
4714 - "to": "", ~/~/ Дата и время окончания запроса
4715 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4716 -}
4717 -
4718 -Пример ответа:
4719 -
4720 -[ 
4721 - {
4722 - "harvesterName": "", ~/~/Комбайн, номер
4723 - "harvesterId": 0, ~/~/Комбайн, id
4724 -"harvesterModel": "", ~/~/ Модель комбайна
4725 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4726 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4727 - "events": [ ~/~/Список событий в разрезе комбайна
4728 - {
4729 - "driverId": "", ~/~/Идентификатор водителя
4730 - "driverName": "", ~/~/Водитель комбайна, ФИО
4731 - "RFID": "", ~/~/ идентификатор карты-метки
4732 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4733 - "vehicleId": 0, ~/~/идентификатор объекта
4734 - "vehicleName": "string", ~/~/ Имя объекта
4735 - "modelName": "string", ~/~/ Имя модели объекта
4736 - "nearestVehicles": [ ~/~/Объекты рядом
4737 - {
4738 - "vehicleId": 0, ~/~/идентификатор объекта
4739 - "vehicleName": "string" ~/~/ Имя объекта
4740 - }
4741 - ],
4742 - "fields": [ ~/~/Поля, где происходила выгрузка
4743 - {
4744 - "id": 0, ~/~/ идентификатор пользователя 
4745 - "name": "string" ~/~/ имя пользователя 
4746 - }
4747 - ],
4748 - "event": "string", ~/~/Событие
4749 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4750 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4751 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4752 - "cultureName": "string", ~/~/ название культуры
4753 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4754 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4755 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4756 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4757 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4758 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4759 - "issued": 0, ~/~/Выдано, бункеров
4760 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4761 - "latitude": 0, ~/~/Широта
4762 - "longitude": 0, ~/~/ Долгота
4763 - "litresAway": 0, ~/~/Отдано, л
4764 - "m3Away": 0 ~/~/Отдано, м3
4765 - }
4766 - ]
4767 - }
4768 -]
4769 -
4770 -
4771 -== **Отчет трек-датчики** ==
4772 -
4773 -(% class="box infomessage" %)
4774 -(((
4775 -**POST /api/v3/Reports/sensorsWorks**
4776 -)))
4777 -
4778 -**Пример запроса:**
4779 -
4780 -{
4781 - "vehicleIds": [ ~/~/ Список ID объектов
4782 - 0
4783 - ],
4784 - "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4785 - "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4786 - "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4787 -}
4788 -
4789 -**Пример ответа:**
4790 -
4791 -(((
4792 -{
4793 - "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4794 - {
4795 - "vehicleId": 0, ~/~/ Идентификатор ТС
4796 - "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4797 - {
4798 - "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4799 - "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4800 - "duration": 0, ~/~/  Продолжительность интервала в секундах.
4801 - "name": "string", ~/~/ Наименование оборудования.
4802 - "mileage": 0, ~/~/ Пробег за время работы оборудования.
4803 - "totalMileage": 0, ~/~/ Общий пробег.
4804 - "avgSpeed": 0 ~/~/ Средняя скорость.
4805 - }
4806 - ]
4807 - }
4808 - ]
4809 -}
4810 -)))
4811 -
4812 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4813 -
4814 -
4815 -== **Запрос списка полей** ==
4816 -
4817 -(% class="box successmessage" %)
4818 -(((
4819 -**POST /api/v3/agroLands/find**
4820 -)))
4821 -
4822 -Пример запроса:
4823 -
4824 -(((
4825 -(((
4826 -(((
4827 -{
4828 - "year": 0, ~/~/ Фильтр по году
4829 - "name": "string", ~/~/ Фильтр по названию
4830 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4831 -}
4832 -)))
4833 -)))
4834 -
4835 -
4836 -)))
4837 -
4838 -Пример ответа:
4839 -
4840 -(((
4841 -[
4842 - {
4843 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4844 - "year": 0, ~/~/ Год поля
4845 - "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4846 - "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4847 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4848 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4849 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4850 - "counts": { ~/~/ Счётчики с/х поля 
4851 - "fieldOperations": 0, ~/~/ Количество операций на поле
4852 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4853 - "facts": 0 ~/~/ Счётчик факта
4854 - },
4855 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4856 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4857 - "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4858 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4859 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4860 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4861 - "planComment": "string", ~/~/ Комментарий к полю
4862 - "productivity": 0, ~/~/ Урожайность.
4863 - "id": 0, ~/~/ Идентификатор объекта геозоны
4864 - "name": "string", ~/~/ Название объекта геозоны
4865 - "type": 0, ~/~/ Тип объекта геозоны
4866 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4867 - "fname": "string", ~/~/ Имя файла
4868 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4869 - "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4870 - "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4871 - "description": "string", ~/~/ Описание объекта геозоны
4872 - "area": 0, ~/~/ Площадь, м2
4873 - "perimetr": 0, ~/~/ Периметр, м
4874 - "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4875 - }
4876 -]
4877 -
4878 -
4879 -== **Создание нового поля ** ==
4880 -
4881 -(% class="box successmessage" %)
4882 -(((
4883 -**POST /api/v3/agroLands**
4884 -)))
4885 -
4886 -Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
4887 -X-agent  - ID клиента
4888 -
4889 -Пример запроса:
4890 -
4891 -(((
4892 -{
4893 - "extId": "string", 
4894 - "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
4895 - "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
4896 - "display": "string", ~/~/ Настройки отображения
4897 - "year": 0, ~/~/ Год поля
4898 - "name": "string", ~/~/ Наименование
4899 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4900 - "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4901 - "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4902 - "planComment": "string", ~/~/ Комментарий к полю
4903 - "cropRotations": [ ~/~/ Данные по севообороту
4904 - {
4905 - "landId": 0, ~/~/ ID поля
4906 - "landName": "string", ~/~/ Название поля
4907 - "year": 0, ~/~/ Год урожая
4908 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4909 - "cultureName": "string", ~/~/ Название культуры
4910 - "productivity": 0, ~/~/ Урожайность
4911 - "area": 0, ~/~/ Площадь поля, Га
4912 - "total": 0, ~/~/ Валовый сбор
4913 - "productivityFact": 0, ~/~/ Фактическая урожайность
4914 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4915 - "totalFact": 0, ~/~/ Фактический валовый сбор
4916 - "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4917 - "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4918 - "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4919 - "isyearplan": true, ~/~/ Годовой план 
4920 - "comment": "string" ~/~/ Комментарий
4921 - }
4922 - ]
4923 -}
4924 -)))
4925 -
4926 -(((
4927 -
4928 -)))
4929 -
4930 -Пример ответа:
4931 -
4932 -(((
4933 -(((
4934 -{
4935 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4936 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4937 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4938 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4939 - "cropRotations": [ ~/~/ Данные по севообороту
4940 - {
4941 - "landId": 0, ~/~/ ID поля
4942 - "landName": "string", ~/~/ Название поля
4943 - "year": 0, ~/~/ Год урожая 
4944 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4945 - "cultureName": "string", ~/~/ Название культуры
4946 - "productivity": 0, ~/~/ Урожайность
4947 - "area": 0, ~/~/ Площадь поля, Га.
4948 - "total": 0, ~/~/ Валовый сбор
4949 - "productivityFact": 0, ~/~/ Фактическая урожайность
4950 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4951 - "totalFact": 0, ~/~/ Фактический валовый сбор
4952 - "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
4953 - "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
4954 - "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
4955 - "isyearplan": true, ~/~/ годовой план 
4956 - "comment": "string" ~/~/ Комментарий
4957 - }
4958 - ],
4959 - "cropVegetation": [ ~/~/ История вегетации поля
4960 - {
4961 - "values": [  ~/~/ Данные вегетации и состояния посева
4962 - {
4963 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4964 - "ndvi": 0 ~/~/ Индекс вегетации
4965 - }
4966 - ],
4967 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
4968 - {
4969 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4970 - "type": "string", ~/~/ Тип
4971 - "pictureid": "string" ~/~/ Идентификатор ресурса
4972 - }
4973 - ],
4974 - "states": [ ~/~/ Ключевые даты развития поля
4975 - {
4976 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4977 - "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
4978 - }
4979 - ]
4980 - }
4981 - ],
4982 - "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
4983 - "counts": {
4984 - "fieldOperations": 0, ~/~/ Количество операций на поле
4985 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4986 - "facts": 0 ~/~/ Счётчик факта
4987 - },
4988 - "planComment": "string", ~/~/ Комментарий к полю
4989 -)))
4990 -
4991 -(((
4992 - "productivity": 0, ~/~/ Урожайность.
4993 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4994 - "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
4995 - "year": 0, ~/~/ Год поля
4996 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4997 - "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4998 - "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4999 - "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5000 - "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5001 - "id": 0, ~/~/ Идентификатор объекта геозоны
5002 - "name": "string", ~/~/ Название объекта геозоны
5003 - "type": 0, ~/~/ Тип объекта геозоны
5004 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5005 - "fname": "string", ~/~/ Имя файла
5006 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5007 - "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5008 - "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5009 - "description": "string", ~/~/ Описание объекта геозоны
5010 - "area": 0, ~/~/ Площадь, м2
5011 - "perimetr": 0, ~/~/ Периметр, м
5012 - "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5013 -}
5014 -
5015 -
5016 -)))
5017 -)))
5018 -)))
5019 -
5020 -== **Получение поля по id** ==
5021 -
5022 -(% class="box infomessage" %)
5023 -(((
5024 -**GET /api/v3/agroLands/{id}**
5025 -)))
5026 -
5027 -Пример запроса:
5028 -id  ~/~/ Идентификатор поля
5029 -
5030 -Пример ответа:
5031 -
5032 -(((
5033 -{
5034 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5035 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5036 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5037 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5038 - "cropRotations": [ ~/~/ Данные по севообороту
5039 - {
5040 - "landId": 0, ~/~/ ID поля
5041 - "landName": "string", ~/~/ Название поля
5042 - "year": 0, ~/~/ Год урожая
5043 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5044 - "cultureName": "string", ~/~/ Название культуры
5045 - "productivity": 0, ~/~/ Урожайность
5046 - "area": 0, ~/~/ Площадь поля, Га
5047 - "total": 0, ~/~/ Валовый сбор
5048 - "productivityFact": 0, ~/~/ Фактическая урожайность
5049 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5050 - "totalFact": 0, ~/~/ Фактический валовый сбор
5051 - "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5052 - "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5053 - "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5054 - "isyearplan": true, ~/~/ План года 
5055 - "comment": "string" ~/~/ Комментарий
5056 - }
5057 - ],
5058 - "cropVegetation": [ ~/~/ История вегетации поля
5059 - {
5060 - "values": [ ~/~/ Данные вегетации и состояния посева
5061 - {
5062 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5063 - "ndvi": 0 ~/~/ Индекс вегетации
5064 - }
5065 - ],
5066 - "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5067 - {
5068 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5069 - "type": "string", ~/~/ Тип 
5070 - "pictureid": "string" ~/~/ Идентификатор ресурса
5071 - }
5072 - ],
5073 - "states": [ ~/~/ Ключевые даты развития поля
5074 - {
5075 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5076 - "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5077 - }
5078 - ]
5079 - }
5080 - ],
5081 - "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5082 - "counts": {
5083 - "fieldOperations": 0, ~/~/ Количество операций на поле
5084 - "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5085 - "facts": 0 ~/~/ Счётчик факта
5086 - },
5087 - "planComment": "string", ~/~/ Комментарий к полю
5088 - "productivity": 0, ~/~/ Урожайность.
5089 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5090 -)))
5091 -
5092 -(((
5093 -(((
5094 - "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5095 - "year": 0, ~/~/ Год поля
5096 - "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5097 - "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5098 - "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5099 - "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5100 - "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5101 - "id": 0, ~/~/ Идентификатор объекта геозоны
5102 - "name": "string", ~/~/ Название объекта геозоны
5103 - "type": 0, ~/~/ Тип объекта геозоны 
5104 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5105 - "fname": "string", ~/~/ Имя файла
5106 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5107 - "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5108 - "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5109 - "description": "string", ~/~/ Описание объекта геозоны
5110 - "area": 0, ~/~/ Площадь, м2
5111 - "perimetr": 0, ~/~/ Периметр, м
5112 - "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5113 -}
5114 -)))
5115 -
5116 -
5117 -== **Удаление существующего поля** ==
5118 -
5119 -(% class="box errormessage" %)
5120 -(((
5121 -**DELETE /api/v3/agroLands/{id}**
5122 -)))
5123 -
5124 -Пример запроса:
5125 -id  ~/~/ Идентификатор поля
5126 -
5127 -Пример ответа:
5128 -
5129 -(((
5130 -200 ~/~/ Успех
5131 -)))
5132 -
5133 -(((
5134 -
5135 -)))
5136 -
5137 -(((
5138 -(((
5139 -(((
5140 -
5141 -)))
5142 -
5143 -(((
5144 -== **Изменение поля** ==
5145 -
5146 -(% class="box infomessage" %)
5147 -(((
5148 -**PUT /api/v3/agroLands**
5149 -)))
5150 -
5151 -Пример запроса:
5152 -
5153 -(((
5154 -(((
5155 -{
5156 - "id": 0, ~/~/ Идентификатор поля
5157 - "extId": "string", ~/~/ ExtId
5158 - "shape": "string", ~/~/ Форма поля
5159 - "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5160 - "display": "string", ~/~/ Настройки отображения
5161 - "year": 0, ~/~/ Год поля
5162 - "name": "string", ~/~/ Наименование
5163 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5164 - "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5165 - "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5166 - "planComment": "string", ~/~/Комментарий к полю
5167 - "cropRotations": [  ~/~/ Данные по севообороту
5168 - {
5169 - "landId": 0, ~/~/ ID поля
5170 - "landName": "string", ~/~/ Название поля
5171 - "year": 0, ~/~/ Год урожая
5172 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5173 - "cultureName": "string", ~/~/ Название культуры
5174 - "productivity": 0, ~/~/ Урожайность
5175 - "area": 0, ~/~/ Площадь поля, Га.
5176 - "total": 0, ~/~/ Валовый сбор
5177 - "productivityFact": 0, ~/~/ Фактическая урожайность
5178 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5179 - "totalFact": 0, ~/~/ Фактический валовый сбор
5180 - "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5181 - "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5182 - "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5183 - "isyearplan": true, 
5184 - "comment": "string" ~/~/ Комментарий
5185 - }
5186 - ],
5187 - "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5188 -}
5189 -)))
5190 -)))
5191 -
5192 -(((
5193 -
5194 -)))
5195 -
5196 -Пример ответа:
5197 -
5198 -(((
5199 -(((
5200 -(((
5201 -{
5202 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5203 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5204 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5205 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5206 - "cropRotations": [ ~/~/ Данные по севообороту
5207 - {
5208 - "landId": 0, ~/~/ ID поля
5209 - "landName": "string", ~/~/ Название поля
5210 - "year": 0, ~/~/  Год урожая
5211 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5212 - "cultureName": "string", ~/~/ Название культуры
5213 - "productivity": 0, ~/~/ Урожайность
5214 - "area": 0, ~/~/ Площадь поля, Га
5215 - "total": 0, ~/~/ Валовый сбор
5216 - "productivityFact": 0, ~/~/ Фактическая урожайность
5217 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5218 - "totalFact": 0, ~/~/ Фактический валовый сбор
5219 - "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5220 - "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5221 - "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5222 - "isyearplan": true, ~/~/ 
5223 - "comment": "string" ~/~/ Комментарий
5224 - }
5225 - ],
5226 - "cropVegetation": [ ~/~/ История вегетации поля
5227 - {
5228 - "values": [ ~/~/ Данные вегетации и состояния посева
5229 - {
5230 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5231 - "ndvi": 0 ~/~/ Индекс вегетации
5232 - }
5233 - ],
5234 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5235 - {
5236 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5237 - "type": "string", ~/~/ Тип
5238 - "pictureid": "string" ~/~/ Идентификатор ресурса
5239 - }
5240 - ],
5241 - "states": [ ~/~/ Ключевые даты развития поля 
5242 - {
5243 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5244 - "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5245 - }
5246 - ]
5247 - }
5248 - ],
5249 - "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5250 - "counts": { 
5251 - "fieldOperations": 0, ~/~/ Количество операций на поле
5252 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5253 - "facts": 0 ~/~/ Счётчик факта
5254 - },
5255 - "planComment": "string", ~/~/ Комментарий к полю
5256 - "productivity": 0, ~/~/ Урожайность.
5257 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5258 - "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5259 - "year": 0, ~/~/ Год поля
5260 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5261 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5262 - "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5263 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5264 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5265 - "id": 0, ~/~/ Идентификатор объекта геозоны
5266 - "name": "string", ~/~/ Название объекта геозоны
5267 - "type": 0, ~/~/ Тип объекта геозоны
5268 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5269 - "fname": "string", ~/~/ Имя файла
5270 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5271 - "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5272 - "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5273 - "description": "string", ~/~/ Описание объекта геозоны
5274 - "area": 0, ~/~/ Площадь, м2
5275 - "perimetr": 0, ~/~/ Периметр, м
5276 - "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5277 -}
5278 -)))
5279 -)))
5280 -)))
5281 -)))
5282 -)))
5283 -
5284 -
5285 -== **Редактирование года урожая ** ==
5286 -
5287 -(% class="box successmessage" %)
5288 -(((
5289 -**POST /api/v3/agroLands/updateOpenCloseYear**
5290 -)))
5291 -
5292 -Пример запроса:
5293 -
5294 -(((
5295 -(((
5296 -{
5297 - "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5298 - 0
5299 - ],
5300 - "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5301 - "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5302 -}
5303 -)))
5304 -
5305 -
5306 -)))
5307 -
5308 -Пример ответа:
5309 -
5310 -(((
5311 -(((
5312 -{
5313 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5314 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5315 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5316 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5317 - "cropRotations": [ ~/~/ Данные по севообороту
5318 - {
5319 - "landId": 0, ~/~/ ID поля
5320 - "landName": "string", ~/~/ Название поля
5321 - "year": 0, ~/~/ Год урожая
5322 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5323 - "cultureName": "string", ~/~/ Название культуры
5324 - "productivity": 0, ~/~/ Урожайность
5325 - "area": 0, ~/~/ Площадь поля, Га.
5326 - "total": 0, ~/~/ Валовый сбор
5327 - "productivityFact": 0, ~/~/ Фактическая урожайность
5328 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5329 - "totalFact": 0, ~/~/ Фактический валовый сбор
5330 - "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5331 - "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5332 - "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5333 - "isyearplan": true, ~/~/ 
5334 - "comment": "string" ~/~/ Комментарий
5335 - }
5336 - ],
5337 - "cropVegetation": [ ~/~/ История вегетации поля
5338 - {
5339 - "values": [ ~/~/ Данные вегетации и состояния посева
5340 - {
5341 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5342 - "ndvi": 0 ~/~/ Индекс вегетации
5343 - }
5344 - ],
5345 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5346 - {
5347 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5348 - "type": "string", ~/~/ Тип
5349 - "pictureid": "string" ~/~/ Идентификатор ресурса
5350 - }
5351 - ],
5352 - "states": [ ~/~/ Ключевые даты развития поля
5353 - {
5354 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5355 - "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5356 - }
5357 - ]
5358 - }
5359 - ],
5360 - "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5361 - "counts": { 
5362 - "fieldOperations": 0, ~/~/ Количество операций на поле
5363 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5364 - "facts": 0 ~/~/ Счётчик факта
5365 - },
5366 - "planComment": "string", ~/~/ Комментарий к полю
5367 - "productivity": 0, ~/~/ Урожайность.
5368 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5369 - "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5370 - "year": 0, ~/~/ Год поля
5371 - "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5372 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5373 - "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5374 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5375 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5376 - "id": 0, ~/~/ Идентификатор объекта геозоны
5377 - "name": "string", ~/~/ Название объекта геозоны
5378 - "type": 0, ~/~/ Тип объекта геозоны
5379 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5380 - "fname": "string", ~/~/ Имя файла
5381 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5382 - "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5383 - "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5384 - "description": "string", ~/~/ Описание объекта геозоны
5385 - "area": 0, ~/~/ Площадь, м2
5386 - "perimetr": 0, ~/~/ ериметр, м
5387 - "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5388 -}
5389 -)))
5390 -
5391 -
5392 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5393 -)))
5394 -)))
5395 -)))
5396 -
5397 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5398 -
5399 -
5400 -(% class="box infomessage" %)
5401 -(((
5402 -**GET api/v3/Vehicles/recyclebin/all**
5403 -)))
5404 -
5405 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5406 -
5407 -Параметр запроса: {parentId} - идентификатор агента
5408 -
5409 -В заголовках запроса: X-Auth: Токен авторизации
5410 -
5411 -Ответ:
5412 -
5413 -[ 
5414 - {
5415 - "recordTime": "", ~/~/Время записи
5416 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5417 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5418 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
5419 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5420 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5421 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5422 - "items": [ ~/~/ 
5423 -nullable: true ~/~/Детали
5424 - {
5425 - "name": "string", ~/~/наименование столбца
5426 - "value": "string" ~/~/содержание столбца
5427 - }
5428 - ]
5429 - },
5430 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5431 - "string"
5432 - ]
5433 - }
5434 -]
5435 -
5436 -
5437 -== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5438 -
5439 -(% class="box infomessage" %)
5440 -(((
5441 -**POST api/v3/Vehicles/recyclebin/erase**
5442 -)))
5443 -
5444 -В заголовках запроса: X-Auth: Токен авторизации
5445 -
5446 -Пример запроса:
5447 -
5448 -[
5449 -0
5450 -]
5451 -
5452 -
5453 -Пример ответа:
5454 -
5455 -[ 
5456 -{
5457 - "recordTime": "", ~/~/Время записи
5458 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5459 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5460 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
5461 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5462 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5463 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5464 - "items": [ ~/~/Детали
5465 - {
5466 - "name": "", ~/~/Имя свойства
5467 - "value": "" ~/~/Значение свойства
5468 - }
5469 - ]
5470 - },
5471 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5472 - ""
5473 - ]
5474 - }
5475 -]
5476 -
5477 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5478 -
5479 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5480 -
5481 -(% class="box infomessage" %)
5482 -(((
5483 -**POST api/v3/Vehicles/recyclebin/restore**
5484 -)))
5485 -
5486 -В заголовках запроса: X-Auth: Токен авторизации
5487 -
5488 -Параметры в теле запроса (JSON):
5489 -
5490 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5491 -
5492 -В заголовках запроса: X-Auth: Токен авторизации
5493 -
5494 -
5495 -Пример запроса:
5496 -
5497 -(((
5498 -[
5499 -)))
5500 -
5501 -(((
5502 - 0
5503 -)))
5504 -
5505 -(((
5506 -]
5507 -)))
5508 -
5509 -
5510 -Пример ответа:
5511 -
5512 -[
5513 -{
5514 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5515 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5516 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5517 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
5518 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5519 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5520 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5521 - "items": [ ~/~/Детали
5522 - {
5523 - "name": "string", ~/~/Имя свойства
5524 - "value": "string" ~/~/Значение свойства
5525 - }
5526 - ]
5527 - },
5528 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5529 - "string"
5530 - ]
5531 - }
5532 -]
5533 -
5534 -
5535 -= **Раздел: Журнал заданий ** =
5536 -
5537 -
5538 -== **Создание задания в Журнале заданий** ==
5539 -
5540 -(% class="box infomessage" %)
5541 -(((
5542 -**POST /api/v3/vehicletasks**
5543 -)))
5544 -
5545 -Пример запроса:
5546 -
5547 -(((
5548 -{
5549 - "vehicleId": 0, ~/~/ Идентификатор ТС
5550 - "description": "string", ~/~/ Описание
5551 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5552 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5553 - "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5554 - "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5555 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5556 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5557 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5558 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5559 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5560 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5561 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5562 - "cost": { 
5563 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5564 - "Name": "string", ~/~/ Наименование
5565 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5566 - "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5567 - "Norm": 0 ~/~/ Норма внесения
5568 - },
5569 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5570 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5571 - "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5572 - "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5573 - "deleted": true, ~/~/ Признак удаления
5574 - "extId": "string", 
5575 - "GeoIds": [ ~/~/ Cвязанные поля
5576 - 0
5577 - ]
5578 -}
5579 -)))
5580 -
5581 -
5582 -Пример ответа:
5583 -
5584 -{
5585 - "vehicleId": 0, ~/~/ Идентификатор ТС
5586 - "description": "string", ~/~/ Описание
5587 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5588 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5589 - "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5590 - "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5591 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5592 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5593 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5594 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5595 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5596 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5597 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5598 - "cost": { 
5599 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5600 - "Name": "string", ~/~/ Наименование
5601 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5602 - "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5603 - "Norm": 0 ~/~/ Норма внесения
5604 - },
5605 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5606 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5607 - "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5608 - "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5609 - "deleted": true, ~/~/ Признак удаления
5610 - "extId": "string", ~/~/ ExtId
5611 - "GeoIds": [ ~/~/ Связанные поля
5612 - 0
5613 - ]
5614 -}
5615 -
5616 -
5617 -== **Редактирование задания в Журнале заданий** ==
5618 -
5619 -(% class="box successmessage" %)
5620 -(((
5621 -**PUT /api/v3/vehicletasks**
5622 -)))
5623 -
5624 -Пример запроса:
5625 -
5626 -(((
5627 -{
5628 - "vehicleId": 0, ~/~/ Идентификатор ТС
5629 - "description": "string", ~/~/ Описание
5630 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5631 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5632 - "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5633 - "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5634 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5635 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5636 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5637 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5638 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5639 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5640 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5641 - "cost": { 
5642 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5643 - "Name": "string", ~/~/ Наименование
5644 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5645 - "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5646 - "Norm": 0 ~/~/ Норма внесения
5647 - },
5648 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5649 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5650 - "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5651 - "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5652 - "deleted": true, ~/~/ Признак удаления
5653 - "extId": "string", ~/~/ ExtId
5654 - "GeoIds": [ ~/~/ Связанные поля
5655 - 0
5656 - ]
5657 -}
5658 -)))
5659 -
5660 -
5661 -Пример ответа:
5662 -
5663 -{
5664 - "vehicleId": 0, ~/~/ Идентификатор ТС
5665 - "description": "string", ~/~/ Описание
5666 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5667 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5668 - "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5669 - "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5670 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5671 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5672 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5673 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5674 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5675 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5676 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5677 - "cost": { 
5678 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5679 - "Name": "string", ~/~/ Наименование
5680 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5681 - "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5682 - "Norm": 0 ~/~/ Норма внесения
5683 - },
5684 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5685 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5686 - "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5687 - "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5688 - "deleted": true, ~/~/ Признак удаления
5689 - "extId": "string", ~/~/ ExtId
5690 - "GeoIds": [ ~/~/ Связанные поля
5691 - 0
5692 - ]
5693 -}
5694 -
5695 -
5696 -== **Удаление задания в Журнале заданий** ==
5697 -
5698 -(% class="box warningmessage" %)
5699 -(((
5700 -**DELETE /api/v3/vehicletasks**
5701 -)))
5702 -
5703 -Пример запроса:
5704 -
5705 -(((
5706 -[
5707 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5708 -]
5709 -)))
5710 -
5711 -(((
5712 -
5713 -)))
5714 -
5715 -Пример ответа:
5716 -
5717 -{
5718 - "vehicleId": 0, ~/~/ Идентификатор ТС
5719 - "description": "string", ~/~/ Описание
5720 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5721 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5722 - "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5723 - "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5724 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5725 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5726 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5727 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5728 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5729 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5730 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5731 - "cost": { 
5732 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5733 - "Name": "string", ~/~/ Наименование
5734 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5735 - "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5736 - "Norm": 0 ~/~/ Норма внесения
5737 - },
5738 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5739 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5740 - "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5741 - "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5742 - "deleted": true, ~/~/ Признак удаления
5743 - "extId": "string", ~/~/ ExtId
5744 - "GeoIds": [ ~/~/ Связанные поля
5745 - 0
5746 - ]
5747 -}
5748 -
5749 -
5750 -== **Получение списка Журнала заданий** ==
5751 -
5752 -(% class="box infomessage" %)
5753 -(((
5754 -**POST /api/v3/vehicletasks/getbyperiod**
5755 -)))
5756 -
5757 -Пример запроса:
5758 -
5759 -(((
5760 -{
5761 - "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
5762 - "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
5763 - "TimeZone": 0, ~/~/ Часовой пояс.
5764 - "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
5765 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
5766 - ],
5767 - "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
5768 - 0
5769 - ],
5770 - "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
5771 - 0
5772 - ],
5773 - "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
5774 - "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
5775 -}
5776 -)))
5777 -
5778 -
5779 -Пример ответа:
5780 -
5781 -(((
5782 -{
5783 - "total": 0,  ~/~/ Общее количество записей
5784 - "pages": 0,  ~/~/ Общее количество страниц
5785 - "currentPage": 0, ~/~/ Текущая страница
5786 - "items": [  ~/~/ Записи 
5787 - {
5788 - "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5789 - "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
5790 - "name": "string", ~/~/ Название задания.
5791 - "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
5792 - "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
5793 - "workKind": "string", ~/~/ Вид работ
5794 - "techOp": "string", ~/~/ Тех. операция
5795 - "trailerModel": "string", ~/~/ Модель агрегата
5796 - "width": "string", ~/~/ Ширина, м
5797 - "speed": "string", ~/~/ Тех. скорость
5798 - "fields": "string", ~/~/ Поля
5799 - "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
5800 - "vehicles": "string", ~/~/ Объект-модель
5801 - "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
5802 - "drivers": "string", ~/~/ Водители
5803 - "tmc": "string", ~/~/ ТМЦ
5804 - "client": "string", ~/~/  Клиент
5805 - "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5806 - "dep": "string", ~/~/ Подразделение
5807 - "geoIds": [ ~/~/  Связанные поля
5808 - 0
5809 - ]
5810 - }
5811 - ]
5812 -}
5813 -)))
5814 -
5815 -
5816 -= **Раздел: Локатор ** =
5817 -
5818 -
5819 -== **Получение списка локаторов, доступных пользователю ** ==
5820 -
5821 -(% class="box infomessage" %)
5822 -(((
5823 -**GET /api/v3/locators**
5824 -)))
5825 -
5826 -В заголовках запроса: X-Auth: Токен авторизации
5827 -
5828 -
5829 -Пример ответа:
5830 -
5831 -(((
5832 -[
5833 - {
5834 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5835 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5836 - "agentName": "string", ~/~/ Наименование агента.
5837 - "isEnabled": true, ~/~/ Активен 
5838 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5839 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5840 - "name": "string", ~/~/ Наименование
5841 - "status": 0, ~/~/ 
5842 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5843 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5844 - "validity": 0, ~/~/ Срок действия в днях (1-90).
5845 - "autoProlongation": true, ~/~/ Автопродление срока действия.
5846 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5847 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5848 - "url": "string", ~/~/ Ссылка
5849 - "language": 0, ~/~/ Язык.
5850 - "vehiclesCount": 0, ~/~/ Количество объектов.
5851 - "geozonesCount": 0, ~/~/ Количество геозон.
5852 - "fieldsCount": 0 ~/~/ Количество полей.
5853 - }
5854 -]
5855 -)))
5856 -
5857 -
5858 -
5859 -== **Создание локатора** ==
5860 -
5861 -(% class="box successmessage" %)
5862 -(((
5863 -**POST /api/v3/locators**
5864 -)))
5865 -
5866 -Пример запроса:
5867 -
5868 -(((
5869 -{
5870 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5871 - "isEnabled": true, ~/~/ Активность
5872 - "name": "string", ~/~/ Наименование локатора
5873 - "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
5874 - "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5875 - "validity": 0, ~/~/ Срок действия в днях (1-90)
5876 - "autoProlongation": true, ~/~/ Автопродление срока действия.
5877 - "url": "string", ~/~/ Ссылка
5878 - "language": 0 ~/~/ Язык
5879 -}
5880 -)))
5881 -
5882 -
5883 -Пример ответа:
5884 -
5885 -(((
5886 -3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
5887 -)))
5888 -
5889 -
5890 -
5891 -== **Изменение локатора** ==
5892 -
5893 -(% class="box infomessage" %)
5894 -(((
5895 -**PUT /api/v3/locators**
5896 -)))
5897 -
5898 -Пример запроса:
5899 -
5900 -(((
5901 -{
5902 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5903 - "isEnabled": true, ~/~/ Активность 
5904 - "name": "string", ~/~/ Наименование
5905 - "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
5906 - "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
5907 - "validity": 0, ~/~/ Срок действия в днях (1-90)
5908 - "autoProlongation": true, ~/~/ Автопродление срока действия
5909 - "url": "string", ~/~/ Ссылка
5910 - "language": 0 ~/~/ Язык
5911 -}
5912 -)))
5913 -
5914 -
5915 -Пример ответа:
5916 -
5917 -200 ~/~/ Success
5918 -
5919 -
5920 -== **Удалить локатор** ==
5921 -
5922 -(% class="box warningmessage" %)
5923 -(((
5924 -**DELETE /api/v3/locators**
5925 -)))
5926 -
5927 -Пример запроса:
5928 -
5929 -(((
5930 -[
5931 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
5932 -]
5933 -)))
5934 -
5935 -
5936 -
5937 -
5938 5938  (% class="box" lang="en-US" style="text-align: center;" %)
5939 5939  (((
5940 5940  (% 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 г.