Last modified by Андрей Калиновский on 2025/03/28 11:43
<
From version < 20.5 >
edited by Артем Шемяков
on 2022/09/01 17:32
To version < 104.2 >
edited by Илья Крайнов
on 2023/08/03 18:01
>
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 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
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,21 +40,22 @@
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 - }
54 +}
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,59 +65,243 @@
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  
83 83  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 84  
85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
133 +(% 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": "", ~/~/ тип клиента1
103 - "status": "", ~/~/ статус клиента
104 - }
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 - Отказ)
155 +}
105 105  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
106 106  
107 -(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
159 +(% class="box successmessage" %)
160 +(((
161 +**POST /api/v3/agents **
162 +)))
108 108  
164 +Метод позволяет добавить клиента, указанного в запросе.
109 109  
110 -(% class="box" style="text-align: center;" %)
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" %)
111 111  (((
112 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
224 +**PUT /api/v3/agents**
113 113  )))
114 114  
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 +
115 115  (% class="box successmessage" %)
116 116  (((
117 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
309 +(% lang="en-US" %)**POST /api/v3/users**
118 118  )))
119 119  
120 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
121 121  
122 122  (% style="color:#000000" %)Метод запроса: **POST**
123 123  
... ... @@ -127,31 +127,56 @@
127 127  
128 128  (% style="color:#000000" %)Параметры в теле запроса (JSON):
129 129  
130 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
131 131   "lastName": "", ~/~/ фамилия
132 132   "firstName": "", ~/~/ имя
133 133   "position": "", ~/~/ должность
134 134   "phone": "", ~/~/ телефон
135 135   "organization": "", ~/~/ организация
136 - "login": "", ~/~/ логин
137 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 - "email": "", ~/~/ email
139 - "description": "", ~/~/ описание
140 - "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 - отключен
141 141   "parentId": "", ~/~/ Guid родительского агента
142 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
143 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
144 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
145 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 - "groups": "" , ~/~/ группы пользователя, названия групп
148 - }
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 - Азербайджанский
353 +}
149 149  
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 +
150 150  (% style="text-align:left" %)
151 151  (% style="color:#000000; font-weight:normal" %)Ответ:
152 152  
153 153  (% style="text-align:left" %)
154 -(% style="color:#000000; font-weight:normal" %){
371 +(% style="color:#000000; font-weight:normal" %){    
155 155  
156 156  (% style="text-align:left" %)
157 157  (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
... ... @@ -170,27 +170,30 @@
170 170   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
171 171   "kind": "" , ~/~/ тип аутентификации
172 172   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
173 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
390 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
174 174  
175 175  (% style="text-align:left" %)
176 -(% style="color:#000000; font-weight:normal" %) }
393 +(% style="color:#000000; font-weight:normal" %)}
177 177  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
178 178  
179 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
180 180  (((
181 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
399 +(% lang="en-US" %)**POST /api/v3/users/find**
182 182  )))
183 183  
184 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
185 185  
186 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
404 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
187 187  
188 188  (% style="color:#000000" %)Метод запроса: **POST**
189 189  
190 190  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
191 191  
192 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
410 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
193 193  
412 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
413 +
194 194  (% style="color:#000000" %){
195 195  
196 196   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -198,11 +198,11 @@
198 198   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 199   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
200 200  
201 -(% style="color:#000000" %) }
421 +(% style="color:#000000" %)}
202 202  
203 203  (% style="color:#000000" %)Ответ:
204 204  
205 -(% style="color:#000000" %){ (%%)
425 +(% style="color:#000000" %){         (%%)
206 206  
207 207   "id": "" , ~/~/ идентификатор пользователя
208 208   "lastName": "" , ~/~/ фамилия
... ... @@ -216,17 +216,70 @@
216 216   "email": "" , ~/~/ E-mail
217 217   "sessionDuration":"", ~/~/ длительность сессии в минутах
218 218   "status": "1",  ~/~/ статус пользователя
219 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
220 220  
221 -(% style="color:#000000" %) }
441 +(% style="color:#000000" %)}
222 222  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
223 223  
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 +
224 224  (% class="box warningmessage" %)
225 225  (((
226 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
499 +(% lang="en-US" %)**PUT /api/v3/users**
227 227  )))
228 228  
229 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
230 230  
231 231  (% style="color:#000000" %)Метод запроса: **PUT**
232 232  
... ... @@ -235,98 +235,386 @@
235 235  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
236 236  
237 237  (% lang="en-US" style="text-align:left" %)
238 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
511 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
239 239  
513 +(% lang="en-US" style="text-align:left" %)
514 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
240 240  
516 +(% lang="en-US" style="text-align:left" %)
517 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
518 + "lastName": "" , ~/~/ фамилия
519 + "firstName": "" , ~/~/ имя
520 + "position": "" , ~/~/ должность
521 + "phone": "" , ~/~/ телефон
522 + "organization": "" , ~/~/ организация
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": "" , ~/~/ описание
529 + "isEnabled": "" , ~/~/ признак включения
530 + "parentId": "" , ~/~/ Guid родительского агента
531 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
532 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 +
541 +(% lang="en-US" style="text-align:left" %)
542 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
543 +
544 +(% lang="en-US" style="text-align:left" %)
545 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
546 +
547 +(% lang="en-US" style="text-align:left" %)
548 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
549 +
550 +(% lang="en-US" style="text-align:left" %)
551 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
552 + "lastName": "" , ~/~/ фамилия
553 + "firstName": "" , ~/~/ имя
554 + "position": "" , ~/~/ должность
555 + "phone": "" , ~/~/ телефон
556 + "organization": "" , ~/~/ организация
557 + "login": "" , ~/~/ логин
558 + "password": "" , ~/~/ пароль 
559 + "email": "" , ~/~/ email
560 + "description": "" , ~/~/ описание
561 + "isEnabled": "" , ~/~/ признак включения
562 + "parentId": "" , ~/~/ Guid родительского агента
563 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
570 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
571 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
572 +
573 +(% lang="en-US" style="text-align:left" %)
574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 +
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
577 +
241 241  (% class="box warningmessage" %)
242 242  (((
243 -(% 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}**
244 244  )))
245 245  
246 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
247 247  
248 248  (% style="color:#000000" %)Метод запроса: **PUT**
249 249  
250 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:
587 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
251 251  
252 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
589 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
253 253  
254 -(% class="western" %)
255 -{{{ "description": "", // описание
256 - "data": "" // данные, связанные со сменой статуса}}}
591 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
257 257  
593 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
594 +
595 +(% style="color:#000000" %){
596 +
597 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
598 + "description": "" , ~/~/ описание
599 + "data": "" , ~/~/ данные, связанные со сменой статуса
600 +
258 258  (% style="color:#000000" %)}
259 259  
260 260  (% style="text-align:left" %)
261 261  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
262 262  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
263 263  
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 +
264 264  (% class="box errormessage" %)
265 265  (((
266 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
267 267  )))
268 268  
269 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
270 270  
271 271  (% style="color:#000000" %)Метод запроса: **DELETE**
272 272  
273 273  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
274 274  
275 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
678 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
276 276  
680 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
681 +
277 277  (% style="text-align:left" %)
278 278  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
279 279  
685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
280 280  
281 -(% class="box" style="text-align: center;" %)
282 -(((
283 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
284 -)))
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
285 285  
286 286  (% class="box infomessage" %)
287 287  (((
288 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
289 289  )))
290 290  
291 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
292 292  
293 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
294 294  
295 295  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
296 296  
297 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
700 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
298 298  
299 299  (% style="color:#000000" %)Метод запроса: **GET**
300 300  
301 -(% 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}
302 302  
303 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
304 304  
305 305  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
306 306  
307 307  (% style="color:#000000" %)Ответ:
308 308  
309 -(% style="color:#000000" %){
712 +(((
713 +{
714 + "vehicleId": "", ~/~/ ID объекта
715 + "name": "", ~/~/ Имя объекта
716 + "imei": "", ~/~/ IMEI объекта
717 + "deviceTypeId": , ~/~/ ID типа устройства
718 + "deviceTypeName": "", ~/~/ Название типа устройства
719 + "sim1": "", ~/~/ Номер SIM1
720 + "sim2": "", ~/~/ Номер SIM2
310 310  
311 -(% class="western" %)
312 -{{{ "vehicleId": “”, // идентификатор объекта
313 - "name": "", // имя объекта
314 - "imei": "", // IMEI объекта
315 - "deviceTypeId": “”, // идентификатор устройства объекта
316 - "deviceTypeName": "" // наименование устройства объекта
317 - "parentId": "", // идентификатор клиента-родителя
318 - "parentName": "" // наименование клиента-родителя,
319 - "modelId": "", // идентификатор модели объекта
320 - "modelName": "" // наименование модели объекта,
321 - "unitId": "", // идентификатор подразделения
322 - "unitName": "", // наименование подразделения
323 - "status": “”, // статус объекта
324 - ...
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
726 +
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" ~/~/ Дата пересчета последних моточасов
325 325   },
326 - ...}}}
327 327  
328 -(% style="color:#000000" %)}
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 + },
329 329  
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 +
888 +}
889 +)))
890 +
330 330  (% style="text-align:left" %)
331 331  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
332 332  
... ... @@ -333,13 +333,14 @@
333 333  (% style="text-align:left" %)
334 334  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
335 335  
897 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
336 336  
337 337  (% class="box successmessage" %)
338 338  (((
339 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
901 +(% lang="en-US" %)**POST /api/v3/vehicles**
340 340  )))
341 341  
342 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
904 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
343 343  
344 344  (% style="color:#000000" %)Метод запроса: **POST**
345 345  
... ... @@ -347,118 +347,226 @@
347 347  
348 348  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
349 349  
350 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
912 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
351 351  
352 -(% class="western" %)
353 -{{{ "parentId": "", // ID клиента
354 - "name": "", // имя ТС
355 - "imei": "", // IMEI
356 - "deviceTypeId": "",// ID типа устройства
357 - "modelId": "",
358 - "unitId": "", // ID подразделения
359 - "sim1": "", // Номер SIM 1
360 - "sim2": "", // Номер SIM2
361 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
362 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
363 - "consumptionIdle": "",// Расход топлива на холостом ходу
364 - "counters": {
365 - "mileage": "", // пробег
366 - "mileageEnabled": true, // флаг активности счётчика "пробег"
367 - "motohours":"", // моточасы
368 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
369 - },
370 - "cmsv6Parameters": { // параметры CMSv6
371 - "enabled": true, // флаг включения
372 - //"id": "", // идентификатор
373 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
374 - "login": "", // имя учетной записи
375 - "password": "" // пароль учетной записи
914 +(% style="color:#000000" %){
915 +
916 + "parentId": "" , ~/~/ ID клиента
917 + "name": "" , ~/~/ имя ТС
918 + "imei": "" , ~/~/ IMEI
919 + "deviceTypeId": "" , ~/~/ ID типа устройства
920 + "modelId": "" , ~/~/ ID модели
921 + "unitId": "" , ~/~/ ID подразделения
922 + "sim1": "" , ~/~/ Номер SIM 1
923 + "sim2": "" , ~/~/ Номер SIM2
924 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
925 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
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 ~/~/ флаг активности счётчика "моточасы"
376 376   },
377 - "inspectionTasks": [ // задания на ТО
948 + "cmsv6Parameters": { ~/~/ параметры CMSv6
949 + "enabled": true, ~/~/ флаг включения
950 + "id": "" , ~/~/ идентификатор
951 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
952 + "login": "" , ~/~/ имя учетной записи
953 + "password": "" ~/~/ пароль учетной записи
954 + },
955 + "inspectionTasks": ~/~/ задания на ТО
378 378   {
379 - "enabled": "", // Признак включения
380 - "name": "", // Имя задания
381 - "description": "", // Описание задания
382 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
383 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
384 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
385 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
386 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
387 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
388 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
389 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
957 + "enabled": "" , ~/~/ Признак включения
958 + "name": "" , ~/~/ Имя задания
959 + "description": "" , ~/~/ Описание задания
960 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
961 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
962 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
963 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
964 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
965 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
966 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
967 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
968 + }
969 +
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 + ],
984 +
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"
390 390   },
391 - ]}}}
392 392  
393 -(% style="color:#000000" %)… }
1024 +~/~/ Характерные для произвольного:
394 394  
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 +
395 395  (% style="color:#000000" %)Ответ:
396 396  
397 397  (% style="color:#000000" %){
398 398  
399 -(% class="western" %)
400 -{{{ "vehicleId": "", //ID ТС
401 - "parentId": "", //Guid владельца ТС
402 - "name": "", //Имя объекта
403 - "imei": "", //IMEI
404 - "deviceTypeId": "", //ID типа устройства
405 - "modelId": "", //ID модели
406 - "unitId": "", //ID подразделения
407 - "sim1": "", //SIM1
408 - "sim2": "", //SIM2
409 - "consumptionPer100Km": "", //Расход топлива на 100 км
410 - "consumptionIdle": "", //Расход топлива на холостом ходу
411 - "counters": { //Счётчики
412 - "mileageEnabled": true,
413 - "motohoursEnabled": true,
414 - "mileage": "",
415 - "motohours": 345.0
416 - },
417 - "cmsv6Parameters": { //Параметры CmsV6
418 - "id": null,
419 - "enabled": true, //флаг включения
420 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
421 - "login": "", // имя учетной записи
422 - "password": "" // пароль учетной записи
423 - },
424 - "inspectionTasks": [ // задания на ТО
425 - {
426 - "id": "", // ID задачи
427 - "enabled": false, // Признак включения
428 - "name": "", // Имя задания
429 - "description": "", // Описание задания
430 - "mileageCondition": "", // Условие по пробегу
431 - "lastMileage": "", // Пробег (в метрах)
432 - "motohoursCondition": "", // Условие по моточасам
433 - "lastMotohours": "", // Моточасы
434 - "periodicCondition": "", // Условие периодичности по времени
435 - "kind": "", // Вид периодичности по времени
436 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
437 - }
438 - ]}}}
1066 + "vehicleId": "", ~/~/ID ТС 
1067 + "parentId": "", ~/~/Guid владельца ТС
1068 + "name": "", ~/~/Имя объекта
1069 + "imei": "", ~/~/IMEI
1070 + "deviceTypeId": "", ~/~/ID типа устройства
1071 + "modelId": "", ~/~/ID модели
1072 + "unitId": "", ~/~/ID подразделения
1073 + "sim1": "", ~/~/SIM1
1074 + "sim2": "", ~/~/SIM2
1075 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1076 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1077 + "counters": { ~/~/Счётчики
1078 + "mileageEnabled": true,
1079 + "motohoursEnabled": true,
1080 + "mileage": "",
1081 + "motohours": 345.0
1082 + },
1083 + "cmsv6Parameters": { ~/~/Параметры CmsV6
1084 + "id": null,
1085 + "enabled": true, ~/~/флаг включения
1086 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1087 + "login": "", ~/~/ имя учетной записи
1088 + "password": "" ~/~/ пароль учетной записи
1089 + },
1090 + "inspectionTasks": { ~/~/ задания на ТО
1091 + "id": "", ~/~/ ID задачи
1092 + "enabled": false, ~/~/ Признак включения
1093 + "name": "", ~/~/ Имя задания
1094 + "description": "", ~/~/ Описание задания
1095 + "mileageCondition": "", ~/~/ Условие по пробегу
1096 + "lastMileage": "", ~/~/ Пробег (в метрах)
1097 + "motohoursCondition": "", ~/~/ Условие по моточасам
1098 + "lastMotohours": "", ~/~/ Моточасы
1099 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1100 + "kind": "", ~/~/ Вид периодичности по времени 
1101 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1102 + }
439 439  
440 440  (% style="text-align:left" %)
441 441  (% style="color:#000000" %)}
442 442  
1107 +**Валидация:**
1108 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1109 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1110 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
443 443  
444 -(% class="box successmessage" %)
1112 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1113 +
1114 +(% class="box infomessage" %)
445 445  (((
446 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1116 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
447 447  )))
448 448  
449 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1119 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
450 450  
451 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
1121 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
452 452  
453 453  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
454 454  
455 455  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
456 456  
457 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
1127 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
458 458  
459 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
1129 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
460 460  
461 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
1131 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
462 462  
463 463  (% style="color:#000000" %)Метод запроса: **POST**
464 464  
... ... @@ -466,78 +466,115 @@
466 466  
467 467  (% style="color:#000000" %)В заголовках запроса:
468 468  
469 -(% style="color:#000000" %)− Content-Type: application/json
1139 +(% style="color:#000000" %)− Content-Type: __**application/json**__
470 470  
471 471  (% style="color:#000000" %)− X-Auth: Токен авторизации
472 472  
473 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
1143 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
474 474  
475 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
1145 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
476 476  
477 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
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 +}
478 478  
479 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
1158 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
480 480  
481 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
1160 +(% style="color:#000000" %)Ответ:
482 482  
483 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
1162 +(% style="color:#000000" %){
484 484  
485 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
1164 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1165 + "name": "" ~/~/ наименование объекта
1166 + "imei": "" ~/~/ IMEI объекта
1167 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
1168 + "deviceTypeName": "" ~/~/ наименование типа устройства
1169 + "sim1": "" ~/~/ первый номер телефона
1170 + "sim2": "" ~/~/ второй номер телефона
1171 + "parentId": "" ~/~/ идентификатор клиента-родителя
1172 + "parentName": "" ~/~/ наименование клиента-родителя
1173 + "modelId": "" ~/~/ идентификатор модели объекта
1174 + "modelName": "" ~/~/ наименование модели объекта
1175 + "unitId": "" ~/~/ идентификатор подразделения
1176 + "unitName": "" ~/~/ наименование подразделения
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 + }(%%)
1190 +(% style="color:#000000" %)}
486 486  
487 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1192 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
488 488  
489 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1194 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
490 490  
491 -
492 492  (% class="box successmessage" %)
493 493  (((
494 -(% 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}**
495 495  )))
496 496  
497 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1201 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
498 498  
499 499  (% style="color:#000000" %)Метод запроса: **POST**
500 500  
501 501  (% 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}
502 502  
503 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
1207 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
504 504  
505 505  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
506 506  
507 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
1211 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
508 508  
509 -(% class="western" %)
510 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
511 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
512 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
513 - "date": "", // Дата смены статуса (null если сменить немедленно)
514 - "description": "", // Описание
515 - "data": "", // Данные
516 - "overwrite": false, // Флаг перезаписи
517 - "stage": "", // Состояние, может быть null}}}
1213 +(% style="color:#000000" %){
518 518  
1215 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1216 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1217 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1218 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1219 + "description": "", ~/~/ Описание
1220 + "data": "", ~/~/ Данные
1221 + "overwrite": false, ~/~/ Флаг перезаписи
1222 + "stage": "", ~/~/ Состояние, может быть null
1223 +
519 519  (% style="color:#000000" %)}
520 520  
521 -(% style="color:#000000" %)Ответ: {
1226 +(% style="color:#000000" %)Ответ:
522 522  
523 -(% class="western" %)
524 -{{{ "status": "", // значение статуса
525 - "date": "", // Дата смены статуса
526 - "description": "", // Описание
527 - "data": "", // Данные
528 - "overwrite": false, // Флаг перезаписи
529 - "stage": "", // Состояние}}}
1228 +(% style="color:#000000" %){
530 530  
1230 + "status": "", ~/~/ значение статуса
1231 + "date": "", ~/~/ Дата смены статуса 
1232 + "description": "", ~/~/ Описание
1233 + "data": "", ~/~/ Данные
1234 + "overwrite": false, ~/~/ Флаг перезаписи
1235 + "stage": "", ~/~/ Состояние
1236 +
531 531  (% style="text-align:left" %)
532 -(% style="color:#000000" %)}
1238 +(% style="color:#000000" %) }
533 533  
1240 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
534 534  
535 535  (% class="box warningmessage" %)
536 536  (((
537 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1244 +(% lang="en-US" %)**PUT /api/v3/vehicles**
538 538  )))
539 539  
540 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1247 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
541 541  
542 542  (% style="color:#000000" %)Метод запроса: **PUT**
543 543  
... ... @@ -547,26 +547,223 @@
547 547  
548 548  (% style="color:#000000" %)Параметры в теле запроса (JSON):
549 549  
550 -(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
1257 +(% style="color:#000000" %){
1258 + "vehicleId": , ~/~/ ID объекта
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": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
551 551  
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 + }
1312 +
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 +
552 552  (% style="color:#000000" %)Ответ:
553 553  
554 554  (% lang="en-US" style="text-align:left" %)
555 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
1408 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
556 556  
1410 +(% lang="en-US" style="text-align:left" %)
1411 + "vehicleId": "", ~/~/ ID ТС
1412 + "parentId": "", ~/~/ ID клиента
1413 + "name": "", ~/~/ имя ТС
1414 + "imei": "", ~/~/ IMEI
1415 + "deviceTypeId": "", ~/~/ типа устройства
1416 + "modelId": "", ~/~/ ID модели
1417 + "unitId": "", ~/~/ ID подразделения
1418 + "sim1": "", ~/~/ SIM 1
1419 + "sim2": "", ~/~/ SIM2
1420 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1421 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1422 + "counters": 
1423 + {
1424 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1425 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1426 + "mileage": "", ~/~/ пробег
1427 + "motohours": "", ~/~/ моточасы
1428 + }
1429 + "cmsv6Parameters": ~/~/ параметры CMSv6
1430 + {
1431 + "id": ~/~/ идентификатор
1432 + "enabled": true, ~/~/ флаг включения
1433 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1434 + "login": "", ~/~/ имя учетной записи
1435 + "password": "", ~/~/ пароль учетной записи
1436 + }
1437 + "inspectionTasks": ~/~/ задания на ТО
1438 + {
1439 + "id": "", ~/~/ ID задания
1440 + "enabled": false, ~/~/ Признак включения
1441 + "name": "", ~/~/ Имя задания
1442 + "description": "", ~/~/ Описание задания
1443 + "mileageCondition": "", ~/~/ Условие по пробегу
1444 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1445 + "motohoursCondition": "", ~/~/ Условие по моточасам
1446 + "lastMotohours": "", ~/~/ Моточасы
1447 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1448 + "kind": "", ~/~/ Вид периодичности по времени
1449 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1450 + }
557 557  
1452 +(% lang="en-US" style="text-align:left" %)
1453 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1454 +
1455 +**Валидация:**
1456 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1457 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1458 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1459 +
1460 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1461 +
558 558  (% class="box errormessage" %)
559 559  (((
560 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1464 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
561 561  )))
562 562  
563 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1467 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
564 564  
565 565  (% style="color:#000000" %)Метод запроса: **DELETE**
566 566  
567 567  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
568 568  
569 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1473 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
570 570  
571 571  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
572 572  
... ... @@ -573,18 +573,16 @@
573 573  (% style="text-align:left" %)
574 574  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
575 575  
1480 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
576 576  
577 -(% class="box" lang="en-US" style="text-align: center;" %)
578 -(((
579 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
580 -)))
1482 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
581 581  
582 582  (% class="box infomessage" %)
583 583  (((
584 -(% 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**
585 585  )))
586 586  
587 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1489 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
588 588  
589 589  (% style="color:#000000" %)Метод запроса: **GET**
590 590  
... ... @@ -592,51 +592,1158 @@
592 592  
593 593  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
594 594  
595 -(% style="color:#000000" %)Ответ: [
1497 +(% style="color:#000000" %)Ответ:
596 596  
597 -(% class="western" %)
598 -{{{ {
599 - "deviceTypeId" : "", // ID типа устройства
600 - "deviceTypeName" : "" // Название типа устройства
601 - },}}}
1499 +(% style="color:#000000" %){
602 602  
1501 + "deviceTypeId" : "", ~/~/ ID типа устройства
1502 + "deviceTypeName" : "" ~/~/ Название типа устройства
1503 +
603 603  (% style="text-align:left" %)
604 -(% style="color:#000000" %)…** **]
1505 +(% style="color:#000000" %)}
605 605  
606 606  
607 -(% class="box" style="text-align: center;" %)
1508 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1509 +
1510 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
1511 +
1512 +(% class="box infomessage" %)
608 608  (((
609 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1514 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
610 610  )))
611 611  
1517 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
1518 +
1519 +(% style="color:#000000" %)Метод запроса: **POST**
1520 +
1521 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
1522 +
1523 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1524 +
1525 +(% style="text-align:left" %)
1526 +Тело запроса:
1527 +
1528 +(% style="text-align:left" %)
1529 +{
1530 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
1531 +}
1532 +
1533 +(% style="text-align:left" %)
1534 +Ответ:
1535 +
1536 +[
1537 + {
1538 + "id": 0, ~/~/ Идентификатор объекта геозоны
1539 + "name": "string", ~/~/ Название объекта геозоны
1540 + "type": 0, ~/~/ Тип объекта геозоны
1541 + "fname": "string", ~/~/ Имя файла
1542 + "parentId": "string", ~/~/ Идентификатор клиента
1543 + "radius": 0, ~/~/ Радиус геообъекта
1544 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
1545 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
1546 + "description": "string", ~/~/ Описание
1547 + "area": 0, ~/~/ Площадь, м^^2^^
1548 + "perimetr": 0, ~/~/ Периметр, м
1549 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
1550 + }
1551 +]
1552 +
1553 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
1554 +
612 612  (% class="box infomessage" %)
613 613  (((
614 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1557 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
615 615  )))
616 616  
617 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1560 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
618 618  
1562 +(% style="color:#000000" %)Метод запроса: **POST**
1563 +
1564 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
1565 +
1566 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1567 +
1568 +(% style="text-align:left" %)
1569 +Тело запроса:
1570 +
1571 +{
1572 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
1573 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
1574 + "ids": [ ], ~/~/ Массив id объектов
1575 + "byTime": 0, ~/~/ Объединение событий по времени 
1576 + "byDist": 0, ~/~/ Объединение событий по расстоянию
1577 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
1578 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
1579 +}
1580 +
1581 +Ответ:
1582 +[
1583 + {
1584 + "geozoneId": 0, ~/~/ ID геообъекта
1585 + "geozoneName": "string", ~/~/ Название геообъекта
1586 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
1587 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
1588 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
1589 + "vehicleId": 0, ~/~/ ID объекта
1590 + "vehicleName": "string" ~/~/ Имя объекта
1591 + }
1592 +]
1593 +
1594 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
1595 +
1596 +(% class="box infomessage" %)
1597 +(((
1598 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
1599 +)))
1600 +
1601 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
1602 +
1603 +(% style="color:#000000" %)Метод запроса: **POST**
1604 +
1605 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
1606 +
1607 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1608 +
1609 +(% style="text-align:left" %)
1610 +Тело запроса:
1611 +
1612 +{
1613 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
1614 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
1615 + "ids": [ ], ~/~/ Массив id геообъектов
1616 + "byTime": 0, ~/~/ Объединение событий по времени 
1617 + "byDist": 0, ~/~/ Объединение событий по расстоянию
1618 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
1619 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
1620 +}
1621 +
1622 +Ответ:
1623 +
1624 +[
1625 + {
1626 + "geozoneId": 0, ~/~/ ID геообъекта
1627 + "geozoneName": "string", ~/~/ Название геообъекта
1628 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
1629 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
1630 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
1631 + "vehicleId": 0, ~/~/ ID объекта
1632 + "vehicleName": "string" ~/~/ Имя объекта
1633 + }
1634 +]
1635 +
1636 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1637 +
1638 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1639 +
1640 +(% class="box infomessage" %)
1641 +(((
1642 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1643 +)))
1644 +
1645 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1646 +
619 619  (% style="color:#000000" %)Метод запроса: **GET**
620 620  
621 621  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
622 622  
623 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1651 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
624 624  
625 -(% style="color:#000000" %)Ответ: [
1653 +(% style="color:#000000" %)Ответ:
626 626  
627 -(% class="western" style="margin-bottom:19px" %)
628 -{{{ {}}}
1655 +(% style="color:#000000" %){
629 629  
630 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1657 + "id": "", ~/~/ ID типа датчика 
1658 + "name": "", ~/~/ Название
1659 + "description": "", ~/~/ Описание
631 631  
632 -(% class="western" %)
633 -{{{ "description": "" // Описание
634 - },}}}
635 -
636 636  (% style="text-align:left" %)
637 -(% style="color:#000000" %)… ]
1662 +(% style="color:#000000" %)}
638 638  
1664 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
639 639  
1666 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1667 +
1668 +(% class="box infomessage" style="text-align: left;" %)
1669 +(((
1670 +**POST /api/v3/terminalMessages/count**
1671 +)))
1672 +
1673 +(% style="text-align: left;" %)
1674 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1675 +
1676 +(% style="text-align: left;" %)
1677 +Метод запроса **POST**
1678 +
1679 +(% style="text-align: left;" %)
1680 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1681 +
1682 +(% style="text-align: left;" %)
1683 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1684 +
1685 +(% style="text-align: left;" %)
1686 +{
1687 + "vehicleIds": [
1688 + id ~/~/ здесь передается список идентификаторов объектов
1689 + ],
1690 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1691 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1692 +}
1693 +
1694 +(% style="text-align: left;" %)
1695 +Ответ:
1696 +
1697 +(% style="text-align: left;" %)
1698 +[
1699 + {
1700 + "vehicleId": 0, ~/~/ идентификатор объекта
1701 + "count": 0 ~/~/ количество сообщений за период
1702 + }
1703 +]
1704 +
1705 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1706 +
1707 +(% class="box infomessage" %)
1708 +(((
1709 +**POST /api/v3/terminalMessages**
1710 +)))
1711 +
1712 +Метод возвращает список сообщений терминала объекта за выбранный период.
1713 +
1714 +(% style="text-align: left;" %)
1715 +Метод запроса **POST**
1716 +
1717 +(% style="text-align: left;" %)
1718 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1719 +
1720 +(% style="text-align: left;" %)
1721 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1722 +
1723 +{
1724 + "vehicleId": 0, ~/~/ id объекта
1725 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1726 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1727 +}
1728 +
1729 +Ответ:
1730 +
1731 +[
1732 + {
1733 + "messages": [
1734 + {
1735 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1736 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1737 + "speed": 0, ~/~/ Скорость, км/ч
1738 + "altitude": 0, ~/~/ Высота, м
1739 + "latitude": 0, ~/~/ Широта [-90°;90°]
1740 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1741 + "satellites": 0, ~/~/ Кол-во спутников
1742 + "voltage": 0, ~/~/ Напряжение
1743 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1744 + "additionalProp1": "string",
1745 + "additionalProp2": "string",
1746 + "additionalProp3": "string"
1747 + },
1748 + "photoCount": 0 ~/~/ Кол-во фото
1749 + }
1750 + ]
1751 + }
1752 +]
1753 +
1754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1755 +
1756 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1757 +
1758 +(% class="box infomessage" %)
1759 +(((
1760 +**POST /api/v3/notifications/find**
1761 +)))
1762 +
1763 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1764 +
1765 +(% style="text-align: left;" %)
1766 +Метод запроса **POST**
1767 +
1768 +(% style="text-align: left;" %)
1769 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1770 +
1771 +(% style="text-align: left;" %)
1772 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1773 +
1774 +{
1775 + "parentId": "" ~/~/ id клиента
1776 +}
1777 +
1778 +Ответ:
1779 +
1780 +[
1781 + {
1782 + "id": 0, ~/~/ ID уведомления
1783 + "name": "string", ~/~/ Название уведомления
1784 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1785 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1786 + "userId": "", ~/~/ Пользователь, создавший уведомление
1787 + "parentId": "", ~/~/ Идентификатор клиента
1788 + "parentName": "string" ~/~/ Имя клиента
1789 + }
1790 +]
1791 +
1792 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1793 +
1794 +(% class="box infomessage" %)
1795 +(((
1796 +**GET /api/v3/notifications/{id}**
1797 +)))
1798 +
1799 +Метод возвращает данные правил формирования выбранного уведомления.
1800 +
1801 +(% style="text-align: left;" %)
1802 +Метод запроса **GET**
1803 +
1804 +(% style="text-align: left;" %)
1805 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1806 +
1807 +(% style="text-align: left;" %)
1808 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1809 +
1810 +(% style="text-align: left;" %)
1811 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1812 +
1813 +(% style="text-align: left;" %)
1814 +(% style="color:#000000" %)Ответ:
1815 +
1816 +(% style="text-align: left;" %)
1817 +(% style="color:#000000" %){
1818 + "id": 0, ~/~/ (%%)id уведомления
1819 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1820 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1821 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1822 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1823 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1824 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1825 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1826 +(% style="color:#000000" %) 0
1827 + ],
1828 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1829 +(% style="color:#000000" %) 0
1830 + ],
1831 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1832 +(% style="color:#000000" %) 0
1833 + ],
1834 + "settings": { ~/~/ Список параметров уведомления
1835 + "additionalProp1": "string",
1836 + "additionalProp2": "string",
1837 + "additionalProp3": "string"
1838 + },
1839 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1840 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1841 +(% style="color:#000000" %) ""
1842 + ],
1843 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1844 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1845 +(% style="color:#000000" %) "string"
1846 + ],
1847 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1848 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1849 +(% style="color:#000000" %) {
1850 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1851 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1852 +(% style="color:#000000" %) }
1853 + ],
1854 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1855 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1856 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1857 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1858 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1859 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1860 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1861 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1862 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1863 +(% style="color:#000000" %)}
1864 +
1865 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1866 +
1867 +(% class="box warningmessage" %)
1868 +(((
1869 +**PUT /api/v3/notifications/**
1870 +)))
1871 +
1872 +Метод позволяет отредактировать уведомление.
1873 +
1874 +Метод запроса **PUT**
1875 +
1876 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1877 +
1878 +В заголовках запроса: X-Auth: Токен авторизации
1879 +
1880 +Тело запроса:
1881 +{
1882 + "id": 0, ~/~/ id уведомления
1883 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1884 + "userId": "", ~/~/ Пользователь, создавший уведомление
1885 + "parentId": "", ~/~/ Идентификатор клиента
1886 + "parentName": "string", ~/~/ Имя клиента
1887 + "name": "string", ~/~/ Название уведомления
1888 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1889 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1890 + 0
1891 + ],
1892 + "geoids": [ ~/~/ Список id геообъектов для анализа
1893 + 0
1894 + ],
1895 + "fieldids": [ ~/~/ Список id полей для анализа
1896 + 0
1897 + ],
1898 + "settings": { ~/~/ Список параметров уведомления
1899 + "additionalProp1": "string",
1900 + "additionalProp2": "string",
1901 + "additionalProp3": "string"
1902 + },
1903 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1904 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1905 + ""
1906 + ],
1907 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1908 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1909 + "string"
1910 + ],
1911 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1912 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1913 + {
1914 + "id": 0, ~/~/ Идентификатор участника чата
1915 + "info": "string" ~/~/ Дополнительные сведения
1916 + }
1917 + ],
1918 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1919 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1920 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1921 + "kind": 0, ~/~/ Определяет вид уведомления
1922 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1923 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1924 + "timezone": 0, ~/~/ Сдвиг часового пояса
1925 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1926 + "autoProlongation": true ~/~/ Автопродление срока действия
1927 +}
1928 +
1929 +Ответ:
1930 +
1931 +Success
1932 +
1933 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1934 +
1935 +(% class="box errormessage" %)
1936 +(((
1937 +**DELETE /api/v3/notifications/{id}**
1938 +)))
1939 +
1940 +Метод позволяет удалить выбранное уведомление.
1941 +
1942 +Метод запроса **DELETE**
1943 +
1944 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1945 +
1946 +Передаваемый параметр: {id} - id уведомления
1947 +
1948 +В заголовках запроса: X-Auth: Токен авторизации
1949 +
1950 +Ответ:
1951 +
1952 +Success
1953 +
1954 +
1955 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
1956 +
1957 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
1958 +
1959 +(% class="box infomessage" %)
1960 +(((
1961 +**POST /api/v3/Drivers/find**
1962 +)))
1963 +
1964 +Передается параметр: parentId - ID клиента-родителя
1965 +
1966 +Ответ:
1967 +
1968 +[
1969 + {
1970 + "name": "string", ~/~/ Определяет наименование
1971 + "description": "string", ~/~/ Определяет описание
1972 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
1973 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
1974 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
1975 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
1976 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
1977 + "deleted": true ~/~/ Признак удаления
1978 + }
1979 +]
1980 +
1981 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
1982 +
1983 +(% class="box infomessage" %)
1984 +(((
1985 +**GET /api/v3/Drivers/{driverGuid}**
1986 +)))
1987 +
1988 +Передается параметр: ID водителя
1989 +
1990 +Ответ:
1991 +
1992 +{
1993 + "name": "string", ~/~/ Определяет наименование
1994 + "description": "string", ~/~/ Определяет описание
1995 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
1996 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
1997 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
1998 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
1999 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2000 + "deleted": true ~/~/ Признак удаления
2001 +}
2002 +
2003 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2004 +
2005 +(% class="box successmessage" %)
2006 +(((
2007 +**POST /api/v3/Drivers**
2008 +)))
2009 +
2010 +Запрос:
2011 +
2012 +{
2013 + "name": "string",
2014 + "description": "string",
2015 + "hiredate": "2023-06-30T12:50:54.020Z",
2016 + "chopdate": "2023-06-30T12:50:54.020Z",
2017 + "exclusive": true,
2018 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2019 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2020 + "deleted": true
2021 +}
2022 +
2023 +Ответ:
2024 +
2025 +{
2026 + "name": "string",
2027 + "description": "string",
2028 + "hiredate": "2023-06-30T12:50:54.051Z",
2029 + "chopdate": "2023-06-30T12:50:54.051Z",
2030 + "exclusive": true,
2031 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2032 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2033 + "deleted": true
2034 +}
2035 +
2036 +
2037 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2038 +
2039 +(% class="box warningmessage" %)
2040 +(((
2041 +**PUT /api/v3/Drivers**
2042 +)))
2043 +
2044 +Запрос:
2045 +
2046 +{
2047 + "name": "string",
2048 + "description": "string",
2049 + "hiredate": "2023-06-30T12:50:27.910Z",
2050 + "chopdate": "2023-06-30T12:50:27.910Z",
2051 + "exclusive": true,
2052 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2053 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2054 + "deleted": true
2055 +}
2056 +
2057 +Ответ:
2058 +
2059 +{
2060 + "name": "string",
2061 + "description": "string",
2062 + "hiredate": "2023-06-30T12:50:27.929Z",
2063 + "chopdate": "2023-06-30T12:50:27.929Z",
2064 + "exclusive": true,
2065 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2066 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2067 + "deleted": true
2068 +}
2069 +
2070 +
2071 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2072 +
2073 +(% class="box errormessage" %)
2074 +(((
2075 +**DELETE /api/v3/Drivers/{driverGuid}**
2076 +)))
2077 +
2078 +Передается параметр: ID водителя
2079 +
2080 +Ответ:
2081 +
2082 +Success
2083 +
2084 +
2085 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2086 +
2087 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2088 +
2089 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2090 +
2091 +(% class="box infomessage" %)
2092 +(((
2093 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2094 +)))
2095 +
2096 +Запрос:
2097 +
2098 +{
2099 + "Ids": [
2100 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2101 + ],
2102 + "BeginTime": "2023-06-30T12:49:04.365Z",
2103 + "EndTime": "2023-06-30T12:49:04.365Z"
2104 +}
2105 +
2106 +Ответ:
2107 +
2108 +[
2109 + {
2110 + "VehicleId": 0,
2111 + "CreateTime": "2023-06-30T09:52:31.240Z",
2112 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2113 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2114 + "BeginTime": "2023-06-30T09:52:31.240Z",
2115 + "EndTime": "2023-06-30T09:52:31.240Z"
2116 + }
2117 +]
2118 +
2119 +
2120 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2121 +
2122 +(% class="box infomessage" %)
2123 +(((
2124 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2125 +)))
2126 +
2127 +Запрос:
2128 +
2129 +{
2130 + "Ids": [
2131 + 0
2132 + ],
2133 + "BeginTime": "2023-06-30T12:48:39.419Z",
2134 + "EndTime": "2023-06-30T12:48:39.419Z"
2135 +}
2136 +
2137 +Ответ:
2138 +
2139 +[
2140 + {
2141 + "VehicleId": 0,
2142 + "CreateTime": "2023-06-30T09:54:01.631Z",
2143 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2144 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2145 + "BeginTime": "2023-06-30T09:54:01.631Z",
2146 + "EndTime": "2023-06-30T09:54:01.631Z"
2147 + }
2148 +]
2149 +
2150 +
2151 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2152 +
2153 +(% class="box successmessage" %)
2154 +(((
2155 +**POST /api/v3/DriversVehiclesAssignments**
2156 +)))
2157 +
2158 +Передается массив назначений
2159 +
2160 +Запрос:
2161 +
2162 +[
2163 + {
2164 + "VehicleId": 0, ~/~/ Идентификатор объекта
2165 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2166 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2167 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2168 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2169 + }
2170 +]
2171 +
2172 +Ответ:
2173 +
2174 +[
2175 + {
2176 + "VehicleId": 0,
2177 + "CreateTime": "2023-06-30T11:04:46.903Z",
2178 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2179 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2180 + "BeginTime": "2023-06-30T11:04:46.903Z",
2181 + "EndTime": "2023-06-30T11:04:46.903Z"
2182 + }
2183 +]
2184 +
2185 +
2186 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2187 +
2188 +(% class="box warningmessage" %)
2189 +(((
2190 +**PUT /api/v3/DriversVehiclesAssignments**
2191 +)))
2192 +
2193 +Запрос:
2194 +
2195 +[
2196 + {
2197 + "VehicleId": 0,
2198 + "CreateTime": "2023-06-30T11:14:08.117Z",
2199 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2200 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2201 + "BeginTime": "2023-06-30T11:14:08.117Z",
2202 + "EndTime": "2023-06-30T11:14:08.117Z"
2203 + }
2204 +]
2205 +
2206 +Ответ:
2207 +
2208 +[
2209 + {
2210 + "VehicleId": 0,
2211 + "CreateTime": "2023-06-30T11:14:53.349Z",
2212 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2213 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2214 + "BeginTime": "2023-06-30T11:14:53.349Z",
2215 + "EndTime": "2023-06-30T11:14:53.349Z"
2216 + }
2217 +]
2218 +
2219 +
2220 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2221 +
2222 +(% class="box errormessage" %)
2223 +(((
2224 +**DELETE /api/v3/DriversVehiclesAssignments**
2225 +)))
2226 +
2227 +Запрос:
2228 +
2229 +[
2230 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2231 +]
2232 +
2233 +Ответ:
2234 +
2235 +Success
2236 +
2237 +
2238 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2239 +
2240 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2241 +
2242 +(% class="box infomessage" %)
2243 +(((
2244 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2245 +)))
2246 +
2247 +Запрос:
2248 +
2249 +{
2250 + "Ids": [
2251 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2252 + ],
2253 + "BeginTime": "2023-06-30T12:47:12.162Z",
2254 + "EndTime": "2023-06-30T12:47:12.162Z"
2255 +}
2256 +
2257 +Ответ:
2258 +
2259 +[
2260 + {
2261 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2262 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2263 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2264 + "BeginTime": "2023-06-30T11:19:40.703Z",
2265 + "EndTime": "2023-06-30T11:19:40.703Z"
2266 + }
2267 +]
2268 +
2269 +
2270 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2271 +
2272 +(% class="box infomessage" %)
2273 +(((
2274 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2275 +)))
2276 +
2277 +Запрос:
2278 +
2279 +{
2280 + "Ids": [
2281 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2282 + ],
2283 + "BeginTime": "2023-06-30T12:47:12.162Z",
2284 + "EndTime": "2023-06-30T12:47:12.162Z"
2285 +}
2286 +
2287 +Ответ:
2288 +
2289 +[
2290 + {
2291 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2292 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2293 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2294 + "BeginTime": "2023-06-30T11:19:40.703Z",
2295 + "EndTime": "2023-06-30T11:19:40.703Z"
2296 + }
2297 +]
2298 +
2299 +
2300 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2301 +
2302 +(% class="box successmessage" %)
2303 +(((
2304 +**POST /api/v3/DriversRfidsAssignments**
2305 +)))
2306 +
2307 +Запрос:
2308 +
2309 +[
2310 + {
2311 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2312 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2313 + "BeginTime": "2023-06-30T11:27:08.635Z",
2314 + "EndTime": "2023-06-30T11:27:08.635Z"
2315 + }
2316 +]
2317 +
2318 +Ответ:
2319 +
2320 +[
2321 + {
2322 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2323 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2324 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2325 + "BeginTime": "2023-06-30T11:27:08.677Z",
2326 + "EndTime": "2023-06-30T11:27:08.677Z"
2327 + }
2328 +]
2329 +
2330 +
2331 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2332 +
2333 +(% class="box warningmessage" %)
2334 +(((
2335 +**PUT /api/v3/DriversRfidsAssignments**
2336 +)))
2337 +
2338 +Запрос:
2339 +
2340 +[
2341 + {
2342 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2343 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2344 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2345 + "BeginTime": "2023-06-30T11:28:43.330Z",
2346 + "EndTime": "2023-06-30T11:28:43.330Z"
2347 + }
2348 +]
2349 +
2350 +Ответ:
2351 +
2352 +[
2353 + {
2354 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2355 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2356 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2357 + "BeginTime": "2023-06-30T11:28:43.331Z",
2358 + "EndTime": "2023-06-30T11:28:43.331Z"
2359 + }
2360 +]
2361 +
2362 +
2363 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2364 +
2365 +(% class="box errormessage" %)
2366 +(((
2367 +**DELETE /api/v3/DriversRfidsAssignments**
2368 +)))
2369 +
2370 +Запрос:
2371 +
2372 +[
2373 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2374 +]
2375 +
2376 +Ответ:
2377 +
2378 +Success
2379 +
2380 +
2381 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2382 +
2383 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2384 +
2385 +(% class="box infomessage" %)
2386 +(((
2387 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2388 +)))
2389 +
2390 +Запрос:
2391 +
2392 +{
2393 + "Ids": [
2394 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2395 + ],
2396 + "BeginTime": "2023-06-30T12:45:10.852Z",
2397 + "EndTime": "2023-06-30T12:45:10.852Z"
2398 +}
2399 +
2400 +Ответ:
2401 +
2402 +[
2403 + {
2404 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2405 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2406 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2407 + "BeginTime": "2023-06-30T11:58:04.695Z",
2408 + "EndTime": "2023-06-30T11:58:04.695Z"
2409 + }
2410 +]
2411 +
2412 +
2413 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2414 +
2415 +(% class="box infomessage" %)
2416 +(((
2417 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2418 +)))
2419 +
2420 +Запрос:
2421 +
2422 +{
2423 + "Ids": [
2424 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2425 + ],
2426 + "BeginTime": "2023-06-30T12:45:10.852Z",
2427 + "EndTime": "2023-06-30T12:45:10.852Z"
2428 +}
2429 +
2430 +Ответ:
2431 +
2432 +[
2433 + {
2434 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2435 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2436 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2437 + "BeginTime": "2023-06-30T11:58:04.695Z",
2438 + "EndTime": "2023-06-30T11:58:04.695Z"
2439 + }
2440 +]
2441 +
2442 +
2443 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2444 +
2445 +(% class="box successmessage" %)
2446 +(((
2447 +**POST /api/v3/DriversFuelCardsAssignments**
2448 +)))
2449 +
2450 +Запрос:
2451 +
2452 +[
2453 + {
2454 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2455 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2456 + "BeginTime": "2023-06-30T12:09:53.175Z",
2457 + "EndTime": "2023-06-30T12:09:53.175Z"
2458 + }
2459 +]
2460 +
2461 +Ответ:
2462 +
2463 +[
2464 + {
2465 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2466 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2467 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2468 + "BeginTime": "2023-06-30T12:09:53.201Z",
2469 + "EndTime": "2023-06-30T12:09:53.201Z"
2470 + }
2471 +]
2472 +
2473 +
2474 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2475 +
2476 +(% class="box warningmessage" %)
2477 +(((
2478 +**PUT /api/v3/DriversFuelCardsAssignments**
2479 +)))
2480 +
2481 +Запрос:
2482 +
2483 +[
2484 + {
2485 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2486 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2487 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2488 + "BeginTime": "2023-06-30T12:09:53.201Z",
2489 + "EndTime": "2023-06-30T12:09:53.201Z"
2490 + }
2491 +]
2492 +
2493 +Ответ:
2494 +
2495 +[
2496 + {
2497 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2498 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2499 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2500 + "BeginTime": "2023-06-30T12:09:53.201Z",
2501 + "EndTime": "2023-06-30T12:09:53.201Z"
2502 + }
2503 +]
2504 +
2505 +
2506 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2507 +
2508 +(% class="box errormessage" %)
2509 +(((
2510 +**DELETE /api/v3/DriversFuelCardsAssignments**
2511 +)))
2512 +
2513 +Запрос:
2514 +
2515 +[
2516 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2517 +]
2518 +
2519 +Ответ:
2520 +
2521 +Success
2522 +
2523 +
2524 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2525 +
2526 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
2527 +
2528 +(% class="box infomessage" %)
2529 +(((
2530 +**POST /api/v3/Rfids/find**
2531 +)))
2532 +
2533 +Запрос:
2534 +
2535 +{
2536 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2537 +}
2538 +
2539 +Ответ:
2540 +
2541 +[
2542 + {
2543 + "name": "string",
2544 + "number": 0,
2545 + "period": 0, ~/~/ Частота трансляции радиометки
2546 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2547 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2548 + "deleted": true
2549 + }
2550 +]
2551 +
2552 +
2553 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2554 +
2555 +(% class="box infomessage" %)
2556 +(((
2557 +**GET /api/v3/Rfids/{rfidGuid}**
2558 +)))
2559 +
2560 +Передаем параметр rfidGuid - идентификатор карты-метки
2561 +
2562 +Ответ:
2563 +
2564 +[
2565 + {
2566 + "name": "string",
2567 + "number": 0,
2568 + "period": 0, ~/~/ Частота трансляции радиометки
2569 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2570 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2571 + "deleted": true
2572 + }
2573 +]
2574 +
2575 +
2576 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2577 +
2578 +(% class="box successmessage" %)
2579 +(((
2580 +**POST /api/v3/Rfids**
2581 +)))
2582 +
2583 +Запрос:
2584 +
2585 +{
2586 + "name": "string",
2587 + "number": 0,
2588 + "period": 0,
2589 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2590 + "deleted": true
2591 +}
2592 +
2593 +Ответ:
2594 +
2595 +{
2596 + "name": "string",
2597 + "number": 0,
2598 + "period": 0,
2599 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2600 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2601 + "deleted": true
2602 +}
2603 +
2604 +
2605 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2606 +
2607 +(% class="box warningmessage" %)
2608 +(((
2609 +**PUT /api/v3/Rfids**
2610 +)))
2611 +
2612 +Запрос:
2613 +
2614 +{
2615 + "name": "string",
2616 + "number": 0,
2617 + "period": 0,
2618 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2619 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2620 + "deleted": true
2621 +}
2622 +
2623 +Ответ:
2624 +
2625 +{
2626 + "name": "string",
2627 + "number": 0,
2628 + "period": 0,
2629 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2630 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2631 + "deleted": true
2632 +}
2633 +
2634 +
2635 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2636 +
2637 +(% class="box errormessage" %)
2638 +(((
2639 +**DELETE /api/v3/Rfids/{rfidGuid}**
2640 +)))
2641 +
2642 +Передаем параметр rfidGuid - идентификатор карты-метки
2643 +
2644 +Ответ:
2645 +
2646 +Success
2647 +
2648 +
640 640  (% class="box" lang="en-US" style="text-align: center;" %)
641 641  (((
642 642  (% 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 г.