Редактировал(а) Андрей Калиновский 2025/04/21 14:13
<
От версии < 89.3 >
отредактировано Илья Крайнов
на 2023/05/22 14:41
К версии < 13.1 >
отредактировано Артем Шемяков
на 2022/09/01 15:14
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Теги
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Содержимое
... ... @@ -1,68 +1,62 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 +== Описание ГЛОНАССSoft Public API ==
3 +
4 +== ==
5 +
6 +(% class="box" style="text-align: center;" %)
2 2  (((
3 -**Содержание страницы:**
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
4 4  )))
5 5  
6 -{{toc/}}
11 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
7 7  
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
8 8  
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 +
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
21 +)))
18 18  
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 -(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
26 26  )))
27 27  
28 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
36 +(% style="color:#000000" %)Метод запроса: **GET**
37 37  
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}
38 +(% 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>
42 42  
40 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
43 43  
44 -(% style="color:#000000" %)**Ответ:**
42 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
45 45  
46 -(% lang="en-US" %)
47 -(% style="color:#000000" %){
44 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
48 48  
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
46 +(% 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" %)]
52 52  
53 -(% lang="en-US" %)
54 -}
55 55  
56 -**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
49 +(% class="box" style="text-align: center;" %)
50 +(((
51 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
52 +)))
57 57  
58 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 -
60 60  (% class="box infomessage" %)
61 61  (((
62 -(% lang="en-US" %)**GET /api/v3/auth/check**
56 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
63 63  )))
64 64  
65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
59 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
66 66  
67 67  (% style="color:#000000" %)Метод запроса: **GET**
68 68  
... ... @@ -73,243 +73,98 @@
73 73  (% lang="en-US" %)
74 74  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
75 75  
76 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 -
80 80  (% class="box infomessage" %)
81 81  (((
82 -**GET api/v3/agents/{id}**
73 +(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
83 83  )))
84 84  
85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
76 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
86 86  
87 -(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
88 -
89 89  (% style="color:#000000" %)Метод запроса: **GET**
90 90  
91 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
80 +(% 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]]
92 92  
93 -Запрос должен содержать данные параметра "**agentId**"
82 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
94 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 - }
84 +(% lang="en-US" %)
85 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
119 119  
120 -== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
88 +(% class="box" lang="en-US" style="text-align: center;" %)
89 +(((
90 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
91 +)))
92 +
122 122  (% class="box infomessage" %)
123 123  (((
124 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
95 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
125 125  )))
126 126  
127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
98 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
128 128  
129 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
100 +(% style="color:#000000" %)Метод запроса: **GET**
130 130  
131 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
102 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
134 134  
135 -(% style="color:#000000" %)Метод запроса: **POST**
106 +(% style="color:#000000" %)Ответ: [
136 136  
137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
108 +(% class="western" %)
109 +{{{ {
110 + "deviceTypeId" : "", // ID типа устройства
111 + "deviceTypeName" : "" // Название типа устройства
112 + },}}}
138 138  
139 -(% style="color:#000000" %)Параметр запроса:
114 +(% style="text-align:left" %)
115 +(% style="color:#000000" %)…** **]
140 140  
141 -(% style="color:#000000" %){
142 - "parentId": "string"
143 -}
144 144  
145 -(% style="color:#000000" %)Ответ:
146 -
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 -}
156 -
157 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 -
159 -(% class="box successmessage" %)
118 +(% class="box" style="text-align: center;" %)
160 160  (((
161 -**POST /api/v3/agents **
120 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
162 162  )))
163 163  
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" %)
123 +(% class="box infomessage" %)
223 223  (((
224 -**PUT /api/v3/agents**
125 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
225 225  )))
226 226  
227 -Метод позволяет отредактировать клиента, указанного в запросе.
128 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
228 228  
229 -Метод запроса: **PUT**
130 +(% style="color:#000000" %)Метод запроса: **GET**
230 230  
231 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
132 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
232 232  
233 -В заголовках запроса: X-Auth: Токен авторизации
134 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
234 234  
136 +(% style="color:#000000" %)Ответ: [
235 235  
236 -Параметры в теле запроса (JSON):
138 +(% class="western" style="margin-bottom:19px" %)
139 +{{{ {}}}
237 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 -}
141 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
259 259  
143 +(% class="western" %)
144 +{{{ "description": "" // Описание
145 + },}}}
260 260  
261 -Ответ:
147 +(% style="text-align:left" %)
148 +(% style="color:#000000" %)… ]
262 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 283  
284 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
285 -
286 -(% class="box errormessage" %)
151 +(% class="box" style="text-align: center;" %)
287 287  (((
288 -**DELETE /api/v3/agents/{clientId}**
153 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
289 289  )))
290 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 -
307 307  (% class="box successmessage" %)
308 308  (((
309 -(% lang="en-US" %)**POST /api/v3/users**
158 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
310 310  )))
311 311  
312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
161 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
313 313  
314 314  (% style="color:#000000" %)Метод запроса: **POST**
315 315  
... ... @@ -317,189 +317,18 @@
317 317  
318 318  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
319 319  
320 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
169 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «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»: [ // группы пользователя «», //названия групп «», «» ] }
321 321  
322 -(% style="color:#000000" %)
323 -{ 
324 - "lastName": "", ~/~/ фамилия
325 - "firstName": "", ~/~/ имя
326 - "position": "", ~/~/ должность
327 - "phone": "", ~/~/ телефон
328 - "organization": "", ~/~/ организация
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 - отключен
336 - "parentId": "", ~/~/ Guid родительского агента
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 -}
354 -
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 -
367 367  (% style="text-align:left" %)
368 -(% style="color:#000000; font-weight:normal" %)Ответ:
172 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
369 369  
370 -(% style="text-align:left" %)
371 -(% style="color:#000000; font-weight:normal" %){    
372 372  
373 -(% style="text-align:left" %)
374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
375 - "lastName": "" , ~/~/ Фамилия ,
376 - "firstName": "" , ~/~/ Имя
377 - "position": "" , ~/~/ Должность
378 - "phone": "" , ~/~/ Телефон
379 - "organization": "" , ~/~/ Организация
380 - "login": "" , ~/~/ Логин
381 - "password": "" , ~/~/ Пароль
382 - "email": "" , ~/~/ Email
383 - "description": "" , ~/~/ Описание
384 - "isEnabled": "" , ~/~/ Признак включения
385 - "parentId": "" , ~/~/ Guid родительского агента
386 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
387 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
388 - "kind": "" , ~/~/ тип аутентификации
389 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
390 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
391 -
392 -(% style="text-align:left" %)
393 -(% style="color:#000000; font-weight:normal" %)}
394 -
395 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 -
397 -(% class="box infomessage" %)
398 -(((
399 -(% lang="en-US" %)**POST /api/v3/users/find**
400 -)))
401 -
402 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
403 -
404 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
405 -
406 -(% style="color:#000000" %)Метод запроса: **POST**
407 -
408 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
409 -
410 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
411 -
412 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
413 -
414 -(% style="color:#000000" %){
415 -
416 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
417 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
418 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
419 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 -
421 -(% style="color:#000000" %)}
422 -
423 -(% style="color:#000000" %)Ответ:
424 -
425 -(% style="color:#000000" %){         (%%)
426 -
427 - "id": "" , ~/~/ идентификатор пользователя
428 - "lastName": "" , ~/~/ фамилия
429 - "firstName": "" , ~/~/ имя
430 - "position": "" , ~/~/ должность
431 - "phone": "" , ~/~/ телефон
432 - "parentId": "" , ~/~/ идентификатор клиента-родителя
433 - "parentName": "" , ~/~/ наименование клиента-родителя
434 - "organization": "" , ~/~/ организация
435 - "login": "" , ~/~/ логин
436 - "email": "" , ~/~/ E-mail
437 - "sessionDuration":"", ~/~/ длительность сессии в минутах
438 - "status": "1",  ~/~/ статус пользователя
439 - "lastLogged": "", ~/~/ дата/время последней авторизации
440 -
441 -(% style="color:#000000" %)}
442 -
443 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
444 -
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 -
497 497  (% class="box warningmessage" %)
498 498  (((
499 -(% lang="en-US" %)**PUT /api/v3/users**
177 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
500 500  )))
501 501  
502 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
180 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
503 503  
504 504  (% style="color:#000000" %)Метод запроса: **PUT**
505 505  
... ... @@ -508,174 +508,98 @@
508 508  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
509 509  
510 510  (% lang="en-US" style="text-align:left" %)
511 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
189 +(% 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» //названия групп ] }  //
512 512  
513 -(% lang="en-US" style="text-align:left" %)
514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 515  
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 -
578 578  (% class="box warningmessage" %)
579 579  (((
580 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
194 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
581 581  )))
582 582  
583 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
197 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
584 584  
585 585  (% style="color:#000000" %)Метод запроса: **PUT**
586 586  
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}
201 +(% 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} Параметр запроса:
588 588  
589 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
203 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
590 590  
591 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
205 +(% class="western" %)
206 +{{{ "description": "", // описание
207 + "data": "" // данные, связанные со сменой статуса}}}
592 592  
593 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
594 -
595 -(% style="color:#000000" %){
596 -
597 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
598 - "description": "" , ~/~/ описание
599 - "data": "" , ~/~/ данные, связанные со сменой статуса
600 -
601 601  (% style="color:#000000" %)}
602 602  
603 603  (% style="text-align:left" %)
604 604  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
605 605  
606 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
607 607  
608 -(% class="box warningmessage" %)
215 +(% class="box successmessage" %)
609 609  (((
610 -**POST /api/v3/users/disable**
217 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
611 611  )))
612 612  
613 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
220 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
614 614  
615 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
222 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
616 616  
617 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
224 +(% style="color:#000000" %)Метод запроса: **POST**
618 618  
619 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
226 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
620 620  
621 - [ 
622 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
623 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
624 - ]
228 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
625 625  
626 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
230 +(% class="western" %)
231 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
232 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
233 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
234 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
627 627  
628 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
236 +(% style="color:#000000" %)}
629 629  
630 -(% class="box warningmessage" %)
238 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
239 +
240 +(% class="western" style="margin-bottom:19px" %)
241 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
242 +
243 +(% lang="en-US" style="text-align:left" %)
244 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
245 +
246 +
247 +(% class="box errormessage" %)
631 631  (((
632 -**POST /api/v3/users/enable**
249 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
633 633  )))
634 634  
635 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
252 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
636 636  
637 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
254 +(% style="color:#000000" %)Метод запроса: **DELETE**
638 638  
639 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
256 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
640 640  
641 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
258 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
642 642  
643 - [ 
644 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
645 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
646 - ]
260 +(% style="text-align:left" %)
261 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
647 647  
648 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
649 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
650 650  
264 +(% class="box" style="text-align: center;" %)
651 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 пользователей, которых не удалось включить или отключить.
266 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
663 663  )))
664 664  
665 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 -
667 667  (% class="box errormessage" %)
668 668  (((
669 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
271 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
670 670  )))
671 671  
672 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
274 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
673 673  
674 674  (% style="color:#000000" %)Метод запроса: **DELETE**
675 675  
676 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
278 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
677 677  
678 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
280 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
679 679  
680 680  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
681 681  
... ... @@ -682,188 +682,51 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
688 -
689 689  (% class="box infomessage" %)
690 690  (((
691 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
290 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
692 692  )))
693 693  
694 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
293 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
695 695  
696 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
295 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
697 697  
698 698  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
699 699  
700 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
299 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
701 701  
702 702  (% style="color:#000000" %)Метод запроса: **GET**
703 703  
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}
303 +(% 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>
705 705  
706 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
305 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
707 707  
708 708  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
709 709  
710 710  (% style="color:#000000" %)Ответ:
711 711  
712 -(((
713 -{
714 - "vehicleId": "", ~/~/ ID объекта
715 - "name": "", ~/~/ Имя объекта
716 - "imei": "", ~/~/ IMEI объекта
717 - "deviceTypeId": , ~/~/ ID типа устройства
718 - "deviceTypeName": "", ~/~/ Название типа устройства
719 - "sim1": "", ~/~/ Номер SIM1
720 - "sim2": "", ~/~/ Номер SIM2
311 +(% style="color:#000000" %){
721 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": "", ~/~/ Дата создания объекта
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" ~/~/ Дата пересчета последних моточасов
313 +(% class="western" %)
314 +{{{ "vehicleId": “”, // идентификатор объекта
315 + "name": "", // имя объекта
316 + "imei": "", // IMEI объекта
317 + "deviceTypeId": “”, // идентификатор устройства объекта
318 + "deviceTypeName": "" // наименование устройства объекта
319 + "parentId": "", // идентификатор клиента-родителя
320 + "parentName": "" // наименование клиента-родителя,
321 + "modelId": "", // идентификатор модели объекта
322 + "modelName": "" // наименование модели объекта,
323 + "unitId": "", // идентификатор подразделения
324 + "unitName": "", // наименование подразделения
325 + "status": “”, // статус объекта
326 + ...
769 769   },
328 + ...}}}
770 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 - },
330 +(% style="color:#000000" %)}
778 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 -
838 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
839 - {
840 - "id": "", ~/~/ ID  задания
841 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
842 - "name": "", ~/~/ Наименование задания
843 - "description": "", ~/~/ Описание задания
844 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
845 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
846 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
847 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
848 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
849 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
850 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
851 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
852 - }
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 -
864 -}
865 -)))
866 -
867 867  (% style="text-align:left" %)
868 868  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
869 869  
... ... @@ -870,14 +870,13 @@
870 870  (% style="text-align:left" %)
871 871  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
872 872  
873 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
874 874  
875 875  (% class="box successmessage" %)
876 876  (((
877 -(% lang="en-US" %)**POST /api/v3/vehicles**
341 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
878 878  )))
879 879  
880 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
344 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
881 881  
882 882  (% style="color:#000000" %)Метод запроса: **POST**
883 883  
... ... @@ -885,247 +885,106 @@
885 885  
886 886  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
887 887  
888 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
352 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
889 889  
890 -(% style="color:#000000" %){
891 -
892 - "parentId": "" , ~/~/ ID клиента
893 - "name": "" , ~/~/ имя ТС
894 - "imei": "" , ~/~/ IMEI
895 - "deviceTypeId": "" , ~/~/ ID типа устройства
896 - "modelId": "" , ~/~/ ID модели
897 - "unitId": "" , ~/~/ ID подразделения
898 - "sim1": "" , ~/~/ Номер SIM 1
899 - "sim2": "" , ~/~/ Номер SIM2
900 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
901 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
902 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
903 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
904 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
905 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
906 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
907 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
908 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
909 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
910 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
911 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
912 - "counters": ~/~/ счетчики
913 - {
914 - "mileage": "" , ~/~/ пробег
915 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
916 - "motohours": "" , ~/~/ моточасы
917 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
354 +(% class="western" %)
355 +{{{ "parentId": "", // ID клиента
356 + "name": "", // имя ТС
357 + "imei": "", // IMEI
358 + "deviceTypeId": "",// ID типа устройства
359 + "modelId": "",
360 + "unitId": "", // ID подразделения
361 + "sim1": "", // Номер SIM 1
362 + "sim2": "", // Номер SIM2
363 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
364 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
365 + "consumptionIdle": "",// Расход топлива на холостом ходу
366 + "counters": {
367 + "mileage": "", // пробег
368 + "mileageEnabled": true, // флаг активности счётчика "пробег"
369 + "motohours":"", // моточасы
370 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
371 + },
372 + "cmsv6Parameters": { // параметры CMSv6
373 + "enabled": true, // флаг включения
374 + //"id": "", // идентификатор
375 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
376 + "login": "", // имя учетной записи
377 + "password": "" // пароль учетной записи
918 918   },
919 - "cmsv6Parameters": { ~/~/ параметры CMSv6
920 - "enabled": true, ~/~/ флаг включения
921 - "id": "" , ~/~/ идентификатор
922 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
923 - "login": "" , ~/~/ имя учетной записи
924 - "password": "" ~/~/ пароль учетной записи
925 - },
926 - "inspectionTasks": ~/~/ задания на ТО
379 + "inspectionTasks": [ // задания на ТО
927 927   {
928 - "enabled": "" , ~/~/ Признак включения
929 - "name": "" , ~/~/ Имя задания
930 - "description": "" , ~/~/ Описание задания
931 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
932 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
933 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
934 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
935 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
936 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
937 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
938 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
939 - }
381 + "enabled": "", // Признак включения
382 + "name": "", // Имя задания
383 + "description": "", // Описание задания
384 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
385 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
386 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
387 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
388 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
389 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
390 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
391 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
392 + },
393 + ]}}}
940 940  
941 -(% style="color:#000000" %) }
395 +(% style="color:#000000" %)… }
942 942  
943 943  (% style="color:#000000" %)Ответ:
944 944  
945 945  (% style="color:#000000" %){
946 946  
947 - "vehicleId": "", ~/~/ID ТС 
948 - "parentId": "", ~/~/Guid владельца ТС
949 - "name": "", ~/~/Имя объекта
950 - "imei": "", ~/~/IMEI
951 - "deviceTypeId": "", ~/~/ID типа устройства
952 - "modelId": "", ~/~/ID модели
953 - "unitId": "", ~/~/ID подразделения
954 - "sim1": "", ~/~/SIM1
955 - "sim2": "", ~/~/SIM2
956 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
957 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
958 - "counters": { ~/~/Счётчики
959 - "mileageEnabled": true,
960 - "motohoursEnabled": true,
961 - "mileage": "",
962 - "motohours": 345.0
963 - },
964 - "cmsv6Parameters": { ~/~/Параметры CmsV6
965 - "id": null,
966 - "enabled": true, ~/~/флаг включения
967 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
968 - "login": "", ~/~/ имя учетной записи
969 - "password": "" ~/~/ пароль учетной записи
970 - },
971 - "inspectionTasks": { ~/~/ задания на ТО
972 - "id": "", ~/~/ ID задачи
973 - "enabled": false, ~/~/ Признак включения
974 - "name": "", ~/~/ Имя задания
975 - "description": "", ~/~/ Описание задания
976 - "mileageCondition": "", ~/~/ Условие по пробегу
977 - "lastMileage": "", ~/~/ Пробег (в метрах)
978 - "motohoursCondition": "", ~/~/ Условие по моточасам
979 - "lastMotohours": "", ~/~/ Моточасы
980 - "periodicCondition": "", ~/~/ Условие периодичности по времени
981 - "kind": "", ~/~/ Вид периодичности по времени 
982 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
983 - }
401 +(% class="western" %)
402 +{{{ "vehicleId": "", //ID ТС
403 + "parentId": "", //Guid владельца ТС
404 + "name": "", //Имя объекта
405 + "imei": "", //IMEI
406 + "deviceTypeId": "", //ID типа устройства
407 + "modelId": "", //ID модели
408 + "unitId": "", //ID подразделения
409 + "sim1": "", //SIM1
410 + "sim2": "", //SIM2
411 + "consumptionPer100Km": "", //Расход топлива на 100 км
412 + "consumptionIdle": "", //Расход топлива на холостом ходу
413 + "counters": { //Счётчики
414 + "mileageEnabled": true,
415 + "motohoursEnabled": true,
416 + "mileage": "",
417 + "motohours": 345.0
418 + },
419 + "cmsv6Parameters": { //Параметры CmsV6
420 + "id": null,
421 + "enabled": true, //флаг включения
422 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
423 + "login": "", // имя учетной записи
424 + "password": "" // пароль учетной записи
425 + },
426 + "inspectionTasks": [ // задания на ТО
427 + {
428 + "id": "", // ID задачи
429 + "enabled": false, // Признак включения
430 + "name": "", // Имя задания
431 + "description": "", // Описание задания
432 + "mileageCondition": "", // Условие по пробегу
433 + "lastMileage": "", // Пробег (в метрах)
434 + "motohoursCondition": "", // Условие по моточасам
435 + "lastMotohours": "", // Моточасы
436 + "periodicCondition": "", // Условие периодичности по времени
437 + "kind": "", // Вид периодичности по времени
438 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
439 + }
440 + ]}}}
984 984  
985 985  (% style="text-align:left" %)
986 986  (% style="color:#000000" %)}
987 987  
988 -**Валидация:**
989 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
990 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
991 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
992 992  
993 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
994 -
995 -(% class="box infomessage" %)
996 -(((
997 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
998 -)))
999 -
1000 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1001 -
1002 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1003 -
1004 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1005 -
1006 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1007 -
1008 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1009 -
1010 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1011 -
1012 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1013 -
1014 -(% style="color:#000000" %)Метод запроса: **POST**
1015 -
1016 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1017 -
1018 -(% style="color:#000000" %)В заголовках запроса:
1019 -
1020 -(% style="color:#000000" %)− Content-Type: __**application/json**__
1021 -
1022 -(% style="color:#000000" %)− X-Auth: Токен авторизации
1023 -
1024 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1025 -
1026 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1027 -
1028 -{
1029 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1030 - "name": null, ~/~/ Имя ТС (string, опционально)
1031 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1032 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1033 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1034 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1035 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1036 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1037 -}
1038 -
1039 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1040 -
1041 -(% style="color:#000000" %)Ответ:
1042 -
1043 -(% style="color:#000000" %){
1044 -
1045 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1046 - "name": "" ~/~/ наименование объекта
1047 - "imei": "" ~/~/ IMEI объекта
1048 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
1049 - "deviceTypeName": "" ~/~/ наименование типа устройства
1050 - "sim1": "" ~/~/ первый номер телефона
1051 - "sim2": "" ~/~/ второй номер телефона
1052 - "parentId": "" ~/~/ идентификатор клиента-родителя
1053 - "parentName": "" ~/~/ наименование клиента-родителя
1054 - "modelId": "" ~/~/ идентификатор модели объекта
1055 - "modelName": "" ~/~/ наименование модели объекта
1056 - "unitId": "" ~/~/ идентификатор подразделения
1057 - "unitName": "" ~/~/ наименование подразделения
1058 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1059 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1060 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1061 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1062 - "customFields": [ 
1063 - {
1064 - "id": "", ~/~/ идентификатор произвольного поля
1065 - "name": "", ~/~/ имя произвольного поля
1066 - "value": "", ~/~/ значение произвольного поля
1067 - "forClient": true, ~/~/ право на отображение у клиента
1068 - "forTooltip": false, ~/~/ право на отображение в подсказке
1069 - "forReport": false ~/~/ право на отображение в отчетах
1070 - }(%%)
1071 -(% style="color:#000000" %)}
1072 -
1073 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1074 -
1075 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1076 -
1077 -(% class="box successmessage" %)
1078 -(((
1079 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1080 -)))
1081 -
1082 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1083 -
1084 -(% style="color:#000000" %)Метод запроса: **POST**
1085 -
1086 -(% 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}
1087 -
1088 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1089 -
1090 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1091 -
1092 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1093 -
1094 -(% style="color:#000000" %){
1095 -
1096 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1097 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1098 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1099 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1100 - "description": "", ~/~/ Описание
1101 - "data": "", ~/~/ Данные
1102 - "overwrite": false, ~/~/ Флаг перезаписи
1103 - "stage": "", ~/~/ Состояние, может быть null
1104 -
1105 -(% style="color:#000000" %)}
1106 -
1107 -(% style="color:#000000" %)Ответ:
1108 -
1109 -(% style="color:#000000" %){
1110 -
1111 - "status": "", ~/~/ значение статуса
1112 - "date": "", ~/~/ Дата смены статуса 
1113 - "description": "", ~/~/ Описание
1114 - "data": "", ~/~/ Данные
1115 - "overwrite": false, ~/~/ Флаг перезаписи
1116 - "stage": "", ~/~/ Состояние
1117 -
1118 -(% style="text-align:left" %)
1119 -(% style="color:#000000" %) }
1120 -
1121 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1122 -
1123 1123  (% class="box warningmessage" %)
1124 1124  (((
1125 -(% lang="en-US" %)**PUT /api/v3/vehicles**
448 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1126 1126  )))
1127 1127  
1128 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
451 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1129 1129  
1130 1130  (% style="color:#000000" %)Метод запроса: **PUT**
1131 1131  
... ... @@ -1135,484 +1135,125 @@
1135 1135  
1136 1136  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1137 1137  
1138 -(% style="color:#000000" %){    
461 +(% 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»: «» //Сколько раз выполнить задание } ] }
1139 1139  
1140 -(((
1141 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1142 - "parentId": "", ~/~/ ID клиента
1143 - "name": "", ~/~/ имя ТС
1144 - "imei": "", ~/~/ IMEI
1145 - "deviceTypeId": "", ~/~/ ID типа устройства
1146 - "modelId": "", ~/~/ , ID модели    
1147 - "unitId": "", ~/~/ подразделения
1148 - "sim1": "", ~/~/ SIM 1
1149 - "sim2": "", ~/~/ SIM2     (%%)
1150 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1151 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1152 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1153 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1154 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1155 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1156 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1157 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1158 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1159 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1160 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1161 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1162 -(% style="color:#000000" %) "counters": 
1163 - {
1164 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1165 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1166 - "mileage": "", ~/~/ пробег, в метрах 
1167 - "motohours": "" ~/~/ моточасы, в секундах
1168 - }
1169 - "cmsv6Parameters": ~/~/ параметры CMSv6
1170 - {       
1171 - "id": "", ~/~/ идентификатор
1172 - "enabled": true, ~/~/ флаг включения
1173 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1174 - "login": "", ~/~/ имя учетной записи
1175 - "password": "", ~/~/ пароль учетной записи
1176 - }
1177 - "inspectionTasks": ~/~/ задания на ТО
1178 - {
1179 - "id": "", ~/~/ ID задания
1180 - "enabled": false, ~/~/ Признак включения
1181 - "name": "", ~/~/ Имя задания
1182 - "description": "", ~/~/ Описание задания
1183 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1184 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1185 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1186 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1187 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1188 - "kind": "", ~/~/ Вид периодичности по времени
1189 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1190 - } 
1191 -)))
1192 -
1193 -(% style="color:#000000" %)}
1194 -
1195 1195  (% style="color:#000000" %)Ответ:
1196 1196  
1197 1197  (% lang="en-US" style="text-align:left" %)
1198 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
466 +(% 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»: «» //Сколько раз выполнить задание } ] }
1199 1199  
1200 -(% lang="en-US" style="text-align:left" %)
1201 - "vehicleId": "", ~/~/ ID ТС
1202 - "parentId": "", ~/~/ ID клиента
1203 - "name": "", ~/~/ имя ТС
1204 - "imei": "", ~/~/ IMEI
1205 - "deviceTypeId": "", ~/~/ типа устройства
1206 - "modelId": "", ~/~/ ID модели
1207 - "unitId": "", ~/~/ ID подразделения
1208 - "sim1": "", ~/~/ SIM 1
1209 - "sim2": "", ~/~/ SIM2
1210 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1211 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1212 - "counters": 
1213 - {
1214 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1215 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1216 - "mileage": "", ~/~/ пробег
1217 - "motohours": "", ~/~/ моточасы
1218 - }
1219 - "cmsv6Parameters": ~/~/ параметры CMSv6
1220 - {
1221 - "id": ~/~/ идентификатор
1222 - "enabled": true, ~/~/ флаг включения
1223 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1224 - "login": "", ~/~/ имя учетной записи
1225 - "password": "", ~/~/ пароль учетной записи
1226 - }
1227 - "inspectionTasks": ~/~/ задания на ТО
1228 - {
1229 - "id": "", ~/~/ ID задания
1230 - "enabled": false, ~/~/ Признак включения
1231 - "name": "", ~/~/ Имя задания
1232 - "description": "", ~/~/ Описание задания
1233 - "mileageCondition": "", ~/~/ Условие по пробегу
1234 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1235 - "motohoursCondition": "", ~/~/ Условие по моточасам
1236 - "lastMotohours": "", ~/~/ Моточасы
1237 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1238 - "kind": "", ~/~/ Вид периодичности по времени
1239 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1240 - }
1241 1241  
1242 -(% lang="en-US" style="text-align:left" %)
1243 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1244 -
1245 -**Валидация:**
1246 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1247 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1248 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1249 -
1250 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1251 -
1252 -(% class="box errormessage" %)
469 +(% class="box successmessage" %)
1253 1253  (((
1254 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
471 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
1255 1255  )))
1256 1256  
1257 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
474 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1258 1258  
1259 -(% style="color:#000000" %)Метод запроса: **DELETE**
476 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
1260 1260  
1261 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
478 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1262 1262  
1263 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
480 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1264 1264  
1265 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
482 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
1266 1266  
1267 -(% style="text-align:left" %)
1268 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
484 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
1269 1269  
1270 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
486 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
1271 1271  
1272 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
488 +(% style="color:#000000" %)Метод запроса: **POST**
1273 1273  
1274 -(% class="box infomessage" %)
1275 -(((
1276 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1277 -)))
490 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1278 1278  
1279 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
492 +(% style="color:#000000" %)В заголовках запроса:
1280 1280  
1281 -(% style="color:#000000" %)Метод запроса: **GET**
494 +(% style="color:#000000" %)− Content-Type: application/json
1282 1282  
1283 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
496 +(% style="color:#000000" %)− X-Auth: Токен авторизации
1284 1284  
1285 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
498 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
1286 1286  
1287 -(% style="color:#000000" %)Ответ:
500 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307", ~/~/ IMEI (string, опционально) "sim": null,~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5 ~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null ~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
1288 1288  
1289 -(% style="color:#000000" %){
502 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
1290 1290  
1291 - "deviceTypeId" : "", ~/~/ ID типа устройства
1292 - "deviceTypeName" : "" ~/~/ Название типа устройства
504 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
1293 1293  
1294 -(% style="text-align:left" %)
1295 -(% style="color:#000000" %)}
506 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1296 1296  
1297 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
508 +(% style="color:#000000" %)0 - «Блокировка»
1298 1298  
1299 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
510 +(% style="color:#000000" %)1 - «Активен»,
1300 1300  
1301 -(% class="box infomessage" %)
1302 -(((
1303 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1304 -)))
512 +(% style="color:#000000" %)2 - «Отменен»
1305 1305  
1306 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
514 +(% style="color:#000000" %)3 - «Оборудован»
1307 1307  
1308 -(% style="color:#000000" %)Метод запроса: **GET**
516 +(% style="color:#000000" %)4 - «Диагностика»
1309 1309  
1310 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
518 +(% style="color:#000000" %)5 - «Сервис»
1311 1311  
1312 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
520 +(% style="color:#000000" %)6 - «Демонтаж»
1313 1313  
1314 -(% style="color:#000000" %)Ответ:
522 +(% style="color:#000000" %)7 - «Монтаж»
1315 1315  
1316 -(% style="color:#000000" %){
524 +(% style="color:#000000" %)8 - «Дозаказ»
1317 1317  
1318 - "id": "", ~/~/ ID типа датчика 
1319 - "name": "", ~/~/ Название
1320 - "description": "", ~/~/ Описание
526 +(% style="color:#000000" %)9 - «Обслужен»
1321 1321  
1322 -(% style="text-align:left" %)
1323 -(% style="color:#000000" %)}
528 +(% style="color:#000000" %)10 - «Списан»
1324 1324  
1325 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
530 +(% style="color:#000000" %)11 - «Неисправен»
1326 1326  
1327 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
532 +(% style="color:#000000" %)12 - «Проверен»
1328 1328  
1329 -(% class="box infomessage" style="text-align: left;" %)
1330 -(((
1331 -**POST /api/v3/terminalMessages/count**
1332 -)))
534 +(% style="text-align:left" %)
535 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
1333 1333  
1334 -(% style="text-align: left;" %)
1335 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1336 1336  
1337 -(% style="text-align: left;" %)
1338 -Метод запроса **POST**
1339 -
1340 -(% style="text-align: left;" %)
1341 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1342 -
1343 -(% style="text-align: left;" %)
1344 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1345 -
1346 -(% style="text-align: left;" %)
1347 -{
1348 - "vehicleIds": [
1349 - id ~/~/ здесь передается список идентификаторов объектов
1350 - ],
1351 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1352 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1353 -}
1354 -
1355 -(% style="text-align: left;" %)
1356 -Ответ:
1357 -
1358 -(% style="text-align: left;" %)
1359 -[
1360 - {
1361 - "vehicleId": 0, ~/~/ идентификатор объекта
1362 - "count": 0 ~/~/ количество сообщений за период
1363 - }
1364 -]
1365 -
1366 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1367 -
1368 -(% class="box infomessage" %)
538 +(% class="box successmessage" %)
1369 1369  (((
1370 -**POST /api/v3/terminalMessages**
540 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1371 1371  )))
1372 1372  
1373 -Метод возвращает список сообщений терминала объекта за выбранный период.
543 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1374 1374  
1375 -(% style="text-align: left;" %)
1376 -Метод запроса **POST**
545 +(% style="color:#000000" %)Метод запроса: **POST**
1377 1377  
1378 -(% style="text-align: left;" %)
1379 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
547 +(% 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}
1380 1380  
1381 -(% style="text-align: left;" %)
1382 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
549 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
1383 1383  
1384 -{
1385 - "vehicleId": 0, ~/~/ id объекта
1386 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1387 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1388 -}
1389 -
1390 -Ответ:
1391 -
1392 -[
1393 - {
1394 - "messages": [
1395 - {
1396 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1397 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1398 - "speed": 0, ~/~/ Скорость, км/ч
1399 - "altitude": 0, ~/~/ Высота, м
1400 - "latitude": 0, ~/~/ Широта [-90°;90°]
1401 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1402 - "satellites": 0, ~/~/ Кол-во спутников
1403 - "voltage": 0, ~/~/ Напряжение
1404 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1405 - "additionalProp1": "string",
1406 - "additionalProp2": "string",
1407 - "additionalProp3": "string"
1408 - },
1409 - "photoCount": 0 ~/~/ Кол-во фото
1410 - }
1411 - ]
1412 - }
1413 -]
1414 -
1415 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1416 -
1417 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1418 -
1419 -(% class="box infomessage" %)
1420 -(((
1421 -**POST /api/v3/notifications/find**
1422 -)))
1423 -
1424 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1425 -
1426 -(% style="text-align: left;" %)
1427 -Метод запроса **POST**
1428 -
1429 -(% style="text-align: left;" %)
1430 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1431 -
1432 -(% style="text-align: left;" %)
1433 1433  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1434 1434  
1435 -{
1436 - "parentId": "" ~/~/ id клиента
1437 -}
553 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
1438 1438  
1439 -Ответ:
555 +(% class="western" %)
556 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
557 + "date": "", // Дата смены статуса (null если сменить немедленно)
558 + "description": "", // Описание
559 + "data": "", // Данные
560 + "overwrite": false, // Флаг перезаписи
561 + "stage": "", // Состояние, может быть null}}}
1440 1440  
1441 -[
1442 - {
1443 - "id": 0, ~/~/ ID уведомления
1444 - "name": "string", ~/~/ Название уведомления
1445 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1446 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1447 - "userId": "", ~/~/ Пользователь, создавший уведомление
1448 - "parentId": "", ~/~/ Идентификатор клиента
1449 - "parentName": "string" ~/~/ Имя клиента
1450 - }
1451 -]
563 +(% style="color:#000000" %)}
1452 1452  
1453 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
565 +(% style="color:#000000" %)Ответ: {
1454 1454  
1455 -(% class="box infomessage" %)
1456 -(((
1457 -**GET /api/v3/notifications/{id}**
1458 -)))
567 +(% class="western" %)
568 +{{{ "status": "", // значение статуса
569 + "date": "", // Дата смены статуса
570 + "description": "", // Описание
571 + "data": "", // Данные
572 + "overwrite": false, // Флаг перезаписи
573 + "stage": "", // Состояние}}}
1459 1459  
1460 -Метод возвращает данные правил формирования выбранного уведомления.
1461 -
1462 -(% style="text-align: left;" %)
1463 -Метод запроса **GET**
1464 -
1465 -(% style="text-align: left;" %)
1466 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1467 -
1468 -(% style="text-align: left;" %)
1469 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1470 -
1471 -(% style="text-align: left;" %)
1472 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1473 -
1474 -(% style="text-align: left;" %)
1475 -(% style="color:#000000" %)Ответ:
1476 -
1477 -(% style="text-align: left;" %)
1478 -(% style="color:#000000" %){
1479 - "id": 0, ~/~/ (%%)id уведомления
1480 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1481 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1482 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1483 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1484 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1485 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1486 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1487 -(% style="color:#000000" %) 0
1488 - ],
1489 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1490 -(% style="color:#000000" %) 0
1491 - ],
1492 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
1493 -(% style="color:#000000" %) 0
1494 - ],
1495 - "settings": { ~/~/ Список параметров уведомления
1496 - "additionalProp1": "string",
1497 - "additionalProp2": "string",
1498 - "additionalProp3": "string"
1499 - },
1500 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1501 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1502 -(% style="color:#000000" %) ""
1503 - ],
1504 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1505 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1506 -(% style="color:#000000" %) "string"
1507 - ],
1508 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1509 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1510 -(% style="color:#000000" %) {
1511 - "id": 0, ~/~/ (%%)Идентификатор участника чата
1512 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1513 -(% style="color:#000000" %) }
1514 - ],
1515 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1516 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1517 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1518 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1519 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1520 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1521 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1522 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1523 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
575 +(% style="text-align:left" %)
1524 1524  (% style="color:#000000" %)}
1525 1525  
1526 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1527 1527  
1528 -(% class="box warningmessage" %)
1529 -(((
1530 -**PUT /api/v3/notifications/**
1531 -)))
1532 -
1533 -Метод позволяет отредактировать уведомление.
1534 -
1535 -Метод запроса **PUT**
1536 -
1537 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1538 -
1539 -В заголовках запроса: X-Auth: Токен авторизации
1540 -
1541 -Тело запроса:
1542 -{
1543 - "id": 0, ~/~/ id уведомления
1544 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1545 - "userId": "", ~/~/ Пользователь, создавший уведомление
1546 - "parentId": "", ~/~/ Идентификатор клиента
1547 - "parentName": "string", ~/~/ Имя клиента
1548 - "name": "string", ~/~/ Название уведомления
1549 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1550 - "vehicleIds": [ ~/~/ Список id объектов для анализа
1551 - 0
1552 - ],
1553 - "geoids": [ ~/~/ Список id геообъектов для анализа
1554 - 0
1555 - ],
1556 - "fieldids": [ ~/~/ Список id полей для анализа
1557 - 0
1558 - ],
1559 - "settings": { ~/~/ Список параметров уведомления
1560 - "additionalProp1": "string",
1561 - "additionalProp2": "string",
1562 - "additionalProp3": "string"
1563 - },
1564 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1565 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1566 - ""
1567 - ],
1568 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1569 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1570 - "string"
1571 - ],
1572 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1573 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1574 - {
1575 - "id": 0, ~/~/ Идентификатор участника чата
1576 - "info": "string" ~/~/ Дополнительные сведения
1577 - }
1578 - ],
1579 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1580 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1581 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1582 - "kind": 0, ~/~/ Определяет вид уведомления
1583 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1584 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1585 - "timezone": 0, ~/~/ Сдвиг часового пояса
1586 - "validity": 0, ~/~/ Срок действия в днях (1-90)
1587 - "autoProlongation": true ~/~/ Автопродление срока действия
1588 -}
1589 -
1590 -Ответ:
1591 -
1592 -Success
1593 -
1594 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1595 -
1596 -(% class="box errormessage" %)
1597 -(((
1598 -**DELETE /api/v3/notifications/{id}**
1599 -)))
1600 -
1601 -Метод позволяет удалить выбранное уведомление.
1602 -
1603 -Метод запроса **DELETE**
1604 -
1605 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1606 -
1607 -Передаваемый параметр: {id} - id уведомления
1608 -
1609 -В заголовках запроса: X-Auth: Токен авторизации
1610 -
1611 -Ответ:
1612 -
1613 -Success
1614 -
1615 1615  (% class="box" lang="en-US" style="text-align: center;" %)
1616 1616  (((
1617 -(% 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]] **
581 +(% lang="ru-RU" style="color: rgb(0, 0, 0); font-variant: normal; font-family: Liberation Serif, serif; font-size: 14pt; font-style: normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% style="color: rgb(0, 0, 0); font-size: 14pt" lang="ru-RU" %)** н**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)**а [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
1618 1618  )))

Меню

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