Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 22.4 >
edited by Артем Шемяков
on 2022/09/02 10:05
To version < 96.2 >
edited by Илья Крайнов
on 2023/06/30 15:20
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,39 +1,46 @@
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  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
14 14  
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
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 infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /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 -(% style="color:#000000" %)Метод запроса: **GET**
30 +(% style="color:#000000" %)Метод запроса: **POST**
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% lang="en-US" %)
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 +
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}
42 +
43 +
37 37  (% style="color:#000000" %)**Ответ:**
38 38  
39 39  (% lang="en-US" %)
... ... @@ -40,8 +40,8 @@
40 40  (% style="color:#000000" %){
41 41  
42 42  (% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 47  }
... ... @@ -48,13 +48,14 @@
48 48  
49 49  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50 50  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
51 51  
52 52  (% class="box infomessage" %)
53 53  (((
54 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
55 55  )))
56 56  
57 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
58 58  
59 59  (% style="color:#000000" %)Метод запроса: **GET**
60 60  
... ... @@ -65,18 +65,58 @@
65 65  (% lang="en-US" %)
66 66  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
67 67  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
68 68  
69 -(% class="box" style="text-align: center;" %)
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 +
80 +(% class="box infomessage" %)
70 70  (((
71 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
72 72  )))
73 73  
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
86 +
87 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
88 +
89 +(% style="color:#000000" %)Метод запроса: **GET**
90 +
91 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
92 +
93 +Запрос должен содержать данные параметра "**agentId**"
94 +
95 +(% style="color:#000000" %)Ответ:
96 +А
97 +{
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
118 + }
119 +
120 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 +
74 74  (% class="box infomessage" %)
75 75  (((
76 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
77 77  )))
78 78  
79 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
80 80  
81 81  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82 82  
... ... @@ -84,37 +84,184 @@
84 84  
85 85  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
86 86  
87 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
88 88  
89 -(% 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>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
92 92  
93 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 96  
97 -(% style="color:#000000" %){
98 - "agentId": "", ~/~/ идентификатор клиента
99 - "parentId": "", ~/~/ идентификатор клиента-родителя
100 - "name": "", ~/~/ наименование клиента
101 - "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 - "status": "", ~/~/ статус клиента
147 +{
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
104 104  }
105 105  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
106 106  
107 -(% class="box" style="text-align: center;" %)
159 +(% class="box successmessage" %)
108 108  (((
109 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
161 +**POST /api/v3/agents **
110 110  )))
111 111  
164 +Метод позволяет добавить клиента, указанного в запросе.
165 +
166 +Метод запроса: **POST**
167 +
168 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
169 +
170 +В заголовках запроса: X-Auth: Токен авторизации
171 +
172 +Параметры в теле запроса (JSON):
173 +
174 +{
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 + "name": "string", ~/~/ имя
177 + "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
179 + "isForeign": true, ~/~/ иностранный контрагент
180 + "district": "string", ~/~/ округ
181 + "region": "string", ~/~/ регион
182 + "city": "string", ~/~/ город
183 + "inn": "string", ~/~/ ИНН
184 + "kpp": "string", ~/~/ КПП
185 + "address": "string", ~/~/ юридический адрес
186 + "addressFact": "string", ~/~/ фактический адрес
187 + "email": "string", ~/~/ email
188 + "director": "string", ~/~/ ФИО руководителя
189 + "bankName": "string", ~/~/ банк
190 + "bankBIK": "string", ~/~/ БИК
191 + "bankRS": "string", ~/~/ номер счёта
192 + "bankKS": "string" ~/~/ корр. счёт
193 +}
194 +
195 +
196 +Ответ:
197 +
198 +{
199 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
200 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
201 + "name": "string", ~/~/ имя
202 + "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
204 + "isForeign": true, ~/~/ иностранный контрагент
205 + "district": "string", ~/~/ округ
206 + "region": "string", ~/~/ регион
207 + "city": "string", ~/~/ город
208 + "inn": "string", ~/~/ ИНН
209 + "kpp": "string", ~/~/ КПП
210 + "address": "string", ~/~/ юридический адрес
211 + "addressFact": "string", ~/~/ фактический адрес
212 + "email": "string", ~/~/ email
213 + "director": "string", ~/~/ ФИО руководителя
214 + "bankName": "string", ~/~/ банк
215 + "bankBIK": "string", ~/~/ БИК
216 + "bankRS": "string", ~/~/ номер счёта
217 + "bankKS": "string" ~/~/ корр. счёт
218 +}
219 +
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 +
222 +(% class="box warningmessage" %)
223 +(((
224 +**PUT /api/v3/agents**
225 +)))
226 +
227 +Метод позволяет отредактировать клиента, указанного в запросе.
228 +
229 +Метод запроса: **PUT**
230 +
231 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
232 +
233 +В заголовках запроса: X-Auth: Токен авторизации
234 +
235 +
236 +Параметры в теле запроса (JSON):
237 +
238 +{
239 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
240 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
241 + "name": "string", ~/~/ имя
242 + "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
244 + "isForeign": true, ~/~/ иностранный контрагент
245 + "district": "string", ~/~/ округ
246 + "region": "string", ~/~/ регион
247 + "city": "string", ~/~/ город
248 + "inn": "string", ~/~/ ИНН
249 + "kpp": "string", ~/~/ КПП
250 + "address": "string", ~/~/ юридический адрес
251 + "addressFact": "string", ~/~/ фактический адрес
252 + "email": "string", ~/~/ email
253 + "director": "string", ~/~/ ФИО руководителя
254 + "bankName": "string", ~/~/ банк
255 + "bankBIK": "string", ~/~/ БИК
256 + "bankRS": "string", ~/~/ номер счёта
257 + "bankKS": "string" ~/~/ корр. счёт
258 +}
259 +
260 +
261 +Ответ:
262 +
263 +{
264 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
265 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
266 + "name": "string", ~/~/ имя
267 + "fullName": "string", ~/~/ полное наименование
268 + "isForeign": true, ~/~/ иностранный контрагент
269 + "district": "string", ~/~/ округ
270 + "region": "string", ~/~/ регион
271 + "city": "string", ~/~/ город
272 + "inn": "string", ~/~/ ИНН
273 + "kpp": "string", ~/~/ КПП
274 + "address": "string", ~/~/ юридический адрес
275 + "addressFact": "string", ~/~/ фактический адрес
276 + "email": "string", ~/~/ email
277 + "director": "string", ~/~/ ФИО руководителя
278 + "bankName": "string", ~/~/ банк
279 + "bankBIK": "string", ~/~/ БИК
280 + "bankRS": "string", ~/~/ номер счёта
281 + "bankKS": "string" ~/~/ корр. счёт
282 +}
283 +
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
285 +
286 +(% class="box errormessage" %)
287 +(((
288 +**DELETE /api/v3/agents/{clientId}**
289 +)))
290 +
291 +Метод позволяет удалить клиента, указанного в строке запроса.
292 +
293 +Метод запроса: **DELETE**
294 +
295 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
296 +
297 +Параметр запроса: **{clientId}** - Guid пользователя
298 +
299 +В заголовках запроса: X-Auth: Токен авторизации
300 +
301 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 +
303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 +
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
306 +
112 112  (% class="box successmessage" %)
113 113  (((
114 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
309 +(% lang="en-US" %)**POST /api/v3/users**
115 115  )))
116 116  
117 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
118 118  
119 119  (% style="color:#000000" %)Метод запроса: **POST**
120 120  
... ... @@ -124,26 +124,51 @@
124 124  
125 125  (% style="color:#000000" %)Параметры в теле запроса (JSON):
126 126  
127 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
128 128   "lastName": "", ~/~/ фамилия
129 129   "firstName": "", ~/~/ имя
130 130   "position": "", ~/~/ должность
131 131   "phone": "", ~/~/ телефон
132 132   "organization": "", ~/~/ организация
133 - "login": "", ~/~/ логин
134 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 - "email": "", ~/~/ email
136 - "description": "", ~/~/ описание
137 - "isEnabled": "", ~/~/ признак включения
329 + "login": "", ~/~/ логин (обязателен)
330 + "password": "", ~/~/ пароль (обязателен)
331 + "email": "", ~/~/ email (обязателен)
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
138 138   "parentId": "", ~/~/ Guid родительского агента
139 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
140 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
141 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
142 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 - "groups": "" , ~/~/ группы пользователя, названия групп
337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
339 + "doubleAuth":
340 + {
341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
343 + },
344 + "groups":
345 + [
346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
347 + ],
348 + "customGroups":
349 + [
350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
351 + ],
352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
145 145  }
146 146  
355 +{
356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 + "lastName": "string",
358 + "firstName": "string",
359 + "position": "string",
360 + "phone": "string",
361 + "organization": "string",
362 + "login": "string",
363 + "password": "string",
364 + "email": "string",
365 +
366 +
147 147  (% style="text-align:left" %)
148 148  (% style="color:#000000; font-weight:normal" %)Ответ:
149 149  
... ... @@ -167,27 +167,30 @@
167 167   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
168 168   "kind": "" , ~/~/ тип аутентификации
169 169   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
170 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
390 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
171 171  
172 172  (% style="text-align:left" %)
173 173  (% style="color:#000000; font-weight:normal" %)}
174 174  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
175 175  
176 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
177 177  (((
178 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
399 +(% lang="en-US" %)**POST /api/v3/users/find**
179 179  )))
180 180  
181 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
182 182  
183 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
404 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
184 184  
185 185  (% style="color:#000000" %)Метод запроса: **POST**
186 186  
187 187  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
188 188  
189 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
410 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
190 190  
412 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
413 +
191 191  (% style="color:#000000" %){
192 192  
193 193   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -213,17 +213,70 @@
213 213   "email": "" , ~/~/ E-mail
214 214   "sessionDuration":"", ~/~/ длительность сессии в минутах
215 215   "status": "1",  ~/~/ статус пользователя
216 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
217 217  
218 218  (% style="color:#000000" %)}
219 219  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
220 220  
445 +(% class="box infomessage" %)
446 +(((
447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
448 +)))
449 +
450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
451 +
452 +(% style="color:#000000" %)Метод запроса: **GET**
453 +
454 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
455 +
456 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
457 +
458 +(% style="color:#000000" %)Ответ:
459 +
460 +(((
461 +(((
462 +{
463 + "id": "", ~/~/ GUID пользователя
464 + "lastName": "", ~/~/ Фамилия 
465 + "firstName": "", ~/~/ Имя
466 + "position": "", ~/~/ Должность
467 + "phone": "", ~/~/ Номер телефона
468 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
469 + "parentName": "", Наименование клиента, которому принадлежит пользователь
470 + "organization": "", ~/~/ Организация
471 + "login": "", ~/~/ Логин пользователя
472 + "email": "", ~/~/ Адрес электронной почты
473 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
474 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
475 + "description": "", ~/~/ Описание
476 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
482 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
483 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
484 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
485 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
486 + "groups": [], ~/~/ Список ролей пользователя
487 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
488 + "authDevices": [ ], ~/~/ Список авторизованных устройств
489 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
490 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
491 +}
492 +)))
493 +)))
494 +
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
496 +
221 221  (% class="box warningmessage" %)
222 222  (((
223 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
499 +(% lang="en-US" %)**PUT /api/v3/users**
224 224  )))
225 225  
226 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
227 227  
228 228  (% style="color:#000000" %)Метод запроса: **PUT**
229 229  
... ... @@ -244,17 +244,22 @@
244 244   "position": "" , ~/~/ должность
245 245   "phone": "" , ~/~/ телефон
246 246   "organization": "" , ~/~/ организация
247 - "login": "" , ~/~/ логин
248 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
249 - "email": "" , ~/~/ email
250 - "description": "" , ~/~/ описание
523 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
527 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
528 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
251 251   "isEnabled": "" , ~/~/ признак включения
252 252   "parentId": "" , ~/~/ Guid родительского агента
253 253   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
254 254   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
255 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
256 - "kind": "" , ~/~/ тип аутентификации
257 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
258 258   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
259 259  
260 260  (% lang="en-US" style="text-align:left" %)
... ... @@ -280,8 +280,12 @@
280 280   "isEnabled": "" , ~/~/ признак включения
281 281   "parentId": "" , ~/~/ Guid родительского агента
282 282   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
283 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
284 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
285 285   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
286 286   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
287 287  
... ... @@ -288,13 +288,14 @@
288 288  (% lang="en-US" style="text-align:left" %)
289 289  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
290 290  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
291 291  
292 292  (% class="box warningmessage" %)
293 293  (((
294 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
295 295  )))
296 296  
297 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
298 298  
299 299  (% style="color:#000000" %)Метод запроса: **PUT**
300 300  
... ... @@ -317,19 +317,79 @@
317 317  (% style="text-align:left" %)
318 318  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
319 319  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
320 320  
608 +(% class="box warningmessage" %)
609 +(((
610 +**POST /api/v3/users/disable**
611 +)))
612 +
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
614 +
615 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
616 +
617 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
618 +
619 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
620 +
621 + [ 
622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
623 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
624 + ]
625 +
626 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
627 +
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
629 +
630 +(% class="box warningmessage" %)
631 +(((
632 +**POST /api/v3/users/enable**
633 +)))
634 +
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
636 +
637 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
638 +
639 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
640 +
641 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
642 +
643 + [ 
644 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
645 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
646 + ]
647 +
648 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
649 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
650 +
651 +(((
652 +В теле ответа:
653 +{
654 + "errorMessages": [
655 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
656 + ],
657 + "users": [
658 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
659 + ]
660 +}
661 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
662 +"users" - массив id пользователей, которых не удалось включить или отключить.
663 +)))
664 +
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
321 321  (% class="box errormessage" %)
322 322  (((
323 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
324 324  )))
325 325  
326 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
327 327  
328 328  (% style="color:#000000" %)Метод запроса: **DELETE**
329 329  
330 330  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
331 331  
332 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
678 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
333 333  
334 334  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
335 335  
... ... @@ -336,51 +336,211 @@
336 336  (% style="text-align:left" %)
337 337  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
338 338  
685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
339 339  
340 -(% class="box" style="text-align: center;" %)
341 -(((
342 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
343 -)))
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
344 344  
345 345  (% class="box infomessage" %)
346 346  (((
347 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
348 348  )))
349 349  
350 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
351 351  
352 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
353 353  
354 354  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
355 355  
356 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
700 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
357 357  
358 358  (% style="color:#000000" %)Метод запроса: **GET**
359 359  
360 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
704 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
361 361  
362 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
363 363  
364 364  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
365 365  
366 366  (% style="color:#000000" %)Ответ:
367 367  
368 -(% style="color:#000000" %){
712 +(((
713 +{
714 + "vehicleId": "", ~/~/ ID объекта
715 + "name": "", ~/~/ Имя объекта
716 + "imei": "", ~/~/ IMEI объекта
717 + "deviceTypeId": , ~/~/ ID типа устройства
718 + "deviceTypeName": "", ~/~/ Название типа устройства
719 + "sim1": "", ~/~/ Номер SIM1
720 + "sim2": "", ~/~/ Номер SIM2
369 369  
370 - "vehicleId": "" , ~/~/ идентификатор объекта
371 - "name": "" , ~/~/ имя объекта
372 - "imei": "" , ~/~/ IMEI объекта
373 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
374 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
375 - "parentId": "" , ~/~/ идентификатор клиента-родителя
376 - "parentName": "" , ~/~/ наименование клиента-родителя,
377 - "modelId": "" , ~/~/ идентификатор модели объекта
378 - "modelName": "" , ~/~/ наименование модели объекта,
379 - "unitId": "" , ~/~/ идентификатор подразделения
380 - "unitName": "" , ~/~/ наименование подразделения
381 - "status": "" , ~/~/ статус объекта
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
382 382  
727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 + "unitName": "string", ~/~/ Наименование подразделения
729 + "status": 0, ~/~/ Статус объекта
730 +
731 + "createdAt": "", ~/~/ Дата создания объекта
732 + },
733 +
734 +"customFields": [ ~/~/ Произвольные поля
735 + {
736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
737 + "name": "string", ~/~/ Имя поля
738 + "value": "string", ~/~/ Значение поля
739 + "forClient": true, ~/~/ Не используемая функция
740 + "forTooltip": true, ~/~/ Отображать в подсказке
741 + "forReport": true ~/~/ Отображать в отчете
742 + }
743 +
744 +], ~/~/ Данные с вкладки нормы
745 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
746 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
747 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
748 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
749 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
750 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
751 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
752 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
753 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 +
758 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 + "mileageCoeff": 0, ~/~/ коэффициент пробега
760 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
761 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
762 + "counters": { ~/~/ Счетчики
763 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
764 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
765 + "mileage": 0, ~/~/ Текущий пробег
766 + "motohours": 0, ~/~/ Текущие моточасы
767 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
768 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
769 + },
770 +
771 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
772 + "id": "string", ~/~/ ID объекта
773 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
774 + "host": "string", ~/~/ CMSV6 Web Host
775 + "login": "string", ~/~/ CMSV6 Account
776 + "password": "string" ~/~/ CMSV6 Password
777 + },
778 +
779 +"commandTemplates": [ ~/~/ Шаблоны команд
780 + {
781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
782 + "name": "string", ~/~/ Наименование команды
783 + "command": "string", ~/~/ Текст команды
784 + "retries": 0 ~/~/ Количество попыток
785 + }
786 + ],
787 +
788 + "sensors": [ ~/~/ Датчики
789 + {
790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
791 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
792 + "type": 0, ~/~/ Тип датчика
793 + "name": "string", ~/~/ Имя датчика
794 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
795 + "inputNumber": 0, ~/~/ Номер входа
796 + "pseudonym": "string", ~/~/ Псевдоним
797 + "medianDegree": 0, ~/~/ Медианная фильтрация
798 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
801 + "gradesTables": [ ~/~/ Массив таблиц тарировки
802 + {
803 + "grades": [ ~/~/ Таблица тарировки 1
804 + {
805 + "input": 0, ~/~/ Входящее значение
806 + "output": 0 ~/~/ Выходящее значение
807 + }
808 + ],
809 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
810 + }
811 + ],
812 + "showInTooltip": true, ~/~/ Отображать в подсказке
813 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
814 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
815 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
816 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
817 + "expr": "string", ~/~/ Формула
818 + "children": [ ~/~/ массив дочерних датчиков
819 + "string"
820 + ],
821 + "customParams": { ~/~/ прочие произвольные параметры
822 + "additionalProp1": "string",
823 + "additionalProp2": "string",
824 + "additionalProp3": "string"
825 + },
826 +
827 +~/~/ Характерные для произвольного:
828 +
829 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 +
831 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 +
833 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 +
835 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 +
837 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 +
839 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 +
841 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 +
843 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 +
845 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 +
847 +~/~/ "ValueOn": "Вкл.",
848 +
849 +~/~/ "ValueOff": "Выкл."
850 + "summaryMaxValue": 0 ~/~/ Макс. значение
851 + }
852 +
853 + "drivers": [ ~/~/ Водители
854 + {
855 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
856 + "name": "string", ~/~/ Наименование
857 + "description": "string",
858 + "isDefault": true ~/~/ По умолчанию
859 + }
860 + ],
861 +
862 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
863 + {
864 + "id": "", ~/~/ ID  задания
865 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
866 + "name": "", ~/~/ Наименование задания
867 + "description": "", ~/~/ Описание задания
868 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
869 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
870 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
871 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
872 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
873 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
874 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
875 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
876 + }
877 + ],
878 +
879 + "statusHistory": [ ~/~/ История статусов
880 + {
881 + "status": 0,
882 + "date": "2023-05-22T09:57:39.562Z",
883 + "description": "string",
884 + "additionalInfo": "string"
885 + }
886 + ]
887 +
383 383  }
889 +)))
384 384  
385 385  (% style="text-align:left" %)
386 386  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -388,13 +388,14 @@
388 388  (% style="text-align:left" %)
389 389  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
390 390  
897 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
391 391  
392 392  (% class="box successmessage" %)
393 393  (((
394 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
901 +(% lang="en-US" %)**POST /api/v3/vehicles**
395 395  )))
396 396  
397 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
904 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
398 398  
399 399  (% style="color:#000000" %)Метод запроса: **POST**
400 400  
... ... @@ -416,12 +416,27 @@
416 416   "sim2": "" , ~/~/ Номер SIM2
417 417   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
418 418   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
419 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
420 - "counters": {
421 - "mileage": "" , ~/~/ пробег
422 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
423 - "motohours": "" , ~/~/ моточасы
424 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
926 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
927 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
928 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
929 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
930 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
931 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
932 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
933 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
934 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
935 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
936 +
937 + "mileageCalcMethod": 0,
938 + "mileageCoeff": 0,
939 + "locationByCellId": true,
940 + "dottedLineTrackWhenNoCoords": true,
941 + "counters": ~/~/ счетчики
942 + {
943 + "mileage": "" , ~/~/ пробег
944 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
945 + "motohours": "" , ~/~/ моточасы
946 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
425 425   },
426 426   "cmsv6Parameters": { ~/~/ параметры CMSv6
427 427   "enabled": true, ~/~/ флаг включения
... ... @@ -445,8 +445,98 @@
445 445   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
446 446   }
447 447  
448 -(% style="color:#000000" %) }
970 +"drivers": [ ~/~/ Водители
971 + {
972 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
973 + "isDefault": true
974 + }
975 + ],
976 + "commandTemplates": [ ~/~/ Шаблон команды
977 + {
978 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
979 + "name": "string",
980 + "command": "string",
981 + "retries": 0
982 + }
983 + ],
449 449  
985 + "sensors": [ ~/~/ Датчики
986 + {
987 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
988 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
989 + "type": 0, ~/~/ Тип датчика
990 + "name": "string", ~/~/ Имя датчика
991 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
992 + "inputNumber": 0, ~/~/ Номер входа
993 + "pseudonym": "string", ~/~/ Псевдоним
994 + "medianDegree": 0, ~/~/ Медианная фильтрация
995 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
996 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
997 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
998 + "gradesTables": [ ~/~/ Массив таблиц тарировки
999 + {
1000 + "grades": [ ~/~/ Таблица тарировки 1
1001 + {
1002 + "input": 0, ~/~/ Входящее значение
1003 + "output": 0 ~/~/ Выходящее значение
1004 + }
1005 + ],
1006 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1007 + }
1008 + ],
1009 + "showInTooltip": true, ~/~/ Отображать в подсказке
1010 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1011 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1012 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1013 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1014 + "expr": "string", ~/~/ Формула
1015 + "children": [ ~/~/ массив дочерних датчиков
1016 + "string"
1017 + ],
1018 + "customParams": { ~/~/ прочие произвольные параметры
1019 + "additionalProp1": "string",
1020 + "additionalProp2": "string",
1021 + "additionalProp3": "string"
1022 + },
1023 +
1024 +~/~/ Характерные для произвольного:
1025 +
1026 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1027 +
1028 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1029 +
1030 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1031 +
1032 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1033 +
1034 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1035 +
1036 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1037 +
1038 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1039 +
1040 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1041 +
1042 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1043 +
1044 +~/~/ "ValueOn": "Вкл.",
1045 +
1046 +~/~/ "ValueOff": "Выкл."
1047 + "summaryMaxValue": 0 ~/~/ Макс. значение
1048 + }
1049 + ],
1050 + "customFields": [ ~/~/ Произвольные поля
1051 + {
1052 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1053 + "name": "string",
1054 + "value": "string",
1055 + "forClient": true,
1056 + "forTooltip": true,
1057 + "forReport": true
1058 + }
1059 + ]
1060 +}
1061 +
450 450  (% style="color:#000000" %)Ответ:
451 451  
452 452  (% style="color:#000000" %){
... ... @@ -492,15 +492,21 @@
492 492  (% style="text-align:left" %)
493 493  (% style="color:#000000" %)}
494 494  
1107 +**Валидация:**
1108 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1109 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1110 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
495 495  
496 -(% class="box successmessage" %)
1112 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1113 +
1114 +(% class="box infomessage" %)
497 497  (((
498 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1116 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
499 499  )))
500 500  
501 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1119 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
502 502  
503 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
1121 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
504 504  
505 505  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
506 506  
... ... @@ -518,24 +518,26 @@
518 518  
519 519  (% style="color:#000000" %)В заголовках запроса:
520 520  
521 -(% style="color:#000000" %)− Content-Type: application/json
1139 +(% style="color:#000000" %)− Content-Type: __**application/json**__
522 522  
523 523  (% style="color:#000000" %)− X-Auth: Токен авторизации
524 524  
525 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
1143 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
526 526  
527 -(% class="western" style="color:#000000" %)##{##
1145 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
528 528  
529 -(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
530 - "name": null, ~/~/ Имя ТС (string, опционально) 
531 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
532 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
533 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
534 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
535 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
536 -(% style="color:#000000" %)}
1147 +{
1148 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1149 + "name": null, ~/~/ Имя ТС (string, опционально)
1150 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1151 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1152 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1153 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1154 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1155 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1156 +}
537 537  
538 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1158 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
539 539  
540 540  (% style="color:#000000" %)Ответ:
541 541  
... ... @@ -554,27 +554,37 @@
554 554   "modelName": "" ~/~/ наименование модели объекта
555 555   "unitId": "" ~/~/ идентификатор подразделения
556 556   "unitName": "" ~/~/ наименование подразделения
557 - "status": "" ~/~/ статус объекта         
558 - "createdAt": "" ~/~/ дата создания объектов  (%%)
1177 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1178 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1179 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1180 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1181 + "customFields": [ 
1182 + {
1183 + "id": "", ~/~/ идентификатор произвольного поля
1184 + "name": "", ~/~/ имя произвольного поля
1185 + "value": "", ~/~/ значение произвольного поля
1186 + "forClient": true, ~/~/ право на отображение у клиента
1187 + "forTooltip": false, ~/~/ право на отображение в подсказке
1188 + "forReport": false ~/~/ право на отображение в отчетах
1189 + }(%%)
559 559  (% style="color:#000000" %)}
560 560  
561 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1192 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
562 562  
563 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1194 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
564 564  
565 -
566 566  (% class="box successmessage" %)
567 567  (((
568 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1198 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
569 569  )))
570 570  
571 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1201 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
572 572  
573 573  (% style="color:#000000" %)Метод запроса: **POST**
574 574  
575 575  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
576 576  
577 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
1207 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
578 578  
579 579  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
580 580  
... ... @@ -607,13 +607,14 @@
607 607  (% style="text-align:left" %)
608 608  (% style="color:#000000" %) }
609 609  
1240 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
610 610  
611 611  (% class="box warningmessage" %)
612 612  (((
613 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1244 +(% lang="en-US" %)**PUT /api/v3/vehicles**
614 614  )))
615 615  
616 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1247 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
617 617  
618 618  (% style="color:#000000" %)Метод запроса: **PUT**
619 619  
... ... @@ -623,51 +623,154 @@
623 623  
624 624  (% style="color:#000000" %)Параметры в теле запроса (JSON):
625 625  
626 -(% style="color:#000000" %){    
1257 +(% style="color:#000000" %){
627 627  
628 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
629 - "parentId": "", ~/~/ ID клиента
630 - "name": "", ~/~/ имя ТС
631 - "imei": "", ~/~/ IMEI
632 - "deviceTypeId": "", ~/~/ ID типа устройства
633 - "modelId": "", ~/~/ , ID модели    
634 - "unitId": "", ~/~/ подразделения
635 - "sim1": "", ~/~/ SIM 1
636 - "sim2": "", ~/~/ SIM2
637 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
638 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
639 - "counters": 
640 - {
641 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
642 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
643 - "mileage": «», пробег
644 - "motohours": «» моточасы
645 - }
646 - "cmsv6Parameters": ~/~/ параметры CMSv6
647 - {       
648 - "id": "", ~/~/ идентификатор
649 - "enabled": true, ~/~/ флаг включения
650 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
651 - "login": "", ~/~/ имя учетной записи
652 - "password": "", ~/~/ пароль учетной записи
653 - }
654 - "inspectionTasks": ~/~/ задания на ТО
655 - {
656 - "id": "", ~/~/ ID задания
657 - "enabled": false, ~/~/ Признак включения
658 - "name": "", ~/~/ Имя задания
659 - "description": "", ~/~/ Описание задания
660 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
661 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
663 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
664 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
665 - "kind": "", ~/~/ Вид периодичности по времени
666 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
667 - } 
1259 + "parentId": "" , ~/~/ ID клиента
1260 + "name": "" , ~/~/ имя ТС
1261 + "imei": "" , ~/~/ IMEI
1262 + "deviceTypeId": "" , ~/~/ ID типа устройства
1263 + "modelId": "" , ~/~/ ID модели
1264 + "unitId": "" , ~/~/ ID подразделения
1265 + "sim1": "" , ~/~/ Номер SIM 1
1266 + "sim2": "" , ~/~/ Номер SIM2
1267 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1268 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1269 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1270 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1271 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1272 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1273 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1274 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1275 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1276 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1277 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1278 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
668 668  
669 -(% style="color:#000000" %)}
1280 + "mileageCalcMethod": 0,
1281 + "mileageCoeff": 0,
1282 + "locationByCellId": true,
1283 + "dottedLineTrackWhenNoCoords": true,
1284 + "counters": ~/~/ счетчики
1285 + {
1286 + "mileage": "" , ~/~/ пробег
1287 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1288 + "motohours": "" , ~/~/ моточасы
1289 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1290 + },
1291 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1292 + "enabled": true, ~/~/ флаг включения
1293 + "id": "" , ~/~/ идентификатор
1294 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1295 + "login": "" , ~/~/ имя учетной записи
1296 + "password": "" ~/~/ пароль учетной записи
1297 + },
1298 + "inspectionTasks": ~/~/ задания на ТО
1299 + {
1300 + "enabled": "" , ~/~/ Признак включения
1301 + "name": "" , ~/~/ Имя задания
1302 + "description": "" , ~/~/ Описание задания
1303 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1304 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1305 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1306 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1307 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1308 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1309 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1310 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1311 + }
670 670  
1313 +"drivers": [ ~/~/ Водители
1314 + {
1315 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1316 + "isDefault": true
1317 + }
1318 + ],
1319 + "commandTemplates": [ ~/~/ Шаблон команды
1320 + {
1321 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1322 + "name": "string",
1323 + "command": "string",
1324 + "retries": 0
1325 + }
1326 + ],
1327 +
1328 + "sensors": [ ~/~/ Датчики
1329 + {
1330 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1331 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1332 + "type": 0, ~/~/ Тип датчика
1333 + "name": "string", ~/~/ Имя датчика
1334 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1335 + "inputNumber": 0, ~/~/ Номер входа
1336 + "pseudonym": "string", ~/~/ Псевдоним
1337 + "medianDegree": 0, ~/~/ Медианная фильтрация
1338 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1339 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1340 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1341 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1342 + {
1343 + "grades": [ ~/~/ Таблица тарировки 1
1344 + {
1345 + "input": 0, ~/~/ Входящее значение
1346 + "output": 0 ~/~/ Выходящее значение
1347 + }
1348 + ],
1349 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1350 + }
1351 + ],
1352 + "showInTooltip": true, ~/~/ Отображать в подсказке
1353 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1354 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1355 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1356 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1357 + "expr": "string", ~/~/ Формула
1358 + "children": [ ~/~/ массив дочерних датчиков
1359 + "string"
1360 + ],
1361 + "customParams": { ~/~/ прочие произвольные параметры
1362 + "additionalProp1": "string",
1363 + "additionalProp2": "string",
1364 + "additionalProp3": "string"
1365 + },
1366 +
1367 +~/~/ Характерные для произвольного:
1368 +
1369 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1370 +
1371 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1372 +
1373 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1374 +
1375 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1376 +
1377 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1378 +
1379 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1380 +
1381 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1382 +
1383 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1384 +
1385 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1386 +
1387 +~/~/ "ValueOn": "Вкл.",
1388 +
1389 +~/~/ "ValueOff": "Выкл."
1390 + "summaryMaxValue": 0 ~/~/ Макс. значение
1391 + }
1392 + ],
1393 + "customFields": [ ~/~/ Произвольные поля
1394 + {
1395 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1396 + "name": "string",
1397 + "value": "string",
1398 + "forClient": true,
1399 + "forTooltip": true,
1400 + "forReport": true
1401 + }
1402 + ]
1403 +}
1404 +
671 671  (% style="color:#000000" %)Ответ:
672 672  
673 673  (% lang="en-US" style="text-align:left" %)
... ... @@ -718,19 +718,25 @@
718 718  (% lang="en-US" style="text-align:left" %)
719 719  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
720 720  
1455 +**Валидация:**
1456 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1457 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1458 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
721 721  
1460 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1461 +
722 722  (% class="box errormessage" %)
723 723  (((
724 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1464 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
725 725  )))
726 726  
727 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1467 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
728 728  
729 729  (% style="color:#000000" %)Метод запроса: **DELETE**
730 730  
731 731  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
732 732  
733 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1473 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
734 734  
735 735  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
736 736  
... ... @@ -737,18 +737,16 @@
737 737  (% style="text-align:left" %)
738 738  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
739 739  
1480 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
740 740  
741 -(% class="box" lang="en-US" style="text-align: center;" %)
742 -(((
743 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
744 -)))
1482 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
745 745  
746 746  (% class="box infomessage" %)
747 747  (((
748 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1486 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
749 749  )))
750 750  
751 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1489 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
752 752  
753 753  (% style="color:#000000" %)Метод запроса: **GET**
754 754  
... ... @@ -766,24 +766,22 @@
766 766  (% style="text-align:left" %)
767 767  (% style="color:#000000" %)}
768 768  
1507 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
769 769  
770 -(% class="box" style="text-align: center;" %)
771 -(((
772 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
773 -)))
1509 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
774 774  
775 775  (% class="box infomessage" %)
776 776  (((
777 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1513 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
778 778  )))
779 779  
780 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1516 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
781 781  
782 782  (% style="color:#000000" %)Метод запроса: **GET**
783 783  
784 784  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
785 785  
786 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1522 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
787 787  
788 788  (% style="color:#000000" %)Ответ:
789 789  
... ... @@ -796,7 +796,851 @@
796 796  (% style="text-align:left" %)
797 797  (% style="color:#000000" %)}
798 798  
1535 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
799 799  
1537 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1538 +
1539 +(% class="box infomessage" style="text-align: left;" %)
1540 +(((
1541 +**POST /api/v3/terminalMessages/count**
1542 +)))
1543 +
1544 +(% style="text-align: left;" %)
1545 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1546 +
1547 +(% style="text-align: left;" %)
1548 +Метод запроса **POST**
1549 +
1550 +(% style="text-align: left;" %)
1551 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1552 +
1553 +(% style="text-align: left;" %)
1554 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1555 +
1556 +(% style="text-align: left;" %)
1557 +{
1558 + "vehicleIds": [
1559 + id ~/~/ здесь передается список идентификаторов объектов
1560 + ],
1561 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1562 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1563 +}
1564 +
1565 +(% style="text-align: left;" %)
1566 +Ответ:
1567 +
1568 +(% style="text-align: left;" %)
1569 +[
1570 + {
1571 + "vehicleId": 0, ~/~/ идентификатор объекта
1572 + "count": 0 ~/~/ количество сообщений за период
1573 + }
1574 +]
1575 +
1576 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 +
1578 +(% class="box infomessage" %)
1579 +(((
1580 +**POST /api/v3/terminalMessages**
1581 +)))
1582 +
1583 +Метод возвращает список сообщений терминала объекта за выбранный период.
1584 +
1585 +(% style="text-align: left;" %)
1586 +Метод запроса **POST**
1587 +
1588 +(% style="text-align: left;" %)
1589 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1590 +
1591 +(% style="text-align: left;" %)
1592 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1593 +
1594 +{
1595 + "vehicleId": 0, ~/~/ id объекта
1596 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1597 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 +}
1599 +
1600 +Ответ:
1601 +
1602 +[
1603 + {
1604 + "messages": [
1605 + {
1606 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 + "speed": 0, ~/~/ Скорость, км/ч
1609 + "altitude": 0, ~/~/ Высота, м
1610 + "latitude": 0, ~/~/ Широта [-90°;90°]
1611 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 + "satellites": 0, ~/~/ Кол-во спутников
1613 + "voltage": 0, ~/~/ Напряжение
1614 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1615 + "additionalProp1": "string",
1616 + "additionalProp2": "string",
1617 + "additionalProp3": "string"
1618 + },
1619 + "photoCount": 0 ~/~/ Кол-во фото
1620 + }
1621 + ]
1622 + }
1623 +]
1624 +
1625 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1626 +
1627 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1628 +
1629 +(% class="box infomessage" %)
1630 +(((
1631 +**POST /api/v3/notifications/find**
1632 +)))
1633 +
1634 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1635 +
1636 +(% style="text-align: left;" %)
1637 +Метод запроса **POST**
1638 +
1639 +(% style="text-align: left;" %)
1640 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1641 +
1642 +(% style="text-align: left;" %)
1643 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1644 +
1645 +{
1646 + "parentId": "" ~/~/ id клиента
1647 +}
1648 +
1649 +Ответ:
1650 +
1651 +[
1652 + {
1653 + "id": 0, ~/~/ ID уведомления
1654 + "name": "string", ~/~/ Название уведомления
1655 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1656 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1657 + "userId": "", ~/~/ Пользователь, создавший уведомление
1658 + "parentId": "", ~/~/ Идентификатор клиента
1659 + "parentName": "string" ~/~/ Имя клиента
1660 + }
1661 +]
1662 +
1663 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1664 +
1665 +(% class="box infomessage" %)
1666 +(((
1667 +**GET /api/v3/notifications/{id}**
1668 +)))
1669 +
1670 +Метод возвращает данные правил формирования выбранного уведомления.
1671 +
1672 +(% style="text-align: left;" %)
1673 +Метод запроса **GET**
1674 +
1675 +(% style="text-align: left;" %)
1676 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1677 +
1678 +(% style="text-align: left;" %)
1679 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1680 +
1681 +(% style="text-align: left;" %)
1682 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1683 +
1684 +(% style="text-align: left;" %)
1685 +(% style="color:#000000" %)Ответ:
1686 +
1687 +(% style="text-align: left;" %)
1688 +(% style="color:#000000" %){
1689 + "id": 0, ~/~/ (%%)id уведомления
1690 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1691 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1692 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1693 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1694 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1695 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1696 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1697 +(% style="color:#000000" %) 0
1698 + ],
1699 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1700 +(% style="color:#000000" %) 0
1701 + ],
1702 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1703 +(% style="color:#000000" %) 0
1704 + ],
1705 + "settings": { ~/~/ Список параметров уведомления
1706 + "additionalProp1": "string",
1707 + "additionalProp2": "string",
1708 + "additionalProp3": "string"
1709 + },
1710 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1711 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1712 +(% style="color:#000000" %) ""
1713 + ],
1714 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1715 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1716 +(% style="color:#000000" %) "string"
1717 + ],
1718 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1719 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1720 +(% style="color:#000000" %) {
1721 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1722 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1723 +(% style="color:#000000" %) }
1724 + ],
1725 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1726 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1727 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1728 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1729 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1730 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1731 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1732 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1733 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1734 +(% style="color:#000000" %)}
1735 +
1736 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1737 +
1738 +(% class="box warningmessage" %)
1739 +(((
1740 +**PUT /api/v3/notifications/**
1741 +)))
1742 +
1743 +Метод позволяет отредактировать уведомление.
1744 +
1745 +Метод запроса **PUT**
1746 +
1747 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1748 +
1749 +В заголовках запроса: X-Auth: Токен авторизации
1750 +
1751 +Тело запроса:
1752 +{
1753 + "id": 0, ~/~/ id уведомления
1754 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1755 + "userId": "", ~/~/ Пользователь, создавший уведомление
1756 + "parentId": "", ~/~/ Идентификатор клиента
1757 + "parentName": "string", ~/~/ Имя клиента
1758 + "name": "string", ~/~/ Название уведомления
1759 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1760 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1761 + 0
1762 + ],
1763 + "geoids": [ ~/~/ Список id геообъектов для анализа
1764 + 0
1765 + ],
1766 + "fieldids": [ ~/~/ Список id полей для анализа
1767 + 0
1768 + ],
1769 + "settings": { ~/~/ Список параметров уведомления
1770 + "additionalProp1": "string",
1771 + "additionalProp2": "string",
1772 + "additionalProp3": "string"
1773 + },
1774 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1775 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1776 + ""
1777 + ],
1778 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1779 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1780 + "string"
1781 + ],
1782 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1783 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1784 + {
1785 + "id": 0, ~/~/ Идентификатор участника чата
1786 + "info": "string" ~/~/ Дополнительные сведения
1787 + }
1788 + ],
1789 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1790 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1791 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1792 + "kind": 0, ~/~/ Определяет вид уведомления
1793 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1794 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1795 + "timezone": 0, ~/~/ Сдвиг часового пояса
1796 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1797 + "autoProlongation": true ~/~/ Автопродление срока действия
1798 +}
1799 +
1800 +Ответ:
1801 +
1802 +Success
1803 +
1804 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1805 +
1806 +(% class="box errormessage" %)
1807 +(((
1808 +**DELETE /api/v3/notifications/{id}**
1809 +)))
1810 +
1811 +Метод позволяет удалить выбранное уведомление.
1812 +
1813 +Метод запроса **DELETE**
1814 +
1815 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1816 +
1817 +Передаваемый параметр: {id} - id уведомления
1818 +
1819 +В заголовках запроса: X-Auth: Токен авторизации
1820 +
1821 +Ответ:
1822 +
1823 +Success
1824 +
1825 +
1826 += Раздел: **Водители** =
1827 +
1828 +Получить список водителей клиента
1829 +
1830 +POST /api/v3/Drivers/find
1831 +
1832 +Передается: parentId - ID клиента-родителя
1833 +
1834 +Ответ:
1835 +
1836 +{{{[
1837 + {
1838 + "name": "string", //Определяет наименование
1839 + "description": "string", // Определяет описание
1840 + "hiredate": "2023-06-30T09:37:58.407Z", // Определяет дату найма
1841 + "chopdate": "2023-06-30T09:37:58.407Z", // Определяет дату увольнения
1842 + "exclusive": true, // Определяет признак "Исключительный"
1843 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя
1844 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
1845 + "deleted": true // Признак удаления
1846 + }
1847 +]}}}
1848 +
1849 +
1850 +Получить данные о водителе
1851 +
1852 +GET /api/v3/Drivers/{driverGuid}
1853 +
1854 +Передается ID водителя
1855 +
1856 +Ответ:
1857 +
1858 +{{{{
1859 + "name": "string", // Определяет наименование
1860 + "description": "string", // Определяет описание
1861 + "hiredate": "2023-06-30T09:33:33.083Z", // Определяет дату найма
1862 + "chopdate": "2023-06-30T09:33:33.083Z", // Определяет дату увольнения
1863 + "exclusive": true, // Определяет признак "Исключительный"
1864 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя
1865 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
1866 + "deleted": true // Признак удаления
1867 +}
1868 +}}}
1869 +
1870 +
1871 +Добавить водителя
1872 +
1873 +POST /api/v3/Drivers
1874 +
1875 +Передается:
1876 +
1877 +{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:43:05.949Z", "chopdate": "2023-06-30T09:43:05.949Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
1878 +
1879 +Ответ:
1880 +
1881 +{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:43:06.014Z", "chopdate": "2023-06-30T09:43:06.014Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
1882 +
1883 +
1884 +Редактировать водителя
1885 +
1886 +PUT /api/v3/Drivers
1887 +
1888 +Передается:
1889 +
1890 +{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:45:41.382Z", "chopdate": "2023-06-30T09:45:41.382Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
1891 +
1892 +Ответ:
1893 +
1894 +{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:45:41.433Z", "chopdate": "2023-06-30T09:45:41.433Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
1895 +
1896 +
1897 +Удалить водителя
1898 +
1899 +DELETE /api/v3/Drivers/{driverGuid}
1900 +
1901 +Передается ID водителя
1902 +
1903 +Ответ:
1904 +
1905 +Success
1906 +
1907 +
1908 += Раздел: **Журнал назначений** =
1909 +
1910 +**Назначение водителя на объект**
1911 +
1912 +Получить назначения водителей запросом к водителю
1913 +
1914 +POST /api/v3/DriversVehiclesAssignments/GetByDrivers
1915 +
1916 +Передаем:
1917 +
1918 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T09:52:31.196Z", "EndTime": "2023-06-30T09:52:31.196Z" }}}}
1919 +
1920 +Ответ:
1921 +
1922 +{{{[
1923 + {
1924 + "VehicleId": 0,
1925 + "CreateTime": "2023-06-30T09:52:31.240Z",
1926 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1927 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1928 + "BeginTime": "2023-06-30T09:52:31.240Z",
1929 + "EndTime": "2023-06-30T09:52:31.240Z"
1930 + }
1931 +]}}}
1932 +
1933 +
1934 +Получить назначения водителей запросом к объекту
1935 +
1936 +POST /api/v3/DriversVehiclesAssignments/GetByVehicles
1937 +
1938 +Передаем:
1939 +
1940 +{{{{ "Ids": [ 0 ], "BeginTime": "2023-06-30T09:54:01.583Z", "EndTime": "2023-06-30T09:54:01.583Z" }}}}
1941 +
1942 +Ответ:
1943 +
1944 +{{{[
1945 + {
1946 + "VehicleId": 0,
1947 + "CreateTime": "2023-06-30T09:54:01.631Z",
1948 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1949 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1950 + "BeginTime": "2023-06-30T09:54:01.631Z",
1951 + "EndTime": "2023-06-30T09:54:01.631Z"
1952 + }
1953 +]}}}
1954 +
1955 +
1956 +Создать назначение водителя на объект
1957 +
1958 +POST /api/v3/DriversVehiclesAssignments
1959 +
1960 +Передается массив назначений
1961 +
1962 +Запрос:
1963 +
1964 +{{{[
1965 + {
1966 + "VehicleId": 0, // Идентификатор объекта
1967 + "CreateTime": "2023-06-30T11:04:46.902Z", // Момент времени создания назначения
1968 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
1969 + "BeginTime": "2023-06-30T11:04:46.902Z", // Момент времени начала назначения
1970 + "EndTime": "2023-06-30T11:04:46.902Z" // Момент времени окончания назначения. Необязательно.
1971 + }
1972 +]}}}
1973 +
1974 +Ответ:
1975 +
1976 +{{{[
1977 + {
1978 + "VehicleId": 0,
1979 + "CreateTime": "2023-06-30T11:04:46.903Z",
1980 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1981 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1982 + "BeginTime": "2023-06-30T11:04:46.903Z",
1983 + "EndTime": "2023-06-30T11:04:46.903Z"
1984 + }
1985 +]}}}
1986 +
1987 +
1988 +Изменить назначения водителей на объекты
1989 +
1990 +PUT /api/v3/DriversVehiclesAssignments
1991 +
1992 +Запрос:
1993 +
1994 +{{{[
1995 + {
1996 + "VehicleId": 0,
1997 + "CreateTime": "2023-06-30T11:14:08.117Z",
1998 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
1999 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2000 + "BeginTime": "2023-06-30T11:14:08.117Z",
2001 + "EndTime": "2023-06-30T11:14:08.117Z"
2002 + }
2003 +]}}}
2004 +
2005 +Ответ:
2006 +
2007 +{{{[
2008 + {
2009 + "VehicleId": 0,
2010 + "CreateTime": "2023-06-30T11:14:53.349Z",
2011 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2012 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2013 + "BeginTime": "2023-06-30T11:14:53.349Z",
2014 + "EndTime": "2023-06-30T11:14:53.349Z"
2015 + }
2016 +]}}}
2017 +
2018 +
2019 +Удалить назначения водителей на объекты
2020 +
2021 +DELETE /api/v3/DriversVehiclesAssignments
2022 +
2023 +Запрос:
2024 +
2025 +{{{[
2026 + {
2027 + "VehicleId": 0,
2028 + "CreateTime": "2023-06-30T11:16:08.341Z",
2029 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2030 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2031 + "BeginTime": "2023-06-30T11:16:08.342Z",
2032 + "EndTime": "2023-06-30T11:16:08.342Z"
2033 + }
2034 +]}}}
2035 +
2036 +Ответ:
2037 +
2038 +{{{[
2039 + {
2040 + "VehicleId": 0,
2041 + "CreateTime": "2023-06-30T11:16:08.344Z",
2042 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2043 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2044 + "BeginTime": "2023-06-30T11:16:08.344Z",
2045 + "EndTime": "2023-06-30T11:16:08.344Z"
2046 + }
2047 +]}}}
2048 +
2049 +
2050 +**Назначение карты-метки водителю**
2051 +
2052 +Получить назначения меток запросом к водителю
2053 +
2054 +POST /api/v3/DriversRfidsAssignments/GetByDrivers
2055 +
2056 +Запрос:
2057 +
2058 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы водителей ], "BeginTime": "2023-06-30T11:19:40.702Z", "EndTime": "2023-06-30T11:19:40.702Z" }}}}
2059 +
2060 +Ответ:
2061 +
2062 +{{{[
2063 + {
2064 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2065 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2066 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2067 + "BeginTime": "2023-06-30T11:19:40.703Z",
2068 + "EndTime": "2023-06-30T11:19:40.703Z"
2069 + }
2070 +]}}}
2071 +
2072 +
2073 +Получить назначения меток запросом к карте-метке
2074 +
2075 +POST /api/v3/DriversRfidsAssignments/GetByDrivers
2076 +
2077 +Запрос:
2078 +
2079 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы карт-меток ], "BeginTime": "2023-06-30T11:19:40.702Z", "EndTime": "2023-06-30T11:19:40.702Z" }}}}
2080 +
2081 +Ответ:
2082 +
2083 +{{{[
2084 + {
2085 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2086 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2087 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2088 + "BeginTime": "2023-06-30T11:19:40.703Z",
2089 + "EndTime": "2023-06-30T11:19:40.703Z"
2090 + }
2091 +]}}}
2092 +
2093 +
2094 +Добавить назначения меток на водителей.
2095 +
2096 +POST /api/v3/DriversRfidsAssignments
2097 +
2098 +Запрос:
2099 +
2100 +{{{[
2101 + {
2102 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2103 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2104 + "BeginTime": "2023-06-30T11:27:08.635Z",
2105 + "EndTime": "2023-06-30T11:27:08.635Z"
2106 + }
2107 +]}}}
2108 +
2109 +Ответ:
2110 +
2111 +{{{[
2112 + {
2113 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2114 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2115 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2116 + "BeginTime": "2023-06-30T11:27:08.677Z",
2117 + "EndTime": "2023-06-30T11:27:08.677Z"
2118 + }
2119 +]}}}
2120 +
2121 +
2122 +Изменить назначения меток на водителей
2123 +
2124 +PUT /api/v3/DriversRfidsAssignments
2125 +
2126 +Запрос:
2127 +
2128 +{{{[
2129 + {
2130 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2131 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2132 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2133 + "BeginTime": "2023-06-30T11:28:43.330Z",
2134 + "EndTime": "2023-06-30T11:28:43.330Z"
2135 + }
2136 +]}}}
2137 +
2138 +Ответ:
2139 +
2140 +{{{[
2141 + {
2142 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2143 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2144 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2145 + "BeginTime": "2023-06-30T11:28:43.331Z",
2146 + "EndTime": "2023-06-30T11:28:43.331Z"
2147 + }
2148 +]}}}
2149 +
2150 +
2151 +Удалить назначения меток на водителей
2152 +
2153 +DELETE /api/v3/DriversRfidsAssignments
2154 +
2155 +Запрос:
2156 +
2157 +{{{[
2158 + {
2159 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2160 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2161 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2162 + "BeginTime": "2023-06-30T11:28:43.330Z",
2163 + "EndTime": "2023-06-30T11:28:43.330Z"
2164 + }
2165 +]}}}
2166 +
2167 +Ответ:
2168 +
2169 +{{{[
2170 + {
2171 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2172 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2173 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2174 + "BeginTime": "2023-06-30T11:28:43.331Z",
2175 + "EndTime": "2023-06-30T11:28:43.331Z"
2176 + }
2177 +]}}}
2178 +
2179 +
2180 +**Назначение топливной карты водителю**
2181 +
2182 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2183 +
2184 +POST /api/v3/DriversFuelCardsAssignments/GetByDrivers
2185 +
2186 +Запрос:
2187 +
2188 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T11:58:04.693Z", "EndTime": "2023-06-30T11:58:04.693Z" }}}}
2189 +
2190 +Ответ:
2191 +
2192 +{{{[
2193 + {
2194 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2195 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2196 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2197 + "BeginTime": "2023-06-30T11:58:04.695Z",
2198 + "EndTime": "2023-06-30T11:58:04.695Z"
2199 + }
2200 +]}}}
2201 +
2202 +
2203 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2204 +
2205 +POST /api/v3/DriversFuelCardsAssignments/GetByCards
2206 +
2207 +Запрос:
2208 +
2209 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T11:58:04.693Z", "EndTime": "2023-06-30T11:58:04.693Z" }}}}
2210 +
2211 +Ответ:
2212 +
2213 +{{{[
2214 + {
2215 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2216 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2217 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2218 + "BeginTime": "2023-06-30T11:58:04.695Z",
2219 + "EndTime": "2023-06-30T11:58:04.695Z"
2220 + }
2221 +]}}}
2222 +
2223 +
2224 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2225 +
2226 +POST /api/v3/DriversFuelCardsAssignments
2227 +
2228 +Запрос:
2229 +
2230 +{{{[
2231 + {
2232 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2233 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2234 + "BeginTime": "2023-06-30T12:09:53.175Z",
2235 + "EndTime": "2023-06-30T12:09:53.175Z"
2236 + }
2237 +]}}}
2238 +
2239 +Ответ:
2240 +
2241 +{{{[
2242 + {
2243 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2244 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2245 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2246 + "BeginTime": "2023-06-30T12:09:53.201Z",
2247 + "EndTime": "2023-06-30T12:09:53.201Z"
2248 + }
2249 +]}}}
2250 +
2251 +
2252 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2253 +
2254 +PUT /api/v3/DriversFuelCardsAssignments
2255 +
2256 +Запрос:
2257 +
2258 +{{{[
2259 + {
2260 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2261 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2262 + "BeginTime": "2023-06-30T12:09:53.175Z",
2263 + "EndTime": "2023-06-30T12:09:53.175Z"
2264 + }
2265 +]}}}
2266 +
2267 +Ответ:
2268 +
2269 +{{{[
2270 + {
2271 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2272 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2273 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2274 + "BeginTime": "2023-06-30T12:09:53.201Z",
2275 + "EndTime": "2023-06-30T12:09:53.201Z"
2276 + }
2277 +]}}}
2278 +
2279 +
2280 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2281 +
2282 +DELETE /api/v3/DriversFuelCardsAssignments
2283 +
2284 +Запрос:
2285 +
2286 +{{{[
2287 + {
2288 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2289 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2290 + "BeginTime": "2023-06-30T12:09:53.175Z",
2291 + "EndTime": "2023-06-30T12:09:53.175Z"
2292 + }
2293 +]}}}
2294 +
2295 +Ответ:
2296 +
2297 +{{{[
2298 + {
2299 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2300 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2301 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2302 + "BeginTime": "2023-06-30T12:09:53.201Z",
2303 + "EndTime": "2023-06-30T12:09:53.201Z"
2304 + }
2305 +]}}}
2306 +
2307 +
2308 +(% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%)
2309 +
2310 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
2311 +
2312 +POST /api/v3/Rfids/find
2313 +
2314 +Запрос:
2315 +
2316 +{{{{ "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }}}}
2317 +
2318 +Ответ:
2319 +
2320 +{{{[
2321 + {
2322 + "name": "string",
2323 + "number": 0,
2324 + "period": 0, // Частота трансляции радиометки
2325 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2326 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2327 + "deleted": true
2328 + }
2329 +]}}}
2330 +
2331 +
2332 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2333 +
2334 +GET /api/v3/Rfids/{rfidGuid}
2335 +
2336 +Передаем параметр rfidGuid - идентификатор карты-метки
2337 +
2338 +Ответ:
2339 +
2340 +{{{{ "name": "string", "number": 0, "period": 0, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
2341 +
2342 +
2343 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2344 +
2345 +POST /api/v3/Rfids
2346 +
2347 +Запрос:
2348 +
2349 +{{{{ "name": "string", "number": 0, "period": 0, "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
2350 +
2351 +Ответ:
2352 +
2353 +{{{{ "name": "string", "number": 0, "period": 0, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
2354 +
2355 +
2356 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2357 +
2358 +PUT /api/v3/Rfids
2359 +
2360 +Запрос:
2361 +
2362 +{{{{ "name": "string", "number": 0, "period": 0, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
2363 +
2364 +Ответ:
2365 +
2366 +{{{{ "name": "string", "number": 0, "period": 0, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}}
2367 +
2368 +
2369 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2370 +
2371 +DELETE /api/v3/Rfids/{rfidGuid}
2372 +
2373 +Передаем параметр rfidGuid - идентификатор карты-метки
2374 +
2375 +Ответ:
2376 +
2377 +Success
2378 +
2379 +
800 800  (% class="box" lang="en-US" style="text-align: center;" %)
801 801  (((
802 802  (% 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]] **

Меню

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