<
From version < 162.1 >
edited by Андрей Калиновский
on 2024/07/25 10:15
To version < 80.1 >
edited by Илья Крайнов
on 2023/03/29 12:23
>
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
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,25 +40,21 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
46 46  (% style="color:#000000" %){
47 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
48 - "User": "testuser" , ~/~/ имя пользователя(%%)
48 +
49 +(% lang="en-US" %)
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
52 +
53 +(% lang="en-US" %)
49 49  }
50 50  
51 51  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
52 52  
53 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
54 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
55 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
56 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
57 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
58 -
59 -(% class="wikigeneratedid" %)
60 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
61 -
62 62  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
63 63  
64 64  (% class="box infomessage" %)
... ... @@ -66,7 +66,7 @@
66 66  (% lang="en-US" %)**GET /api/v3/auth/check**
67 67  )))
68 68  
69 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
70 70  
71 71  (% style="color:#000000" %)Метод запроса: **GET**
72 72  
... ... @@ -86,7 +86,7 @@
86 86  **GET api/v3/agents/{id}**
87 87  )))
88 88  
89 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
90 90  
91 91  (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
92 92  
... ... @@ -97,51 +97,30 @@
97 97  Запрос должен содержать данные параметра "**agentId**"
98 98  
99 99  (% style="color:#000000" %)Ответ:
96
100 100  {
101 - "agentId": "",  (%%)
102 - "parentId": "",
103 - "parentName": "string",
104 - "name": "string",
105 - "fullName": "string",
106 - "agentInfoType": 0,
107 - "isForeign": true/false,
108 - "district": "string", 
109 - "region": "string",
110 - "city": "string",
111 - "inn": "string",
112 - "kpp": "string",
113 - "address": "string",
114 - "addressFact": "string",
115 - "email": "string",
116 - "director": "string",
117 - "bankName": "string",
118 - "bankBIK": "string",
119 - "bankRS": "string",
120 - "bankKS": "string"
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
121 121   }
122 122  
123 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
124 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
125 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
126 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
127 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
128 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
129 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
130 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
131 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
132 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
133 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
134 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
135 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
136 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
137 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
138 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
139 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
140 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
141 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
142 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
143 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
144 -
145 145  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
146 146  
147 147  (% class="box infomessage" %)
... ... @@ -149,13 +149,13 @@
149 149  (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
150 150  )))
151 151  
152 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
153 153  
154 154  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
155 155  
156 156  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
157 157  
158 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
159 159  
160 160  (% style="color:#000000" %)Метод запроса: **POST**
161 161  
... ... @@ -170,23 +170,15 @@
170 170  (% style="color:#000000" %)Ответ:
171 171  
172 172  {
173 - "agentId": "",(% style="color:#000000" %)   (%%)
174 - "parentId": "",
175 - "name": "string",
176 - "fullName": "string",
177 - "agentInfoType": 0,
178 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
179 179  }
180 180  
181 -
182 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
183 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
184 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
185 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
186 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
187 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
188 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
189 -
190 190  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
191 191  
192 192  (% class="box successmessage" %)
... ... @@ -194,7 +194,7 @@
194 194  **POST /api/v3/agents **
195 195  )))
196 196  
197 -Метод позволяет добавить клиента, указанного в запросе.
164 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
198 198  
199 199  Метод запроса: **POST**
200 200  
... ... @@ -205,7 +205,7 @@
205 205  Параметры в теле запроса (JSON):
206 206  
207 207  {
208 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
209 209   "name": "string", ~/~/ имя
210 210   "fullName": "string", ~/~/ полное наименование
211 211   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -225,6 +225,7 @@
225 225   "bankKS": "string" ~/~/ корр. счёт
226 226  }
227 227  
195 +
228 228  Ответ:
229 229  
230 230  {
... ... @@ -249,28 +249,6 @@
249 249   "bankKS": "string" ~/~/ корр. счёт
250 250  }
251 251  
252 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
253 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
254 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
255 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
256 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
257 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
258 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
259 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
260 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
261 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
262 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
263 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
264 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
265 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
266 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
267 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
268 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
269 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
270 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
271 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
272 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
273 -
274 274  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
275 275  
276 276  (% class="box warningmessage" %)
... ... @@ -278,7 +278,7 @@
278 278  **PUT /api/v3/agents**
279 279  )))
280 280  
281 -Метод позволяет отредактировать клиента, указанного в запросе.
227 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
282 282  
283 283  Метод запроса: **PUT**
284 284  
... ... @@ -286,6 +286,7 @@
286 286  
287 287  В заголовках запроса: X-Auth: Токен авторизации
288 288  
235 +
289 289  Параметры в теле запроса (JSON):
290 290  
291 291  {
... ... @@ -310,6 +310,7 @@
310 310   "bankKS": "string" ~/~/ корр. счёт
311 311  }
312 312  
260 +
313 313  Ответ:
314 314  
315 315  {
... ... @@ -340,7 +340,7 @@
340 340  **DELETE /api/v3/agents/{clientId}**
341 341  )))
342 342  
343 -Метод позволяет удалить клиента, указанного в строке запроса.
291 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
344 344  
345 345  Метод запроса: **DELETE**
346 346  
... ... @@ -352,21 +352,6 @@
352 352  
353 353  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
354 354  
355 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
356 -
357 -(% class="box warningmessage" %)
358 -(((
359 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
360 -)))
361 -
362 -Метод позволяет изменить статус клиента, указанного в запросе.
363 -
364 -В пути указывается GUID клиента и статус клиента.
365 -
366 -**status **- значение 0 - заблокирован, 1 - активен.
367 -
368 -Ответ: Code 204
369 -
370 370  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
371 371  
372 372  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -376,7 +376,7 @@
376 376  (% lang="en-US" %)**POST /api/v3/users**
377 377  )))
378 378  
379 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
380 380  
381 381  (% style="color:#000000" %)Метод запроса: **POST**
382 382  
... ... @@ -418,6 +418,7 @@
418 418   ],
419 419   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
420 420  }
354 +
421 421  {
422 422   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
423 423   "lastName": "string",
... ... @@ -429,10 +429,15 @@
429 429   "password": "string",
430 430   "email": "string",
431 431  
366 +
432 432  (% style="text-align:left" %)
433 433  (% style="color:#000000; font-weight:normal" %)Ответ:
434 -{     
435 - "id": "" , ~/~/ ID пользователя
369 +
370 +(% style="text-align:left" %)
371 +(% style="color:#000000; font-weight:normal" %){    
372 +
373 +(% style="text-align:left" %)
374 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
436 436   "lastName": "" , ~/~/ Фамилия ,
437 437   "firstName": "" , ~/~/ Имя
438 438   "position": "" , ~/~/ Должность
... ... @@ -449,8 +449,9 @@
449 449   "kind": "" , ~/~/ тип аутентификации
450 450   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
451 451   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
452 -}
453 453  
392 +(% style="text-align:left" %)
393 +(% style="color:#000000; font-weight:normal" %)}
454 454  
455 455  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
456 456  
... ... @@ -471,16 +471,19 @@
471 471  
472 472  (% style="color:#000000" %)Параметры в теле запроса (JSON):
473 473  
474 -(% style="color:#000000" %){(%%)
414 +(% style="color:#000000" %){
415 +
475 475   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
476 476   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
477 477   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
478 478   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 +
479 479  (% style="color:#000000" %)}
480 480  
481 481  (% style="color:#000000" %)Ответ:
482 482  
483 483  (% style="color:#000000" %){         (%%)
426 +
484 484   "id": "" , ~/~/ идентификатор пользователя
485 485   "lastName": "" , ~/~/ фамилия
486 486   "firstName": "" , ~/~/ имя
... ... @@ -493,7 +493,8 @@
493 493   "email": "" , ~/~/ E-mail
494 494   "sessionDuration":"", ~/~/ длительность сессии в минутах
495 495   "status": "1",  ~/~/ статус пользователя
496 - "lastLogged": "", ~/~/ дата/время последней авторизации
439 + "astLogged": "", ~/~/ дата/время последней авторизации
440 +
497 497  (% style="color:#000000" %)}
498 498  
499 499  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -555,7 +555,7 @@
555 555  (% lang="en-US" %)**PUT /api/v3/users**
556 556  )))
557 557  
558 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
559 559  
560 560  (% style="color:#000000" %)Метод запроса: **PUT**
561 561  
... ... @@ -567,8 +567,10 @@
567 567  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
568 568  
569 569  (% lang="en-US" style="text-align:left" %)
570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
571 - "id": "" , ~/~/ ID пользователя 
514 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 +
516 +(% lang="en-US" style="text-align:left" %)
517 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
572 572   "lastName": "" , ~/~/ фамилия
573 573   "firstName": "" , ~/~/ имя
574 574   "position": "" , ~/~/ должность
... ... @@ -590,7 +590,9 @@
590 590   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
591 591   },
592 592   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
593 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 +
541 +(% lang="en-US" style="text-align:left" %)
594 594  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
595 595  
596 596  (% lang="en-US" style="text-align:left" %)
... ... @@ -597,8 +597,10 @@
597 597  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
598 598  
599 599  (% lang="en-US" style="text-align:left" %)
600 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
601 - "id": "" , ~/~/ идентификатор пользователя
548 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
549 +
550 +(% lang="en-US" style="text-align:left" %)
551 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
602 602   "lastName": "" , ~/~/ фамилия
603 603   "firstName": "" , ~/~/ имя
604 604   "position": "" , ~/~/ должность
... ... @@ -619,8 +619,10 @@
619 619   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
620 620   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
621 621   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
622 -}
623 623  
573 +(% lang="en-US" style="text-align:left" %)
574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 +
624 624  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
625 625  
626 626  (% class="box warningmessage" %)
... ... @@ -628,7 +628,7 @@
628 628  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
629 629  )))
630 630  
631 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
632 632  
633 633  (% style="color:#000000" %)Метод запроса: **PUT**
634 634  
... ... @@ -640,10 +640,12 @@
640 640  
641 641  (% style="color:#000000" %)Параметры в теле запроса (JSON):
642 642  
643 -(% style="color:#000000" %){(%%)
595 +(% style="color:#000000" %){
596 +
644 644   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
645 645   "description": "" , ~/~/ описание
646 646   "data": "" , ~/~/ данные, связанные со сменой статуса
600 +
647 647  (% style="color:#000000" %)}
648 648  
649 649  (% style="text-align:left" %)
... ... @@ -656,7 +656,7 @@
656 656  **POST /api/v3/users/disable**
657 657  )))
658 658  
659 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
613 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
660 660  
661 661  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
662 662  
... ... @@ -665,7 +665,7 @@
665 665  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
666 666  
667 667   [ 
668 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
669 669   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
670 670   ]
671 671  
... ... @@ -678,7 +678,7 @@
678 678  **POST /api/v3/users/enable**
679 679  )))
680 680  
681 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
635 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
682 682  
683 683  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
684 684  
... ... @@ -715,7 +715,7 @@
715 715  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
716 716  )))
717 717  
718 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
719 719  
720 720  (% style="color:#000000" %)Метод запроса: **DELETE**
721 721  
... ... @@ -728,249 +728,6 @@
728 728  (% style="text-align:left" %)
729 729  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
730 730  
731 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
732 -
733 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
734 -
735 -(% class="box infomessage" %)
736 -(((
737 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
738 -)))
739 -
740 -Метод возвращает полную информацию о модели объекта.
741 -
742 -(% style="color:#000000" %)Метод запроса: **GET**
743 -
744 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
745 -
746 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
747 -
748 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
749 -
750 -(% style="color:#000000" %)Ответ:
751 -
752 -(% style="color:#000000" %){
753 - "parentName": "string",
754 - "name": "string",
755 - "picture": "string",
756 - "minspeed": 0,
757 - "maxspeed": 0,
758 - "width": 0,
759 - "imbeddedtrailer": true,
760 - "hoppercapacity": 0,
761 - "hopperdischargespeed": 0,
762 - "modelType": 0,
763 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
764 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
765 - "deleted": true
766 -}
767 -
768 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
769 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
770 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
771 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
772 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
773 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
774 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
775 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
776 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
777 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
778 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
779 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
780 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
781 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
782 -
783 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
784 -
785 -(% class="box successmessage" %)
786 -(((
787 -(% lang="en-US" %)**POST /api/v3/models/find**
788 -)))
789 -
790 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
791 -
792 -(% style="color:#000000" %)Метод запроса: **POST**
793 -
794 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
795 -
796 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
797 -
798 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
799 -
800 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
801 -}
802 -
803 -(% style="color:#000000" %)Ответ:
804 -
805 -(% style="color:#000000" %)[
806 - {
807 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
808 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
809 - "parentName": "string",
810 - "name": "string",
811 - "modelType": 0
812 - }
813 -]
814 -
815 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
816 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
817 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
818 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
819 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
820 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
821 -
822 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
823 -
824 -(% class="box successmessage" %)
825 -(((
826 -(% lang="en-US" %)**POST /api/v3/models**
827 -)))
828 -
829 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
830 -
831 -(% style="color:#000000" %)Метод запроса: **POST**
832 -
833 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
834 -
835 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
836 -
837 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
838 -
839 -{
840 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
841 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
842 - "deleted": true,
843 - "extId": "string",
844 - "name": "string",
845 - "picture": "string",
846 - "minspeed": 0,
847 - "maxspeed": 0,
848 - "width": 0,
849 - "imbeddedtrailer": true,
850 - "fueloutlay": 0,
851 - "hoppercapacity": 0,
852 - "hopperdischargespeed": 0,
853 - "modelType": 0
854 -}
855 -
856 -Ответ:
857 -
858 -{
859 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
860 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
861 - "deleted": true,
862 - "extId": "string",
863 - "name": "string",
864 - "picture": "string",
865 - "minspeed": 0,
866 - "maxspeed": 0,
867 - "width": 0,
868 - "imbeddedtrailer": true,
869 - "hoppercapacity": 0,
870 - "hopperdischargespeed": 0,
871 - "modelType": 0
872 -}
873 -
874 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
875 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
876 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
877 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
878 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
879 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
880 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
881 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
882 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
883 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
884 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
885 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
886 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
887 -
888 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
889 -
890 -(% class="box warningmessage" %)
891 -(((
892 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
893 -)))
894 -
895 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
896 -
897 -(% style="color:#000000" %)Метод запроса: **PUT**
898 -
899 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
900 -
901 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
902 -
903 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
904 -
905 -{
906 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
907 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
908 - "deleted": true,
909 - "extId": "string",
910 - "name": "string",
911 - "picture": "string",
912 - "minspeed": 0,
913 - "maxspeed": 0,
914 - "width": 0,
915 - "imbeddedtrailer": true,
916 - "fueloutlay": 0,
917 - "hoppercapacity": 0,
918 - "hopperdischargespeed": 0,
919 - "modelType": 0
920 -}
921 -
922 -Ответ:
923 -
924 -{
925 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
926 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
927 - "deleted": true,
928 - "extId": "string",
929 - "name": "string",
930 - "picture": "string",
931 - "minspeed": 0,
932 - "maxspeed": 0,
933 - "width": 0,
934 - "imbeddedtrailer": true,
935 - "fueloutlay": 0,
936 - "hoppercapacity": 0,
937 - "hopperdischargespeed": 0,
938 - "modelType": 0
939 -}
940 -
941 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
942 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
943 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
944 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
945 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
946 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
947 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
948 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
949 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
950 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
951 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
952 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
953 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
954 -
955 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
956 -
957 -(% class="box errormessage" %)
958 -(((
959 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
960 -)))
961 -
962 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
963 -
964 -(% style="color:#000000" %)Метод запроса: **DELETE**
965 -
966 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
967 -
968 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
969 -
970 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
971 -
972 -Ответ: В случае успеха **Success 200**
973 -
974 974  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
975 975  
976 976  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -982,7 +982,7 @@
982 982  
983 983  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
984 984  
985 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
986 986  
987 987  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
988 988  
... ... @@ -990,9 +990,9 @@
990 990  
991 991  (% style="color:#000000" %)Метод запроса: **GET**
992 992  
993 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
704 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
994 994  
995 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
706 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
996 996  
997 997  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
998 998  
... ... @@ -1006,129 +1006,20 @@
1006 1006   "deviceTypeId": , ~/~/ ID типа устройства
1007 1007   "deviceTypeName": "", ~/~/ Название типа устройства
1008 1008   "sim1": "", ~/~/ Номер SIM1
1009 - "sim2": "", ~/~/ Номер SIM2
1010 - "parentId": "", ~/~/ ID клиента-родителя
1011 - "parentName": "", ~/~/ Наименование клиента-родителя
1012 - "modelId": "", ~/~/ ID модели объекта
1013 - "modelName": "", ~/~/ Имя модели объекта
1014 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1015 - "unitName": "string", ~/~/ Наименование подразделения
1016 - "status": 0, ~/~/ Статус объекта
1017 - "createdAt": "", ~/~/ Дата создания объекта
720 + "parentId": "", Номер SIM2
721 + "parentName": "", Наименование клиента-родителя
722 + "modelId": "", ID модели объекта
723 + "modelName": "", Имя модели объекта
724 + "createdAt": "", Дата создания объекта
725 + "mileageCalcMethod": "", Выбранный метод расчета пробега
726 + "counters": { ~/~/ Нормы
727 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
728 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
729 + "mileage": "", ~/~/ Пробег по нормам в метрах
730 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
1018 1018   },
1019 -"customFields": [ ~/~/ Произвольные поля
1020 - {
1021 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1022 - "name": "string", ~/~/ Имя поля
1023 - "value": "string", ~/~/ Значение поля
1024 - "forClient": true, ~/~/ Не используемая функция
1025 - "forTooltip": true, ~/~/ Отображать в подсказке
1026 - "forReport": true ~/~/ Отображать в отчете
1027 - }
1028 -
1029 -], ~/~/ Данные с вкладки нормы
1030 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1031 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1032 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1033 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1034 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1035 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1036 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1037 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1038 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1039 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1040 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1041 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1042 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1043 - "mileageCoeff": 0, ~/~/ коэффициент пробега
1044 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1045 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1046 - "counters": { ~/~/ Счетчики
1047 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1048 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1049 - "mileage": 0, ~/~/ Текущий пробег
1050 - "motohours": 0, ~/~/ Текущие моточасы
1051 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1052 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1053 - },
1054 -
1055 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1056 - "id": "string", ~/~/ ID объекта
1057 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
1058 - "host": "string", ~/~/ CMSV6 Web Host
1059 - "login": "string", ~/~/ CMSV6 Account
1060 - "password": "string" ~/~/ CMSV6 Password
1061 - },
1062 -
1063 -"commandTemplates": [ ~/~/ Шаблоны команд
1064 - {
1065 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1066 - "name": "string", ~/~/ Наименование команды
1067 - "command": "string", ~/~/ Текст команды
1068 - "retries": 0 ~/~/ Количество попыток
1069 - }
1070 - ],
1071 - "sensors": [ ~/~/ Датчики
1072 - {
1073 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1074 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1075 - "type": 0, ~/~/ Тип датчика
1076 - "name": "string", ~/~/ Имя датчика
1077 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1078 - "inputNumber": 0, ~/~/ Номер входа
1079 - "pseudonym": "string", ~/~/ Псевдоним
1080 - "medianDegree": 0, ~/~/ Медианная фильтрация
1081 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1082 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1083 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1084 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1085 - {
1086 - "grades": [ ~/~/ Таблица тарировки 1
1087 - {
1088 - "input": 0, ~/~/ Входящее значение
1089 - "output": 0 ~/~/ Выходящее значение
1090 - }
1091 - ],
1092 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1093 - }
1094 - ],
1095 - "showInTooltip": true, ~/~/ Отображать в подсказке
1096 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1097 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1098 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1099 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1100 - "expr": "string", ~/~/ Формула
1101 - "children": [ ~/~/ массив дочерних датчиков
1102 - "string"
1103 - ],
1104 - "customParams": { ~/~/ прочие произвольные параметры
1105 - "additionalProp1": "string",
1106 - "additionalProp2": "string",
1107 - "additionalProp3": "string"
1108 - },
1109 -
1110 -~/~/ Характерные для произвольного:
1111 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1112 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1113 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1114 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1115 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1116 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1117 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1118 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1119 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1120 -~/~/ "ValueOn": "Вкл.",
1121 -~/~/ "ValueOff": "Выкл."
1122 - "summaryMaxValue": 0 ~/~/ Макс. значение
1123 - }
1124 - "drivers": [ ~/~/ Водители
1125 - {
1126 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1127 - "name": "string", ~/~/ Наименование
1128 - "description": "string",
1129 - "isDefault": true ~/~/ По умолчанию
1130 - }
1131 - ],
1132 1132   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1133 1133   {
1134 1134   "id": "", ~/~/ ID  задания
... ... @@ -1144,15 +1144,7 @@
1144 1144   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1145 1145   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1146 1146   }
1147 - ],
1148 -"statusHistory": [ ~/~/ История статусов
1149 - {
1150 - "status": 0,
1151 - "date": "2023-05-22T09:57:39.562Z",
1152 - "description": "string",
1153 - "additionalInfo": "string"
1154 - }
1155 - ]
749 + ]
1156 1156  }
1157 1157  )))
1158 1158  
... ... @@ -1162,73 +1162,6 @@
1162 1162  (% style="text-align:left" %)
1163 1163  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1164 1164  
1165 -
1166 -== **Отправить команду на терминал** ==
1167 -
1168 -(% class="box successmessage" %)
1169 -(((
1170 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1171 -)))
1172 -
1173 -Команда для отправки на тс.
1174 -
1175 -{  
1176 -"id": "", ~/~/идентификатор произвольного поля
1177 -"command": "", ~/~/ Текст команды
1178 -"retries": "", ~/~/ Количество попыток
1179 -"idTemplate": "" ~/~/ ID шаблона команды
1180 -}
1181 -
1182 -
1183 -== **Получить ответ на отправленную на ТС команду** ==
1184 -
1185 -(% class="box infomessage" %)
1186 -(((
1187 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1188 -)))
1189 -
1190 -Идентификатор команды: cmdid
1191 -
1192 -Запрос от терминала на ответ команды
1193 -
1194 -Пример ответ от терминала:
1195 -
1196 -ID= "" ~/~/ идентификатор произвольного поля
1197 -Soft="" ~/~/ версия софта
1198 -GPS=4 ~/~/ тип трекера
1199 -Time=11:05:43 28.06.24 ~/~/ время запроса
1200 -Lat=45.056221 ~/~/ широта
1201 -Lon=39.035938 ~/~/ долгота
1202 -Speed=0.0 ~/~/ скорость
1203 -Course=181.4 ~/~/направление
1204 -
1205 -(((
1206 -== **Список отправленных объекту команд с ответами** ==
1207 -
1208 -(% class="box infomessage" %)
1209 -(((
1210 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1211 -)))
1212 -
1213 -Идентификатор ТС: vehicleId
1214 -
1215 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1216 -
1217 -Пример ответа терминала
1218 -
1219 -[ 
1220 -{    
1221 -"id": "", ~/~/ идентификатор пользователя
1222 -"commandText": "", ~/~/Текст команды.
1223 -"templateId": "", ~/~/Идентификатор шаблона
1224 -"updated": "", ~/~/ Время отправки  
1225 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1226 -"answer": "", ~/~/ Ответ терминала.
1227 -"status": "" ~/~/ Статус отправки
1228 -}
1229 -]
1230 -)))
1231 -
1232 1232  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1233 1233  
1234 1234  (% class="box successmessage" %)
... ... @@ -1236,7 +1236,7 @@
1236 1236  (% lang="en-US" %)**POST /api/v3/vehicles**
1237 1237  )))
1238 1238  
1239 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
1240 1240  
1241 1241  (% style="color:#000000" %)Метод запроса: **POST**
1242 1242  
... ... @@ -1246,7 +1246,8 @@
1246 1246  
1247 1247  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1248 1248  
1249 -(% style="color:#000000" %){(%%)
776 +(% style="color:#000000" %){
777 +
1250 1250   "parentId": "" , ~/~/ ID клиента
1251 1251   "name": "" , ~/~/ имя ТС
1252 1252   "imei": "" , ~/~/ IMEI
... ... @@ -1267,10 +1267,6 @@
1267 1267   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1268 1268   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1269 1269   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1270 - "mileageCalcMethod": 0,
1271 - "mileageCoeff": 0,
1272 - "locationByCellId": true,
1273 - "dottedLineTrackWhenNoCoords": true,
1274 1274   "counters": ~/~/ счетчики
1275 1275   {
1276 1276   "mileage": "" , ~/~/ пробег
... ... @@ -1299,88 +1299,13 @@
1299 1299   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1300 1300   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1301 1301   }
1302 -"drivers": [ ~/~/ Водители
1303 - {
1304 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1305 - "isDefault": true
1306 - }
1307 - ],
1308 - "commandTemplates": [ ~/~/ Шаблон команды
1309 - {
1310 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1311 - "name": "string",
1312 - "command": "string",
1313 - "retries": 0
1314 - }
1315 - ],
1316 -"sensors": [ ~/~/ Датчики
1317 - {
1318 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1319 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1320 - "type": 0, ~/~/ Тип датчика
1321 - "name": "string", ~/~/ Имя датчика
1322 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1323 - "inputNumber": 0, ~/~/ Номер входа
1324 - "pseudonym": "string", ~/~/ Псевдоним
1325 - "medianDegree": 0, ~/~/ Медианная фильтрация
1326 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1327 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1328 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1329 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1330 - {
1331 - "grades": [ ~/~/ Таблица тарировки 1
1332 - {
1333 - "input": 0, ~/~/ Входящее значение
1334 - "output": 0 ~/~/ Выходящее значение
1335 - }
1336 - ],
1337 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1338 - }
1339 - ],
1340 - "showInTooltip": true, ~/~/ Отображать в подсказке
1341 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1342 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1343 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1344 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1345 - "expr": "string", ~/~/ Формула
1346 - "children": [ ~/~/ массив дочерних датчиков
1347 - "string"
1348 - ],
1349 - "customParams": { ~/~/ прочие произвольные параметры
1350 - "additionalProp1": "string",
1351 - "additionalProp2": "string",
1352 - "additionalProp3": "string"
1353 - },
1354 -~/~/ Характерные для произвольного:
1355 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1356 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1357 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1358 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1359 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1360 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1361 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1362 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1363 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1364 -~/~/ "ValueOn": "Вкл.",
1365 -~/~/ "ValueOff": "Выкл."
1366 - "summaryMaxValue": 0 ~/~/ Макс. значение
1367 - }
1368 - ],
1369 - "customFields": [ ~/~/ Произвольные поля
1370 - {
1371 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1372 - "name": "string",
1373 - "value": "string",
1374 - "forClient": true,
1375 - "forTooltip": true,
1376 - "forReport": true
1377 - }
1378 - ]
1379 -}
1380 1380  
827 +(% style="color:#000000" %) }
828 +
1381 1381  (% style="color:#000000" %)Ответ:
1382 1382  
1383 -(% style="color:#000000" %){(%%)
831 +(% style="color:#000000" %){
832 +
1384 1384   "vehicleId": "", ~/~/ID ТС 
1385 1385   "parentId": "", ~/~/Guid владельца ТС
1386 1386   "name": "", ~/~/Имя объекта
... ... @@ -1418,6 +1418,8 @@
1418 1418   "kind": "", ~/~/ Вид периодичности по времени 
1419 1419   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1420 1420   }
870 +
871 +(% style="text-align:left" %)
1421 1421  (% style="color:#000000" %)}
1422 1422  
1423 1423  **Валидация:**
... ... @@ -1432,9 +1432,9 @@
1432 1432  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1433 1433  )))
1434 1434  
1435 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
886 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1436 1436  
1437 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1438 1438  
1439 1439  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1440 1440  
... ... @@ -1476,7 +1476,8 @@
1476 1476  (% style="color:#000000" %)Ответ:
1477 1477  
1478 1478  (% style="color:#000000" %){
1479 - "vehicleId": "" ~/~/ идентификатор объекта
930 +
931 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1480 1480   "name": "" ~/~/ наименование объекта
1481 1481   "imei": "" ~/~/ IMEI объекта
1482 1482   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1513,7 +1513,7 @@
1513 1513  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1514 1514  )))
1515 1515  
1516 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1517 1517  
1518 1518  (% style="color:#000000" %)Метод запроса: **POST**
1519 1519  
... ... @@ -1535,11 +1535,13 @@
1535 1535   "data": "", ~/~/ Данные
1536 1536   "overwrite": false, ~/~/ Флаг перезаписи
1537 1537   "stage": "", ~/~/ Состояние, может быть null
990 +
1538 1538  (% style="color:#000000" %)}
1539 1539  
1540 1540  (% style="color:#000000" %)Ответ:
1541 1541  
1542 -(% style="color:#000000" %){(%%)
995 +(% style="color:#000000" %){
996 +
1543 1543   "status": "", ~/~/ значение статуса
1544 1544   "date": "", ~/~/ Дата смены статуса 
1545 1545   "description": "", ~/~/ Описание
... ... @@ -1546,10 +1546,10 @@
1546 1546   "data": "", ~/~/ Данные
1547 1547   "overwrite": false, ~/~/ Флаг перезаписи
1548 1548   "stage": "", ~/~/ Состояние
1003 +
1004 +(% style="text-align:left" %)
1549 1549  (% style="color:#000000" %) }
1550 1550  
1551 -== ==
1552 -
1553 1553  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1554 1554  
1555 1555  (% class="box warningmessage" %)
... ... @@ -1557,7 +1557,7 @@
1557 1557  (% lang="en-US" %)**PUT /api/v3/vehicles**
1558 1558  )))
1559 1559  
1560 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1561 1561  
1562 1562  (% style="color:#000000" %)Метод запроса: **PUT**
1563 1563  
... ... @@ -1567,16 +1567,18 @@
1567 1567  
1568 1568  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1569 1569  
1570 -(% style="color:#000000" %){
1571 - "vehicleId": , ~/~/ ID объекта
1572 - "parentId": "" , ~/~/ ID клиента
1573 - "name": "" , ~/~/ имя ТС
1574 - "imei": "" , ~/~/ IMEI
1575 - "deviceTypeId": "" , ~/~/ ID типа устройства
1576 - "modelId": "" , ~/~/ ID модели
1577 - "unitId": "" , ~/~/ ID подразделения
1578 - "sim1": "" , ~/~/ Номер SIM 1
1579 - "sim2": "" , ~/~/ Номер SIM2
1024 +(% style="color:#000000" %){    
1025 +
1026 +(((
1027 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1028 + "parentId": "", ~/~/ ID клиента
1029 + "name": "", ~/~/ имя ТС
1030 + "imei": "", ~/~/ IMEI
1031 + "deviceTypeId": "", ~/~/ ID типа устройства
1032 + "modelId": "", ~/~/ , ID модели    
1033 + "unitId": "", ~/~/ подразделения
1034 + "sim1": "", ~/~/ SIM 1
1035 + "sim2": "", ~/~/ SIM2     (%%)
1580 1580   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1581 1581   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1582 1582   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -1589,123 +1589,45 @@
1589 1589   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1590 1590   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1591 1591   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1048 +(% style="color:#000000" %) "counters": 
1049 + {
1050 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1051 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1052 + "mileage": "", ~/~/ пробег, в метрах 
1053 + "motohours": "" ~/~/ моточасы, в секундах
1054 + }
1055 + "cmsv6Parameters": ~/~/ параметры CMSv6
1056 + {       
1057 + "id": "", ~/~/ идентификатор
1058 + "enabled": true, ~/~/ флаг включения
1059 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1060 + "login": "", ~/~/ имя учетной записи
1061 + "password": "", ~/~/ пароль учетной записи
1062 + }
1063 + "inspectionTasks": ~/~/ задания на ТО
1064 + {
1065 + "id": "", ~/~/ ID задания
1066 + "enabled": false, ~/~/ Признак включения
1067 + "name": "", ~/~/ Имя задания
1068 + "description": "", ~/~/ Описание задания
1069 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1070 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1071 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1072 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1073 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1074 + "kind": "", ~/~/ Вид периодичности по времени
1075 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1076 + } 
1077 +)))
1592 1592  
1593 - "mileageCalcMethod": 0,
1594 - "mileageCoeff": 0,
1595 - "locationByCellId": true,
1596 - "dottedLineTrackWhenNoCoords": true,
1597 - "counters": ~/~/ счетчики
1598 - {
1599 - "mileage": "" , ~/~/ пробег
1600 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1601 - "motohours": "" , ~/~/ моточасы
1602 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1603 - },
1604 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1605 - "enabled": true, ~/~/ флаг включения
1606 - "id": "" , ~/~/ идентификатор
1607 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1608 - "login": "" , ~/~/ имя учетной записи
1609 - "password": "" ~/~/ пароль учетной записи
1610 - },
1611 - "inspectionTasks": ~/~/ задания на ТО
1612 - {
1613 - "enabled": "" , ~/~/ Признак включения
1614 - "name": "" , ~/~/ Имя задания
1615 - "description": "" , ~/~/ Описание задания
1616 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1617 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1618 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1619 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1620 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1621 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1622 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1623 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1624 - }
1079 +(% style="color:#000000" %)}
1625 1625  
1626 -"drivers": [ ~/~/ Водители
1627 - {
1628 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1629 - "isDefault": true
1630 - }
1631 - ],
1632 - "commandTemplates": [ ~/~/ Шаблон команды
1633 - {
1634 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1635 - "name": "string",
1636 - "command": "string",
1637 - "retries": 0
1638 - }
1639 - ],
1640 -"sensors": [ ~/~/ Датчики
1641 - {
1642 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1643 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1644 - "type": 0, ~/~/ Тип датчика
1645 - "name": "string", ~/~/ Имя датчика
1646 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1647 - "inputNumber": 0, ~/~/ Номер входа
1648 - "pseudonym": "string", ~/~/ Псевдоним
1649 - "medianDegree": 0, ~/~/ Медианная фильтрация
1650 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1651 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1652 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1653 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1654 - {
1655 - "grades": [ ~/~/ Таблица тарировки 1
1656 - {
1657 - "input": 0, ~/~/ Входящее значение
1658 - "output": 0 ~/~/ Выходящее значение
1659 - }
1660 - ],
1661 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1662 - }
1663 - ],
1664 - "showInTooltip": true, ~/~/ Отображать в подсказке
1665 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1666 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1667 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1668 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1669 - "expr": "string", ~/~/ Формула
1670 - "children": [ ~/~/ массив дочерних датчиков
1671 - "string"
1672 - ],
1673 - "customParams": { ~/~/ прочие произвольные параметры
1674 - "additionalProp1": "string",
1675 - "additionalProp2": "string",
1676 - "additionalProp3": "string"
1677 - },
1678 -~/~/ Характерные для произвольного:
1679 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1680 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1681 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1682 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1683 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1684 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1685 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1686 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1687 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1688 -~/~/ "ValueOn": "Вкл.",
1689 -~/~/ "ValueOff": "Выкл."
1690 - "summaryMaxValue": 0 ~/~/ Макс. значение
1691 - }
1692 - ],
1693 - "customFields": [ ~/~/ Произвольные поля
1694 - {
1695 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1696 - "name": "string",
1697 - "value": "string",
1698 - "forClient": true,
1699 - "forTooltip": true,
1700 - "forReport": true
1701 - }
1702 - ]
1703 -}
1704 -
1705 1705  (% style="color:#000000" %)Ответ:
1706 1706  
1707 1707  (% lang="en-US" style="text-align:left" %)
1708 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
1084 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1085 +
1086 +(% lang="en-US" style="text-align:left" %)
1709 1709   "vehicleId": "", ~/~/ ID ТС
1710 1710   "parentId": "", ~/~/ ID клиента
1711 1711   "name": "", ~/~/ имя ТС
... ... @@ -1746,9 +1746,11 @@
1746 1746   "kind": "", ~/~/ Вид периодичности по времени
1747 1747   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1748 1748   }
1127 +
1128 +(% lang="en-US" style="text-align:left" %)
1749 1749  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1750 1750  
1751 -**Валидация:**
1131 +**валидация:**
1752 1752  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1753 1753  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1754 1754  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
... ... @@ -1760,7 +1760,7 @@
1760 1760  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1761 1761  )))
1762 1762  
1763 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1764 1764  
1765 1765  (% style="color:#000000" %)Метод запроса: **DELETE**
1766 1766  
... ... @@ -1782,19 +1782,22 @@
1782 1782  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1783 1783  )))
1784 1784  
1785 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1786 1786  
1787 1787  (% style="color:#000000" %)Метод запроса: **GET**
1788 1788  
1789 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1169 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1790 1790  
1791 1791  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1792 1792  
1793 1793  (% style="color:#000000" %)Ответ:
1794 1794  
1795 -(% style="color:#000000" %){(%%)
1175 +(% style="color:#000000" %){
1176 +
1796 1796   "deviceTypeId" : "", ~/~/ ID типа устройства
1797 1797   "deviceTypeName" : "" ~/~/ Название типа устройства
1179 +
1180 +(% style="text-align:left" %)
1798 1798  (% style="color:#000000" %)}
1799 1799  
1800 1800  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1806,7 +1806,7 @@
1806 1806  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1807 1807  )))
1808 1808  
1809 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1810 1810  
1811 1811  (% style="color:#000000" %)Метод запроса: **GET**
1812 1812  
... ... @@ -1816,10 +1816,13 @@
1816 1816  
1817 1817  (% style="color:#000000" %)Ответ:
1818 1818  
1819 -(% style="color:#000000" %){(%%)
1202 +(% style="color:#000000" %){
1203 +
1820 1820   "id": "", ~/~/ ID типа датчика 
1821 1821   "name": "", ~/~/ Название
1822 1822   "description": "", ~/~/ Описание
1207 +
1208 +(% style="text-align:left" %)
1823 1823  (% style="color:#000000" %)}
1824 1824  
1825 1825  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1832,7 +1832,7 @@
1832 1832  )))
1833 1833  
1834 1834  (% style="text-align: left;" %)
1835 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1836 1836  
1837 1837  (% style="text-align: left;" %)
1838 1838  Метод запроса **POST**
... ... @@ -1863,56 +1863,6 @@
1863 1863   }
1864 1864  ]
1865 1865  
1866 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1867 -
1868 -(% class="box infomessage" style="text-align: left;" %)
1869 -(((
1870 -**POST /api/v3/terminalMessages/mapping**
1871 -)))
1872 -
1873 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1874 -
1875 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1876 -
1877 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1878 -
1879 -{
1880 - "protocolType": 0,
1881 - "params": ["string"]
1882 -}
1883 -
1884 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1885 -|protocolType|ID типа протокола
1886 -|params|(((
1887 -Массив наименований параметров в сообщении
1888 -)))
1889 -
1890 -Ответ:
1891 -
1892 -{
1893 - "protocolType": 0,
1894 - "mapping": {
1895 - "additionalProp1": {
1896 - "inputType": 0,
1897 - "inputNumber": 0
1898 - },
1899 - "additionalProp2": {
1900 - "inputType": 0,
1901 - "inputNumber": 0
1902 - }
1903 - }
1904 -}
1905 -
1906 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 -|protocolType|Тип протокола
1908 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1909 -|inputNumber|(((
1910 -Номер входа
1911 -)))
1912 -
1913 -(% class="wikigeneratedid" %)
1914 -Перечень 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/]]
1915 -
1916 1916  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1917 1917  
1918 1918  (% class="box infomessage" %)
... ... @@ -1920,7 +1920,7 @@
1920 1920  **POST /api/v3/terminalMessages**
1921 1921  )))
1922 1922  
1923 -Метод возвращает список сообщений терминала объекта за выбранный период.
1259 +Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1924 1924  
1925 1925  (% style="text-align: left;" %)
1926 1926  Метод запроса **POST**
... ... @@ -1937,11 +1937,6 @@
1937 1937   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1938 1938  }
1939 1939  
1940 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1941 -|vehicleId|ID объекта
1942 -|from|Дата и время начала периода запроса
1943 -|to|Дата и время окончания периода запроса
1944 -
1945 1945  Ответ:
1946 1946  
1947 1947  [
... ... @@ -1948,2486 +1948,26 @@
1948 1948   {
1949 1949   "messages": [
1950 1950   {
1951 - "deviceTime": "2023-11-29T07:40:44.052Z",
1952 - "serverTime": "2023-11-29T07:40:44.052Z",
1953 - "speed": 0,
1954 - "altitude": 0,
1955 - "latitude": 0,
1956 - "longitude": 0,
1957 - "satellites": 0,
1958 - "course": 0,
1959 - "voltage": 0,
1960 - "parameters": {
1282 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1283 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1284 + "speed": 0, ~/~/ Скорость, км/ч
1285 + "altitude": 0, ~/~/ Высота, м
1286 + "latitude": 0, ~/~/ Широта [-90°;90°]
1287 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1288 + "satellites": 0, ~/~/ Кол-во спутников
1289 + "voltage": 0, ~/~/ Напряжение
1290 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1961 1961   "additionalProp1": "string",
1962 1962   "additionalProp2": "string",
1963 1963   "additionalProp3": "string"
1964 1964   },
1965 - "photoCount": 0,
1966 - "lbsCorrectedCoords": true,
1967 - "protocolType": 0
1295 + "photoCount": 0 ~/~/ Кол-во фото
1968 1968   }
1969 1969   ]
1970 1970   }
1971 1971  ]
1972 1972  
1973 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1974 -|deviceTime|Время сообщения терминала
1975 -|serverTime|Время когда сообщение поступило на сервер
1976 -|speed|Скорость
1977 -|altitude|Высота над уровнем моря
1978 -|latitude|Широта
1979 -|longitude|Долгота
1980 -|satellites|Кол-во спутников
1981 -|course|Курс
1982 -|voltage|Бортовое напряжение
1983 -|parameters|Список параметров и их значений
1984 -|photoCount|Количество фото
1985 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
1986 -|protocolType|ID типа протокола
1987 1987  
1988 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1989 -
1990 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1991 -
1992 -(% class="box infomessage" %)
1993 -(((
1994 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
1995 -)))
1996 -
1997 -(% style="color:#000000" %)Метод запроса: **POST**
1998 -
1999 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2000 -
2001 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2002 -
2003 -(% style="text-align:left" %)
2004 -Тело запроса:
2005 -
2006 -{
2007 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2008 - "vehicleIds": [0], ~/~/ Список ID объектов
2009 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2010 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2011 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2012 -}
2013 -
2014 -Ответ:
2015 -
2016 -[
2017 - {
2018 - "vehicleId": 0, ~/~/ ID объекта
2019 - "name": "string", ~/~/ Имя ТС
2020 - "periods": [ ~/~/ Периоды
2021 - {
2022 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2023 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2024 - "mileageBegin": 0, ~/~/ Пробег на начало периода
2025 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
2026 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2027 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2028 - }
2029 - ]
2030 - }
2031 -]
2032 -
2033 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2034 -
2035 -(% class="box infomessage" %)
2036 -(((
2037 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2038 -)))
2039 -
2040 -(% style="color:#000000" %)Метод запроса: **POST**
2041 -
2042 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2043 -
2044 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2045 -
2046 -(% style="text-align:left" %)
2047 -Тело запроса:
2048 -
2049 -{
2050 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2051 - "vehicleIds": [0], ~/~/ Список ID объектов
2052 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2053 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2054 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2055 -}
2056 -
2057 -Ответ:
2058 -
2059 -[
2060 - {
2061 - "vehicleId": 0, ~/~/ ID объекта
2062 - "name": "string", ~/~/ Имя ТС
2063 - "periods": [ ~/~/ Периоды
2064 - {
2065 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2066 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2067 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2068 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2069 - "fuelConsumption": 0, ~/~/ Расход топлива
2070 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2071 - }
2072 - ]
2073 - }
2074 -]
2075 -
2076 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2077 -
2078 -(% class="box infomessage" %)
2079 -(((
2080 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2081 -)))
2082 -
2083 -(% style="color:#000000" %)Метод запроса: **POST**
2084 -
2085 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2086 -
2087 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2088 -
2089 -(% style="text-align:left" %)
2090 -Тело запроса:
2091 -
2092 -{
2093 - "vehicleIds": [0], ~/~/ Список ID объектов
2094 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2095 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2096 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2097 -}
2098 -
2099 -Ответ:
2100 -
2101 -[
2102 - {
2103 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2104 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2105 - "vehicleId": 0, ~/~/ ID объекта
2106 - "name": "string", ~/~/ Имя объекта
2107 - "model": "string", ~/~/ Модель объекта
2108 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2109 - {
2110 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2111 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2112 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2113 - "valueFuel": 0, ~/~/ Количество
2114 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2115 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2116 - }
2117 - ]
2118 - }
2119 -]
2120 -
2121 -
2122 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2123 -
2124 -(% class="box infomessage" %)
2125 -(((
2126 -**POST /api/v3/vehicles/moveStop**
2127 -)))
2128 -
2129 -Метод запроса: **POST**
2130 -
2131 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2132 -
2133 -В заголовках запроса: X-Auth: Токен авторизации
2134 -
2135 -
2136 -Тело запроса:
2137 -
2138 -{
2139 - "vehicleIds": [ ], ~/~/ Список ID объектов
2140 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2141 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2142 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2143 -}
2144 -
2145 -Ответ:
2146 -
2147 -[ 
2148 - {
2149 - "vehicleId": 0, ~/~/ ID объекта
2150 - "vehicleName": "string", ~/~/ Имя объекта
2151 - "moves": [ ~/~/ Событие движения
2152 - {
2153 - "mileage": 0, ~/~/ Пробег, км
2154 - "eventId": 0, ~/~/ Идентификатор события
2155 - "eventName": "string", ~/~/ Название события
2156 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2157 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2158 - "duration": 0 ~/~/ Продолжительность события, секунд
2159 - }
2160 - ],
2161 - "stops": [ ~/~/ События стоянок
2162 - {
2163 - "address": "string", ~/~/ Адрес события
2164 - "eventId": 0, ~/~/ Идентификатор события
2165 - "eventName": "string", ~/~/ Название события
2166 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2167 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2168 - "duration": 0 ~/~/ Продолжительность события, секунд
2169 - }
2170 - ]
2171 - }
2172 -]
2173 -
2174 -
2175 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2176 -
2177 -(% class="box infomessage" %)
2178 -(((
2179 -**POST /api/v3/vehicles/getlastdata**
2180 -)))
2181 -
2182 -Метод запроса: **POST**
2183 -
2184 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2185 -
2186 -В заголовках запроса: X-Auth: Токен авторизации
2187 -
2188 -
2189 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2190 -
2191 -Ответ:
2192 - {
2193 - "vehicleId": 0, ~/~/Идентификатор объекта.
2194 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2195 - "vehicleNumber": "string",~/~/Номер объекта.
2196 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2197 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2198 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2199 - "speed": 0,~/~/Скорость объекта.
2200 - "course": 0,~/~/Курс движения [0;360]
2201 - "latitude": 0,~/~/Широта [-90°;90°].
2202 - "longitude": 0,~/~/Долгота [-180°;180°].
2203 - "address": "string",~/~/Адрес.
2204 - "geozones": [ ~/~/Сведения по геозонам.
2205 - {
2206 - "id": 0,
2207 - "name": "string"
2208 - }
2209 -
2210 -
2211 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2212 -
2213 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2214 -
2215 -(% class="box infomessage" %)
2216 -(((
2217 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2218 -)))
2219 -
2220 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2221 -
2222 -(% style="color:#000000" %)Метод запроса: **POST**
2223 -
2224 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2225 -
2226 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2227 -
2228 -(% style="text-align:left" %)
2229 -Тело запроса:
2230 -
2231 -(% style="text-align:left" %)
2232 -{
2233 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2234 -}
2235 -
2236 -(% style="text-align:left" %)
2237 -Ответ:
2238 -
2239 -[
2240 - {
2241 - "id": 0, ~/~/ Идентификатор объекта геозоны
2242 - "name": "string", ~/~/ Название объекта геозоны
2243 - "type": 0, ~/~/ Тип объекта геозоны
2244 - "fname": "string", ~/~/ Имя файла
2245 - "parentId": "string", ~/~/ Идентификатор клиента
2246 - "radius": 0, ~/~/ Радиус геообъекта
2247 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2248 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2249 - "description": "string", ~/~/ Описание
2250 - "area": 0, ~/~/ Площадь, м^^2^^
2251 - "perimetr": 0, ~/~/ Периметр, м
2252 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2253 - }
2254 -]
2255 -
2256 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2257 -
2258 -(% class="box infomessage" %)
2259 -(((
2260 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2261 -)))
2262 -
2263 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2264 -
2265 -(% style="color:#000000" %)Метод запроса: **POST**
2266 -
2267 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2268 -
2269 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2270 -
2271 -(% style="text-align:left" %)
2272 -Тело запроса:
2273 -
2274 -{
2275 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2276 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2277 - "ids": [ ], ~/~/ Массив id объектов
2278 - "byTime": 0, ~/~/ Объединение событий по времени 
2279 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2280 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2281 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2282 -}
2283 -
2284 -Ответ:
2285 -[
2286 - {
2287 - "geozoneId": 0, ~/~/ ID геообъекта
2288 - "geozoneName": "string", ~/~/ Название геообъекта
2289 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2290 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2291 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2292 - "vehicleId": 0, ~/~/ ID объекта
2293 - "vehicleName": "string" ~/~/ Имя объекта
2294 - }
2295 -]
2296 -
2297 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2298 -
2299 -(% class="box infomessage" %)
2300 -(((
2301 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2302 -)))
2303 -
2304 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2305 -
2306 -(% style="color:#000000" %)Метод запроса: **POST**
2307 -
2308 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2309 -
2310 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2311 -
2312 -(% style="text-align:left" %)
2313 -Тело запроса:
2314 -
2315 -{
2316 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2317 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2318 - "ids": [ ], ~/~/ Массив id геообъектов
2319 - "byTime": 0, ~/~/ Объединение событий по времени 
2320 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2321 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2322 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2323 -}
2324 -
2325 -Ответ:
2326 -
2327 -[
2328 - {
2329 - "geozoneId": 0, ~/~/ ID геообъекта
2330 - "geozoneName": "string", ~/~/ Название геообъекта
2331 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2332 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2333 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2334 - "vehicleId": 0, ~/~/ ID объекта
2335 - "vehicleName": "string" ~/~/ Имя объекта
2336 - }
2337 -]
2338 -
2339 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2340 -
2341 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2342 -
2343 -(% class="box infomessage" %)
2344 -(((
2345 -**POST /api/v3/notifications/find**
2346 -)))
2347 -
2348 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2349 -
2350 -(% style="text-align: left;" %)
2351 -Метод запроса **POST**
2352 -
2353 -(% style="text-align: left;" %)
2354 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2355 -
2356 -(% style="text-align: left;" %)
2357 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2358 -
2359 -{
2360 - "parentId": "" ~/~/ id клиента
2361 -}
2362 -
2363 -Ответ:
2364 -
2365 -[
2366 - {
2367 - "id": 0, ~/~/ ID уведомления
2368 - "name": "string", ~/~/ Название уведомления
2369 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2370 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2371 - "userId": "", ~/~/ Пользователь, создавший уведомление
2372 - "parentId": "", ~/~/ Идентификатор клиента
2373 - "parentName": "string" ~/~/ Имя клиента
2374 - }
2375 -]
2376 -
2377 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2378 -
2379 -(% class="box infomessage" %)
2380 -(((
2381 -**GET /api/v3/notifications/{id}**
2382 -)))
2383 -
2384 -Метод возвращает данные правил формирования выбранного уведомления.
2385 -
2386 -(% style="text-align: left;" %)
2387 -Метод запроса **GET**
2388 -
2389 -(% style="text-align: left;" %)
2390 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2391 -
2392 -(% style="text-align: left;" %)
2393 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2394 -
2395 -(% style="text-align: left;" %)
2396 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2397 -
2398 -(% style="text-align: left;" %)
2399 -(% style="color:#000000" %)Ответ:
2400 -
2401 -(% style="text-align: left;" %)
2402 -(% style="color:#000000" %){
2403 - "id": 0, ~/~/ (%%)id уведомления
2404 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2405 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2406 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2407 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2408 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2409 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2410 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2411 -(% style="color:#000000" %) 0
2412 - ],
2413 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2414 -(% style="color:#000000" %) 0
2415 - ],
2416 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
2417 -(% style="color:#000000" %) 0
2418 - ],
2419 - "settings": { ~/~/ Список параметров уведомления
2420 - "additionalProp1": "string",
2421 - "additionalProp2": "string",
2422 - "additionalProp3": "string"
2423 - },
2424 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2425 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2426 -(% style="color:#000000" %) ""
2427 - ],
2428 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2429 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2430 -(% style="color:#000000" %) "string"
2431 - ],
2432 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2433 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2434 -(% style="color:#000000" %) {
2435 - "id": 0, ~/~/ (%%)Идентификатор участника чата
2436 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2437 -(% style="color:#000000" %) }
2438 - ],
2439 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2440 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2441 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2442 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2443 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2444 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2445 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2446 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2447 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2448 -(% style="color:#000000" %)}
2449 -
2450 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2451 -
2452 -(% class="box warningmessage" %)
2453 -(((
2454 -**PUT /api/v3/notifications/**
2455 -)))
2456 -
2457 -Метод позволяет отредактировать уведомление.
2458 -
2459 -Метод запроса **PUT**
2460 -
2461 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2462 -
2463 -В заголовках запроса: X-Auth: Токен авторизации
2464 -
2465 -Тело запроса:
2466 -{
2467 - "id": 0, ~/~/ id уведомления
2468 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2469 - "userId": "", ~/~/ Пользователь, создавший уведомление
2470 - "parentId": "", ~/~/ Идентификатор клиента
2471 - "parentName": "string", ~/~/ Имя клиента
2472 - "name": "string", ~/~/ Название уведомления
2473 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2474 - "vehicleIds": [ ~/~/ Список id объектов для анализа
2475 - 0
2476 - ],
2477 - "geoids": [ ~/~/ Список id геообъектов для анализа
2478 - 0
2479 - ],
2480 - "fieldids": [ ~/~/ Список id полей для анализа
2481 - 0
2482 - ],
2483 - "settings": { ~/~/ Список параметров уведомления
2484 - "additionalProp1": "string",
2485 - "additionalProp2": "string",
2486 - "additionalProp3": "string"
2487 - },
2488 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2489 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2490 - ""
2491 - ],
2492 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2493 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2494 - "string"
2495 - ],
2496 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2497 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2498 - {
2499 - "id": 0, ~/~/ Идентификатор участника чата
2500 - "info": "string" ~/~/ Дополнительные сведения
2501 - }
2502 - ],
2503 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2504 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2505 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2506 - "kind": 0, ~/~/ Определяет вид уведомления
2507 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2508 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2509 - "timezone": 0, ~/~/ Сдвиг часового пояса
2510 - "validity": 0, ~/~/ Срок действия в днях (1-90)
2511 - "autoProlongation": true ~/~/ Автопродление срока действия
2512 -}
2513 -
2514 -Ответ:
2515 -
2516 -Success
2517 -
2518 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2519 -
2520 -(% class="box errormessage" %)
2521 -(((
2522 -**DELETE /api/v3/notifications/{id}**
2523 -)))
2524 -
2525 -Метод позволяет удалить выбранное уведомление.
2526 -
2527 -Метод запроса **DELETE**
2528 -
2529 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2530 -
2531 -Передаваемый параметр: {id} - id уведомления
2532 -
2533 -В заголовках запроса: X-Auth: Токен авторизации
2534 -
2535 -Ответ:
2536 -
2537 -Success
2538 -
2539 -
2540 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2541 -
2542 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2543 -
2544 -(% class="box infomessage" %)
2545 -(((
2546 -**POST /api/v3/Drivers/find**
2547 -)))
2548 -
2549 -Передается параметр: parentId - ID клиента-родителя
2550 -
2551 -Ответ:
2552 -
2553 -[
2554 - {
2555 - "name": "string", ~/~/ Определяет наименование
2556 - "description": "string", ~/~/ Определяет описание
2557 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2558 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2559 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2560 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2561 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2562 - "deleted": true ~/~/ Признак удаления
2563 - }
2564 -]
2565 -
2566 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2567 -
2568 -(% class="box infomessage" %)
2569 -(((
2570 -**GET /api/v3/Drivers/{driverGuid}**
2571 -)))
2572 -
2573 -Передается параметр: ID водителя
2574 -
2575 -Ответ:
2576 -
2577 -{
2578 - "name": "string", ~/~/ Определяет наименование
2579 - "description": "string", ~/~/ Определяет описание
2580 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2581 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2582 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2583 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2584 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2585 - "deleted": true ~/~/ Признак удаления
2586 -}
2587 -
2588 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2589 -
2590 -(% class="box successmessage" %)
2591 -(((
2592 -**POST /api/v3/Drivers**
2593 -)))
2594 -
2595 -Запрос:
2596 -
2597 -{
2598 - "name": "string",
2599 - "description": "string",
2600 - "hiredate": "2023-06-30T12:50:54.020Z",
2601 - "chopdate": "2023-06-30T12:50:54.020Z",
2602 - "exclusive": true,
2603 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2604 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2605 - "deleted": true
2606 -}
2607 -
2608 -Ответ:
2609 -
2610 -{
2611 - "name": "string",
2612 - "description": "string",
2613 - "hiredate": "2023-06-30T12:50:54.051Z",
2614 - "chopdate": "2023-06-30T12:50:54.051Z",
2615 - "exclusive": true,
2616 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2617 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2618 - "deleted": true
2619 -}
2620 -
2621 -
2622 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2623 -
2624 -(% class="box warningmessage" %)
2625 -(((
2626 -**PUT /api/v3/Drivers**
2627 -)))
2628 -
2629 -Запрос:
2630 -
2631 -{
2632 - "name": "string",
2633 - "description": "string",
2634 - "hiredate": "2023-06-30T12:50:27.910Z",
2635 - "chopdate": "2023-06-30T12:50:27.910Z",
2636 - "exclusive": true,
2637 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2638 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2639 - "deleted": true
2640 -}
2641 -
2642 -Ответ:
2643 -
2644 -{
2645 - "name": "string",
2646 - "description": "string",
2647 - "hiredate": "2023-06-30T12:50:27.929Z",
2648 - "chopdate": "2023-06-30T12:50:27.929Z",
2649 - "exclusive": true,
2650 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2651 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2652 - "deleted": true
2653 -}
2654 -
2655 -
2656 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2657 -
2658 -(% class="box errormessage" %)
2659 -(((
2660 -**DELETE /api/v3/Drivers/{driverGuid}**
2661 -)))
2662 -
2663 -Передается параметр: ID водителя
2664 -
2665 -Ответ:
2666 -
2667 -Success
2668 -
2669 -
2670 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2671 -
2672 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2673 -
2674 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2675 -
2676 -(% class="box infomessage" %)
2677 -(((
2678 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2679 -)))
2680 -
2681 -Запрос:
2682 -
2683 -{
2684 - "Ids": [
2685 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2686 - ],
2687 - "BeginTime": "2023-06-30T12:49:04.365Z",
2688 - "EndTime": "2023-06-30T12:49:04.365Z"
2689 -}
2690 -
2691 -Ответ:
2692 -
2693 -[
2694 - {
2695 - "VehicleId": 0,
2696 - "CreateTime": "2023-06-30T09:52:31.240Z",
2697 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2698 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2699 - "BeginTime": "2023-06-30T09:52:31.240Z",
2700 - "EndTime": "2023-06-30T09:52:31.240Z"
2701 - }
2702 -]
2703 -
2704 -
2705 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2706 -
2707 -(% class="box infomessage" %)
2708 -(((
2709 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2710 -)))
2711 -
2712 -Запрос:
2713 -
2714 -{
2715 - "Ids": [
2716 - 0
2717 - ],
2718 - "BeginTime": "2023-06-30T12:48:39.419Z",
2719 - "EndTime": "2023-06-30T12:48:39.419Z"
2720 -}
2721 -
2722 -Ответ:
2723 -
2724 -[
2725 - {
2726 - "VehicleId": 0,
2727 - "CreateTime": "2023-06-30T09:54:01.631Z",
2728 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2729 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2730 - "BeginTime": "2023-06-30T09:54:01.631Z",
2731 - "EndTime": "2023-06-30T09:54:01.631Z"
2732 - }
2733 -]
2734 -
2735 -
2736 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2737 -
2738 -(% class="box successmessage" %)
2739 -(((
2740 -**POST /api/v3/DriversVehiclesAssignments**
2741 -)))
2742 -
2743 -Передается массив назначений
2744 -
2745 -Запрос:
2746 -
2747 -[
2748 - {
2749 - "VehicleId": 0, ~/~/ Идентификатор объекта
2750 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2751 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2752 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2753 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2754 - }
2755 -]
2756 -
2757 -Ответ:
2758 -
2759 -[
2760 - {
2761 - "VehicleId": 0,
2762 - "CreateTime": "2023-06-30T11:04:46.903Z",
2763 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2764 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2765 - "BeginTime": "2023-06-30T11:04:46.903Z",
2766 - "EndTime": "2023-06-30T11:04:46.903Z"
2767 - }
2768 -]
2769 -
2770 -
2771 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2772 -
2773 -(% class="box warningmessage" %)
2774 -(((
2775 -**PUT /api/v3/DriversVehiclesAssignments**
2776 -)))
2777 -
2778 -Запрос:
2779 -
2780 -[
2781 - {
2782 - "VehicleId": 0,
2783 - "CreateTime": "2023-06-30T11:14:08.117Z",
2784 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2785 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2786 - "BeginTime": "2023-06-30T11:14:08.117Z",
2787 - "EndTime": "2023-06-30T11:14:08.117Z"
2788 - }
2789 -]
2790 -
2791 -Ответ:
2792 -
2793 -[
2794 - {
2795 - "VehicleId": 0,
2796 - "CreateTime": "2023-06-30T11:14:53.349Z",
2797 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2798 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2799 - "BeginTime": "2023-06-30T11:14:53.349Z",
2800 - "EndTime": "2023-06-30T11:14:53.349Z"
2801 - }
2802 -]
2803 -
2804 -
2805 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2806 -
2807 -(% class="box errormessage" %)
2808 -(((
2809 -**DELETE /api/v3/DriversVehiclesAssignments**
2810 -)))
2811 -
2812 -Запрос:
2813 -
2814 -[
2815 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2816 -]
2817 -
2818 -Ответ:
2819 -
2820 -Success
2821 -
2822 -
2823 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2824 -
2825 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2826 -
2827 -(% class="box infomessage" %)
2828 -(((
2829 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2830 -)))
2831 -
2832 -Запрос:
2833 -
2834 -{
2835 - "Ids": [
2836 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2837 - ],
2838 - "BeginTime": "2023-06-30T12:47:12.162Z",
2839 - "EndTime": "2023-06-30T12:47:12.162Z"
2840 -}
2841 -
2842 -Ответ:
2843 -
2844 -[
2845 - {
2846 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2847 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2848 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2849 - "BeginTime": "2023-06-30T11:19:40.703Z",
2850 - "EndTime": "2023-06-30T11:19:40.703Z"
2851 - }
2852 -]
2853 -
2854 -
2855 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2856 -
2857 -(% class="box infomessage" %)
2858 -(((
2859 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2860 -)))
2861 -
2862 -Запрос:
2863 -
2864 -{
2865 - "Ids": [
2866 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2867 - ],
2868 - "BeginTime": "2023-06-30T12:47:12.162Z",
2869 - "EndTime": "2023-06-30T12:47:12.162Z"
2870 -}
2871 -
2872 -Ответ:
2873 -
2874 -[
2875 - {
2876 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2877 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2878 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2879 - "BeginTime": "2023-06-30T11:19:40.703Z",
2880 - "EndTime": "2023-06-30T11:19:40.703Z"
2881 - }
2882 -]
2883 -
2884 -
2885 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2886 -
2887 -(% class="box successmessage" %)
2888 -(((
2889 -**POST /api/v3/DriversRfidsAssignments**
2890 -)))
2891 -
2892 -Запрос:
2893 -
2894 -[
2895 - {
2896 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2897 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2898 - "BeginTime": "2023-06-30T11:27:08.635Z",
2899 - "EndTime": "2023-06-30T11:27:08.635Z"
2900 - }
2901 -]
2902 -
2903 -Ответ:
2904 -
2905 -[
2906 - {
2907 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2908 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2909 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2910 - "BeginTime": "2023-06-30T11:27:08.677Z",
2911 - "EndTime": "2023-06-30T11:27:08.677Z"
2912 - }
2913 -]
2914 -
2915 -
2916 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2917 -
2918 -(% class="box warningmessage" %)
2919 -(((
2920 -**PUT /api/v3/DriversRfidsAssignments**
2921 -)))
2922 -
2923 -Запрос:
2924 -
2925 -[
2926 - {
2927 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2928 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2929 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2930 - "BeginTime": "2023-06-30T11:28:43.330Z",
2931 - "EndTime": "2023-06-30T11:28:43.330Z"
2932 - }
2933 -]
2934 -
2935 -Ответ:
2936 -
2937 -[
2938 - {
2939 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2940 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2941 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2942 - "BeginTime": "2023-06-30T11:28:43.331Z",
2943 - "EndTime": "2023-06-30T11:28:43.331Z"
2944 - }
2945 -]
2946 -
2947 -
2948 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2949 -
2950 -(% class="box errormessage" %)
2951 -(((
2952 -**DELETE /api/v3/DriversRfidsAssignments**
2953 -)))
2954 -
2955 -Запрос:
2956 -
2957 -[
2958 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2959 -]
2960 -
2961 -Ответ:
2962 -
2963 -Success
2964 -
2965 -
2966 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2967 -
2968 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2969 -
2970 -(% class="box infomessage" %)
2971 -(((
2972 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2973 -)))
2974 -
2975 -Запрос:
2976 -
2977 -{
2978 - "Ids": [
2979 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2980 - ],
2981 - "BeginTime": "2023-06-30T12:45:10.852Z",
2982 - "EndTime": "2023-06-30T12:45:10.852Z"
2983 -}
2984 -
2985 -Ответ:
2986 -
2987 -[
2988 - {
2989 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2990 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2991 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2992 - "BeginTime": "2023-06-30T11:58:04.695Z",
2993 - "EndTime": "2023-06-30T11:58:04.695Z"
2994 - }
2995 -]
2996 -
2997 -
2998 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2999 -
3000 -(% class="box infomessage" %)
3001 -(((
3002 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3003 -)))
3004 -
3005 -Запрос:
3006 -
3007 -{
3008 - "Ids": [
3009 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3010 - ],
3011 - "BeginTime": "2023-06-30T12:45:10.852Z",
3012 - "EndTime": "2023-06-30T12:45:10.852Z"
3013 -}
3014 -
3015 -Ответ:
3016 -
3017 -[
3018 - {
3019 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3020 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3021 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3022 - "BeginTime": "2023-06-30T11:58:04.695Z",
3023 - "EndTime": "2023-06-30T11:58:04.695Z"
3024 - }
3025 -]
3026 -
3027 -
3028 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3029 -
3030 -(% class="box successmessage" %)
3031 -(((
3032 -**POST /api/v3/DriversFuelCardsAssignments**
3033 -)))
3034 -
3035 -Запрос:
3036 -
3037 -[
3038 - {
3039 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3040 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3041 - "BeginTime": "2023-06-30T12:09:53.175Z",
3042 - "EndTime": "2023-06-30T12:09:53.175Z"
3043 - }
3044 -]
3045 -
3046 -Ответ:
3047 -
3048 -[
3049 - {
3050 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3051 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3052 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3053 - "BeginTime": "2023-06-30T12:09:53.201Z",
3054 - "EndTime": "2023-06-30T12:09:53.201Z"
3055 - }
3056 -]
3057 -
3058 -
3059 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3060 -
3061 -(% class="box warningmessage" %)
3062 -(((
3063 -**PUT /api/v3/DriversFuelCardsAssignments**
3064 -)))
3065 -
3066 -Запрос:
3067 -
3068 -[
3069 - {
3070 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3071 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3072 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3073 - "BeginTime": "2023-06-30T12:09:53.201Z",
3074 - "EndTime": "2023-06-30T12:09:53.201Z"
3075 - }
3076 -]
3077 -
3078 -Ответ:
3079 -
3080 -[
3081 - {
3082 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3084 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 - "BeginTime": "2023-06-30T12:09:53.201Z",
3086 - "EndTime": "2023-06-30T12:09:53.201Z"
3087 - }
3088 -]
3089 -
3090 -
3091 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3092 -
3093 -(% class="box errormessage" %)
3094 -(((
3095 -**DELETE /api/v3/DriversFuelCardsAssignments**
3096 -)))
3097 -
3098 -Запрос:
3099 -
3100 -[
3101 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3102 -]
3103 -
3104 -Ответ:
3105 -
3106 -Success
3107 -
3108 -
3109 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3110 -
3111 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3112 -
3113 -(% class="box infomessage" %)
3114 -(((
3115 -**POST /api/v3/Trailers**
3116 -)))
3117 -
3118 -Пример запроса:
3119 -
3120 -{
3121 - "startDate": "2023-11-14T10:48:03.671Z",
3122 - "endDate": "2023-11-14T10:48:03.671Z",
3123 - "ids": [ 0 ],
3124 - "timezone": 0
3125 -}
3126 -
3127 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3128 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3129 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3130 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3131 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3132 -
3133 -Пример ответа:
3134 -
3135 -[
3136 - {
3137 - "SD": "2023-11-14T10:48:03.717Z",
3138 - "ED": "2023-11-14T10:48:03.717Z", 
3139 - "id": 0,
3140 - "SLat": 0,
3141 - "SLon": 0,
3142 - "ELat": 0,
3143 - "ELon": 0,
3144 - "mileage": 0
3145 - "Duration": 0
3146 - "Address": "string",
3147 - "Address2": "string",
3148 - "name": "string",
3149 - "rid": "string",
3150 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 - "trailer": {
3152 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3153 - "Number": "string",
3154 - "Description": "string",
3155 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3156 - "ExternalID": "string",
3157 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3158 - "CreateTime": "2023-11-14T10:48:03.717Z",
3159 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3160 - "IsDeleted": true
3161 - },
3162 - "filesCount": 0,
3163 - }
3164 -]
3165 -
3166 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3167 -|SD|Дата и время начала события
3168 -|ED|Дата и время окончания события
3169 -|id|ID объекта
3170 -|SLat|Широта начальной координаты
3171 -|SLon|Долгота начальной координаты
3172 -|ELat|Широта конечной координаты
3173 -|ELon|Долгота конечной координаты
3174 -|mileage|Пробег
3175 -|Duration|Продолжительность
3176 -|Address|Адрес начального местоположения
3177 -|Address2|Адрес конечного местоположения
3178 -|name|Имя радиометки
3179 -|rid|Номер радиометки
3180 -|rguid|ID радиометки
3181 -|trailer|Информация об агрегате
3182 -|ModelGuid|ID агрегата
3183 -|Number|Название/номер агрегата
3184 -|Description|Текст примечания агрегата
3185 -
3186 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3187 -
3188 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3189 -
3190 -(% class="box infomessage" %)
3191 -(((
3192 -**POST /api/v3/Rfids/find**
3193 -)))
3194 -
3195 -Запрос:
3196 -
3197 -{
3198 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3199 -}
3200 -
3201 -Ответ:
3202 -
3203 -[
3204 - {
3205 - "name": "string",
3206 - "number": 0,
3207 - "period": 0,
3208 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3209 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3210 - }
3211 -]
3212 -
3213 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3214 -|parentId|ID клиента
3215 -|name|Название карты-метки
3216 -|number|Номер
3217 -|period|Период запросов в секундах (работает только для агрегатов)
3218 -|id|ID карты-метки
3219 -
3220 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3221 -
3222 -(% class="box infomessage" %)
3223 -(((
3224 -**GET /api/v3/Rfids/{rfidGuid}**
3225 -)))
3226 -
3227 -Передаем параметр rfidGuid - идентификатор карты-метки
3228 -
3229 -Ответ:
3230 -
3231 -[
3232 - {
3233 - "name": "string",
3234 - "number": 0,
3235 - "period": 0,
3236 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3237 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3238 - }
3239 -]
3240 -
3241 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3242 -|name|Название карты-метки
3243 -|number|Номер
3244 -|period|Период запросов в секундах (работает только для агрегатов)
3245 -|id|ID карты-метки
3246 -|parentId|ID клиента
3247 -
3248 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3249 -
3250 -(% class="box successmessage" %)
3251 -(((
3252 -**POST /api/v3/Rfids**
3253 -)))
3254 -
3255 -Запрос:
3256 -
3257 -{
3258 - "name": "string",
3259 - "number": 0,
3260 - "period": 0,
3261 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3262 -}
3263 -
3264 -Ответ:
3265 -
3266 -{
3267 - "name": "string",
3268 - "number": 0,
3269 - "period": 0,
3270 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3271 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3272 -}
3273 -
3274 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3275 -|name|Название карты-метки
3276 -|number|Номер
3277 -|period|Период запросов в секундах (работает только для агрегатов)
3278 -|id|ID карты-метки
3279 -|parentId|ID клиента
3280 -
3281 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3282 -
3283 -(% class="box warningmessage" %)
3284 -(((
3285 -**PUT /api/v3/Rfids**
3286 -)))
3287 -
3288 -Запрос:
3289 -
3290 -{
3291 - "name": "string",
3292 - "number": 0,
3293 - "period": 0,
3294 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3295 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3296 -}
3297 -
3298 -Ответ:
3299 -
3300 -{
3301 - "name": "string",
3302 - "number": 0,
3303 - "period": 0,
3304 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3305 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3306 -}
3307 -
3308 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3309 -|name|Название карты-метки
3310 -|number|Номер
3311 -|period|Период запросов в секундах (работает только для агрегатов)
3312 -|id|ID карты-метки
3313 -|parentId|ID клиента
3314 -
3315 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3316 -
3317 -(% class="box errormessage" %)
3318 -(((
3319 -**DELETE /api/v3/Rfids/{rfidGuid}**
3320 -)))
3321 -
3322 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3323 -
3324 -Ответ:
3325 -
3326 -Success
3327 -
3328 -
3329 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3330 -
3331 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3332 -
3333 -(% class="box infomessage" %)
3334 -(((
3335 -**GET /api/v3/Billing/client/balance/{clientId}**
3336 -)))
3337 -
3338 -Параметр запроса: **clientId **- идентификатор клиента.
3339 -
3340 -Ответ:
3341 -
3342 -{
3343 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3344 - "Balance": 0
3345 -}
3346 -
3347 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3348 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3349 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3350 -
3351 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3352 -
3353 -(% class="box infomessage" %)
3354 -(((
3355 -**GET /api/v3/Billing/client/constraint/{clientId}**
3356 -)))
3357 -
3358 -Параметр запроса: **clientId **- идентификатор клиента.
3359 -
3360 -Ответ:
3361 -
3362 -{
3363 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3364 - "CalculationType": 0,
3365 - "PermissibleBalance": 0,
3366 - "DefermentDays": 0,
3367 - "SendUiNotifications": true,
3368 - "SendEmailNotifications": true,
3369 - "IsPrivate": true,
3370 -}
3371 -
3372 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3373 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3374 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3375 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3376 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3377 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3378 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3379 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3380 -
3381 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3382 -
3383 -(% class="box infomessage" %)
3384 -(((
3385 -**GET /api/v3/Billing/client/plan/{clientId}**
3386 -)))
3387 -
3388 -Параметры запроса:
3389 -
3390 -**clientId **- идентификатор клиента.
3391 -
3392 -**planId **- идентификатор тарифного плана.
3393 -
3394 -Ответ:
3395 -
3396 -{
3397 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3398 - "Plan": { **~/~/ Описание тарифного плана**
3399 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3400 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3401 - "Name": "string",
3402 - "IsArchived": true,
3403 - "Constraint": {
3404 - "CalculationType": 0,
3405 - "PermissibleBalance": 0,
3406 - "DefermentDays": 0
3407 - },
3408 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3409 - {
3410 - "Feature": "string",
3411 - "IsFactual": true,
3412 - "Limit": 0,
3413 - "Price": 0,
3414 - "PeriodValue": 0,
3415 - "PeriodType": 0
3416 - }
3417 - ]
3418 - },
3419 - "DebitDate": "2023-10-18T12:46:24.213Z",
3420 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3421 - {
3422 - "Feature": "string",
3423 - "IsEnabled": true,
3424 - "IsPrivate": true,
3425 - "IsFactual": true,
3426 - "Limit": 0,
3427 - "Price": 0,
3428 - "DebitDate": "2023-10-18T12:46:24.213Z",
3429 - "PeriodValue": 0,
3430 - "PeriodType": 0
3431 - }
3432 - ]
3433 -}
3434 -
3435 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3436 -|ClientId|Идентификатор клиента
3437 -|Id|Идентификатор тарифного плана
3438 -|OwnerId|Идентификатор клиента-владельца
3439 -|Name|Наименование тарифного плана
3440 -|IsArchived|Признак, определяющий архивный тарифный план
3441 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3442 -|PermissibleBalance|Допустимый баланс
3443 -|DefermentDays|Отсрочка, количество дней
3444 -|Feature|Код услуги
3445 -|IsEnabled|Признак, определяющий активирована ли услуга
3446 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3447 -|IsFactual|Признак, определяющий расчёт по факту
3448 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3449 -|Price|Цена за единицу.
3450 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3451 -|PeriodValue|Значение периода.
3452 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3453 -
3454 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3455 -
3456 -(% class="box infomessage" %)
3457 -(((
3458 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3459 -)))
3460 -
3461 -Параметр запроса: **clientId **- идентификатор клиента.
3462 -
3463 -Ответ:
3464 -
3465 -[
3466 - {
3467 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3468 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3469 - "Name": "string",
3470 - "IsArchived": true,
3471 - "Constraint": {
3472 - "CalculationType": 0,
3473 - "PermissibleBalance": 0,
3474 - "DefermentDays": 0
3475 - },
3476 - "Features": [
3477 - {
3478 - "Feature": "string",
3479 - "IsFactual": true,
3480 - "Limit": 0,
3481 - "Price": 0,
3482 - "PeriodValue": 0,
3483 - "PeriodType": 0
3484 - }
3485 - ]
3486 - }
3487 -]
3488 -
3489 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3490 -|ClientId|Идентификатор клиента
3491 -|Id|Идентификатор тарифного плана
3492 -|OwnerId|Идентификатор клиента-владельца
3493 -|Name|Наименование тарифного плана
3494 -|IsArchived|Признак, определяющий архивный тарифный план
3495 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3496 -|PermissibleBalance|Допустимый баланс
3497 -|DefermentDays|Отсрочка, количество дней
3498 -|Feature|Код услуги
3499 -|IsFactual|Признак, определяющий расчёт по факту
3500 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3501 -|Price|Цена за единицу.
3502 -|PeriodValue|Значение периода.
3503 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3504 -
3505 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3506 -
3507 -(% class="box infomessage" %)
3508 -(((
3509 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3510 -)))
3511 -
3512 -Параметр запроса: **clientId **- идентификатор клиента.
3513 -
3514 -Ответ:
3515 -
3516 -[
3517 - {
3518 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3520 - "Name": "string",
3521 - "IsArchived": true,
3522 - "Constraint": {
3523 - "CalculationType": 0,
3524 - "PermissibleBalance": 0,
3525 - "DefermentDays": 0
3526 - },
3527 - "Features": [
3528 - {
3529 - "Feature": "string",
3530 - "IsFactual": true,
3531 - "Limit": 0,
3532 - "Price": 0,
3533 - "PeriodValue": 0,
3534 - "PeriodType": 0
3535 - }
3536 - ]
3537 - }
3538 -]
3539 -
3540 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3541 -|ClientId|Идентификатор клиента
3542 -|Id|Идентификатор тарифного плана
3543 -|OwnerId|Идентификатор клиента-владельца
3544 -|Name|Наименование тарифного плана
3545 -|IsArchived|Признак, определяющий архивный тарифный план
3546 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3547 -|PermissibleBalance|Допустимый баланс
3548 -|DefermentDays|Отсрочка, количество дней
3549 -|Feature|Код услуги
3550 -|IsFactual|Признак, определяющий расчёт по факту
3551 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3552 -|Price|Цена за единицу.
3553 -|PeriodValue|Значение периода.
3554 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3555 -
3556 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3557 -
3558 -(% class="box warningmessage" %)
3559 -(((
3560 -**PUT /api/v3/Billing/client/balance**
3561 -)))
3562 -
3563 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3564 -
3565 -Тело запроса:
3566 -
3567 -{
3568 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3569 - "Balance": 0
3570 -}
3571 -
3572 -Ответ: Success
3573 -
3574 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3575 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3576 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3577 -
3578 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3579 -
3580 -(% class="box warningmessage" %)
3581 -(((
3582 -**PUT /api/v3/billing/client/balance/deposit**
3583 -)))
3584 -
3585 -Создает операцию **Пополнение **с указанной суммой
3586 -
3587 -Тело запроса:
3588 -
3589 -{
3590 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3591 - "Balance": 0
3592 -}
3593 -
3594 -Ответ: Success
3595 -
3596 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3597 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3598 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3599 -
3600 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3601 -
3602 -Создает операцию **Списание **с указанной суммой
3603 -
3604 -(% class="box warningmessage" %)
3605 -(((
3606 -**PUT /api/v3/billing/client/balance/withdraw**
3607 -)))
3608 -
3609 -Тело запроса:
3610 -
3611 -{
3612 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3613 - "Balance": 0
3614 -}
3615 -
3616 -Ответ: Success
3617 -
3618 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3619 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3620 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3621 -
3622 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3623 -
3624 -(% class="box warningmessage" %)
3625 -(((
3626 -**PUT /api/v3/Billing/client/constraint**
3627 -)))
3628 -
3629 -Тело запроса:
3630 -
3631 -{
3632 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3633 - "CalculationType": 0,
3634 - "PermissibleBalance": 0,
3635 - "DefermentDays": 0,
3636 - "SendUiNotifications": true,
3637 - "SendEmailNotifications": true,
3638 - "IsPrivate": true,
3639 -}
3640 -
3641 -Ответ: Success
3642 -
3643 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3644 -|ClientId|Идентификатор клиента
3645 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3646 -|PermissibleBalance|Допустимый баланс
3647 -|DefermentDays|(((
3648 -Отсрочка, количество дней
3649 -)))
3650 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3651 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3652 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3653 -
3654 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3655 -
3656 -(% class="box warningmessage" %)
3657 -(((
3658 -**PUT /api/v3/Billing/client/plan**
3659 -)))
3660 -
3661 -Тело запроса:
3662 -
3663 -{
3664 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3665 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3666 - "Features": [
3667 - {
3668 - "Feature": "string",
3669 - "IsEnabled": true,
3670 - "IsFactual": true,
3671 - "Limit": 0,
3672 - "Price": 0,
3673 - "DebitDate": "2023-10-18T13:26:58.987Z",
3674 - "PeriodValue": 0,
3675 - "PeriodType": 0
3676 - }
3677 - ]
3678 -}
3679 -
3680 -Ответ: Success
3681 -
3682 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3683 -|ClientId|Идентификатор клиента
3684 -|PlanId|Идентификатор тарифного плана
3685 -|Feature|Код услуги
3686 -|IsEnabled|Признак, определяющий активирована ли услуга
3687 -|IsFactual|Признак, определяющий расчёт по факту
3688 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3689 -|Price|Цена за единицу.
3690 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3691 -|PeriodValue|Значение периода.
3692 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3693 -
3694 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3695 -
3696 -(% class="box warningmessage" %)
3697 -(((
3698 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3699 -)))
3700 -
3701 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3702 -
3703 -(% class="box infomessage" %)
3704 -(((
3705 -**POST /api/v3/vehicles/import/{agentId}**
3706 -)))
3707 -
3708 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3709 -
3710 -В пути указывается **agentId** - id клиента.
3711 -
3712 -**Заголовок**
3713 -
3714 -**X-Auth: [токен авторизации]**
3715 -
3716 -**Параметры**
3717 -
3718 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3719 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3720 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3721 -
3722 -В теле использовать тип **form-data,** тип значения** file**
3723 -
3724 -**Ключи**
3725 -
3726 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3727 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3728 -|csv|В значении передаем файл датчиков, формат **csv**
3729 -
3730 -Ответ:
3731 -
3732 -{
3733 - "vehicleId": 0,
3734 - "name": "string",
3735 - "errors": ["string"]
3736 -}
3737 -
3738 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3739 -|vehicleId|ID созданного объекта
3740 -|name|Имя созданного объекта
3741 -|errors|Ошибки и их описание
3742 -
3743 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3744 -
3745 -(% class="box infomessage" %)
3746 -(((
3747 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3748 -)))
3749 -
3750 -(% class="wikigeneratedid" %)
3751 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3752 -
3753 -(% class="wikigeneratedid" %)
3754 -В пути указывается **vehicleId **- id объекта.
3755 -
3756 -**Заголовок**
3757 -
3758 -**X-Auth: [токен авторизации]**
3759 -
3760 -В теле использовать тип **form-data.**
3761 -
3762 -Ключи:
3763 -
3764 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3765 -|**history**|В значении передавать файл с историей
3766 -
3767 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3768 -
3769 -Ответ:
3770 -
3771 -{
3772 - "results": [
3773 - {
3774 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3775 - "vehicleId": 0,
3776 - "errors": [
3777 - "string"
3778 - ],
3779 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3780 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3781 - "producedCount": 0,
3782 - "msgCount": 0
3783 - }
3784 - ]
3785 -}
3786 -
3787 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3788 -|results|Результаты импорта в разрезе ТС
3789 -|vehicleGuid|Guid ТС
3790 -|vehicleId|ID ТС
3791 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3792 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3793 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3794 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3795 -|msgCount|Кол-во обработанных сообщений всего
3796 -
3797 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3798 -
3799 -(% class="box infomessage" %)
3800 -(((
3801 -**GET /api/v3/vehicles/import/history/status**
3802 -)))
3803 -
3804 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3805 -
3806 -Ответ:
3807 -
3808 -{
3809 - "activity": true,
3810 - "progress": 0,
3811 - "message": "string"
3812 -}
3813 -
3814 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3815 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3816 -|progress|Guid ТС
3817 -
3818 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3819 -
3820 -(% class="box infomessage" %)
3821 -(((
3822 -**POST /api/v3/vehicles/export**
3823 -)))
3824 -
3825 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3826 -
3827 -Тело запроса:
3828 -
3829 -[
3830 - id
3831 -]
3832 -
3833 -Ответ: Success 200, получаете файлы с настройками.
3834 -
3835 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3836 -
3837 -(% class="box infomessage" %)
3838 -(((
3839 -**POST /api/v3/vehicles/export/history**
3840 -)))
3841 -
3842 -Метод возвращает список сообщений терминала объекта за выбранный период.
3843 -
3844 -Тело запроса:
3845 -
3846 -{
3847 - "vehicleId": 0,
3848 - "asArchive": true,
3849 - "from": "2023-09-27T12:17:45.973Z",
3850 - "to": "2023-09-27T12:17:45.973Z"
3851 -}
3852 -
3853 -Ответ:
3854 -
3855 -Получаете файл. Сообщение: Code 200/Success
3856 -
3857 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3858 -|vehicleId|ID объекта
3859 -|asArchive|true - Архивировать файл, False - не архивировать
3860 -|from|Дата и время начала запроса
3861 -|to|Дата и время окончания запроса
3862 -
3863 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3864 -
3865 -(% class="box infomessage" %)
3866 -(((
3867 -**GET /api/v3/vehicles/export/history/status**
3868 -)))
3869 -
3870 -Метод возвращает список сообщений терминала объекта за выбранный период.
3871 -
3872 -Ответ:
3873 -
3874 -{
3875 - "activity": true,
3876 - "progress": 0,
3877 - "message": "string"
3878 -}
3879 -
3880 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3881 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3882 -|progress|Прогресс экспорта, от 0 до 100%
3883 -|message|Текст описывающий статус
3884 -
3885 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3886 -
3887 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3888 -
3889 -(% class="box infomessage" %)
3890 -(((
3891 -**POST /api/v3/EcoDriving/rating**
3892 -)))
3893 -
3894 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3895 -
3896 -Тело запроса:
3897 -
3898 -{
3899 - "vehicleIds": [vehicleId],
3900 - "from": "2023-11-22T09:29:48.051Z",
3901 - "to": "2023-11-22T09:29:48.051Z"
3902 -}
3903 -
3904 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3905 -|vehicleIds|Массив ID объектов
3906 -|from|Дата начала запроса
3907 -|to|Дата окончания запроса
3908 -
3909 -Ответ:
3910 -
3911 -{
3912 - "items": [
3913 - {
3914 - "from": "2023-11-22T09:29:48.052Z",
3915 - "to": "2023-11-22T09:29:48.052Z",
3916 - "vehicleId": 0,
3917 - "vehicleName": "string",
3918 - "vehicleModel": "string",
3919 - "penalty": 0,
3920 - "score": 0,
3921 - "totalViolations": 0,
3922 - "violationsByType": {
3923 - "overspeedingViolations": 0,
3924 - "accelerationViolations": 0,
3925 - "brakingViolations": 0,
3926 - "turningViolations": 0,
3927 - "dangerousDrivingViolations": 0,
3928 - "sensorViolations": 0
3929 - },
3930 - "moveTime": 0,
3931 - "mileage": 0,
3932 - "tripsCount": 0,
3933 - "trips": [
3934 - {
3935 - "penalty": 0,
3936 - "score": 0,
3937 - "violationsCount": 0,
3938 - "violationsByType": {
3939 - "overspeedingViolations": 0,
3940 - "accelerationViolations": 0,
3941 - "brakingViolations": 0,
3942 - "turningViolations": 0,
3943 - "dangerousDrivingViolations": 0,
3944 - "sensorViolations": 0
3945 - },
3946 - "moveTime": 0,
3947 - "mileage": 0,
3948 - "motohours": 0,
3949 - "maxSpeed": 0,
3950 - "startAddress": "string",
3951 - "endAddress": "string",
3952 - "drivers": [
3953 - {
3954 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3955 - "driverName": "string",
3956 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3957 - }
3958 - ]
3959 - }
3960 - ]
3961 - }
3962 - ]
3963 -}
3964 -
3965 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3966 -|from|Дата начала запроса
3967 -|to|Дата  окончания
3968 -|vehicleId|ID объекта
3969 -|vehicleName|Имя объекта
3970 -|vehicleModel|Модель объекта
3971 -|penalty|Сумма штрафных баллов
3972 -|score|Оценка
3973 -|totalViolations|Суммарное количество нарушений
3974 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3975 -|overspeedingViolations|Превышение скорости
3976 -|accelerationViolations|Ускорение
3977 -|brakingViolations|Торможение
3978 -|turningViolations|Резкий поворот
3979 -|dangerousDrivingViolations|Резкое вождение
3980 -|sensorViolations|Нарушение по датчику
3981 -|moveTime|Время в движении
3982 -|mileage|Пробег
3983 -|tripsCount|Количество рейсов
3984 -|motohours|Моточасы
3985 -|maxSpeed|Максимальная скорость
3986 -|startAddress|Адрес начала рейса
3987 -|endAddress|Адрес окончания рейса
3988 -|drivers|Список водителей, которые были на объекте в течениии рейса
3989 -|driverGuid|Guid водителя
3990 -|driverName|Имя водителя
3991 -|driverRfid|Номер Карты-метки
3992 -
3993 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
3994 -
3995 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
3996 -
3997 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
3998 -
3999 -(% class="box infomessage" %)
4000 -(((
4001 -POST /api/v3/fuelcards/transactions
4002 -)))
4003 -
4004 -Метод запроса: POST
4005 -
4006 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4007 -\\В заголовках запроса: X-Auth: Токен авторизации
4008 -
4009 -Параметры в теле запроса (JSON):
4010 -
4011 -{
4012 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4013 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4014 - "ids": [ 
4015 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4016 - ],
4017 - "timezone": 0 ~/~/Таймзона
4018 -}
4019 -
4020 -
4021 -Ответ:
4022 - {
4023 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4024 - "driver": "string", ~/~/Водители, привязанные к ТК
4025 - "object": "string", ~/~/Наименование ТС
4026 - "amount": 0, ~/~/Количество топлива
4027 - "amountDut": 0, ~/~/Количество по ДУТ
4028 - "amountDiff": 0, ~/~/Разница, л
4029 - "amountDiffPerc": 0, ~/~/Разница, %
4030 - "summa": 0, ~/~/Стоимость, руб
4031 - "serviceName": "string", ~/~/Тип топлива
4032 - "price": 0, ~/~/Цена за литр, руб
4033 - "cardName": "string", ~/~/Наименование ТК
4034 - "cardNum": "string", ~/~/Номер ТК
4035 - "operator": "string", ~/~/Оператор ТК
4036 - "address": "string" ~/~/Адрес АЗС
4037 - }
4038 -
4039 -
4040 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4041 -
4042 -
4043 -== **Получение полных данных о ретрансляторе** ==
4044 -
4045 -(% class="box infomessage" %)
4046 -(((
4047 -**GET ** **/api/v3/retranslations/{id}**
4048 -)))
4049 -
4050 -Идентификатор запроса: ID
4051 -
4052 -
4053 -Пример ответа:
4054 -
4055 -{  
4056 -"description": "", ~/~/ Определяет описание
4057 -"subscriberId": "", ~/~/ Подписчик
4058 -"protocolType": 0, ~/~/ Тип протокола
4059 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4060 -"address": "string", ~/~/ Адрес события
4061 -"objects": [ ~/~/Объекты для ретрансляции
4062 -{      
4063 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4064 -"name": "", ~/~/ Наименование объекта ретрансляции
4065 -"imei": "", ~/~/ IMEI объекта  
4066 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4067 -}
4068 - ],  
4069 -"id": "", ~/~/ идентификатор пользователя   
4070 -"parentId": "", ~/~/Guid родителя
4071 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4072 -}
4073 -
4074 -
4075 -== **Удаление данных ретранслятора** ==
4076 -
4077 -(% class="box infomessage" %)
4078 -(((
4079 -**DELETE** **/api/v3/retranslations/{id}**
4080 -)))
4081 -
4082 -Параметр запроса: ID
4083 -
4084 -
4085 -== **Создание ретранслятора** ==
4086 -
4087 -(% class="box infomessage" %)
4088 -(((
4089 -**POST ** **/api/v3/retranslations/{id}**
4090 -)))
4091 -
4092 -Запрос:
4093 -
4094 -{  
4095 -"description": "", ~/~/ Описание
4096 -"subscriberId": "", ~/~/ Подписчик
4097 -"protocolType": 0, ~/~/ Тип протокола
4098 -"address": "", ~/~/ Адрес ретрансляции
4099 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4100 -"objects": [ ~/~/Объекты для ретрансляции
4101 -{      
4102 -"id": "", ~/~/ идентификатор пользователя     
4103 -"imei": "", ~/~/IMEI объекта
4104 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4105 -}
4106 - ]
4107 -}
4108 -
4109 -
4110 -Ответ:
4111 -
4112 -{  
4113 -"description": "string", ~/~/ Определяет описание
4114 -"subscriberId": "", ~/~/ идентификатор запроса
4115 -"protocolType": 0, ~/~/ Тип протокола
4116 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4117 -"address": "", ~/~/ Адрес события
4118 -"objects": [ ~/~/Объекты для ретрансляции
4119 -{      
4120 -"id": "", ~/~/ идентификатор пользователя    
4121 -"name": "string", ~/~/ Название уведомления
4122 -"imei": "string", ~/~/IMEI объекта  
4123 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4124 -}
4125 - ],  
4126 -"id": "", ~/~/ идентификатор пользователя  
4127 -"parentId": "", ~/~/ Guid идентификатор родителя
4128 -"deleted": true ~/~/ Признак удаления
4129 -}
4130 -
4131 -
4132 -== **Редактирование ретранслятора** ==
4133 -
4134 -(% class="box infomessage" %)
4135 -(((
4136 -**PUT** **/api/v3/retranslations**
4137 -)))
4138 -
4139 -Пример запроса:
4140 -
4141 -{  
4142 -"id": "", ~/~/ идентификатор пользователя   
4143 -"description": "string", ~/~/ Определяет описание
4144 -"subscriberId": "", ~/~/ идентификатор запроса
4145 -"protocolType": 0, ~/~/ Тип протокола
4146 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4147 -"address": "string", ~/~/ Адрес события
4148 -"objects": ~/~/Объекты для ретрансляции
4149 -[    
4150 -{      
4151 -"id": "",  ~/~/ идентификатор пользователя         
4152 -"imei": "", ~/~/IMEI объекта
4153 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4154 -}
4155 - ]
4156 -}
4157 -
4158 -
4159 -Пример ответа:
4160 -
4161 -{  
4162 -"description": "", ~/~/ Определяет описание
4163 -"subscriberId": "", ~/~/ идентификатор запроса
4164 -"protocolType": 0, ~/~/ Тип протокола
4165 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4166 -"address": "string", ~/~/ Адрес события
4167 -"objects": [ ~/~/Объекты для ретрансляции
4168 -{      
4169 -"id": "", ~/~/ идентификатор пользователя     
4170 -"name": "string", ~/~/ Название уведомления    
4171 -"imei": "", ~/~/IMEI объекта
4172 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4173 -}
4174 - ],
4175 -"id": "", ~/~/ идентификатор пользователя   
4176 -"parentId": "", ~/~/ Guid идентификатор родителя
4177 -"deleted": true ~/~/ Признак удаления
4178 -}
4179 -
4180 -
4181 -== **Получение списка ретранслятора клиента** ==
4182 -
4183 -(% class="box infomessage" %)
4184 -(((
4185 -**POST /api/v3/retranslations/find**
4186 -)))
4187 -
4188 -Пример запроса:
4189 -
4190 -{  
4191 -"id": "", ~/~/ идентификатор пользователя   
4192 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4193 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4194 -}
4195 -
4196 -Ответ:
4197 -
4198 -[ 
4199 -{    
4200 -"description": "", ~/~/ Определяет описание
4201 -"subscriberId": "", ~/~/ идентификатор запроса
4202 -"protocolType": 0, ~/~/ Тип протокола
4203 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4204 -"address": "string", ~/~/ Адрес события
4205 -"id": "", ~/~/ идентификатор пользователя   
4206 -"parentId": "", ~/~/ Guid идентификатор родителя
4207 -"deleted": true ~/~/ Признак удаления
4208 -}
4209 -]
4210 -
4211 -
4212 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4213 -
4214 -== **API для отчета по выгрузке комбайнов** ==
4215 -
4216 -(% class="box infomessage" %)
4217 -(((
4218 -POST **/api/v3/Reports/harvesterUnloading**
4219 -)))
4220 -
4221 -Пример запроса:
4222 -
4223 -{
4224 - "byTime": 0, ~/~/ Объединение событий по времени
4225 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4226 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4227 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4228 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4229 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4230 - 0
4231 - ],
4232 - "from": "", ~/~/ Дата и время начало запроса
4233 - "to": "", ~/~/ Дата и время окончания запроса
4234 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4235 -}
4236 -
4237 -Пример ответа:
4238 -
4239 -[ 
4240 - {
4241 - "harvesterName": "", ~/~/Комбайн, номер
4242 - "harvesterId": 0, ~/~/Комбайн, id
4243 -"harvesterModel": "", ~/~/ Модель комбайна
4244 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4245 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4246 - "events": [ ~/~/Список событий в разрезе комбайна
4247 - {
4248 - "driverId": "", ~/~/Идентификатор водителя
4249 - "driverName": "", ~/~/Водитель комбайна, ФИО
4250 - "RFID": "", ~/~/ идентификатор карты-метки
4251 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4252 - "vehicleId": 0, ~/~/идентификатор объекта
4253 - "vehicleName": "string", ~/~/ Имя объекта
4254 - "modelName": "string", ~/~/ Имя модели объекта
4255 - "nearestVehicles": [ ~/~/Объекты рядом
4256 - {
4257 - "vehicleId": 0, ~/~/идентификатор объекта
4258 - "vehicleName": "string" ~/~/ Имя объекта
4259 - }
4260 - ],
4261 - "fields": [ ~/~/Поля, где происходила выгрузка
4262 - {
4263 - "id": 0, ~/~/ идентификатор пользователя 
4264 - "name": "string" ~/~/ имя пользователя 
4265 - }
4266 - ],
4267 - "event": "string", ~/~/Событие
4268 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4269 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4270 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4271 - "cultureName": "string", ~/~/ название культуры
4272 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4273 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4274 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4275 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4276 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4277 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4278 - "issued": 0, ~/~/Выдано, бункеров
4279 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4280 - "latitude": 0, ~/~/Широта
4281 - "longitude": 0, ~/~/ Долгота
4282 - "litresAway": 0, ~/~/Отдано, л
4283 - "m3Away": 0 ~/~/Отдано, м3
4284 - }
4285 - ]
4286 - }
4287 -]
4288 -
4289 -
4290 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4291 -
4292 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4293 -
4294 -
4295 -(% class="box infomessage" %)
4296 -(((
4297 -GET api/v3/Vehicles/recyclebin/all
4298 -)))
4299 -
4300 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4301 -
4302 -Параметр запроса: {parentId} - идентификатор агента
4303 -
4304 -В заголовках запроса: X-Auth: Токен авторизации
4305 -
4306 -Ответ:
4307 -
4308 -[ 
4309 - {
4310 - "recordTime": "", ~/~/Время записи
4311 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4312 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4313 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4314 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4315 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4316 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4317 - "items": [ ~/~/ 
4318 -nullable: true ~/~/Детали
4319 - {
4320 - "name": "string", ~/~/наименование столбца
4321 - "value": "string" ~/~/содержание столбца
4322 - }
4323 - ]
4324 - },
4325 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4326 - "string"
4327 - ]
4328 - }
4329 -]
4330 -
4331 -
4332 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4333 -
4334 -(% class="box infomessage" %)
4335 -(((
4336 -POST/api/v3/Vehicles/recyclebin/erase
4337 -)))
4338 -
4339 -В заголовках запроса: X-Auth: Токен авторизации
4340 -
4341 -Пример запроса:
4342 -
4343 -[
4344 -0
4345 -]
4346 -
4347 -
4348 -Пример ответа:
4349 -
4350 -[ 
4351 -{
4352 - "recordTime": "", ~/~/Время записи
4353 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4354 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4355 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
4356 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4357 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4358 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4359 - "items": [ ~/~/Детали
4360 - {
4361 - "name": "", ~/~/Имя свойства
4362 - "value": "" ~/~/Значение свойства
4363 - }
4364 - ]
4365 - },
4366 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4367 - ""
4368 - ]
4369 - }
4370 -]
4371 -
4372 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4373 -
4374 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4375 -
4376 -(% class="box infomessage" %)
4377 -(((
4378 -POST/api/v3/Vehicles/recyclebin/restore
4379 -)))
4380 -
4381 -В заголовках запроса: X-Auth: Токен авторизации
4382 -
4383 -Параметры в теле запроса (JSON):
4384 -
4385 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4386 -
4387 -В заголовках запроса: X-Auth: Токен авторизации
4388 -
4389 -
4390 -Пример запроса:
4391 -
4392 -(((
4393 -[
4394 -)))
4395 -
4396 -(((
4397 - 0
4398 -)))
4399 -
4400 -(((
4401 -]
4402 -)))
4403 -
4404 -
4405 -Пример ответа:
4406 -
4407 -[
4408 -{
4409 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4410 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4411 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4412 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4413 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4414 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4415 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4416 - "items": [ ~/~/Детали
4417 - {
4418 - "name": "string", ~/~/Имя свойства
4419 - "value": "string" ~/~/Значение свойства
4420 - }
4421 - ]
4422 - },
4423 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4424 - "string"
4425 - ]
4426 - }
4427 -]
4428 -
4429 -
4430 -
4431 4431  (% class="box" lang="en-US" style="text-align: center;" %)
4432 4432  (((
4433 4433  (% 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 г.