Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 47.1 >
edited by Илья Крайнов
on 2022/11/21 10:32
To version < 92.1 >
edited by Илья Крайнов
on 2023/05/22 15:40
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,31 +1,31 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
6 +{{toc/}}
12 12  
8 +
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box successmessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
... ... @@ -38,9 +38,9 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}(%%)
42 -
41 +}
43 43  
43 +
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,13 +55,14 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,18 +72,58 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 +
80 +(% class="box infomessage" %)
77 77  (((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
79 79  )))
80 80  
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 +
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% 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(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -91,37 +91,184 @@
91 91  
92 92  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
95 95  
96 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
101 101  
102 102  (% style="color:#000000" %)Ответ:
103 103  
104 -(% style="color:#000000" %){
105 - "agentId": "", ~/~/ идентификатор клиента
106 - "parentId": "", ~/~/ идентификатор клиента-родителя
107 - "name": "", ~/~/ наименование клиента
108 - "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
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 - Отказ)
111 111  }
112 112  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113 113  
114 -(% class="box" style="text-align: center;" %)
159 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
161 +**POST /api/v3/agents **
117 117  )))
118 118  
164 +Метод позволяет добавить клиента, указанного в запросе.
165 +
166 +Метод запроса: **POST**
167 +
168 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
169 +
170 +В заголовках запроса: X-Auth: Токен авторизации
171 +
172 +Параметры в теле запроса (JSON):
173 +
174 +{
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 + "name": "string", ~/~/ имя
177 + "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
179 + "isForeign": true, ~/~/ иностранный контрагент
180 + "district": "string", ~/~/ округ
181 + "region": "string", ~/~/ регион
182 + "city": "string", ~/~/ город
183 + "inn": "string", ~/~/ ИНН
184 + "kpp": "string", ~/~/ КПП
185 + "address": "string", ~/~/ юридический адрес
186 + "addressFact": "string", ~/~/ фактический адрес
187 + "email": "string", ~/~/ email
188 + "director": "string", ~/~/ ФИО руководителя
189 + "bankName": "string", ~/~/ банк
190 + "bankBIK": "string", ~/~/ БИК
191 + "bankRS": "string", ~/~/ номер счёта
192 + "bankKS": "string" ~/~/ корр. счёт
193 +}
194 +
195 +
196 +Ответ:
197 +
198 +{
199 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
200 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
201 + "name": "string", ~/~/ имя
202 + "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
204 + "isForeign": true, ~/~/ иностранный контрагент
205 + "district": "string", ~/~/ округ
206 + "region": "string", ~/~/ регион
207 + "city": "string", ~/~/ город
208 + "inn": "string", ~/~/ ИНН
209 + "kpp": "string", ~/~/ КПП
210 + "address": "string", ~/~/ юридический адрес
211 + "addressFact": "string", ~/~/ фактический адрес
212 + "email": "string", ~/~/ email
213 + "director": "string", ~/~/ ФИО руководителя
214 + "bankName": "string", ~/~/ банк
215 + "bankBIK": "string", ~/~/ БИК
216 + "bankRS": "string", ~/~/ номер счёта
217 + "bankKS": "string" ~/~/ корр. счёт
218 +}
219 +
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 +
222 +(% class="box warningmessage" %)
223 +(((
224 +**PUT /api/v3/agents**
225 +)))
226 +
227 +Метод позволяет отредактировать клиента, указанного в запросе.
228 +
229 +Метод запроса: **PUT**
230 +
231 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
232 +
233 +В заголовках запроса: X-Auth: Токен авторизации
234 +
235 +
236 +Параметры в теле запроса (JSON):
237 +
238 +{
239 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
240 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
241 + "name": "string", ~/~/ имя
242 + "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
244 + "isForeign": true, ~/~/ иностранный контрагент
245 + "district": "string", ~/~/ округ
246 + "region": "string", ~/~/ регион
247 + "city": "string", ~/~/ город
248 + "inn": "string", ~/~/ ИНН
249 + "kpp": "string", ~/~/ КПП
250 + "address": "string", ~/~/ юридический адрес
251 + "addressFact": "string", ~/~/ фактический адрес
252 + "email": "string", ~/~/ email
253 + "director": "string", ~/~/ ФИО руководителя
254 + "bankName": "string", ~/~/ банк
255 + "bankBIK": "string", ~/~/ БИК
256 + "bankRS": "string", ~/~/ номер счёта
257 + "bankKS": "string" ~/~/ корр. счёт
258 +}
259 +
260 +
261 +Ответ:
262 +
263 +{
264 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
265 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
266 + "name": "string", ~/~/ имя
267 + "fullName": "string", ~/~/ полное наименование
268 + "isForeign": true, ~/~/ иностранный контрагент
269 + "district": "string", ~/~/ округ
270 + "region": "string", ~/~/ регион
271 + "city": "string", ~/~/ город
272 + "inn": "string", ~/~/ ИНН
273 + "kpp": "string", ~/~/ КПП
274 + "address": "string", ~/~/ юридический адрес
275 + "addressFact": "string", ~/~/ фактический адрес
276 + "email": "string", ~/~/ email
277 + "director": "string", ~/~/ ФИО руководителя
278 + "bankName": "string", ~/~/ банк
279 + "bankBIK": "string", ~/~/ БИК
280 + "bankRS": "string", ~/~/ номер счёта
281 + "bankKS": "string" ~/~/ корр. счёт
282 +}
283 +
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
285 +
286 +(% class="box errormessage" %)
287 +(((
288 +**DELETE /api/v3/agents/{clientId}**
289 +)))
290 +
291 +Метод позволяет удалить клиента, указанного в строке запроса.
292 +
293 +Метод запроса: **DELETE**
294 +
295 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
296 +
297 +Параметр запроса: **{clientId}** - Guid пользователя
298 +
299 +В заголовках запроса: X-Auth: Токен авторизации
300 +
301 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 +
303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 +
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
306 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
309 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -131,7 +131,8 @@
131 131  
132 132  (% style="color:#000000" %)Параметры в теле запроса (JSON):
133 133  
134 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
135 135   "lastName": "", ~/~/ фамилия
136 136   "firstName": "", ~/~/ имя
137 137   "position": "", ~/~/ должность
... ... @@ -140,17 +140,41 @@
140 140   "login": "", ~/~/ логин (обязателен)
141 141   "password": "", ~/~/ пароль (обязателен)
142 142   "email": "", ~/~/ email (обязателен)
143 - "description": "", ~/~/ описание
144 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
145 145   "parentId": "", ~/~/ Guid родительского агента
146 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
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 - Азербайджанский
152 152  }
153 153  
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 +
154 154  (% style="text-align:left" %)
155 155  (% style="color:#000000; font-weight:normal" %)Ответ:
156 156  
... ... @@ -179,13 +179,14 @@
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
181 181  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
399 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -222,17 +222,18 @@
222 222   "email": "" , ~/~/ E-mail
223 223   "sessionDuration":"", ~/~/ длительность сессии в минутах
224 224   "status": "1",  ~/~/ статус пользователя
225 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
226 226  
227 227  (% style="color:#000000" %)}
228 228  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
230 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **GET**
238 238  
... ... @@ -259,8 +259,11 @@
259 259   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
260 260   "description": "", ~/~/ Описание
261 261   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
262 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
263 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
264 264   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
265 265   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
266 266   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -274,13 +274,14 @@
274 274  )))
275 275  )))
276 276  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
277 277  
278 278  (% class="box warningmessage" %)
279 279  (((
280 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
499 +(% lang="en-US" %)**PUT /api/v3/users**
281 281  )))
282 282  
283 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
284 284  
285 285  (% style="color:#000000" %)Метод запроса: **PUT**
286 286  
... ... @@ -288,8 +288,6 @@
288 288  
289 289  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
290 290  
291 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
292 -
293 293  (% lang="en-US" style="text-align:left" %)
294 294  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
295 295  
... ... @@ -304,7 +304,9 @@
304 304   "phone": "" , ~/~/ телефон
305 305   "organization": "" , ~/~/ организация
306 306   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
307 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
308 308   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
309 309  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
310 310   "isEnabled": "" , ~/~/ признак включения
... ... @@ -311,9 +311,12 @@
311 311   "parentId": "" , ~/~/ Guid родительского агента
312 312   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
313 313   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
314 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
315 - "kind": "" , ~/~/ тип аутентификации
316 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
317 317   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
318 318  
319 319  (% lang="en-US" style="text-align:left" %)
... ... @@ -339,8 +339,12 @@
339 339   "isEnabled": "" , ~/~/ признак включения
340 340   "parentId": "" , ~/~/ Guid родительского агента
341 341   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
342 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
343 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
344 344   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
345 345   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
346 346  
... ... @@ -347,13 +347,14 @@
347 347  (% lang="en-US" style="text-align:left" %)
348 348  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
349 349  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
350 350  
351 351  (% class="box warningmessage" %)
352 352  (((
353 -(% 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}**
354 354  )))
355 355  
356 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
357 357  
358 358  (% style="color:#000000" %)Метод запроса: **PUT**
359 359  
... ... @@ -376,13 +376,14 @@
376 376  (% style="text-align:left" %)
377 377  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
378 378  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
379 379  
380 380  (% class="box warningmessage" %)
381 381  (((
382 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
610 +**POST /api/v3/users/disable**
383 383  )))
384 384  
385 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
386 386  
387 387  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
388 388  
... ... @@ -397,13 +397,14 @@
397 397  
398 398  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
399 399  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
400 400  
401 401  (% class="box warningmessage" %)
402 402  (((
403 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
632 +**POST /api/v3/users/enable**
404 404  )))
405 405  
406 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
407 407  
408 408  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
409 409  
... ... @@ -431,15 +431,16 @@
431 431  }
432 432  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
433 433  "users" - массив id пользователей, которых не удалось включить или отключить.
434 -
435 435  )))
436 436  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
437 437  (% class="box errormessage" %)
438 438  (((
439 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
440 440  )))
441 441  
442 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
443 443  
444 444  (% style="color:#000000" %)Метод запроса: **DELETE**
445 445  
... ... @@ -452,20 +452,18 @@
452 452  (% style="text-align:left" %)
453 453  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
454 454  
685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
455 455  
456 -(% class="box" style="text-align: center;" %)
457 -(((
458 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
459 -)))
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
460 460  
461 461  (% class="box infomessage" %)
462 462  (((
463 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
464 464  )))
465 465  
466 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
467 467  
468 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
469 469  
470 470  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
471 471  
... ... @@ -473,9 +473,9 @@
473 473  
474 474  (% style="color:#000000" %)Метод запроса: **GET**
475 475  
476 -(% 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}
477 477  
478 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
479 479  
480 480  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
481 481  
... ... @@ -489,18 +489,124 @@
489 489   "deviceTypeId": , ~/~/ ID типа устройства
490 490   "deviceTypeName": "", ~/~/ Название типа устройства
491 491   "sim1": "", ~/~/ Номер SIM1
492 - "parentId": "", Номер SIM2
493 - "parentName": "", Наименование клиента-родителя
494 - "modelId": "", ID модели объекта
495 - "modelName": "", Имя модели объекта
496 - "createdAt": "", Дата создания объекта
497 - "mileageCalcMethod": "", Выбранный метод расчета пробега
498 - "counters": { ~/~/ Нормы
499 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
500 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
501 - "mileage": "", ~/~/ Пробег по нормам в метрах
502 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
720 + "sim2": "", ~/~/ Номер SIM2
721 +
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": "", ~/~/ Дата создания объекта
503 503   },
733 +
734 +"customFields": [ ~/~/ Произвольные поля
735 + {
736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
737 + "name": "string", ~/~/ Имя поля
738 + "value": "string", ~/~/ Значение поля
739 + "forClient": true, ~/~/ Не используемая функция
740 + "forTooltip": true, ~/~/ Отображать в подсказке
741 + "forReport": true ~/~/ Отображать в отчете
742 + }
743 +
744 +], ~/~/ Данные с вкладки нормы
745 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
746 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
747 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
748 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
749 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
750 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
751 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
752 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
753 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 +
758 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 + "mileageCoeff": 0, ~/~/ коэффициент пробега
760 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
761 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
762 + "counters": { ~/~/ Счетчики
763 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
764 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
765 + "mileage": 0, ~/~/ Текущий пробег
766 + "motohours": 0, ~/~/ Текущие моточасы
767 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
768 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
769 + },
770 +
771 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
772 + "id": "string", ~/~/ ID объекта
773 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
774 + "host": "string", ~/~/ CMSV6 Web Host
775 + "login": "string", ~/~/ CMSV6 Account
776 + "password": "string" ~/~/ CMSV6 Password
777 + },
778 +
779 +"commandTemplates": [ ~/~/ Шаблоны команд
780 + {
781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
782 + "name": "string", ~/~/ Наименование команды
783 + "command": "string", ~/~/ Текст команды
784 + "retries": 0 ~/~/ Количество попыток
785 + }
786 + ],
787 +
788 + "sensors": [ ~/~/ Датчики
789 + {
790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
791 + "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный
792 + "type": 0, ~/~/ Тип датчика
793 + "name": "string", ~/~/ Имя датчика
794 + "inputType": 0, ~/~/ Тип входа
795 + "inputNumber": 0, ~/~/ Номер входа
796 + "pseudonym": "string", ~/~/ Псевдоним
797 + "medianDegree": 0, ~/~/ Медианная фильтрация
798 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 + "gradeType": 0, ~/~/ Тип тарировки
801 + "gradesTables": [ ~/~/ Тип тарировки Таблица
802 + {
803 + "grades": [ ~/~/ Тарировка
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,
817 + "expr": "string",
818 + "children": [
819 + "string"
820 + ],
821 + "customParams": {
822 + "additionalProp1": "string",
823 + "additionalProp2": "string",
824 + "additionalProp3": "string"
825 + },
826 + "summaryMaxValue": 0
827 + }
828 +
829 + "drivers": [ ~/~/ Водители
830 + {
831 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "name": "string",
833 + "description": "string",
834 + "isDefault": true
835 + }
836 + ],
837 +
504 504   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
505 505   {
506 506   "id": "", ~/~/ ID  задания
... ... @@ -516,7 +516,17 @@
516 516   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
517 517   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
518 518   }
519 - ]
853 + ],
854 +
855 + "statusHistory": [ ~/~/ История статусов
856 + {
857 + "status": 0,
858 + "date": "2023-05-22T09:57:39.562Z",
859 + "description": "string",
860 + "additionalInfo": "string"
861 + }
862 + ]
863 +
520 520  }
521 521  )))
522 522  
... ... @@ -526,13 +526,14 @@
526 526  (% style="text-align:left" %)
527 527  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
528 528  
873 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
529 529  
530 530  (% class="box successmessage" %)
531 531  (((
532 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
877 +(% lang="en-US" %)**POST /api/v3/vehicles**
533 533  )))
534 534  
535 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
536 536  
537 537  (% style="color:#000000" %)Метод запроса: **POST**
538 538  
... ... @@ -564,6 +564,11 @@
564 564   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
565 565   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
566 566   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
912 +
913 + "mileageCalcMethod": 0,
914 + "mileageCoeff": 0,
915 + "locationByCellId": true,
916 + "dottedLineTrackWhenNoCoords": true,
567 567   "counters": ~/~/ счетчики
568 568   {
569 569   "mileage": "" , ~/~/ пробег
... ... @@ -593,7 +593,72 @@
593 593   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
594 594   }
595 595  
596 -(% style="color:#000000" %) }
946 +"drivers": [ ~/~/ Водители
947 + {
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "isDefault": true
950 + }
951 + ],
952 + "commandTemplates": [ ~/~/ Шаблон команды
953 + {
954 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
955 + "name": "string",
956 + "command": "string",
957 + "retries": 0
958 + }
959 + ],
960 + "sensors": [ ~/~/ Датчики
961 + {
962 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
963 + "kind": 0,
964 + "type": 0,
965 + "name": "string",
966 + "inputType": 0,
967 + "inputNumber": 0,
968 + "pseudonym": "string",
969 + "medianDegree": 0,
970 + "isInverted": true,
971 + "disabled": true,
972 + "gradeType": 0,
973 + "gradesTables": [
974 + {
975 + "grades": [
976 + {
977 + "input": 0,
978 + "output": 0
979 + }
980 + ],
981 + "relevanceTime": "2023-05-22T12:19:59.728Z"
982 + }
983 + ],
984 + "showInTooltip": true,
985 + "showLastValid": true,
986 + "showAsDutOnGraph": true,
987 + "showWithoutIgn": true,
988 + "agrFunction": 0,
989 + "expr": "string",
990 + "children": [
991 + "string"
992 + ],
993 + "customParams": {
994 + "additionalProp1": "string",
995 + "additionalProp2": "string",
996 + "additionalProp3": "string"
997 + },
998 + "summaryMaxValue": 0
999 + }
1000 + ],
1001 + "customFields": [ ~/~/ Произвольные поля
1002 + {
1003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1004 + "name": "string",
1005 + "value": "string",
1006 + "forClient": true,
1007 + "forTooltip": true,
1008 + "forReport": true
1009 + }
1010 + ]
1011 +}
597 597  
598 598  (% style="color:#000000" %)Ответ:
599 599  
... ... @@ -645,15 +645,16 @@
645 645  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
646 646  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
647 647  
1063 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
648 648  
649 -(% class="box successmessage" %)
1065 +(% class="box infomessage" %)
650 650  (((
651 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1067 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
652 652  )))
653 653  
654 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1070 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
655 655  
656 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1072 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
657 657  
658 658  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
659 659  
... ... @@ -690,7 +690,7 @@
690 690   "customFields": null ~/~/ значение любого из произвольных полей ТС
691 691  }
692 692  
693 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1109 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
694 694  
695 695  (% style="color:#000000" %)Ответ:
696 696  
... ... @@ -712,18 +712,28 @@
712 712   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
713 713   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
714 714   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
715 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
1131 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1132 + "customFields": [ 
1133 + {
1134 + "id": "", ~/~/ идентификатор произвольного поля
1135 + "name": "", ~/~/ имя произвольного поля
1136 + "value": "", ~/~/ значение произвольного поля
1137 + "forClient": true, ~/~/ право на отображение у клиента
1138 + "forTooltip": false, ~/~/ право на отображение в подсказке
1139 + "forReport": false ~/~/ право на отображение в отчетах
1140 + }(%%)
716 716  (% style="color:#000000" %)}
717 717  
718 718  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
719 719  
1145 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
720 720  
721 721  (% class="box successmessage" %)
722 722  (((
723 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1149 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
724 724  )))
725 725  
726 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1152 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
727 727  
728 728  (% style="color:#000000" %)Метод запроса: **POST**
729 729  
... ... @@ -762,13 +762,14 @@
762 762  (% style="text-align:left" %)
763 763  (% style="color:#000000" %) }
764 764  
1191 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
765 765  
766 766  (% class="box warningmessage" %)
767 767  (((
768 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1195 +(% lang="en-US" %)**PUT /api/v3/vehicles**
769 769  )))
770 770  
771 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1198 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
772 772  
773 773  (% style="color:#000000" %)Метод запроса: **PUT**
774 774  
... ... @@ -778,18 +778,16 @@
778 778  
779 779  (% style="color:#000000" %)Параметры в теле запроса (JSON):
780 780  
781 -(% style="color:#000000" %){    
1208 +(% style="color:#000000" %){
782 782  
783 -(((
784 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
785 - "parentId": "", ~/~/ ID клиента
786 - "name": "", ~/~/ имя ТС
787 - "imei": "", ~/~/ IMEI
788 - "deviceTypeId": "", ~/~/ ID типа устройства
789 - "modelId": "", ~/~/ , ID модели    
790 - "unitId": "", ~/~/ подразделения
791 - "sim1": "", ~/~/ SIM 1
792 - "sim2": "", ~/~/ SIM2     (%%)
1210 + "parentId": "" , ~/~/ ID клиента
1211 + "name": "" , ~/~/ имя ТС
1212 + "imei": "" , ~/~/ IMEI
1213 + "deviceTypeId": "" , ~/~/ ID типа устройства
1214 + "modelId": "" , ~/~/ ID модели
1215 + "unitId": "" , ~/~/ ID подразделения
1216 + "sim1": "" , ~/~/ Номер SIM 1
1217 + "sim2": "" , ~/~/ Номер SIM2
793 793   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
794 794   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
795 795   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -802,39 +802,107 @@
802 802   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
803 803   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
804 804   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
805 -(% style="color:#000000" %) "counters": 
806 - {
807 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
808 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
809 - "mileage": "", ~/~/ пробег, в метрах 
810 - "motohours": "" ~/~/ моточасы, в секундах
811 - }
812 - "cmsv6Parameters": ~/~/ параметры CMSv6
813 - {       
814 - "id": "", ~/~/ идентификатор
815 - "enabled": true, ~/~/ флаг включения
816 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
817 - "login": "", ~/~/ имя учетной записи
818 - "password": "", ~/~/ пароль учетной записи
819 - }
820 - "inspectionTasks": ~/~/ задания на ТО
821 - {
822 - "id": "", ~/~/ ID задания
823 - "enabled": false, ~/~/ Признак включения
824 - "name": "", ~/~/ Имя задания
825 - "description": "", ~/~/ Описание задания
826 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
827 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
828 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
829 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
830 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
831 - "kind": "", ~/~/ Вид периодичности по времени
832 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
833 - } 
834 -)))
835 835  
836 -(% style="color:#000000" %)}
1231 + "mileageCalcMethod": 0,
1232 + "mileageCoeff": 0,
1233 + "locationByCellId": true,
1234 + "dottedLineTrackWhenNoCoords": true,
1235 + "counters": ~/~/ счетчики
1236 + {
1237 + "mileage": "" , ~/~/ пробег
1238 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1239 + "motohours": "" , ~/~/ моточасы
1240 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1241 + },
1242 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1243 + "enabled": true, ~/~/ флаг включения
1244 + "id": "" , ~/~/ идентификатор
1245 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1246 + "login": "" , ~/~/ имя учетной записи
1247 + "password": "" ~/~/ пароль учетной записи
1248 + },
1249 + "inspectionTasks": ~/~/ задания на ТО
1250 + {
1251 + "enabled": "" , ~/~/ Признак включения
1252 + "name": "" , ~/~/ Имя задания
1253 + "description": "" , ~/~/ Описание задания
1254 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1255 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1256 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1257 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1258 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1259 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1260 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1261 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1262 + }
837 837  
1264 +"drivers": [ ~/~/ Водители
1265 + {
1266 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1267 + "isDefault": true
1268 + }
1269 + ],
1270 + "commandTemplates": [ ~/~/ Шаблон команды
1271 + {
1272 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1273 + "name": "string",
1274 + "command": "string",
1275 + "retries": 0
1276 + }
1277 + ],
1278 + "sensors": [ ~/~/ Датчики
1279 + {
1280 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1281 + "kind": 0,
1282 + "type": 0,
1283 + "name": "string",
1284 + "inputType": 0,
1285 + "inputNumber": 0,
1286 + "pseudonym": "string",
1287 + "medianDegree": 0,
1288 + "isInverted": true,
1289 + "disabled": true,
1290 + "gradeType": 0,
1291 + "gradesTables": [
1292 + {
1293 + "grades": [
1294 + {
1295 + "input": 0,
1296 + "output": 0
1297 + }
1298 + ],
1299 + "relevanceTime": "2023-05-22T12:19:59.728Z"
1300 + }
1301 + ],
1302 + "showInTooltip": true,
1303 + "showLastValid": true,
1304 + "showAsDutOnGraph": true,
1305 + "showWithoutIgn": true,
1306 + "agrFunction": 0,
1307 + "expr": "string",
1308 + "children": [
1309 + "string"
1310 + ],
1311 + "customParams": {
1312 + "additionalProp1": "string",
1313 + "additionalProp2": "string",
1314 + "additionalProp3": "string"
1315 + },
1316 + "summaryMaxValue": 0
1317 + }
1318 + ],
1319 + "customFields": [ ~/~/ Произвольные поля
1320 + {
1321 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1322 + "name": "string",
1323 + "value": "string",
1324 + "forClient": true,
1325 + "forTooltip": true,
1326 + "forReport": true
1327 + }
1328 + ]
1329 +}
1330 +
838 838  (% style="color:#000000" %)Ответ:
839 839  
840 840  (% lang="en-US" style="text-align:left" %)
... ... @@ -885,18 +885,19 @@
885 885  (% lang="en-US" style="text-align:left" %)
886 886  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
887 887  
888 -**валидация:**
1381 +**Валидация:**
889 889  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
890 890  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
891 891  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
892 892  
1386 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
893 893  
894 894  (% class="box errormessage" %)
895 895  (((
896 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1390 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
897 897  )))
898 898  
899 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1393 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
900 900  
901 901  (% style="color:#000000" %)Метод запроса: **DELETE**
902 902  
... ... @@ -909,18 +909,16 @@
909 909  (% style="text-align:left" %)
910 910  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
911 911  
1406 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
912 912  
913 -(% class="box" lang="en-US" style="text-align: center;" %)
914 -(((
915 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
916 -)))
1408 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
917 917  
918 918  (% class="box infomessage" %)
919 919  (((
920 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1412 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
921 921  )))
922 922  
923 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1415 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
924 924  
925 925  (% style="color:#000000" %)Метод запроса: **GET**
926 926  
... ... @@ -938,24 +938,22 @@
938 938  (% style="text-align:left" %)
939 939  (% style="color:#000000" %)}
940 940  
1433 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
941 941  
942 -(% class="box" style="text-align: center;" %)
943 -(((
944 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
945 -)))
1435 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
946 946  
947 947  (% class="box infomessage" %)
948 948  (((
949 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1439 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
950 950  )))
951 951  
952 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1442 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
953 953  
954 954  (% style="color:#000000" %)Метод запроса: **GET**
955 955  
956 956  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
957 957  
958 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1448 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
959 959  
960 960  (% style="color:#000000" %)Ответ:
961 961  
... ... @@ -968,7 +968,296 @@
968 968  (% style="text-align:left" %)
969 969  (% style="color:#000000" %)}
970 970  
1461 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
971 971  
1463 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1464 +
1465 +(% class="box infomessage" style="text-align: left;" %)
1466 +(((
1467 +**POST /api/v3/terminalMessages/count**
1468 +)))
1469 +
1470 +(% style="text-align: left;" %)
1471 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1472 +
1473 +(% style="text-align: left;" %)
1474 +Метод запроса **POST**
1475 +
1476 +(% style="text-align: left;" %)
1477 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1478 +
1479 +(% style="text-align: left;" %)
1480 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1481 +
1482 +(% style="text-align: left;" %)
1483 +{
1484 + "vehicleIds": [
1485 + id ~/~/ здесь передается список идентификаторов объектов
1486 + ],
1487 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1488 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1489 +}
1490 +
1491 +(% style="text-align: left;" %)
1492 +Ответ:
1493 +
1494 +(% style="text-align: left;" %)
1495 +[
1496 + {
1497 + "vehicleId": 0, ~/~/ идентификатор объекта
1498 + "count": 0 ~/~/ количество сообщений за период
1499 + }
1500 +]
1501 +
1502 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1503 +
1504 +(% class="box infomessage" %)
1505 +(((
1506 +**POST /api/v3/terminalMessages**
1507 +)))
1508 +
1509 +Метод возвращает список сообщений терминала объекта за выбранный период.
1510 +
1511 +(% style="text-align: left;" %)
1512 +Метод запроса **POST**
1513 +
1514 +(% style="text-align: left;" %)
1515 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1516 +
1517 +(% style="text-align: left;" %)
1518 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1519 +
1520 +{
1521 + "vehicleId": 0, ~/~/ id объекта
1522 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1523 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1524 +}
1525 +
1526 +Ответ:
1527 +
1528 +[
1529 + {
1530 + "messages": [
1531 + {
1532 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1533 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1534 + "speed": 0, ~/~/ Скорость, км/ч
1535 + "altitude": 0, ~/~/ Высота, м
1536 + "latitude": 0, ~/~/ Широта [-90°;90°]
1537 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1538 + "satellites": 0, ~/~/ Кол-во спутников
1539 + "voltage": 0, ~/~/ Напряжение
1540 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1541 + "additionalProp1": "string",
1542 + "additionalProp2": "string",
1543 + "additionalProp3": "string"
1544 + },
1545 + "photoCount": 0 ~/~/ Кол-во фото
1546 + }
1547 + ]
1548 + }
1549 +]
1550 +
1551 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1552 +
1553 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1554 +
1555 +(% class="box infomessage" %)
1556 +(((
1557 +**POST /api/v3/notifications/find**
1558 +)))
1559 +
1560 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1561 +
1562 +(% style="text-align: left;" %)
1563 +Метод запроса **POST**
1564 +
1565 +(% style="text-align: left;" %)
1566 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1567 +
1568 +(% style="text-align: left;" %)
1569 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1570 +
1571 +{
1572 + "parentId": "" ~/~/ id клиента
1573 +}
1574 +
1575 +Ответ:
1576 +
1577 +[
1578 + {
1579 + "id": 0, ~/~/ ID уведомления
1580 + "name": "string", ~/~/ Название уведомления
1581 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1582 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1583 + "userId": "", ~/~/ Пользователь, создавший уведомление
1584 + "parentId": "", ~/~/ Идентификатор клиента
1585 + "parentName": "string" ~/~/ Имя клиента
1586 + }
1587 +]
1588 +
1589 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1590 +
1591 +(% class="box infomessage" %)
1592 +(((
1593 +**GET /api/v3/notifications/{id}**
1594 +)))
1595 +
1596 +Метод возвращает данные правил формирования выбранного уведомления.
1597 +
1598 +(% style="text-align: left;" %)
1599 +Метод запроса **GET**
1600 +
1601 +(% style="text-align: left;" %)
1602 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1603 +
1604 +(% style="text-align: left;" %)
1605 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1606 +
1607 +(% style="text-align: left;" %)
1608 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1609 +
1610 +(% style="text-align: left;" %)
1611 +(% style="color:#000000" %)Ответ:
1612 +
1613 +(% style="text-align: left;" %)
1614 +(% style="color:#000000" %){
1615 + "id": 0, ~/~/ (%%)id уведомления
1616 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1617 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1618 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1619 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1620 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1621 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1622 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1623 +(% style="color:#000000" %) 0
1624 + ],
1625 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1626 +(% style="color:#000000" %) 0
1627 + ],
1628 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1629 +(% style="color:#000000" %) 0
1630 + ],
1631 + "settings": { ~/~/ Список параметров уведомления
1632 + "additionalProp1": "string",
1633 + "additionalProp2": "string",
1634 + "additionalProp3": "string"
1635 + },
1636 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1637 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1638 +(% style="color:#000000" %) ""
1639 + ],
1640 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1641 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1642 +(% style="color:#000000" %) "string"
1643 + ],
1644 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1645 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1646 +(% style="color:#000000" %) {
1647 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1648 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1649 +(% style="color:#000000" %) }
1650 + ],
1651 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1652 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1653 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1654 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1655 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1656 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1657 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1658 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1659 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1660 +(% style="color:#000000" %)}
1661 +
1662 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1663 +
1664 +(% class="box warningmessage" %)
1665 +(((
1666 +**PUT /api/v3/notifications/**
1667 +)))
1668 +
1669 +Метод позволяет отредактировать уведомление.
1670 +
1671 +Метод запроса **PUT**
1672 +
1673 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1674 +
1675 +В заголовках запроса: X-Auth: Токен авторизации
1676 +
1677 +Тело запроса:
1678 +{
1679 + "id": 0, ~/~/ id уведомления
1680 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1681 + "userId": "", ~/~/ Пользователь, создавший уведомление
1682 + "parentId": "", ~/~/ Идентификатор клиента
1683 + "parentName": "string", ~/~/ Имя клиента
1684 + "name": "string", ~/~/ Название уведомления
1685 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1686 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1687 + 0
1688 + ],
1689 + "geoids": [ ~/~/ Список id геообъектов для анализа
1690 + 0
1691 + ],
1692 + "fieldids": [ ~/~/ Список id полей для анализа
1693 + 0
1694 + ],
1695 + "settings": { ~/~/ Список параметров уведомления
1696 + "additionalProp1": "string",
1697 + "additionalProp2": "string",
1698 + "additionalProp3": "string"
1699 + },
1700 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1701 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1702 + ""
1703 + ],
1704 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1705 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1706 + "string"
1707 + ],
1708 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1709 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1710 + {
1711 + "id": 0, ~/~/ Идентификатор участника чата
1712 + "info": "string" ~/~/ Дополнительные сведения
1713 + }
1714 + ],
1715 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1716 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1717 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1718 + "kind": 0, ~/~/ Определяет вид уведомления
1719 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1720 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1721 + "timezone": 0, ~/~/ Сдвиг часового пояса
1722 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1723 + "autoProlongation": true ~/~/ Автопродление срока действия
1724 +}
1725 +
1726 +Ответ:
1727 +
1728 +Success
1729 +
1730 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1731 +
1732 +(% class="box errormessage" %)
1733 +(((
1734 +**DELETE /api/v3/notifications/{id}**
1735 +)))
1736 +
1737 +Метод позволяет удалить выбранное уведомление.
1738 +
1739 +Метод запроса **DELETE**
1740 +
1741 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1742 +
1743 +Передаваемый параметр: {id} - id уведомления
1744 +
1745 +В заголовках запроса: X-Auth: Токен авторизации
1746 +
1747 +Ответ:
1748 +
1749 +Success
1750 +
972 972  (% class="box" lang="en-US" style="text-align: center;" %)
973 973  (((
974 974  (% 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 г.