Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 38.1 >
edited by Илья Крайнов
on 2022/11/17 14:49
To version < 136.1 >
edited by Андрей Калиновский
on 2024/02/27 18:05
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -1,37 +1,37 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
6 +{{toc/}}
12 12  
8 +
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 23  (% class="box successmessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
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  
... ... @@ -38,8 +38,7 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}(%%)
42 -
41 +}
43 43  
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
... ... @@ -55,13 +55,20 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
58 58  
63 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 +
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
67 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
70 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,56 +72,307 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
81 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
83 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
84 +
85 +(% class="box infomessage" %)
77 77  (((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
87 +**GET api/v3/agents/{id}**
79 79  )))
80 80  
90 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
91 +
92 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
93 +
94 +(% style="color:#000000" %)Метод запроса: **GET**
95 +
96 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
97 +
98 +Запрос должен содержать данные параметра "**agentId**"
99 +
100 +(% style="color:#000000" %)Ответ:
101 +{
102 + "agentId": "",  (%%)
103 + "parentId": "",
104 + "parentName": "string",
105 + "name": "string",
106 + "fullName": "string",
107 + "agentInfoType": 0,
108 + "isForeign": true/false,
109 + "district": "string", 
110 + "region": "string",
111 + "city": "string",
112 + "inn": "string",
113 + "kpp": "string",
114 + "address": "string",
115 + "addressFact": "string",
116 + "email": "string",
117 + "director": "string",
118 + "bankName": "string",
119 + "bankBIK": "string",
120 + "bankRS": "string",
121 + "bankKS": "string"
122 + }
123 +
124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145 +
146 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147 +
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
150 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
153 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
90 90  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91 91  
92 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -(% style="color:#000000" %)Метод запроса: **GET**
161 +(% style="color:#000000" %)Метод запроса: **POST**
95 95  
96 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
163 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
165 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
167 +(% style="color:#000000" %){
168 + "parentId": "string"
169 +}
101 101  
102 102  (% style="color:#000000" %)Ответ:
103 103  
104 -(% style="color:#000000" %){
105 - "agentId": "", ~/~/ идентификатор клиента
106 - "parentId": "", ~/~/ идентификатор клиента-родителя
107 - "name": "", ~/~/ наименование клиента
108 - "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
173 +{
174 + "agentId": "",(% style="color:#000000" %)   (%%)
175 + "parentId": "",
176 + "name": "string",
177 + "fullName": "string",
178 + "agentInfoType": 0,
179 +(% style="color:#000000" %) "status": "",
111 111  }
112 112  
113 113  
114 -(% class="box" style="text-align: center;" %)
183 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
186 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
189 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
190 +
191 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
192 +
193 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
195 +**POST /api/v3/agents **
117 117  )))
118 118  
198 +Метод позволяет добавить клиента, указанного в запросе.
199 +
200 +Метод запроса: **POST**
201 +
202 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
203 +
204 +В заголовках запроса: X-Auth: Токен авторизации
205 +
206 +Параметры в теле запроса (JSON):
207 +
208 +{
209 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
210 + "name": "string", ~/~/ имя
211 + "fullName": "string", ~/~/ полное наименование
212 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
213 + "isForeign": true, ~/~/ иностранный контрагент
214 + "district": "string", ~/~/ округ
215 + "region": "string", ~/~/ регион
216 + "city": "string", ~/~/ город
217 + "inn": "string", ~/~/ ИНН
218 + "kpp": "string", ~/~/ КПП
219 + "address": "string", ~/~/ юридический адрес
220 + "addressFact": "string", ~/~/ фактический адрес
221 + "email": "string", ~/~/ email
222 + "director": "string", ~/~/ ФИО руководителя
223 + "bankName": "string", ~/~/ банк
224 + "bankBIK": "string", ~/~/ БИК
225 + "bankRS": "string", ~/~/ номер счёта
226 + "bankKS": "string" ~/~/ корр. счёт
227 +}
228 +
229 +
230 +Ответ:
231 +
232 +{
233 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
234 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
235 + "name": "string", ~/~/ имя
236 + "fullName": "string", ~/~/ полное наименование
237 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
238 + "isForeign": true, ~/~/ иностранный контрагент
239 + "district": "string", ~/~/ округ
240 + "region": "string", ~/~/ регион
241 + "city": "string", ~/~/ город
242 + "inn": "string", ~/~/ ИНН
243 + "kpp": "string", ~/~/ КПП
244 + "address": "string", ~/~/ юридический адрес
245 + "addressFact": "string", ~/~/ фактический адрес
246 + "email": "string", ~/~/ email
247 + "director": "string", ~/~/ ФИО руководителя
248 + "bankName": "string", ~/~/ банк
249 + "bankBIK": "string", ~/~/ БИК
250 + "bankRS": "string", ~/~/ номер счёта
251 + "bankKS": "string" ~/~/ корр. счёт
252 +}
253 +
254 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
255 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
256 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
257 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
258 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
259 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
260 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
261 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
262 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
263 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
264 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
265 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
266 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
267 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
268 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
269 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
270 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
271 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
272 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
273 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
274 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
275 +
276 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
277 +
278 +(% class="box warningmessage" %)
279 +(((
280 +**PUT /api/v3/agents**
281 +)))
282 +
283 +Метод позволяет отредактировать клиента, указанного в запросе.
284 +
285 +Метод запроса: **PUT**
286 +
287 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
288 +
289 +В заголовках запроса: X-Auth: Токен авторизации
290 +
291 +Параметры в теле запроса (JSON):
292 +
293 +{
294 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
295 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
296 + "name": "string", ~/~/ имя
297 + "fullName": "string", ~/~/ полное наименование
298 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
299 + "isForeign": true, ~/~/ иностранный контрагент
300 + "district": "string", ~/~/ округ
301 + "region": "string", ~/~/ регион
302 + "city": "string", ~/~/ город
303 + "inn": "string", ~/~/ ИНН
304 + "kpp": "string", ~/~/ КПП
305 + "address": "string", ~/~/ юридический адрес
306 + "addressFact": "string", ~/~/ фактический адрес
307 + "email": "string", ~/~/ email
308 + "director": "string", ~/~/ ФИО руководителя
309 + "bankName": "string", ~/~/ банк
310 + "bankBIK": "string", ~/~/ БИК
311 + "bankRS": "string", ~/~/ номер счёта
312 + "bankKS": "string" ~/~/ корр. счёт
313 +}
314 +
315 +Ответ:
316 +
317 +{
318 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
319 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
320 + "name": "string", ~/~/ имя
321 + "fullName": "string", ~/~/ полное наименование
322 + "isForeign": true, ~/~/ иностранный контрагент
323 + "district": "string", ~/~/ округ
324 + "region": "string", ~/~/ регион
325 + "city": "string", ~/~/ город
326 + "inn": "string", ~/~/ ИНН
327 + "kpp": "string", ~/~/ КПП
328 + "address": "string", ~/~/ юридический адрес
329 + "addressFact": "string", ~/~/ фактический адрес
330 + "email": "string", ~/~/ email
331 + "director": "string", ~/~/ ФИО руководителя
332 + "bankName": "string", ~/~/ банк
333 + "bankBIK": "string", ~/~/ БИК
334 + "bankRS": "string", ~/~/ номер счёта
335 + "bankKS": "string" ~/~/ корр. счёт
336 +}
337 +
338 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
339 +
340 +(% class="box errormessage" %)
341 +(((
342 +**DELETE /api/v3/agents/{clientId}**
343 +)))
344 +
345 +Метод позволяет удалить клиента, указанного в строке запроса.
346 +
347 +Метод запроса: **DELETE**
348 +
349 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
350 +
351 +Параметр запроса: **{clientId}** - Guid пользователя
352 +
353 +В заголовках запроса: X-Auth: Токен авторизации
354 +
355 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
356 +
357 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
358 +
359 +(% class="box warningmessage" %)
360 +(((
361 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
362 +)))
363 +
364 +Метод позволяет изменить статус клиента, указанного в запросе.
365 +
366 +В пути указывается GUID клиента и статус клиента.
367 +
368 +**status **- значение 0 - заблокирован, 1 - активен.
369 +
370 +Ответ: Code 204
371 +
372 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
373 +
374 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
375 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
378 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
381 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -131,26 +131,50 @@
131 131  
132 132  (% style="color:#000000" %)Параметры в теле запроса (JSON):
133 133  
134 -(% style="color:#000000" %){ 
391 +(% style="color:#000000" %)
392 +{ 
135 135   "lastName": "", ~/~/ фамилия
136 136   "firstName": "", ~/~/ имя
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
143 - "description": "", ~/~/ описание
144 - "isEnabled": "", ~/~/ признак включения
398 + "login": "", ~/~/ логин (обязателен)
399 + "password": "", ~/~/ пароль (обязателен)
400 + "email": "", ~/~/ email (обязателен)
401 + "description": "string", ~/~/ Описание
402 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
403 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
404 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
145 145   "parentId": "", ~/~/ Guid родительского агента
146 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
406 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
407 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
408 + "doubleAuth":
409 + {
410 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
411 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
412 + },
413 + "groups":
414 + [
415 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
416 + ],
417 + "customGroups":
418 + [
419 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
420 + ],
421 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
152 152  }
153 153  
424 +{
425 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
426 + "lastName": "string",
427 + "firstName": "string",
428 + "position": "string",
429 + "phone": "string",
430 + "organization": "string",
431 + "login": "string",
432 + "password": "string",
433 + "email": "string",
434 +
154 154  (% style="text-align:left" %)
155 155  (% style="color:#000000; font-weight:normal" %)Ответ:
156 156  
... ... @@ -174,18 +174,20 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
458 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
181 181  
182 182  
183 -(% class="box successmessage" %)
464 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
465 +
466 +(% class="box infomessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
468 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
471 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -222,17 +222,70 @@
222 222   "email": "" , ~/~/ E-mail
223 223   "sessionDuration":"", ~/~/ длительность сессии в минутах
224 224   "status": "1",  ~/~/ статус пользователя
225 - "astLogged": "", ~/~/ дата/время последней авторизации
508 + "lastLogged": "", ~/~/ дата/время последней авторизации
226 226  
227 227  (% style="color:#000000" %)}
228 228  
512 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
514 +(% class="box infomessage" %)
515 +(((
516 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
517 +)))
518 +
519 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
520 +
521 +(% style="color:#000000" %)Метод запроса: **GET**
522 +
523 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
524 +
525 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
526 +
527 +(% style="color:#000000" %)Ответ:
528 +
529 +(((
530 +(((
531 +{
532 + "id": "", ~/~/ GUID пользователя
533 + "lastName": "", ~/~/ Фамилия 
534 + "firstName": "", ~/~/ Имя
535 + "position": "", ~/~/ Должность
536 + "phone": "", ~/~/ Номер телефона
537 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
538 + "parentName": "", Наименование клиента, которому принадлежит пользователь
539 + "organization": "", ~/~/ Организация
540 + "login": "", ~/~/ Логин пользователя
541 + "email": "", ~/~/ Адрес электронной почты
542 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
543 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
544 + "description": "", ~/~/ Описание
545 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
546 + "doubleAuth":
547 + {
548 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
549 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
550 + },
551 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
552 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
553 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
554 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
555 + "groups": [], ~/~/ Список ролей пользователя
556 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
557 + "authDevices": [ ], ~/~/ Список авторизованных устройств
558 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
559 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
560 +}
561 +)))
562 +)))
563 +
564 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
565 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
568 +(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
571 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -253,17 +253,22 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
592 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
593 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
594 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
595 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
596 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
597 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 263   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 - "kind": "" , ~/~/ тип аутентификации
266 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
602 + "doubleAuth":
603 + {
604 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
605 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
606 + },
607 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
267 267   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
268 268  
269 269  (% lang="en-US" style="text-align:left" %)
... ... @@ -289,8 +289,12 @@
289 289   "isEnabled": "" , ~/~/ признак включения
290 290   "parentId": "" , ~/~/ Guid родительского агента
291 291   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 - "kind": "" , ~/~/ тип аутентификации
633 + "doubleAuth":
634 + {
635 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
636 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
637 + },
638 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
294 294   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 295   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
296 296  
... ... @@ -297,13 +297,14 @@
297 297  (% lang="en-US" style="text-align:left" %)
298 298  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
299 299  
645 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
300 300  
301 301  (% class="box warningmessage" %)
302 302  (((
303 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
649 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
652 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -326,13 +326,14 @@
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
675 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
329 329  
330 330  (% class="box warningmessage" %)
331 331  (((
332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
679 +**POST /api/v3/users/disable**
333 333  )))
334 334  
335 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
682 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
336 336  
337 337  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
338 338  
... ... @@ -347,13 +347,14 @@
347 347  
348 348  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
349 349  
697 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
350 350  
351 351  (% class="box warningmessage" %)
352 352  (((
353 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
701 +**POST /api/v3/users/enable**
354 354  )))
355 355  
356 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
704 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
357 357  
358 358  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
359 359  
... ... @@ -369,6 +369,7 @@
369 369  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 370  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371 371  
720 +(((
372 372  В теле ответа:
373 373  {
374 374   "errorMessages": [
... ... @@ -380,14 +380,16 @@
380 380  }
381 381  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 382  "users" - массив id пользователей, которых не удалось включить или отключить.
383 -
732 +)))
384 384  
734 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
735 +
385 385  (% class="box errormessage" %)
386 386  (((
387 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
738 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
388 388  )))
389 389  
390 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
741 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
391 391  
392 392  (% style="color:#000000" %)Метод запроса: **DELETE**
393 393  
... ... @@ -400,20 +400,261 @@
400 400  (% style="text-align:left" %)
401 401  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
402 402  
754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
403 403  
404 -(% class="box" style="text-align: center;" %)
756 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
757 +
758 +(% class="box infomessage" %)
405 405  (((
406 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
760 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
407 407  )))
408 408  
763 +Метод возвращает полную информацию о модели объекта.
764 +
765 +(% style="color:#000000" %)Метод запроса: **GET**
766 +
767 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
768 +
769 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
770 +
771 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
772 +
773 +(% style="color:#000000" %)Ответ:
774 +
775 +(% style="color:#000000" %){
776 + "parentName": "string",
777 + "name": "string",
778 + "picture": "string",
779 + "minspeed": 0,
780 + "maxspeed": 0,
781 + "width": 0,
782 + "imbeddedtrailer": true,
783 + "hoppercapacity": 0,
784 + "hopperdischargespeed": 0,
785 + "modelType": 0,
786 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
787 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
788 + "deleted": true
789 +}
790 +
791 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
792 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
793 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
794 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
795 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
796 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
797 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
798 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
799 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
800 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
801 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
802 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
803 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
804 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
805 +
806 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
807 +
808 +(% class="box successmessage" %)
809 +(((
810 +(% lang="en-US" %)**POST /api/v3/models/find**
811 +)))
812 +
813 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
814 +
815 +(% style="color:#000000" %)Метод запроса: **POST**
816 +
817 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
818 +
819 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
820 +
821 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
822 +
823 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
824 +}
825 +
826 +(% style="color:#000000" %)Ответ:
827 +
828 +(% style="color:#000000" %)[
829 + {
830 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "parentName": "string",
833 + "name": "string",
834 + "modelType": 0
835 + }
836 +]
837 +
838 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
839 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
840 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
841 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
842 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
844 +
845 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
846 +
847 +(% class="box successmessage" %)
848 +(((
849 +(% lang="en-US" %)**POST /api/v3/models**
850 +)))
851 +
852 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
853 +
854 +(% style="color:#000000" %)Метод запроса: **POST**
855 +
856 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
857 +
858 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
859 +
860 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
861 +
862 +{
863 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
864 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
865 + "deleted": true,
866 + "extId": "string",
867 + "name": "string",
868 + "picture": "string",
869 + "minspeed": 0,
870 + "maxspeed": 0,
871 + "width": 0,
872 + "imbeddedtrailer": true,
873 + "fueloutlay": 0,
874 + "hoppercapacity": 0,
875 + "hopperdischargespeed": 0,
876 + "modelType": 0
877 +}
878 +
879 +Ответ:
880 +
881 +{
882 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
883 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
884 + "deleted": true,
885 + "extId": "string",
886 + "name": "string",
887 + "picture": "string",
888 + "minspeed": 0,
889 + "maxspeed": 0,
890 + "width": 0,
891 + "imbeddedtrailer": true,
892 + "hoppercapacity": 0,
893 + "hopperdischargespeed": 0,
894 + "modelType": 0
895 +}
896 +
897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
898 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
899 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
900 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
901 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
903 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
904 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
905 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
906 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
907 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
908 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
909 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
910 +
911 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
912 +
913 +(% class="box warningmessage" %)
914 +(((
915 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
916 +)))
917 +
918 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
919 +
920 +(% style="color:#000000" %)Метод запроса: **PUT**
921 +
922 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
923 +
924 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
925 +
926 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
927 +
928 +{
929 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
931 + "deleted": true,
932 + "extId": "string",
933 + "name": "string",
934 + "picture": "string",
935 + "minspeed": 0,
936 + "maxspeed": 0,
937 + "width": 0,
938 + "imbeddedtrailer": true,
939 + "fueloutlay": 0,
940 + "hoppercapacity": 0,
941 + "hopperdischargespeed": 0,
942 + "modelType": 0
943 +}
944 +
945 +Ответ:
946 +
947 +{
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
950 + "deleted": true,
951 + "extId": "string",
952 + "name": "string",
953 + "picture": "string",
954 + "minspeed": 0,
955 + "maxspeed": 0,
956 + "width": 0,
957 + "imbeddedtrailer": true,
958 + "fueloutlay": 0,
959 + "hoppercapacity": 0,
960 + "hopperdischargespeed": 0,
961 + "modelType": 0
962 +}
963 +
964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
965 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
966 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
967 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
968 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
970 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
971 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
972 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
973 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
974 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
975 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
976 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
977 +
978 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
979 +
980 +(% class="box errormessage" %)
981 +(((
982 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
983 +)))
984 +
985 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
986 +
987 +(% style="color:#000000" %)Метод запроса: **DELETE**
988 +
989 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
990 +
991 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
992 +
993 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
994 +
995 +Ответ: В случае успеха **Success 200**
996 +
997 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
998 +
999 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1000 +
409 409  (% class="box infomessage" %)
410 410  (((
411 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1003 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
412 412  )))
413 413  
414 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1006 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
415 415  
416 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1008 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
417 417  
418 418  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
419 419  
... ... @@ -421,85 +421,192 @@
421 421  
422 422  (% style="color:#000000" %)Метод запроса: **GET**
423 423  
424 -(% 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>
1016 +(% 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}
425 425  
426 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
1018 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
427 427  
428 428  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
429 429  
430 430  (% style="color:#000000" %)Ответ:
431 431  
1024 +(((
432 432  {
433 -
434 434   "vehicleId": "", ~/~/ ID объекта
435 -
436 436   "name": "", ~/~/ Имя объекта
437 -
438 438   "imei": "", ~/~/ IMEI объекта
439 -
440 440   "deviceTypeId": , ~/~/ ID типа устройства
441 -
442 442   "deviceTypeName": "", ~/~/ Название типа устройства
443 -
444 444   "sim1": "", ~/~/ Номер SIM1
1032 + "sim2": "", ~/~/ Номер SIM2
445 445  
446 - "parentId": "", Номер SIM2
1034 + "parentId": "", ~/~/ ID клиента-родителя
1035 + "parentName": "", ~/~/ Наименование клиента-родителя
1036 + "modelId": "", ~/~/ ID модели объекта
1037 + "modelName": "", ~/~/ Имя модели объекта
447 447  
448 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
1039 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1040 + "unitName": "string", ~/~/ Наименование подразделения
1041 + "status": 0, ~/~/ Статус объекта
449 449  
450 - "modelId": "", ID модели объекта
1043 + "createdAt": "", ~/~/ Дата создания объекта
1044 + },
451 451  
452 - "modelName": "", Имя модели объекта
1046 +"customFields": [ ~/~/ Произвольные поля
1047 + {
1048 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1049 + "name": "string", ~/~/ Имя поля
1050 + "value": "string", ~/~/ Значение поля
1051 + "forClient": true, ~/~/ Не используемая функция
1052 + "forTooltip": true, ~/~/ Отображать в подсказке
1053 + "forReport": true ~/~/ Отображать в отчете
1054 + }
453 453  
454 - "createdAt": "", Дата создания объекта
1056 +], ~/~/ Данные с вкладки нормы
1057 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1058 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1059 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1060 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1061 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1062 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1063 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1064 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1065 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1066 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1067 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1068 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
455 455  
456 - "mileageCalcMethod": "", Выбранный метод расчета пробега
1070 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1071 + "mileageCoeff": 0, ~/~/ коэффициент пробега
1072 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1073 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1074 + "counters": { ~/~/ Счетчики
1075 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1076 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1077 + "mileage": 0, ~/~/ Текущий пробег
1078 + "motohours": 0, ~/~/ Текущие моточасы
1079 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1080 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1081 + },
457 457  
458 - "counters": { ~/~/ Нормы
1083 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1084 + "id": "string", ~/~/ ID объекта
1085 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
1086 + "host": "string", ~/~/ CMSV6 Web Host
1087 + "login": "string", ~/~/ CMSV6 Account
1088 + "password": "string" ~/~/ CMSV6 Password
1089 + },
459 459  
460 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
1091 +"commandTemplates": [ ~/~/ Шаблоны команд
1092 + {
1093 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1094 + "name": "string", ~/~/ Наименование команды
1095 + "command": "string", ~/~/ Текст команды
1096 + "retries": 0 ~/~/ Количество попыток
1097 + }
1098 + ],
461 461  
462 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
1100 + "sensors": [ ~/~/ Датчики
1101 + {
1102 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1103 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1104 + "type": 0, ~/~/ Тип датчика
1105 + "name": "string", ~/~/ Имя датчика
1106 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1107 + "inputNumber": 0, ~/~/ Номер входа
1108 + "pseudonym": "string", ~/~/ Псевдоним
1109 + "medianDegree": 0, ~/~/ Медианная фильтрация
1110 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1111 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1112 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1113 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1114 + {
1115 + "grades": [ ~/~/ Таблица тарировки 1
1116 + {
1117 + "input": 0, ~/~/ Входящее значение
1118 + "output": 0 ~/~/ Выходящее значение
1119 + }
1120 + ],
1121 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1122 + }
1123 + ],
1124 + "showInTooltip": true, ~/~/ Отображать в подсказке
1125 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1126 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1127 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1128 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1129 + "expr": "string", ~/~/ Формула
1130 + "children": [ ~/~/ массив дочерних датчиков
1131 + "string"
1132 + ],
1133 + "customParams": { ~/~/ прочие произвольные параметры
1134 + "additionalProp1": "string",
1135 + "additionalProp2": "string",
1136 + "additionalProp3": "string"
1137 + },
463 463  
464 - "mileage": "", ~/~/ Пробег по нормам в метрах
1139 +~/~/ Характерные для произвольного:
465 465  
466 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
1141 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
467 467  
468 - },
1143 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
469 469  
470 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1145 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
471 471  
472 - {
1147 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
473 473  
474 - "id": "", ~/~/ ID  задания
1149 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
475 475  
476 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1151 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
477 477  
478 - "name": "", ~/~/ Наименование задания
1153 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
479 479  
480 - "description": "", ~/~/ Описание задания
1155 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
481 481  
482 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1157 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
483 483  
484 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1159 +~/~/ "ValueOn": "Вкл.",
485 485  
486 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1161 +~/~/ "ValueOff": "Выкл."
1162 + "summaryMaxValue": 0 ~/~/ Макс. значение
1163 + }
487 487  
488 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1165 + "drivers": [ ~/~/ Водители
1166 + {
1167 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1168 + "name": "string", ~/~/ Наименование
1169 + "description": "string",
1170 + "isDefault": true ~/~/ По умолчанию
1171 + }
1172 + ],
489 489  
1174 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1175 + {
1176 + "id": "", ~/~/ ID  задания
1177 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1178 + "name": "", ~/~/ Наименование задания
1179 + "description": "", ~/~/ Описание задания
1180 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1181 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1182 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1183 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
490 490   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491 -
492 492   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 -
494 494   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495 -
496 496   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497 -
498 498   }
1189 + ],
499 499  
500 - ]
1191 + "statusHistory": [ ~/~/ История статусов
1192 + {
1193 + "status": 0,
1194 + "date": "2023-05-22T09:57:39.562Z",
1195 + "description": "string",
1196 + "additionalInfo": "string"
1197 + }
1198 + ]
501 501  
502 502  }
1201 +)))
503 503  
504 504  (% style="text-align:left" %)
505 505  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -507,13 +507,14 @@
507 507  (% style="text-align:left" %)
508 508  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
509 509  
1209 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
510 510  
511 511  (% class="box successmessage" %)
512 512  (((
513 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
1213 +(% lang="en-US" %)**POST /api/v3/vehicles**
514 514  )))
515 515  
516 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
1216 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
517 517  
518 518  (% style="color:#000000" %)Метод запроса: **POST**
519 519  
... ... @@ -545,6 +545,11 @@
545 545   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
546 546   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
547 547   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1248 +
1249 + "mileageCalcMethod": 0,
1250 + "mileageCoeff": 0,
1251 + "locationByCellId": true,
1252 + "dottedLineTrackWhenNoCoords": true,
548 548   "counters": ~/~/ счетчики
549 549   {
550 550   "mileage": "" , ~/~/ пробег
... ... @@ -574,8 +574,98 @@
574 574   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
575 575   }
576 576  
577 -(% style="color:#000000" %) }
1282 +"drivers": [ ~/~/ Водители
1283 + {
1284 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1285 + "isDefault": true
1286 + }
1287 + ],
1288 + "commandTemplates": [ ~/~/ Шаблон команды
1289 + {
1290 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1291 + "name": "string",
1292 + "command": "string",
1293 + "retries": 0
1294 + }
1295 + ],
578 578  
1297 + "sensors": [ ~/~/ Датчики
1298 + {
1299 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1300 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1301 + "type": 0, ~/~/ Тип датчика
1302 + "name": "string", ~/~/ Имя датчика
1303 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1304 + "inputNumber": 0, ~/~/ Номер входа
1305 + "pseudonym": "string", ~/~/ Псевдоним
1306 + "medianDegree": 0, ~/~/ Медианная фильтрация
1307 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1308 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1309 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1310 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1311 + {
1312 + "grades": [ ~/~/ Таблица тарировки 1
1313 + {
1314 + "input": 0, ~/~/ Входящее значение
1315 + "output": 0 ~/~/ Выходящее значение
1316 + }
1317 + ],
1318 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1319 + }
1320 + ],
1321 + "showInTooltip": true, ~/~/ Отображать в подсказке
1322 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1323 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1324 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1325 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1326 + "expr": "string", ~/~/ Формула
1327 + "children": [ ~/~/ массив дочерних датчиков
1328 + "string"
1329 + ],
1330 + "customParams": { ~/~/ прочие произвольные параметры
1331 + "additionalProp1": "string",
1332 + "additionalProp2": "string",
1333 + "additionalProp3": "string"
1334 + },
1335 +
1336 +~/~/ Характерные для произвольного:
1337 +
1338 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1339 +
1340 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1341 +
1342 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1343 +
1344 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1345 +
1346 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1347 +
1348 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1349 +
1350 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1351 +
1352 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1353 +
1354 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1355 +
1356 +~/~/ "ValueOn": "Вкл.",
1357 +
1358 +~/~/ "ValueOff": "Выкл."
1359 + "summaryMaxValue": 0 ~/~/ Макс. значение
1360 + }
1361 + ],
1362 + "customFields": [ ~/~/ Произвольные поля
1363 + {
1364 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1365 + "name": "string",
1366 + "value": "string",
1367 + "forClient": true,
1368 + "forTooltip": true,
1369 + "forReport": true
1370 + }
1371 + ]
1372 +}
1373 +
579 579  (% style="color:#000000" %)Ответ:
580 580  
581 581  (% style="color:#000000" %){
... ... @@ -626,15 +626,16 @@
626 626  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
627 627  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
628 628  
1424 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
629 629  
630 -(% class="box successmessage" %)
1426 +(% class="box infomessage" %)
631 631  (((
632 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1428 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
633 633  )))
634 634  
635 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1431 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
636 636  
637 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1433 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
638 638  
639 639  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
640 640  
... ... @@ -660,19 +660,19 @@
660 660  
661 661  (% style="color:#000000" %)Параметры в теле запроса (JSON):
662 662  
663 -(% class="western" style="color:#000000" %)##{##
1459 +{
1460 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1461 + "name": null, ~/~/ Имя ТС (string, опционально)
1462 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1463 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1464 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1465 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1466 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1467 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1468 +}
664 664  
665 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
666 - "name": null, ~/~/ Имя ТС (string, опционально) 
667 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
668 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
669 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
670 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
671 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
672 -(% style="color:#000000" %)}
1470 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
673 673  
674 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
675 -
676 676  (% style="color:#000000" %)Ответ:
677 677  
678 678  (% style="color:#000000" %){
... ... @@ -693,18 +693,28 @@
693 693   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
694 694   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
695 695   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
696 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
1492 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1493 + "customFields": [ 
1494 + {
1495 + "id": "", ~/~/ идентификатор произвольного поля
1496 + "name": "", ~/~/ имя произвольного поля
1497 + "value": "", ~/~/ значение произвольного поля
1498 + "forClient": true, ~/~/ право на отображение у клиента
1499 + "forTooltip": false, ~/~/ право на отображение в подсказке
1500 + "forReport": false ~/~/ право на отображение в отчетах
1501 + }(%%)
697 697  (% style="color:#000000" %)}
698 698  
699 699  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
700 700  
1506 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
701 701  
702 702  (% class="box successmessage" %)
703 703  (((
704 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1510 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
705 705  )))
706 706  
707 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1513 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
708 708  
709 709  (% style="color:#000000" %)Метод запроса: **POST**
710 710  
... ... @@ -743,13 +743,14 @@
743 743  (% style="text-align:left" %)
744 744  (% style="color:#000000" %) }
745 745  
1552 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
746 746  
747 747  (% class="box warningmessage" %)
748 748  (((
749 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1556 +(% lang="en-US" %)**PUT /api/v3/vehicles**
750 750  )))
751 751  
752 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1559 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
753 753  
754 754  (% style="color:#000000" %)Метод запроса: **PUT**
755 755  
... ... @@ -759,18 +759,16 @@
759 759  
760 760  (% style="color:#000000" %)Параметры в теле запроса (JSON):
761 761  
762 -(% style="color:#000000" %){    
763 -
764 -(((
765 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
766 - "parentId": "", ~/~/ ID клиента
767 - "name": "", ~/~/ имя ТС
768 - "imei": "", ~/~/ IMEI
769 - "deviceTypeId": "", ~/~/ ID типа устройства
770 - "modelId": "", ~/~/ , ID модели    
771 - "unitId": "", ~/~/ подразделения
772 - "sim1": "", ~/~/ SIM 1
773 - "sim2": "", ~/~/ SIM2     (%%)
1569 +(% style="color:#000000" %){
1570 + "vehicleId": , ~/~/ ID объекта
1571 + "parentId": "" , ~/~/ ID клиента
1572 + "name": "" , ~/~/ имя ТС
1573 + "imei": "" , ~/~/ IMEI
1574 + "deviceTypeId": "" , ~/~/ ID типа устройства
1575 + "modelId": "" , ~/~/ ID модели
1576 + "unitId": "" , ~/~/ ID подразделения
1577 + "sim1": "" , ~/~/ Номер SIM 1
1578 + "sim2": "" , ~/~/ Номер SIM2
774 774   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
775 775   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
776 776   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -783,39 +783,132 @@
783 783   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
784 784   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
785 785   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
786 -(% style="color:#000000" %) "counters": 
787 - {
788 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
789 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
790 - "mileage": "", ~/~/ пробег, в метрах 
791 - "motohours": "" ~/~/ моточасы, в секундах
792 - }
793 - "cmsv6Parameters": ~/~/ параметры CMSv6
794 - {       
795 - "id": "", ~/~/ идентификатор
796 - "enabled": true, ~/~/ флаг включения
797 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
798 - "login": "", ~/~/ имя учетной записи
799 - "password": "", ~/~/ пароль учетной записи
800 - }
801 - "inspectionTasks": ~/~/ задания на ТО
802 - {
803 - "id": "", ~/~/ ID задания
804 - "enabled": false, ~/~/ Признак включения
805 - "name": "", ~/~/ Имя задания
806 - "description": "", ~/~/ Описание задания
807 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
808 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
809 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
810 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
811 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
812 - "kind": "", ~/~/ Вид периодичности по времени
813 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
814 - } 
815 -)))
816 816  
817 -(% style="color:#000000" %)}
1592 + "mileageCalcMethod": 0,
1593 + "mileageCoeff": 0,
1594 + "locationByCellId": true,
1595 + "dottedLineTrackWhenNoCoords": true,
1596 + "counters": ~/~/ счетчики
1597 + {
1598 + "mileage": "" , ~/~/ пробег
1599 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1600 + "motohours": "" , ~/~/ моточасы
1601 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1602 + },
1603 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1604 + "enabled": true, ~/~/ флаг включения
1605 + "id": "" , ~/~/ идентификатор
1606 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1607 + "login": "" , ~/~/ имя учетной записи
1608 + "password": "" ~/~/ пароль учетной записи
1609 + },
1610 + "inspectionTasks": ~/~/ задания на ТО
1611 + {
1612 + "enabled": "" , ~/~/ Признак включения
1613 + "name": "" , ~/~/ Имя задания
1614 + "description": "" , ~/~/ Описание задания
1615 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1616 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1617 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1618 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1619 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1620 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1621 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1622 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1623 + }
818 818  
1625 +"drivers": [ ~/~/ Водители
1626 + {
1627 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1628 + "isDefault": true
1629 + }
1630 + ],
1631 + "commandTemplates": [ ~/~/ Шаблон команды
1632 + {
1633 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1634 + "name": "string",
1635 + "command": "string",
1636 + "retries": 0
1637 + }
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 +~/~/ Характерные для произвольного:
1680 +
1681 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1682 +
1683 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1684 +
1685 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1686 +
1687 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1688 +
1689 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1690 +
1691 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1692 +
1693 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1694 +
1695 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1696 +
1697 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1698 +
1699 +~/~/ "ValueOn": "Вкл.",
1700 +
1701 +~/~/ "ValueOff": "Выкл."
1702 + "summaryMaxValue": 0 ~/~/ Макс. значение
1703 + }
1704 + ],
1705 + "customFields": [ ~/~/ Произвольные поля
1706 + {
1707 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1708 + "name": "string",
1709 + "value": "string",
1710 + "forClient": true,
1711 + "forTooltip": true,
1712 + "forReport": true
1713 + }
1714 + ]
1715 +}
1716 +
819 819  (% style="color:#000000" %)Ответ:
820 820  
821 821  (% lang="en-US" style="text-align:left" %)
... ... @@ -866,18 +866,19 @@
866 866  (% lang="en-US" style="text-align:left" %)
867 867  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
868 868  
869 -**валидация:**
1767 +**Валидация:**
870 870  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
871 871  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
872 872  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
873 873  
1772 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
874 874  
875 875  (% class="box errormessage" %)
876 876  (((
877 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1776 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
878 878  )))
879 879  
880 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1779 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
881 881  
882 882  (% style="color:#000000" %)Метод запроса: **DELETE**
883 883  
... ... @@ -890,22 +890,20 @@
890 890  (% style="text-align:left" %)
891 891  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
892 892  
1792 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
893 893  
894 -(% class="box" lang="en-US" style="text-align: center;" %)
895 -(((
896 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
897 -)))
1794 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
898 898  
899 899  (% class="box infomessage" %)
900 900  (((
901 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1798 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
902 902  )))
903 903  
904 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1801 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
905 905  
906 906  (% style="color:#000000" %)Метод запроса: **GET**
907 907  
908 -(% 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]]
1805 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
909 909  
910 910  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911 911  
... ... @@ -919,24 +919,22 @@
919 919  (% style="text-align:left" %)
920 920  (% style="color:#000000" %)}
921 921  
1819 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
922 922  
923 -(% class="box" style="text-align: center;" %)
924 -(((
925 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
926 -)))
1821 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
927 927  
928 928  (% class="box infomessage" %)
929 929  (((
930 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1825 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
931 931  )))
932 932  
933 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1828 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
934 934  
935 935  (% style="color:#000000" %)Метод запроса: **GET**
936 936  
937 937  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
938 938  
939 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1834 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
940 940  
941 941  (% style="color:#000000" %)Ответ:
942 942  
... ... @@ -949,7 +949,2219 @@
949 949  (% style="text-align:left" %)
950 950  (% style="color:#000000" %)}
951 951  
1847 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
952 952  
1849 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1850 +
1851 +(% class="box infomessage" style="text-align: left;" %)
1852 +(((
1853 +**POST /api/v3/terminalMessages/count**
1854 +)))
1855 +
1856 +(% style="text-align: left;" %)
1857 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1858 +
1859 +(% style="text-align: left;" %)
1860 +Метод запроса **POST**
1861 +
1862 +(% style="text-align: left;" %)
1863 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1864 +
1865 +(% style="text-align: left;" %)
1866 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1867 +
1868 +(% style="text-align: left;" %)
1869 +{
1870 + "vehicleIds": [
1871 + id ~/~/ здесь передается список идентификаторов объектов
1872 + ],
1873 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1874 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1875 +}
1876 +
1877 +(% style="text-align: left;" %)
1878 +Ответ:
1879 +
1880 +(% style="text-align: left;" %)
1881 +[
1882 + {
1883 + "vehicleId": 0, ~/~/ идентификатор объекта
1884 + "count": 0 ~/~/ количество сообщений за период
1885 + }
1886 +]
1887 +
1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889 +
1890 +(% class="box infomessage" style="text-align: left;" %)
1891 +(((
1892 +**POST /api/v3/terminalMessages/mapping**
1893 +)))
1894 +
1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896 +
1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898 +
1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900 +
1901 +{
1902 + "protocolType": 0,
1903 + "params": ["string"]
1904 +}
1905 +
1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 +|protocolType|ID типа протокола
1908 +|params|(((
1909 +Массив наименований параметров в сообщении
1910 +)))
1911 +
1912 +Ответ:
1913 +
1914 +{
1915 + "protocolType": 0,
1916 + "mapping": {
1917 + "additionalProp1": {
1918 + "inputType": 0,
1919 + "inputNumber": 0
1920 + },
1921 + "additionalProp2": {
1922 + "inputType": 0,
1923 + "inputNumber": 0
1924 + }
1925 + }
1926 +}
1927 +
1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 +|protocolType|Тип протокола
1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 +|inputNumber|Номер входа
1932 +
1933 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1934 +
1935 +(% class="box infomessage" %)
1936 +(((
1937 +**POST /api/v3/terminalMessages**
1938 +)))
1939 +
1940 +Метод возвращает список сообщений терминала объекта за выбранный период.
1941 +
1942 +(% style="text-align: left;" %)
1943 +Метод запроса **POST**
1944 +
1945 +(% style="text-align: left;" %)
1946 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1947 +
1948 +(% style="text-align: left;" %)
1949 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1950 +
1951 +{
1952 + "vehicleId": 0, ~/~/ id объекта
1953 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1954 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1955 +}
1956 +
1957 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 +|vehicleId|ID объекта
1959 +|from|Дата и время начала периода запроса
1960 +|to|Дата и время окончания периода запроса
1961 +
1962 +Ответ:
1963 +
1964 +[
1965 + {
1966 + "messages": [
1967 + {
1968 + "deviceTime": "2023-11-29T07:40:44.052Z",
1969 + "serverTime": "2023-11-29T07:40:44.052Z",
1970 + "speed": 0,
1971 + "altitude": 0,
1972 + "latitude": 0,
1973 + "longitude": 0,
1974 + "satellites": 0,
1975 + "course": 0,
1976 + "voltage": 0,
1977 + "parameters": {
1978 + "additionalProp1": "string",
1979 + "additionalProp2": "string",
1980 + "additionalProp3": "string"
1981 + },
1982 + "photoCount": 0,
1983 + "lbsCorrectedCoords": true,
1984 + "protocolType": 0
1985 + }
1986 + ]
1987 + }
1988 +]
1989 +
1990 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 +|deviceTime|Время сообщения терминала
1992 +|serverTime|Время когда сообщение поступило на сервер
1993 +|speed|Скорость
1994 +|altitude|Высота над уровнем моря
1995 +|latitude|Широта
1996 +|longitude|Долгота
1997 +|satellites|Кол-во спутников
1998 +|course|Курс
1999 +|voltage|Бортовое напряжение
2000 +|parameters|Список параметров и их значений
2001 +|photoCount|Количество фото
2002 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 +|protocolType|ID типа протокола
2004 +
2005 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 +
2007 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2008 +
2009 +(% class="box infomessage" %)
2010 +(((
2011 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2012 +)))
2013 +
2014 +(% style="color:#000000" %)Метод запроса: **POST**
2015 +
2016 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2017 +
2018 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2019 +
2020 +(% style="text-align:left" %)
2021 +Тело запроса:
2022 +
2023 +{
2024 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2025 + "vehicleIds": [0], ~/~/ Список ID объектов
2026 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2027 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2028 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2029 +}
2030 +
2031 +Ответ:
2032 +
2033 +[
2034 + {
2035 + "vehicleId": 0, ~/~/ ID объекта
2036 + "name": "string", ~/~/ Имя ТС
2037 + "periods": [ ~/~/ Периоды
2038 + {
2039 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2040 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2041 + "mileageBegin": 0, ~/~/ Пробег на начало периода
2042 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
2043 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2044 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2045 + }
2046 + ]
2047 + }
2048 +]
2049 +
2050 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2051 +
2052 +(% class="box infomessage" %)
2053 +(((
2054 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2055 +)))
2056 +
2057 +(% style="color:#000000" %)Метод запроса: **POST**
2058 +
2059 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2060 +
2061 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2062 +
2063 +(% style="text-align:left" %)
2064 +Тело запроса:
2065 +
2066 +{
2067 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2068 + "vehicleIds": [0], ~/~/ Список ID объектов
2069 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2070 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2071 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2072 +}
2073 +
2074 +Ответ:
2075 +
2076 +[
2077 + {
2078 + "vehicleId": 0, ~/~/ ID объекта
2079 + "name": "string", ~/~/ Имя ТС
2080 + "periods": [ ~/~/ Периоды
2081 + {
2082 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2083 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2084 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2085 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2086 + "fuelConsumption": 0, ~/~/ Расход топлива
2087 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2088 + }
2089 + ]
2090 + }
2091 +]
2092 +
2093 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2094 +
2095 +(% class="box infomessage" %)
2096 +(((
2097 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2098 +)))
2099 +
2100 +(% style="color:#000000" %)Метод запроса: **POST**
2101 +
2102 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2103 +
2104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2105 +
2106 +(% style="text-align:left" %)
2107 +Тело запроса:
2108 +
2109 +{
2110 + "vehicleIds": [0], ~/~/ Список ID объектов
2111 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2112 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2113 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2114 +}
2115 +
2116 +Ответ:
2117 +
2118 +[
2119 + {
2120 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2121 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2122 + "vehicleId": 0, ~/~/ ID объекта
2123 + "name": "string", ~/~/ Имя объекта
2124 + "model": "string", ~/~/ Модель объекта
2125 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2126 + {
2127 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2128 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2129 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2130 + "valueFuel": 0, ~/~/ Количество
2131 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2132 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2133 + }
2134 + ]
2135 + }
2136 +]
2137 +
2138 +
2139 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2140 +
2141 +(% class="box infomessage" %)
2142 +(((
2143 +**POST/api/v3/vehicles/moveStop**
2144 +)))
2145 +
2146 +Метод запроса: **POST**
2147 +
2148 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2149 +
2150 +В заголовках запроса: X-Auth: Токен авторизации
2151 +
2152 +
2153 +Тело запроса:
2154 +
2155 +{
2156 +
2157 + "vehicleIds": [ ], ~/~/ Список ID объектов
2158 +
2159 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2160 +
2161 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2162 +
2163 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2164 +
2165 +}
2166 +
2167 +Ответ:
2168 +
2169 +[
2170 +
2171 + {
2172 +
2173 + "vehicleId": 0, ~/~/ ID объекта
2174 +
2175 + "vehicleName": "string", ~/~/ Имя объекта
2176 +
2177 + "moves": [ ~/~/ Событие движения
2178 +
2179 + {
2180 +
2181 + "mileage": 0, ~/~/ Пробег, км
2182 +
2183 + "eventId": 0, ~/~/ Идентификатор события
2184 +
2185 + "eventName": "string", ~/~/ Название события
2186 +
2187 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2188 +
2189 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2190 +
2191 + "duration": 0 ~/~/ Продолжительность события, секунд
2192 +
2193 + }
2194 +
2195 + ],
2196 +
2197 + "stops": [ ~/~/ События стоянок
2198 +
2199 + {
2200 +
2201 + "address": "string", ~/~/ Адрес события
2202 +
2203 + "eventId": 0, ~/~/ Идентификатор события
2204 +
2205 + "eventName": "string", ~/~/ Название события
2206 +
2207 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2208 +
2209 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2210 +
2211 + "duration": 0 ~/~/ Продолжительность события, секунд
2212 +
2213 +
2214 + }
2215 +
2216 + ]
2217 +
2218 + }
2219 +
2220 +]
2221 +
2222 +
2223 +
2224 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2225 +
2226 +(% class="box infomessage" %)
2227 +(((
2228 +**POST/api/v3/vehicles/getlastdata**
2229 +)))
2230 +
2231 +Метод запроса: **POST**
2232 +
2233 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2234 +
2235 +В заголовках запроса: X-Auth: Токен авторизации
2236 +
2237 +
2238 +Тело запроса:
2239 +
2240 +{
2241 +
2242 + "vehicleIds": [ ], ~/~/ Список ID машины
2243 +
2244 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2245 +
2246 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2247 +
2248 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2249 +
2250 +}
2251 +
2252 +
2253 +Ответ:
2254 +
2255 +[
2256 + {
2257 + "vehicleId": 0, ~/~/Идентификатор объекта.
2258 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2259 + "vehicleNumber": "string",~/~/Номер объекта.
2260 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2261 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на траспортном средстве.
2262 + "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных.
2263 + "speed": 0,~/~/Скорость объекта.
2264 + "course": 0,~/~/Курс движения [0;360]
2265 + "latitude": 0,~/~/Широта [-90°;90°].
2266 + "longitude": 0,~/~/Долгота [-180°;180°].
2267 + "address": "string",~/~/Адрес.
2268 + "geozones": [ ~/~/Сведения по геозонам.
2269 + {
2270 + "id": 0,
2271 + "name": "string"
2272 + }
2273 + ]
2274 + }
2275 +]
2276 +
2277 +
2278 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2279 +
2280 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2281 +
2282 +(% class="box infomessage" %)
2283 +(((
2284 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2285 +)))
2286 +
2287 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2288 +
2289 +(% style="color:#000000" %)Метод запроса: **POST**
2290 +
2291 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2292 +
2293 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2294 +
2295 +(% style="text-align:left" %)
2296 +Тело запроса:
2297 +
2298 +(% style="text-align:left" %)
2299 +{
2300 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2301 +}
2302 +
2303 +(% style="text-align:left" %)
2304 +Ответ:
2305 +
2306 +[
2307 + {
2308 + "id": 0, ~/~/ Идентификатор объекта геозоны
2309 + "name": "string", ~/~/ Название объекта геозоны
2310 + "type": 0, ~/~/ Тип объекта геозоны
2311 + "fname": "string", ~/~/ Имя файла
2312 + "parentId": "string", ~/~/ Идентификатор клиента
2313 + "radius": 0, ~/~/ Радиус геообъекта
2314 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2315 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2316 + "description": "string", ~/~/ Описание
2317 + "area": 0, ~/~/ Площадь, м^^2^^
2318 + "perimetr": 0, ~/~/ Периметр, м
2319 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2320 + }
2321 +]
2322 +
2323 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2324 +
2325 +(% class="box infomessage" %)
2326 +(((
2327 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2328 +)))
2329 +
2330 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2331 +
2332 +(% style="color:#000000" %)Метод запроса: **POST**
2333 +
2334 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2335 +
2336 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2337 +
2338 +(% style="text-align:left" %)
2339 +Тело запроса:
2340 +
2341 +{
2342 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2343 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2344 + "ids": [ ], ~/~/ Массив id объектов
2345 + "byTime": 0, ~/~/ Объединение событий по времени 
2346 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2347 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2348 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2349 +}
2350 +
2351 +Ответ:
2352 +[
2353 + {
2354 + "geozoneId": 0, ~/~/ ID геообъекта
2355 + "geozoneName": "string", ~/~/ Название геообъекта
2356 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2357 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2358 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2359 + "vehicleId": 0, ~/~/ ID объекта
2360 + "vehicleName": "string" ~/~/ Имя объекта
2361 + }
2362 +]
2363 +
2364 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2365 +
2366 +(% class="box infomessage" %)
2367 +(((
2368 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2369 +)))
2370 +
2371 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2372 +
2373 +(% style="color:#000000" %)Метод запроса: **POST**
2374 +
2375 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2376 +
2377 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2378 +
2379 +(% style="text-align:left" %)
2380 +Тело запроса:
2381 +
2382 +{
2383 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2384 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2385 + "ids": [ ], ~/~/ Массив id геообъектов
2386 + "byTime": 0, ~/~/ Объединение событий по времени 
2387 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2388 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2389 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2390 +}
2391 +
2392 +Ответ:
2393 +
2394 +[
2395 + {
2396 + "geozoneId": 0, ~/~/ ID геообъекта
2397 + "geozoneName": "string", ~/~/ Название геообъекта
2398 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2399 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2400 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2401 + "vehicleId": 0, ~/~/ ID объекта
2402 + "vehicleName": "string" ~/~/ Имя объекта
2403 + }
2404 +]
2405 +
2406 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2407 +
2408 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2409 +
2410 +(% class="box infomessage" %)
2411 +(((
2412 +**POST /api/v3/notifications/find**
2413 +)))
2414 +
2415 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2416 +
2417 +(% style="text-align: left;" %)
2418 +Метод запроса **POST**
2419 +
2420 +(% style="text-align: left;" %)
2421 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2422 +
2423 +(% style="text-align: left;" %)
2424 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2425 +
2426 +{
2427 + "parentId": "" ~/~/ id клиента
2428 +}
2429 +
2430 +Ответ:
2431 +
2432 +[
2433 + {
2434 + "id": 0, ~/~/ ID уведомления
2435 + "name": "string", ~/~/ Название уведомления
2436 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2437 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2438 + "userId": "", ~/~/ Пользователь, создавший уведомление
2439 + "parentId": "", ~/~/ Идентификатор клиента
2440 + "parentName": "string" ~/~/ Имя клиента
2441 + }
2442 +]
2443 +
2444 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2445 +
2446 +(% class="box infomessage" %)
2447 +(((
2448 +**GET /api/v3/notifications/{id}**
2449 +)))
2450 +
2451 +Метод возвращает данные правил формирования выбранного уведомления.
2452 +
2453 +(% style="text-align: left;" %)
2454 +Метод запроса **GET**
2455 +
2456 +(% style="text-align: left;" %)
2457 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2458 +
2459 +(% style="text-align: left;" %)
2460 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2461 +
2462 +(% style="text-align: left;" %)
2463 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2464 +
2465 +(% style="text-align: left;" %)
2466 +(% style="color:#000000" %)Ответ:
2467 +
2468 +(% style="text-align: left;" %)
2469 +(% style="color:#000000" %){
2470 + "id": 0, ~/~/ (%%)id уведомления
2471 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2472 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2473 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2474 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2475 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2476 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2477 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2478 +(% style="color:#000000" %) 0
2479 + ],
2480 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2481 +(% style="color:#000000" %) 0
2482 + ],
2483 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
2484 +(% style="color:#000000" %) 0
2485 + ],
2486 + "settings": { ~/~/ Список параметров уведомления
2487 + "additionalProp1": "string",
2488 + "additionalProp2": "string",
2489 + "additionalProp3": "string"
2490 + },
2491 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2492 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2493 +(% style="color:#000000" %) ""
2494 + ],
2495 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2496 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2497 +(% style="color:#000000" %) "string"
2498 + ],
2499 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2500 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2501 +(% style="color:#000000" %) {
2502 + "id": 0, ~/~/ (%%)Идентификатор участника чата
2503 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2504 +(% style="color:#000000" %) }
2505 + ],
2506 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2507 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2508 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2509 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2510 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2511 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2512 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2513 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2514 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2515 +(% style="color:#000000" %)}
2516 +
2517 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2518 +
2519 +(% class="box warningmessage" %)
2520 +(((
2521 +**PUT /api/v3/notifications/**
2522 +)))
2523 +
2524 +Метод позволяет отредактировать уведомление.
2525 +
2526 +Метод запроса **PUT**
2527 +
2528 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2529 +
2530 +В заголовках запроса: X-Auth: Токен авторизации
2531 +
2532 +Тело запроса:
2533 +{
2534 + "id": 0, ~/~/ id уведомления
2535 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2536 + "userId": "", ~/~/ Пользователь, создавший уведомление
2537 + "parentId": "", ~/~/ Идентификатор клиента
2538 + "parentName": "string", ~/~/ Имя клиента
2539 + "name": "string", ~/~/ Название уведомления
2540 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2541 + "vehicleIds": [ ~/~/ Список id объектов для анализа
2542 + 0
2543 + ],
2544 + "geoids": [ ~/~/ Список id геообъектов для анализа
2545 + 0
2546 + ],
2547 + "fieldids": [ ~/~/ Список id полей для анализа
2548 + 0
2549 + ],
2550 + "settings": { ~/~/ Список параметров уведомления
2551 + "additionalProp1": "string",
2552 + "additionalProp2": "string",
2553 + "additionalProp3": "string"
2554 + },
2555 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2556 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2557 + ""
2558 + ],
2559 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2560 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2561 + "string"
2562 + ],
2563 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2564 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2565 + {
2566 + "id": 0, ~/~/ Идентификатор участника чата
2567 + "info": "string" ~/~/ Дополнительные сведения
2568 + }
2569 + ],
2570 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2571 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2572 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2573 + "kind": 0, ~/~/ Определяет вид уведомления
2574 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2575 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2576 + "timezone": 0, ~/~/ Сдвиг часового пояса
2577 + "validity": 0, ~/~/ Срок действия в днях (1-90)
2578 + "autoProlongation": true ~/~/ Автопродление срока действия
2579 +}
2580 +
2581 +Ответ:
2582 +
2583 +Success
2584 +
2585 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2586 +
2587 +(% class="box errormessage" %)
2588 +(((
2589 +**DELETE /api/v3/notifications/{id}**
2590 +)))
2591 +
2592 +Метод позволяет удалить выбранное уведомление.
2593 +
2594 +Метод запроса **DELETE**
2595 +
2596 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2597 +
2598 +Передаваемый параметр: {id} - id уведомления
2599 +
2600 +В заголовках запроса: X-Auth: Токен авторизации
2601 +
2602 +Ответ:
2603 +
2604 +Success
2605 +
2606 +
2607 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2608 +
2609 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2610 +
2611 +(% class="box infomessage" %)
2612 +(((
2613 +**POST /api/v3/Drivers/find**
2614 +)))
2615 +
2616 +Передается параметр: parentId - ID клиента-родителя
2617 +
2618 +Ответ:
2619 +
2620 +[
2621 + {
2622 + "name": "string", ~/~/ Определяет наименование
2623 + "description": "string", ~/~/ Определяет описание
2624 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2625 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2626 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2627 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2628 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2629 + "deleted": true ~/~/ Признак удаления
2630 + }
2631 +]
2632 +
2633 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2634 +
2635 +(% class="box infomessage" %)
2636 +(((
2637 +**GET /api/v3/Drivers/{driverGuid}**
2638 +)))
2639 +
2640 +Передается параметр: ID водителя
2641 +
2642 +Ответ:
2643 +
2644 +{
2645 + "name": "string", ~/~/ Определяет наименование
2646 + "description": "string", ~/~/ Определяет описание
2647 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2648 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2649 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2650 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2651 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2652 + "deleted": true ~/~/ Признак удаления
2653 +}
2654 +
2655 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2656 +
2657 +(% class="box successmessage" %)
2658 +(((
2659 +**POST /api/v3/Drivers**
2660 +)))
2661 +
2662 +Запрос:
2663 +
2664 +{
2665 + "name": "string",
2666 + "description": "string",
2667 + "hiredate": "2023-06-30T12:50:54.020Z",
2668 + "chopdate": "2023-06-30T12:50:54.020Z",
2669 + "exclusive": true,
2670 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2671 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2672 + "deleted": true
2673 +}
2674 +
2675 +Ответ:
2676 +
2677 +{
2678 + "name": "string",
2679 + "description": "string",
2680 + "hiredate": "2023-06-30T12:50:54.051Z",
2681 + "chopdate": "2023-06-30T12:50:54.051Z",
2682 + "exclusive": true,
2683 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2684 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2685 + "deleted": true
2686 +}
2687 +
2688 +
2689 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2690 +
2691 +(% class="box warningmessage" %)
2692 +(((
2693 +**PUT /api/v3/Drivers**
2694 +)))
2695 +
2696 +Запрос:
2697 +
2698 +{
2699 + "name": "string",
2700 + "description": "string",
2701 + "hiredate": "2023-06-30T12:50:27.910Z",
2702 + "chopdate": "2023-06-30T12:50:27.910Z",
2703 + "exclusive": true,
2704 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2705 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2706 + "deleted": true
2707 +}
2708 +
2709 +Ответ:
2710 +
2711 +{
2712 + "name": "string",
2713 + "description": "string",
2714 + "hiredate": "2023-06-30T12:50:27.929Z",
2715 + "chopdate": "2023-06-30T12:50:27.929Z",
2716 + "exclusive": true,
2717 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2718 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2719 + "deleted": true
2720 +}
2721 +
2722 +
2723 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2724 +
2725 +(% class="box errormessage" %)
2726 +(((
2727 +**DELETE /api/v3/Drivers/{driverGuid}**
2728 +)))
2729 +
2730 +Передается параметр: ID водителя
2731 +
2732 +Ответ:
2733 +
2734 +Success
2735 +
2736 +
2737 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2738 +
2739 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2740 +
2741 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2742 +
2743 +(% class="box infomessage" %)
2744 +(((
2745 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2746 +)))
2747 +
2748 +Запрос:
2749 +
2750 +{
2751 + "Ids": [
2752 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2753 + ],
2754 + "BeginTime": "2023-06-30T12:49:04.365Z",
2755 + "EndTime": "2023-06-30T12:49:04.365Z"
2756 +}
2757 +
2758 +Ответ:
2759 +
2760 +[
2761 + {
2762 + "VehicleId": 0,
2763 + "CreateTime": "2023-06-30T09:52:31.240Z",
2764 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2765 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2766 + "BeginTime": "2023-06-30T09:52:31.240Z",
2767 + "EndTime": "2023-06-30T09:52:31.240Z"
2768 + }
2769 +]
2770 +
2771 +
2772 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2773 +
2774 +(% class="box infomessage" %)
2775 +(((
2776 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2777 +)))
2778 +
2779 +Запрос:
2780 +
2781 +{
2782 + "Ids": [
2783 + 0
2784 + ],
2785 + "BeginTime": "2023-06-30T12:48:39.419Z",
2786 + "EndTime": "2023-06-30T12:48:39.419Z"
2787 +}
2788 +
2789 +Ответ:
2790 +
2791 +[
2792 + {
2793 + "VehicleId": 0,
2794 + "CreateTime": "2023-06-30T09:54:01.631Z",
2795 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2796 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2797 + "BeginTime": "2023-06-30T09:54:01.631Z",
2798 + "EndTime": "2023-06-30T09:54:01.631Z"
2799 + }
2800 +]
2801 +
2802 +
2803 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2804 +
2805 +(% class="box successmessage" %)
2806 +(((
2807 +**POST /api/v3/DriversVehiclesAssignments**
2808 +)))
2809 +
2810 +Передается массив назначений
2811 +
2812 +Запрос:
2813 +
2814 +[
2815 + {
2816 + "VehicleId": 0, ~/~/ Идентификатор объекта
2817 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2818 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2819 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2820 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2821 + }
2822 +]
2823 +
2824 +Ответ:
2825 +
2826 +[
2827 + {
2828 + "VehicleId": 0,
2829 + "CreateTime": "2023-06-30T11:04:46.903Z",
2830 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2831 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2832 + "BeginTime": "2023-06-30T11:04:46.903Z",
2833 + "EndTime": "2023-06-30T11:04:46.903Z"
2834 + }
2835 +]
2836 +
2837 +
2838 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2839 +
2840 +(% class="box warningmessage" %)
2841 +(((
2842 +**PUT /api/v3/DriversVehiclesAssignments**
2843 +)))
2844 +
2845 +Запрос:
2846 +
2847 +[
2848 + {
2849 + "VehicleId": 0,
2850 + "CreateTime": "2023-06-30T11:14:08.117Z",
2851 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2852 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2853 + "BeginTime": "2023-06-30T11:14:08.117Z",
2854 + "EndTime": "2023-06-30T11:14:08.117Z"
2855 + }
2856 +]
2857 +
2858 +Ответ:
2859 +
2860 +[
2861 + {
2862 + "VehicleId": 0,
2863 + "CreateTime": "2023-06-30T11:14:53.349Z",
2864 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2865 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2866 + "BeginTime": "2023-06-30T11:14:53.349Z",
2867 + "EndTime": "2023-06-30T11:14:53.349Z"
2868 + }
2869 +]
2870 +
2871 +
2872 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2873 +
2874 +(% class="box errormessage" %)
2875 +(((
2876 +**DELETE /api/v3/DriversVehiclesAssignments**
2877 +)))
2878 +
2879 +Запрос:
2880 +
2881 +[
2882 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2883 +]
2884 +
2885 +Ответ:
2886 +
2887 +Success
2888 +
2889 +
2890 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2891 +
2892 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2893 +
2894 +(% class="box infomessage" %)
2895 +(((
2896 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2897 +)))
2898 +
2899 +Запрос:
2900 +
2901 +{
2902 + "Ids": [
2903 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2904 + ],
2905 + "BeginTime": "2023-06-30T12:47:12.162Z",
2906 + "EndTime": "2023-06-30T12:47:12.162Z"
2907 +}
2908 +
2909 +Ответ:
2910 +
2911 +[
2912 + {
2913 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2914 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2915 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2916 + "BeginTime": "2023-06-30T11:19:40.703Z",
2917 + "EndTime": "2023-06-30T11:19:40.703Z"
2918 + }
2919 +]
2920 +
2921 +
2922 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2923 +
2924 +(% class="box infomessage" %)
2925 +(((
2926 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2927 +)))
2928 +
2929 +Запрос:
2930 +
2931 +{
2932 + "Ids": [
2933 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2934 + ],
2935 + "BeginTime": "2023-06-30T12:47:12.162Z",
2936 + "EndTime": "2023-06-30T12:47:12.162Z"
2937 +}
2938 +
2939 +Ответ:
2940 +
2941 +[
2942 + {
2943 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2944 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2945 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2946 + "BeginTime": "2023-06-30T11:19:40.703Z",
2947 + "EndTime": "2023-06-30T11:19:40.703Z"
2948 + }
2949 +]
2950 +
2951 +
2952 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2953 +
2954 +(% class="box successmessage" %)
2955 +(((
2956 +**POST /api/v3/DriversRfidsAssignments**
2957 +)))
2958 +
2959 +Запрос:
2960 +
2961 +[
2962 + {
2963 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2964 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2965 + "BeginTime": "2023-06-30T11:27:08.635Z",
2966 + "EndTime": "2023-06-30T11:27:08.635Z"
2967 + }
2968 +]
2969 +
2970 +Ответ:
2971 +
2972 +[
2973 + {
2974 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2975 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2977 + "BeginTime": "2023-06-30T11:27:08.677Z",
2978 + "EndTime": "2023-06-30T11:27:08.677Z"
2979 + }
2980 +]
2981 +
2982 +
2983 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2984 +
2985 +(% class="box warningmessage" %)
2986 +(((
2987 +**PUT /api/v3/DriversRfidsAssignments**
2988 +)))
2989 +
2990 +Запрос:
2991 +
2992 +[
2993 + {
2994 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2996 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2997 + "BeginTime": "2023-06-30T11:28:43.330Z",
2998 + "EndTime": "2023-06-30T11:28:43.330Z"
2999 + }
3000 +]
3001 +
3002 +Ответ:
3003 +
3004 +[
3005 + {
3006 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3007 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3008 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3009 + "BeginTime": "2023-06-30T11:28:43.331Z",
3010 + "EndTime": "2023-06-30T11:28:43.331Z"
3011 + }
3012 +]
3013 +
3014 +
3015 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3016 +
3017 +(% class="box errormessage" %)
3018 +(((
3019 +**DELETE /api/v3/DriversRfidsAssignments**
3020 +)))
3021 +
3022 +Запрос:
3023 +
3024 +[
3025 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3026 +]
3027 +
3028 +Ответ:
3029 +
3030 +Success
3031 +
3032 +
3033 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3034 +
3035 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3036 +
3037 +(% class="box infomessage" %)
3038 +(((
3039 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3040 +)))
3041 +
3042 +Запрос:
3043 +
3044 +{
3045 + "Ids": [
3046 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3047 + ],
3048 + "BeginTime": "2023-06-30T12:45:10.852Z",
3049 + "EndTime": "2023-06-30T12:45:10.852Z"
3050 +}
3051 +
3052 +Ответ:
3053 +
3054 +[
3055 + {
3056 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3057 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3058 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3059 + "BeginTime": "2023-06-30T11:58:04.695Z",
3060 + "EndTime": "2023-06-30T11:58:04.695Z"
3061 + }
3062 +]
3063 +
3064 +
3065 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3066 +
3067 +(% class="box infomessage" %)
3068 +(((
3069 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3070 +)))
3071 +
3072 +Запрос:
3073 +
3074 +{
3075 + "Ids": [
3076 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3077 + ],
3078 + "BeginTime": "2023-06-30T12:45:10.852Z",
3079 + "EndTime": "2023-06-30T12:45:10.852Z"
3080 +}
3081 +
3082 +Ответ:
3083 +
3084 +[
3085 + {
3086 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3087 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3088 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3089 + "BeginTime": "2023-06-30T11:58:04.695Z",
3090 + "EndTime": "2023-06-30T11:58:04.695Z"
3091 + }
3092 +]
3093 +
3094 +
3095 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3096 +
3097 +(% class="box successmessage" %)
3098 +(((
3099 +**POST /api/v3/DriversFuelCardsAssignments**
3100 +)))
3101 +
3102 +Запрос:
3103 +
3104 +[
3105 + {
3106 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3107 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3108 + "BeginTime": "2023-06-30T12:09:53.175Z",
3109 + "EndTime": "2023-06-30T12:09:53.175Z"
3110 + }
3111 +]
3112 +
3113 +Ответ:
3114 +
3115 +[
3116 + {
3117 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3118 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3119 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3120 + "BeginTime": "2023-06-30T12:09:53.201Z",
3121 + "EndTime": "2023-06-30T12:09:53.201Z"
3122 + }
3123 +]
3124 +
3125 +
3126 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3127 +
3128 +(% class="box warningmessage" %)
3129 +(((
3130 +**PUT /api/v3/DriversFuelCardsAssignments**
3131 +)))
3132 +
3133 +Запрос:
3134 +
3135 +[
3136 + {
3137 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3138 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3139 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3140 + "BeginTime": "2023-06-30T12:09:53.201Z",
3141 + "EndTime": "2023-06-30T12:09:53.201Z"
3142 + }
3143 +]
3144 +
3145 +Ответ:
3146 +
3147 +[
3148 + {
3149 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3150 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3152 + "BeginTime": "2023-06-30T12:09:53.201Z",
3153 + "EndTime": "2023-06-30T12:09:53.201Z"
3154 + }
3155 +]
3156 +
3157 +
3158 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3159 +
3160 +(% class="box errormessage" %)
3161 +(((
3162 +**DELETE /api/v3/DriversFuelCardsAssignments**
3163 +)))
3164 +
3165 +Запрос:
3166 +
3167 +[
3168 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3169 +]
3170 +
3171 +Ответ:
3172 +
3173 +Success
3174 +
3175 +
3176 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3177 +
3178 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3179 +
3180 +(% class="box infomessage" %)
3181 +(((
3182 +**POST /api/v3/Trailers**
3183 +)))
3184 +
3185 +Пример запроса:
3186 +
3187 +{
3188 + "startDate": "2023-11-14T10:48:03.671Z",
3189 + "endDate": "2023-11-14T10:48:03.671Z",
3190 + "ids": [ 0 ],
3191 + "timezone": 0
3192 +}
3193 +
3194 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3195 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3196 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3197 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3198 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3199 +
3200 +Пример ответа:
3201 +
3202 +[
3203 + {
3204 + "SD": "2023-11-14T10:48:03.717Z",
3205 + "ED": "2023-11-14T10:48:03.717Z", 
3206 + "id": 0,
3207 + "SLat": 0,
3208 + "SLon": 0,
3209 + "ELat": 0,
3210 + "ELon": 0,
3211 + "mileage": 0
3212 + "Duration": 0
3213 + "Address": "string",
3214 + "Address2": "string",
3215 + "name": "string",
3216 + "rid": "string",
3217 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3218 + "trailer": {
3219 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3220 + "Number": "string",
3221 + "Description": "string",
3222 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3223 + "ExternalID": "string",
3224 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3225 + "CreateTime": "2023-11-14T10:48:03.717Z",
3226 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3227 + "IsDeleted": true
3228 + },
3229 + "filesCount": 0,
3230 + }
3231 +]
3232 +
3233 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3234 +|SD|Дата и время начала события
3235 +|ED|Дата и время окончания события
3236 +|id|ID объекта
3237 +|SLat|Широта начальной координаты
3238 +|SLon|Долгота начальной координаты
3239 +|ELat|Широта конечной координаты
3240 +|ELon|Долгота конечной координаты
3241 +|mileage|Пробег
3242 +|Duration|Продолжительность
3243 +|Address|Адрес начального местоположения
3244 +|Address2|Адрес конечного местоположения
3245 +|name|Имя радиометки
3246 +|rid|Номер радиометки
3247 +|rguid|ID радиометки
3248 +|trailer|Информация об агрегате
3249 +|ModelGuid|ID агрегата
3250 +|Number|Название/номер агрегата
3251 +|Description|Текст примечания агрегата
3252 +
3253 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3254 +
3255 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3256 +
3257 +(% class="box infomessage" %)
3258 +(((
3259 +**POST /api/v3/Rfids/find**
3260 +)))
3261 +
3262 +Запрос:
3263 +
3264 +{
3265 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3266 +}
3267 +
3268 +Ответ:
3269 +
3270 +[
3271 + {
3272 + "name": "string",
3273 + "number": 0,
3274 + "period": 0,
3275 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3276 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3277 + }
3278 +]
3279 +
3280 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3281 +|parentId|ID клиента
3282 +|name|Название карты-метки
3283 +|number|Номер
3284 +|period|Период запросов в секундах (работает только для агрегатов)
3285 +|id|ID карты-метки
3286 +
3287 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3288 +
3289 +(% class="box infomessage" %)
3290 +(((
3291 +**GET /api/v3/Rfids/{rfidGuid}**
3292 +)))
3293 +
3294 +Передаем параметр rfidGuid - идентификатор карты-метки
3295 +
3296 +Ответ:
3297 +
3298 +[
3299 + {
3300 + "name": "string",
3301 + "number": 0,
3302 + "period": 0,
3303 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3304 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3305 + }
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 successmessage" %)
3318 +(((
3319 +**POST /api/v3/Rfids**
3320 +)))
3321 +
3322 +Запрос:
3323 +
3324 +{
3325 + "name": "string",
3326 + "number": 0,
3327 + "period": 0,
3328 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3329 +}
3330 +
3331 +Ответ:
3332 +
3333 +{
3334 + "name": "string",
3335 + "number": 0,
3336 + "period": 0,
3337 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3338 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3339 +}
3340 +
3341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3342 +|name|Название карты-метки
3343 +|number|Номер
3344 +|period|Период запросов в секундах (работает только для агрегатов)
3345 +|id|ID карты-метки
3346 +|parentId|ID клиента
3347 +
3348 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3349 +
3350 +(% class="box warningmessage" %)
3351 +(((
3352 +**PUT /api/v3/Rfids**
3353 +)))
3354 +
3355 +Запрос:
3356 +
3357 +{
3358 + "name": "string",
3359 + "number": 0,
3360 + "period": 0,
3361 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3362 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3363 +}
3364 +
3365 +Ответ:
3366 +
3367 +{
3368 + "name": "string",
3369 + "number": 0,
3370 + "period": 0,
3371 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3372 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3373 +}
3374 +
3375 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3376 +|name|Название карты-метки
3377 +|number|Номер
3378 +|period|Период запросов в секундах (работает только для агрегатов)
3379 +|id|ID карты-метки
3380 +|parentId|ID клиента
3381 +
3382 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3383 +
3384 +(% class="box errormessage" %)
3385 +(((
3386 +**DELETE /api/v3/Rfids/{rfidGuid}**
3387 +)))
3388 +
3389 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3390 +
3391 +Ответ:
3392 +
3393 +Success
3394 +
3395 +
3396 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3397 +
3398 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3399 +
3400 +(% class="box infomessage" %)
3401 +(((
3402 +**GET /api/v3/Billing/client/balance/{clientId}**
3403 +)))
3404 +
3405 +Параметр запроса: **clientId **- идентификатор клиента.
3406 +
3407 +Ответ:
3408 +
3409 +{
3410 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3411 + "Balance": 0
3412 +}
3413 +
3414 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3415 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3416 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3417 +
3418 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3419 +
3420 +(% class="box infomessage" %)
3421 +(((
3422 +**GET /api/v3/Billing/client/constraint/{clientId}**
3423 +)))
3424 +
3425 +Параметр запроса: **clientId **- идентификатор клиента.
3426 +
3427 +Ответ:
3428 +
3429 +{
3430 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3431 + "CalculationType": 0,
3432 + "PermissibleBalance": 0,
3433 + "DefermentDays": 0,
3434 + "SendUiNotifications": true,
3435 + "SendEmailNotifications": true,
3436 + "IsPrivate": true,
3437 +}
3438 +
3439 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3440 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3441 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3442 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3443 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3444 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3445 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3446 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3447 +
3448 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3449 +
3450 +(% class="box infomessage" %)
3451 +(((
3452 +**GET /api/v3/Billing/client/plan/{clientId}**
3453 +)))
3454 +
3455 +Параметры запроса:
3456 +
3457 +**clientId **- идентификатор клиента.
3458 +
3459 +**planId **- идентификатор тарифного плана.
3460 +
3461 +Ответ:
3462 +
3463 +{
3464 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 + "Plan": { **~/~/ Описание тарифного плана**
3466 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3467 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3468 + "Name": "string",
3469 + "IsArchived": true,
3470 + "Constraint": {
3471 + "CalculationType": 0,
3472 + "PermissibleBalance": 0,
3473 + "DefermentDays": 0
3474 + },
3475 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3476 + {
3477 + "Feature": "string",
3478 + "IsFactual": true,
3479 + "Limit": 0,
3480 + "Price": 0,
3481 + "PeriodValue": 0,
3482 + "PeriodType": 0
3483 + }
3484 + ]
3485 + },
3486 + "DebitDate": "2023-10-18T12:46:24.213Z",
3487 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3488 + {
3489 + "Feature": "string",
3490 + "IsEnabled": true,
3491 + "IsPrivate": true,
3492 + "IsFactual": true,
3493 + "Limit": 0,
3494 + "Price": 0,
3495 + "DebitDate": "2023-10-18T12:46:24.213Z",
3496 + "PeriodValue": 0,
3497 + "PeriodType": 0
3498 + }
3499 + ]
3500 +}
3501 +
3502 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3503 +|ClientId|Идентификатор клиента
3504 +|Id|Идентификатор тарифного плана
3505 +|OwnerId|Идентификатор клиента-владельца
3506 +|Name|Наименование тарифного плана
3507 +|IsArchived|Признак, определяющий архивный тарифный план
3508 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3509 +|PermissibleBalance|Допустимый баланс
3510 +|DefermentDays|Отсрочка, количество дней
3511 +|Feature|Код услуги
3512 +|IsEnabled|Признак, определяющий активирована ли услуга
3513 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3514 +|IsFactual|Признак, определяющий расчёт по факту
3515 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3516 +|Price|Цена за единицу.
3517 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3518 +|PeriodValue|Значение периода.
3519 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3520 +
3521 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3522 +
3523 +(% class="box infomessage" %)
3524 +(((
3525 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3526 +)))
3527 +
3528 +Параметр запроса: **clientId **- идентификатор клиента.
3529 +
3530 +Ответ:
3531 +
3532 +[
3533 + {
3534 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3535 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3536 + "Name": "string",
3537 + "IsArchived": true,
3538 + "Constraint": {
3539 + "CalculationType": 0,
3540 + "PermissibleBalance": 0,
3541 + "DefermentDays": 0
3542 + },
3543 + "Features": [
3544 + {
3545 + "Feature": "string",
3546 + "IsFactual": true,
3547 + "Limit": 0,
3548 + "Price": 0,
3549 + "PeriodValue": 0,
3550 + "PeriodType": 0
3551 + }
3552 + ]
3553 + }
3554 +]
3555 +
3556 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3557 +|ClientId|Идентификатор клиента
3558 +|Id|Идентификатор тарифного плана
3559 +|OwnerId|Идентификатор клиента-владельца
3560 +|Name|Наименование тарифного плана
3561 +|IsArchived|Признак, определяющий архивный тарифный план
3562 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3563 +|PermissibleBalance|Допустимый баланс
3564 +|DefermentDays|Отсрочка, количество дней
3565 +|Feature|Код услуги
3566 +|IsFactual|Признак, определяющий расчёт по факту
3567 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3568 +|Price|Цена за единицу.
3569 +|PeriodValue|Значение периода.
3570 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3571 +
3572 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3573 +
3574 +(% class="box infomessage" %)
3575 +(((
3576 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3577 +)))
3578 +
3579 +Параметр запроса: **clientId **- идентификатор клиента.
3580 +
3581 +Ответ:
3582 +
3583 +[
3584 + {
3585 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3586 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3587 + "Name": "string",
3588 + "IsArchived": true,
3589 + "Constraint": {
3590 + "CalculationType": 0,
3591 + "PermissibleBalance": 0,
3592 + "DefermentDays": 0
3593 + },
3594 + "Features": [
3595 + {
3596 + "Feature": "string",
3597 + "IsFactual": true,
3598 + "Limit": 0,
3599 + "Price": 0,
3600 + "PeriodValue": 0,
3601 + "PeriodType": 0
3602 + }
3603 + ]
3604 + }
3605 +]
3606 +
3607 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3608 +|ClientId|Идентификатор клиента
3609 +|Id|Идентификатор тарифного плана
3610 +|OwnerId|Идентификатор клиента-владельца
3611 +|Name|Наименование тарифного плана
3612 +|IsArchived|Признак, определяющий архивный тарифный план
3613 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3614 +|PermissibleBalance|Допустимый баланс
3615 +|DefermentDays|Отсрочка, количество дней
3616 +|Feature|Код услуги
3617 +|IsFactual|Признак, определяющий расчёт по факту
3618 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3619 +|Price|Цена за единицу.
3620 +|PeriodValue|Значение периода.
3621 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3622 +
3623 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3624 +
3625 +(% class="box warningmessage" %)
3626 +(((
3627 +**PUT /api/v3/Billing/client/balance**
3628 +)))
3629 +
3630 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3631 +
3632 +Тело запроса:
3633 +
3634 +{
3635 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3636 + "Balance": 0
3637 +}
3638 +
3639 +Ответ: Success
3640 +
3641 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3642 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3643 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3644 +
3645 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3646 +
3647 +(% class="box warningmessage" %)
3648 +(((
3649 +**PUT /api/v3/billing/client/balance/deposit**
3650 +)))
3651 +
3652 +Создает операцию **Пополнение **с указанной суммой
3653 +
3654 +Тело запроса:
3655 +
3656 +{
3657 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3658 + "Balance": 0
3659 +}
3660 +
3661 +Ответ: Success
3662 +
3663 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3664 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3665 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3666 +
3667 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3668 +
3669 +Создает операцию **Списание **с указанной суммой
3670 +
3671 +(% class="box warningmessage" %)
3672 +(((
3673 +**PUT /api/v3/billing/client/balance/withdraw**
3674 +)))
3675 +
3676 +Тело запроса:
3677 +
3678 +{
3679 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3680 + "Balance": 0
3681 +}
3682 +
3683 +Ответ: Success
3684 +
3685 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3686 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3687 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3688 +
3689 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3690 +
3691 +(% class="box warningmessage" %)
3692 +(((
3693 +**PUT /api/v3/Billing/client/constraint**
3694 +)))
3695 +
3696 +Тело запроса:
3697 +
3698 +{
3699 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3700 + "CalculationType": 0,
3701 + "PermissibleBalance": 0,
3702 + "DefermentDays": 0,
3703 + "SendUiNotifications": true,
3704 + "SendEmailNotifications": true,
3705 + "IsPrivate": true,
3706 +}
3707 +
3708 +Ответ: Success
3709 +
3710 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3711 +|ClientId|Идентификатор клиента
3712 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3713 +|PermissibleBalance|Допустимый баланс
3714 +|DefermentDays|(((
3715 +Отсрочка, количество дней
3716 +)))
3717 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3718 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3719 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3720 +
3721 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3722 +
3723 +(% class="box warningmessage" %)
3724 +(((
3725 +**PUT /api/v3/Billing/client/plan**
3726 +)))
3727 +
3728 +Тело запроса:
3729 +
3730 +{
3731 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3732 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3733 + "Features": [
3734 + {
3735 + "Feature": "string",
3736 + "IsEnabled": true,
3737 + "IsFactual": true,
3738 + "Limit": 0,
3739 + "Price": 0,
3740 + "DebitDate": "2023-10-18T13:26:58.987Z",
3741 + "PeriodValue": 0,
3742 + "PeriodType": 0
3743 + }
3744 + ]
3745 +}
3746 +
3747 +Ответ: Success
3748 +
3749 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3750 +|ClientId|Идентификатор клиента
3751 +|PlanId|Идентификатор тарифного плана
3752 +|Feature|Код услуги
3753 +|IsEnabled|Признак, определяющий активирована ли услуга
3754 +|IsFactual|Признак, определяющий расчёт по факту
3755 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3756 +|Price|Цена за единицу.
3757 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3758 +|PeriodValue|Значение периода.
3759 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3760 +
3761 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3762 +
3763 +(% class="box warningmessage" %)
3764 +(((
3765 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3766 +)))
3767 +
3768 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3769 +
3770 +(% class="box infomessage" %)
3771 +(((
3772 +**POST /api/v3/vehicles/import/{agentId}**
3773 +)))
3774 +
3775 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3776 +
3777 +В пути указывается **agentId** - id клиента.
3778 +
3779 +**Заголовок**
3780 +
3781 +**X-Auth: [токен авторизации]**
3782 +
3783 +**Параметры**
3784 +
3785 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3786 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3787 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3788 +
3789 +В теле использовать тип **form-data,** тип значения** file**
3790 +
3791 +**Ключи**
3792 +
3793 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3794 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3795 +|csv|В значении передаем файл датчиков, формат **csv**
3796 +
3797 +Ответ:
3798 +
3799 +{
3800 + "vehicleId": 0,
3801 + "name": "string",
3802 + "errors": ["string"]
3803 +}
3804 +
3805 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3806 +|vehicleId|ID созданного объекта
3807 +|name|Имя созданного объекта
3808 +|errors|Ошибки и их описание
3809 +
3810 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3811 +
3812 +(% class="box infomessage" %)
3813 +(((
3814 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3815 +)))
3816 +
3817 +(% class="wikigeneratedid" %)
3818 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3819 +
3820 +(% class="wikigeneratedid" %)
3821 +В пути указывается **vehicleId **- id объекта.
3822 +
3823 +**Заголовок**
3824 +
3825 +**X-Auth: [токен авторизации]**
3826 +
3827 +В теле использовать тип **form-data.**
3828 +
3829 +Ключи:
3830 +
3831 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3832 +|**history**|В значении передавать файл с историей
3833 +
3834 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3835 +
3836 +Ответ:
3837 +
3838 +{
3839 + "results": [
3840 + {
3841 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3842 + "vehicleId": 0,
3843 + "errors": [
3844 + "string"
3845 + ],
3846 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3847 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3848 + "producedCount": 0,
3849 + "msgCount": 0
3850 + }
3851 + ]
3852 +}
3853 +
3854 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3855 +|results|Результаты импорта в разрезе ТС
3856 +|vehicleGuid|Guid ТС
3857 +|vehicleId|ID ТС
3858 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3859 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3860 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3861 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3862 +|msgCount|Кол-во обработанных сообщений всего
3863 +
3864 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3865 +
3866 +(% class="box infomessage" %)
3867 +(((
3868 +**GET /api/v3/vehicles/import/history/status**
3869 +)))
3870 +
3871 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3872 +
3873 +Ответ:
3874 +
3875 +{
3876 + "activity": true,
3877 + "progress": 0,
3878 + "message": "string"
3879 +}
3880 +
3881 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3882 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3883 +|progress|Guid ТС
3884 +
3885 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3886 +
3887 +(% class="box infomessage" %)
3888 +(((
3889 +**POST /api/v3/vehicles/export**
3890 +)))
3891 +
3892 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3893 +
3894 +Тело запроса:
3895 +
3896 +[
3897 + id
3898 +]
3899 +
3900 +Ответ: Success 200, получаете файлы с настройками.
3901 +
3902 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3903 +
3904 +(% class="box infomessage" %)
3905 +(((
3906 +**POST /api/v3/vehicles/export/history**
3907 +)))
3908 +
3909 +Метод возвращает список сообщений терминала объекта за выбранный период.
3910 +
3911 +Тело запроса:
3912 +
3913 +{
3914 + "vehicleId": 0,
3915 + "asArchive": true,
3916 + "from": "2023-09-27T12:17:45.973Z",
3917 + "to": "2023-09-27T12:17:45.973Z"
3918 +}
3919 +
3920 +Ответ:
3921 +
3922 +Получаете файл. Сообщение: Code 200/Success
3923 +
3924 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3925 +|vehicleId|ID объекта
3926 +|asArchive|true - Архивировать файл, False - не архивировать
3927 +|from|Дата и время начала запроса
3928 +|to|Дата и время окончания запроса
3929 +
3930 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3931 +
3932 +(% class="box infomessage" %)
3933 +(((
3934 +**GET /api/v3/vehicles/export/history/status**
3935 +)))
3936 +
3937 +Метод возвращает список сообщений терминала объекта за выбранный период.
3938 +
3939 +Ответ:
3940 +
3941 +{
3942 + "activity": true,
3943 + "progress": 0,
3944 + "message": "string"
3945 +}
3946 +
3947 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3948 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3949 +|progress|Прогресс экспорта, от 0 до 100%
3950 +|message|Текст описывающий статус
3951 +
3952 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3953 +
3954 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3955 +
3956 +(% class="box infomessage" %)
3957 +(((
3958 +**POST /api/v3/EcoDriving/rating**
3959 +)))
3960 +
3961 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3962 +
3963 +Тело запроса:
3964 +
3965 +{
3966 + "vehicleIds": [vehicleId],
3967 + "from": "2023-11-22T09:29:48.051Z",
3968 + "to": "2023-11-22T09:29:48.051Z"
3969 +}
3970 +
3971 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3972 +|vehicleIds|Массив ID объектов
3973 +|from|Дата начала запроса
3974 +|to|Дата окончания запроса
3975 +
3976 +Ответ:
3977 +
3978 +{
3979 + "items": [
3980 + {
3981 + "from": "2023-11-22T09:29:48.052Z",
3982 + "to": "2023-11-22T09:29:48.052Z",
3983 + "vehicleId": 0,
3984 + "vehicleName": "string",
3985 + "vehicleModel": "string",
3986 + "penalty": 0,
3987 + "score": 0,
3988 + "totalViolations": 0,
3989 + "violationsByType": {
3990 + "overspeedingViolations": 0,
3991 + "accelerationViolations": 0,
3992 + "brakingViolations": 0,
3993 + "turningViolations": 0,
3994 + "dangerousDrivingViolations": 0,
3995 + "sensorViolations": 0
3996 + },
3997 + "moveTime": 0,
3998 + "mileage": 0,
3999 + "tripsCount": 0,
4000 + "trips": [
4001 + {
4002 + "penalty": 0,
4003 + "score": 0,
4004 + "violationsCount": 0,
4005 + "violationsByType": {
4006 + "overspeedingViolations": 0,
4007 + "accelerationViolations": 0,
4008 + "brakingViolations": 0,
4009 + "turningViolations": 0,
4010 + "dangerousDrivingViolations": 0,
4011 + "sensorViolations": 0
4012 + },
4013 + "moveTime": 0,
4014 + "mileage": 0,
4015 + "motohours": 0,
4016 + "maxSpeed": 0,
4017 + "startAddress": "string",
4018 + "endAddress": "string",
4019 + "drivers": [
4020 + {
4021 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4022 + "driverName": "string",
4023 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4024 + }
4025 + ]
4026 + }
4027 + ]
4028 + }
4029 + ]
4030 +}
4031 +
4032 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4033 +|from|Дата начала запроса
4034 +|to|Дата  окончания
4035 +|vehicleId|ID объекта
4036 +|vehicleName|Имя объекта
4037 +|vehicleModel|Модель объекта
4038 +|penalty|Сумма штрафных баллов
4039 +|score|Оценка
4040 +|totalViolations|Суммарное количество нарушений
4041 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4042 +|overspeedingViolations|Превышение скорости
4043 +|accelerationViolations|Ускорение
4044 +|brakingViolations|Торможение
4045 +|turningViolations|Резкий поворот
4046 +|dangerousDrivingViolations|Резкое вождение
4047 +|sensorViolations|Нарушение по датчику
4048 +|moveTime|Время в движении
4049 +|mileage|Пробег
4050 +|tripsCount|Количество рейсов
4051 +|motohours|Моточасы
4052 +|maxSpeed|Максимальная скорость
4053 +|startAddress|Адрес начала рейса
4054 +|endAddress|Адрес окончания рейса
4055 +|drivers|Список водителей, которые были на объекте в течениии рейса
4056 +|driverGuid|Guid водителя
4057 +|driverName|Имя водителя
4058 +|driverRfid|Номер Карты-метки
4059 +
953 953  (% class="box" lang="en-US" style="text-align: center;" %)
954 954  (((
955 955  (% 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,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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