Редактировал(а) Андрей Калиновский 2025/03/28 11:43
<
От версии < 66.11 >
отредактировано Илья Крайнов
на 2022/11/24 13:36
К версии < 20.4 >
отредактировано Артем Шемяков
на 2022/09/01 17:28
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Теги
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Содержимое
... ... @@ -1,45 +1,39 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -= Описание ГЛОНАССSoft Public API 3.0 =
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 +== ==
4 4  
5 -{{toc/}}
6 +(% class="box" style="text-align: center;" %)
7 +(((
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 +)))
6 6  
7 -
8 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
9 -
10 10  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 11  
12 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
13 13  
14 14  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 +
15 15  
16 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 +)))
17 17  
18 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
19 -
20 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
21 -
22 22  (% class="box infomessage" %)
23 23  (((
24 -(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 25  )))
26 26  
27 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 28  
29 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
30 30  
31 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
32 32  
33 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 34  
35 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
36 -
37 -(% style="color:#000000" %){
38 - "login": "testuser",
39 - "password": "testuser"
40 -}(%%)
41 -
42 -
36 +(% lang="en-US" %)
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -46,8 +46,8 @@
46 46  (% style="color:#000000" %){
47 47  
48 48  (% lang="en-US" %)
49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
50 - "User": "testuser" , ~/~/ имя пользователя
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
51 51  
52 52  (% lang="en-US" %)
53 53  }
... ... @@ -54,14 +54,13 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% lang="en-US" %)**GET /api/v3/auth/check**
54 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,28 +72,30 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
75 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
76 76  
77 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
69 +(% class="box" style="text-align: center;" %)
70 +(((
71 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
72 +)))
78 78  
79 79  (% class="box infomessage" %)
80 80  (((
81 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
76 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 82  )))
83 83  
84 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
85 85  
86 86  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
87 87  
88 88  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
89 89  
90 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
91 91  
92 92  (% style="color:#000000" %)Метод запроса: **GET**
93 93  
94 94  (% 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>
95 95  
96 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
91 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
97 97  
98 98  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
99 99  
... ... @@ -104,163 +104,25 @@
104 104   "parentId": "", ~/~/ идентификатор клиента-родителя
105 105   "name": "", ~/~/ наименование клиента
106 106   "fullName": "", ~/~/ полное наименование клиента
107 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
108 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
109 -}
102 + "agentInfoType": "", ~/~/ тип клиента1
103 + "status": "", ~/~/ статус клиента
104 + }
110 110  
111 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
112 112  
113 -(% class="box successmessage" %)
114 -(((
115 -**POST /api/v3/agents **
116 -)))
107 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
117 117  
118 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
119 119  
120 -Метод запроса: **POST**
121 -
122 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
123 -
124 -В заголовках запроса: X-Auth: Токен авторизации
125 -
126 -Параметры в теле запроса (JSON):
127 -
128 -{
129 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
130 - "name": "string", ~/~/ имя
131 - "fullName": "string", ~/~/ полное наименование
132 - "isForeign": true, ~/~/ иностранный контрагент
133 - "district": "string", ~/~/ округ
134 - "region": "string", ~/~/ регион
135 - "city": "string", ~/~/ город
136 - "inn": "string", ~/~/ ИНН
137 - "kpp": "string", ~/~/ КПП
138 - "address": "string", ~/~/ юридический адрес
139 - "addressFact": "string", ~/~/ фактический адрес
140 - "email": "string", ~/~/ email
141 - "director": "string", ~/~/ ФИО руководителя
142 - "bankName": "string", ~/~/ банк
143 - "bankBIK": "string", ~/~/ БИК
144 - "bankRS": "string", ~/~/ номер счёта
145 - "bankKS": "string" ~/~/ корр. счёт
146 -}
147 -
148 -
149 -Ответ:
150 -
151 -{
152 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
153 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
154 - "name": "string", ~/~/ имя
155 - "fullName": "string", ~/~/ полное наименование
156 - "isForeign": true, ~/~/ иностранный контрагент
157 - "district": "string", ~/~/ округ
158 - "region": "string", ~/~/ регион
159 - "city": "string", ~/~/ город
160 - "inn": "string", ~/~/ ИНН
161 - "kpp": "string", ~/~/ КПП
162 - "address": "string", ~/~/ юридический адрес
163 - "addressFact": "string", ~/~/ фактический адрес
164 - "email": "string", ~/~/ email
165 - "director": "string", ~/~/ ФИО руководителя
166 - "bankName": "string", ~/~/ банк
167 - "bankBIK": "string", ~/~/ БИК
168 - "bankRS": "string", ~/~/ номер счёта
169 - "bankKS": "string" ~/~/ корр. счёт
170 -}
171 -
172 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
173 -
174 -(% class="box warningmessage" %)
110 +(% class="box" style="text-align: center;" %)
175 175  (((
176 -**PUT /api/v3/agents**
112 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
177 177  )))
178 178  
179 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
180 -
181 -Метод запроса: **PUT**
182 -
183 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
184 -
185 -В заголовках запроса: X-Auth: Токен авторизации
186 -
187 -
188 -Параметры в теле запроса (JSON):
189 -
190 -{
191 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
192 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
193 - "name": "string", ~/~/ имя
194 - "fullName": "string", ~/~/ полное наименование
195 - "isForeign": true, ~/~/ иностранный контрагент
196 - "district": "string", ~/~/ округ
197 - "region": "string", ~/~/ регион
198 - "city": "string", ~/~/ город
199 - "inn": "string", ~/~/ ИНН
200 - "kpp": "string", ~/~/ КПП
201 - "address": "string", ~/~/ юридический адрес
202 - "addressFact": "string", ~/~/ фактический адрес
203 - "email": "string", ~/~/ email
204 - "director": "string", ~/~/ ФИО руководителя
205 - "bankName": "string", ~/~/ банк
206 - "bankBIK": "string", ~/~/ БИК
207 - "bankRS": "string", ~/~/ номер счёта
208 - "bankKS": "string" ~/~/ корр. счёт
209 -}
210 -
211 -
212 -Ответ:
213 -
214 -{
215 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
216 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
217 - "name": "string", ~/~/ имя
218 - "fullName": "string", ~/~/ полное наименование
219 - "isForeign": true, ~/~/ иностранный контрагент
220 - "district": "string", ~/~/ округ
221 - "region": "string", ~/~/ регион
222 - "city": "string", ~/~/ город
223 - "inn": "string", ~/~/ ИНН
224 - "kpp": "string", ~/~/ КПП
225 - "address": "string", ~/~/ юридический адрес
226 - "addressFact": "string", ~/~/ фактический адрес
227 - "email": "string", ~/~/ email
228 - "director": "string", ~/~/ ФИО руководителя
229 - "bankName": "string", ~/~/ банк
230 - "bankBIK": "string", ~/~/ БИК
231 - "bankRS": "string", ~/~/ номер счёта
232 - "bankKS": "string" ~/~/ корр. счёт
233 -}
234 -
235 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
236 -
237 -(% class="box errormessage" %)
238 -(((
239 -**DELETE /api/v3/agents/{clientId}**
240 -)))
241 -
242 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
243 -
244 -Метод запроса: **DELETE**
245 -
246 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
247 -
248 -Параметр запроса: **{clientId}** - Guid пользователя
249 -
250 -В заголовках запроса: X-Auth: Токен авторизации
251 -
252 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
253 -
254 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
255 -
256 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
257 -
258 258  (% class="box successmessage" %)
259 259  (((
260 -(% lang="en-US" %)**POST /api/v3/users**
117 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
261 261  )))
262 262  
263 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
120 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
264 264  
265 265  (% style="color:#000000" %)Метод запроса: **POST**
266 266  
... ... @@ -276,9 +276,9 @@
276 276   "position": "", ~/~/ должность
277 277   "phone": "", ~/~/ телефон
278 278   "organization": "", ~/~/ организация
279 - "login": "", ~/~/ логин (обязателен)
280 - "password": "", ~/~/ пароль (обязателен)
281 - "email": "", ~/~/ email (обязателен)
136 + "login": "", ~/~/ логин
137 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 + "email": "", ~/~/ email
282 282   "description": "", ~/~/ описание
283 283   "isEnabled": "", ~/~/ признак включения
284 284   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -287,14 +287,14 @@
287 287   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
288 288   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
289 289   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
290 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
291 -}
147 + "groups": "" , ~/~/ группы пользователя, названия групп
148 + }
292 292  
293 293  (% style="text-align:left" %)
294 294  (% style="color:#000000; font-weight:normal" %)Ответ:
295 295  
296 296  (% style="text-align:left" %)
297 -(% style="color:#000000; font-weight:normal" %){    
154 +(% style="color:#000000; font-weight:normal" %){
298 298  
299 299  (% style="text-align:left" %)
300 300  (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
... ... @@ -313,31 +313,27 @@
313 313   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
314 314   "kind": "" , ~/~/ тип аутентификации
315 315   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
316 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
173 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
317 317  
318 318  (% style="text-align:left" %)
319 319  (% style="color:#000000; font-weight:normal" %)}
320 320  
321 321  
322 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
323 -
324 324  (% class="box successmessage" %)
325 325  (((
326 -(% lang="en-US" %)**POST /api/v3/users/find**
181 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
327 327  )))
328 328  
329 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
184 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
330 330  
331 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
186 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
332 332  
333 333  (% style="color:#000000" %)Метод запроса: **POST**
334 334  
335 335  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
336 336  
337 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
338 338  
339 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
340 -
341 341  (% style="color:#000000" %){
342 342  
343 343   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -349,9 +349,9 @@
349 349  
350 350  (% style="color:#000000" %)Ответ:
351 351  
352 -(% style="color:#000000" %){         (%%)
205 +(% style="color:#000000" %){
353 353  
354 - "id": "" , ~/~/ идентификатор пользователя
207 +(% style="color:#000000" %) "id": "" , ~/~/ идентификатор пользователя
355 355   "lastName": "" , ~/~/ фамилия
356 356   "firstName": "" , ~/~/ имя
357 357   "position": "" , ~/~/ должность
... ... @@ -361,71 +361,22 @@
361 361   "organization": "" , ~/~/ организация
362 362   "login": "" , ~/~/ логин
363 363   "email": "" , ~/~/ E-mail
364 - "sessionDuration":"", ~/~/ длительность сессии в минутах
365 - "status": "1",  ~/~/ статус пользователя
366 - "astLogged": "", ~/~/ дата/время последней авторизации
367 367  
368 368  (% style="color:#000000" %)}
369 369  
220 +(% class="western" style="margin-bottom:19px" %)
221 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
370 370  
371 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
223 +(% lang="en-US" style="text-align:left" %)
224 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
372 372  
373 -(% class="box successmessage" %)
374 -(((
375 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
376 -)))
377 377  
378 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
379 -
380 -(% style="color:#000000" %)Метод запроса: **GET**
381 -
382 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
383 -
384 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
385 -
386 -(% style="color:#000000" %)Ответ:
387 -
388 -(((
389 -(((
390 -{
391 - "id": "", ~/~/ GUID пользователя
392 - "lastName": "", ~/~/ Фамилия 
393 - "firstName": "", ~/~/ Имя
394 - "position": "", ~/~/ Должность
395 - "phone": "", ~/~/ Номер телефона
396 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
397 - "parentName": "", Наименование клиента, которому принадлежит пользователь
398 - "organization": "", ~/~/ Организация
399 - "login": "", ~/~/ Логин пользователя
400 - "email": "", ~/~/ Адрес электронной почты
401 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
402 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
403 - "description": "", ~/~/ Описание
404 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
405 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
406 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
407 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
408 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
409 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
410 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
411 - "groups": [], ~/~/ Список ролей пользователя
412 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
413 - "authDevices": [ ], ~/~/ Список авторизованных устройств
414 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
415 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
416 -}
417 -)))
418 -)))
419 -
420 -
421 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
422 -
423 423  (% class="box warningmessage" %)
424 424  (((
425 -(% lang="en-US" %)**PUT /api/v3/users**
229 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
426 426  )))
427 427  
428 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
232 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
429 429  
430 430  (% style="color:#000000" %)Метод запроса: **PUT**
431 431  
... ... @@ -434,88 +434,26 @@
434 434  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
435 435  
436 436  (% lang="en-US" style="text-align:left" %)
437 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
241 +(% 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» //названия групп ] }  //
438 438  
439 -(% lang="en-US" style="text-align:left" %)
440 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
441 441  
442 -(% lang="en-US" style="text-align:left" %)
443 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
444 - "lastName": "" , ~/~/ фамилия
445 - "firstName": "" , ~/~/ имя
446 - "position": "" , ~/~/ должность
447 - "phone": "" , ~/~/ телефон
448 - "organization": "" , ~/~/ организация
449 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
450 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
451 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
452 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
453 - "isEnabled": "" , ~/~/ признак включения
454 - "parentId": "" , ~/~/ Guid родительского агента
455 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
456 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
457 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
458 - "kind": "" , ~/~/ тип аутентификации
459 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
460 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
461 -
462 -(% lang="en-US" style="text-align:left" %)
463 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
464 -
465 -(% lang="en-US" style="text-align:left" %)
466 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
467 -
468 -(% lang="en-US" style="text-align:left" %)
469 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
470 -
471 -(% lang="en-US" style="text-align:left" %)
472 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
473 - "lastName": "" , ~/~/ фамилия
474 - "firstName": "" , ~/~/ имя
475 - "position": "" , ~/~/ должность
476 - "phone": "" , ~/~/ телефон
477 - "organization": "" , ~/~/ организация
478 - "login": "" , ~/~/ логин
479 - "password": "" , ~/~/ пароль 
480 - "email": "" , ~/~/ email
481 - "description": "" , ~/~/ описание
482 - "isEnabled": "" , ~/~/ признак включения
483 - "parentId": "" , ~/~/ Guid родительского агента
484 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
485 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
486 - "kind": "" , ~/~/ тип аутентификации
487 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
488 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
489 -
490 -(% lang="en-US" style="text-align:left" %)
491 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
492 -
493 -
494 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
495 -
496 496  (% class="box warningmessage" %)
497 497  (((
498 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
246 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
499 499  )))
500 500  
501 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
249 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
502 502  
503 503  (% style="color:#000000" %)Метод запроса: **PUT**
504 504  
505 -(% 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}
253 +(% 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} Параметр запроса:
506 506  
507 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
255 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
508 508  
509 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
257 +(% class="western" %)
258 +{{{ "description": "", // описание
259 + "data": "" // данные, связанные со сменой статуса}}}
510 510  
511 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
512 -
513 -(% style="color:#000000" %){
514 -
515 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
516 - "description": "" , ~/~/ описание
517 - "data": "" , ~/~/ данные, связанные со сменой статуса
518 -
519 519  (% style="color:#000000" %)}
520 520  
521 521  (% style="text-align:left" %)
... ... @@ -522,155 +522,72 @@
522 522  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
523 523  
524 524  
525 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
526 -
527 -(% class="box warningmessage" %)
528 -(((
529 -**POST /api/v3/users/disable**
530 -)))
531 -
532 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
533 -
534 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
535 -
536 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
537 -
538 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
539 -
540 - [ 
541 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
542 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
543 - ]
544 -
545 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
546 -
547 -
548 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
549 -
550 -(% class="box warningmessage" %)
551 -(((
552 -**POST /api/v3/users/enable**
553 -)))
554 -
555 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
556 -
557 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
558 -
559 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
560 -
561 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
562 -
563 - [ 
564 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
565 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
566 - ]
567 -
568 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
569 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
570 -
571 -(((
572 -В теле ответа:
573 -{
574 - "errorMessages": [
575 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
576 - ],
577 - "users": [
578 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
579 - ]
580 -}
581 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
582 -"users" - массив id пользователей, которых не удалось включить или отключить.
583 -
584 -
585 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
586 -)))
587 -
588 588  (% class="box errormessage" %)
589 589  (((
590 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
269 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
591 591  )))
592 592  
593 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
272 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
594 594  
595 595  (% style="color:#000000" %)Метод запроса: **DELETE**
596 596  
597 597  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
598 598  
599 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
278 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
600 600  
601 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
602 -
603 603  (% style="text-align:left" %)
604 604  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
605 605  
606 606  
607 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
284 +(% class="box" style="text-align: center;" %)
285 +(((
286 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
287 +)))
608 608  
609 -
610 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
611 -
612 612  (% class="box infomessage" %)
613 613  (((
614 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
291 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
615 615  )))
616 616  
617 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
294 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
618 618  
619 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
296 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
620 620  
621 621  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
622 622  
623 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
300 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
624 624  
625 625  (% style="color:#000000" %)Метод запроса: **GET**
626 626  
627 627  (% 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>
628 628  
629 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
306 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
630 630  
631 631  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
632 632  
633 633  (% style="color:#000000" %)Ответ:
634 634  
635 -(((
636 -{
637 - "vehicleId": "", ~/~/ ID объекта
638 - "name": "", ~/~/ Имя объекта
639 - "imei": "", ~/~/ IMEI объекта
640 - "deviceTypeId": , ~/~/ ID типа устройства
641 - "deviceTypeName": "", ~/~/ Название типа устройства
642 - "sim1": "", ~/~/ Номер SIM1
643 - "parentId": "", Номер SIM2
644 - "parentName": "", Наименование клиента-родителя
645 - "modelId": "", ID модели объекта
646 - "modelName": "", Имя модели объекта
647 - "createdAt": "", Дата создания объекта
648 - "mileageCalcMethod": "", Выбранный метод расчета пробега
649 - "counters": { ~/~/ Нормы
650 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
651 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
652 - "mileage": "", ~/~/ Пробег по нормам в метрах
653 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
654 - },
655 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
656 - {
657 - "id": "", ~/~/ ID  задания
658 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
659 - "name": "", ~/~/ Наименование задания
660 - "description": "", ~/~/ Описание задания
661 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
662 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
663 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
664 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
665 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
666 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
667 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
668 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
669 - }
670 - ]
671 -}
672 -)))
312 +(% style="color:#000000" %){
673 673  
314 +(% class="western" %)
315 +{{{ "vehicleId": “”, // идентификатор объекта
316 + "name": "", // имя объекта
317 + "imei": "", // IMEI объекта
318 + "deviceTypeId": “”, // идентификатор устройства объекта
319 + "deviceTypeName": "" // наименование устройства объекта
320 + "parentId": "", // идентификатор клиента-родителя
321 + "parentName": "" // наименование клиента-родителя,
322 + "modelId": "", // идентификатор модели объекта
323 + "modelName": "" // наименование модели объекта,
324 + "unitId": "", // идентификатор подразделения
325 + "unitName": "", // наименование подразделения
326 + "status": “”, // статус объекта
327 + ...
328 + },
329 + ...}}}
330 +
331 +(% style="color:#000000" %)}
332 +
674 674  (% style="text-align:left" %)
675 675  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
676 676  
... ... @@ -678,14 +678,12 @@
678 678  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
679 679  
680 680  
681 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
682 -
683 683  (% class="box successmessage" %)
684 684  (((
685 -(% lang="en-US" %)**POST /api/v3/vehicles**
342 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
686 686  )))
687 687  
688 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
345 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
689 689  
690 690  (% style="color:#000000" %)Метод запроса: **POST**
691 691  
... ... @@ -693,132 +693,118 @@
693 693  
694 694  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
695 695  
696 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
353 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
697 697  
698 -(% style="color:#000000" %){
699 -
700 - "parentId": "" , ~/~/ ID клиента
701 - "name": "" , ~/~/ имя ТС
702 - "imei": "" , ~/~/ IMEI
703 - "deviceTypeId": "" , ~/~/ ID типа устройства
704 - "modelId": "" , ~/~/ ID модели
705 - "unitId": "" , ~/~/ ID подразделения
706 - "sim1": "" , ~/~/ Номер SIM 1
707 - "sim2": "" , ~/~/ Номер SIM2
708 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
709 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
710 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
711 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
712 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
713 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
714 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
715 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
716 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
717 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
718 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
719 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
720 - "counters": ~/~/ счетчики
721 - {
722 - "mileage": "" , ~/~/ пробег
723 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
724 - "motohours": "" , ~/~/ моточасы
725 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
355 +(% class="western" %)
356 +{{{ "parentId": "", // ID клиента
357 + "name": "", // имя ТС
358 + "imei": "", // IMEI
359 + "deviceTypeId": "",// ID типа устройства
360 + "modelId": "",
361 + "unitId": "", // ID подразделения
362 + "sim1": "", // Номер SIM 1
363 + "sim2": "", // Номер SIM2
364 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
365 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
366 + "consumptionIdle": "",// Расход топлива на холостом ходу
367 + "counters": {
368 + "mileage": "", // пробег
369 + "mileageEnabled": true, // флаг активности счётчика "пробег"
370 + "motohours":"", // моточасы
371 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
372 + },
373 + "cmsv6Parameters": { // параметры CMSv6
374 + "enabled": true, // флаг включения
375 + //"id": "", // идентификатор
376 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
377 + "login": "", // имя учетной записи
378 + "password": "" // пароль учетной записи
726 726   },
727 - "cmsv6Parameters": { ~/~/ параметры CMSv6
728 - "enabled": true, ~/~/ флаг включения
729 - "id": "" , ~/~/ идентификатор
730 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
731 - "login": "" , ~/~/ имя учетной записи
732 - "password": "" ~/~/ пароль учетной записи
733 - },
734 - "inspectionTasks": ~/~/ задания на ТО
380 + "inspectionTasks": [ // задания на ТО
735 735   {
736 - "enabled": "" , ~/~/ Признак включения
737 - "name": "" , ~/~/ Имя задания
738 - "description": "" , ~/~/ Описание задания
739 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
740 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
741 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
742 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
743 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
744 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
745 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
746 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
747 - }
382 + "enabled": "", // Признак включения
383 + "name": "", // Имя задания
384 + "description": "", // Описание задания
385 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
386 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
387 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
388 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
389 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
390 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
391 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
392 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
393 + },
394 + ]}}}
748 748  
749 -(% style="color:#000000" %) }
396 +(% style="color:#000000" %)… }
750 750  
751 751  (% style="color:#000000" %)Ответ:
752 752  
753 753  (% style="color:#000000" %){
754 754  
755 - "vehicleId": "", ~/~/ID ТС 
756 - "parentId": "", ~/~/Guid владельца ТС
757 - "name": "", ~/~/Имя объекта
758 - "imei": "", ~/~/IMEI
759 - "deviceTypeId": "", ~/~/ID типа устройства
760 - "modelId": "", ~/~/ID модели
761 - "unitId": "", ~/~/ID подразделения
762 - "sim1": "", ~/~/SIM1
763 - "sim2": "", ~/~/SIM2
764 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
765 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
766 - "counters": { ~/~/Счётчики
767 - "mileageEnabled": true,
768 - "motohoursEnabled": true,
769 - "mileage": "",
770 - "motohours": 345.0
771 - },
772 - "cmsv6Parameters": { ~/~/Параметры CmsV6
773 - "id": null,
774 - "enabled": true, ~/~/флаг включения
775 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
776 - "login": "", ~/~/ имя учетной записи
777 - "password": "" ~/~/ пароль учетной записи
778 - },
779 - "inspectionTasks": { ~/~/ задания на ТО
780 - "id": "", ~/~/ ID задачи
781 - "enabled": false, ~/~/ Признак включения
782 - "name": "", ~/~/ Имя задания
783 - "description": "", ~/~/ Описание задания
784 - "mileageCondition": "", ~/~/ Условие по пробегу
785 - "lastMileage": "", ~/~/ Пробег (в метрах)
786 - "motohoursCondition": "", ~/~/ Условие по моточасам
787 - "lastMotohours": "", ~/~/ Моточасы
788 - "periodicCondition": "", ~/~/ Условие периодичности по времени
789 - "kind": "", ~/~/ Вид периодичности по времени 
790 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
791 - }
402 +(% class="western" %)
403 +{{{ "vehicleId": "", //ID ТС
404 + "parentId": "", //Guid владельца ТС
405 + "name": "", //Имя объекта
406 + "imei": "", //IMEI
407 + "deviceTypeId": "", //ID типа устройства
408 + "modelId": "", //ID модели
409 + "unitId": "", //ID подразделения
410 + "sim1": "", //SIM1
411 + "sim2": "", //SIM2
412 + "consumptionPer100Km": "", //Расход топлива на 100 км
413 + "consumptionIdle": "", //Расход топлива на холостом ходу
414 + "counters": { //Счётчики
415 + "mileageEnabled": true,
416 + "motohoursEnabled": true,
417 + "mileage": "",
418 + "motohours": 345.0
419 + },
420 + "cmsv6Parameters": { //Параметры CmsV6
421 + "id": null,
422 + "enabled": true, //флаг включения
423 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
424 + "login": "", // имя учетной записи
425 + "password": "" // пароль учетной записи
426 + },
427 + "inspectionTasks": [ // задания на ТО
428 + {
429 + "id": "", // ID задачи
430 + "enabled": false, // Признак включения
431 + "name": "", // Имя задания
432 + "description": "", // Описание задания
433 + "mileageCondition": "", // Условие по пробегу
434 + "lastMileage": "", // Пробег (в метрах)
435 + "motohoursCondition": "", // Условие по моточасам
436 + "lastMotohours": "", // Моточасы
437 + "periodicCondition": "", // Условие периодичности по времени
438 + "kind": "", // Вид периодичности по времени
439 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
440 + }
441 + ]}}}
792 792  
793 793  (% style="text-align:left" %)
794 794  (% style="color:#000000" %)}
795 795  
796 -**Валидация:**
797 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
798 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
799 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
800 800  
801 -
802 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
803 -
804 804  (% class="box successmessage" %)
805 805  (((
806 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
449 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
807 807  )))
808 808  
809 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
452 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
810 810  
811 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
454 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
812 812  
813 813  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
814 814  
815 815  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
816 816  
817 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
460 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
818 818  
819 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
462 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
820 820  
821 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
464 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
822 822  
823 823  (% style="color:#000000" %)Метод запроса: **POST**
824 824  
... ... @@ -826,117 +826,78 @@
826 826  
827 827  (% style="color:#000000" %)В заголовках запроса:
828 828  
829 -(% style="color:#000000" %)− Content-Type: __**application/json**__
472 +(% style="color:#000000" %)− Content-Type: application/json
830 830  
831 831  (% style="color:#000000" %)− X-Auth: Токен авторизации
832 832  
833 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
476 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
834 834  
835 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
478 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
836 836  
837 -{
838 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
839 - "name": null, ~/~/ Имя ТС (string, опционально)
840 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
841 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
842 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
843 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
844 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
845 - "customFields": null ~/~/ значение любого из произвольных полей ТС
846 -}
480 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
847 847  
848 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
482 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
849 849  
850 -(% style="color:#000000" %)Ответ:
484 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
851 851  
852 -(% style="color:#000000" %){
486 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
853 853  
854 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
855 - "name": "" ~/~/ наименование объекта
856 - "imei": "" ~/~/ IMEI объекта
857 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
858 - "deviceTypeName": "" ~/~/ наименование типа устройства
859 - "sim1": "" ~/~/ первый номер телефона
860 - "sim2": "" ~/~/ второй номер телефона
861 - "parentId": "" ~/~/ идентификатор клиента-родителя
862 - "parentName": "" ~/~/ наименование клиента-родителя
863 - "modelId": "" ~/~/ идентификатор модели объекта
864 - "modelName": "" ~/~/ наименование модели объекта
865 - "unitId": "" ~/~/ идентификатор подразделения
866 - "unitName": "" ~/~/ наименование подразделения
867 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
868 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
869 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
870 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
871 - "customFields": [ 
872 - {
873 - "id": "", ~/~/ идентификатор произвольного поля
874 - "name": "", ~/~/ имя произвольного поля
875 - "value": "", ~/~/ значение произвольного поля
876 - "forClient": true, ~/~/ право на отображение у клиента
877 - "forTooltip": false, ~/~/ право на отображение в подсказке
878 - "forReport": false ~/~/ право на отображение в отчетах
879 - }(%%)
880 -(% style="color:#000000" %)}
488 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
881 881  
882 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
490 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
883 883  
492 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
884 884  
885 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
886 886  
887 887  (% class="box successmessage" %)
888 888  (((
889 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
497 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
890 890  )))
891 891  
892 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
500 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
893 893  
894 894  (% style="color:#000000" %)Метод запроса: **POST**
895 895  
896 896  (% 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}
897 897  
898 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
506 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
899 899  
900 900  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
901 901  
902 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
510 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
903 903  
904 -(% style="color:#000000" %){
512 +(% class="western" %)
513 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
514 +  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
515 +  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
516 + "date": "", // Дата смены статуса (null если сменить немедленно)
517 + "description": "", // Описание
518 + "data": "", // Данные
519 + "overwrite": false, // Флаг перезаписи
520 + "stage": "", // Состояние, может быть null}}}
905 905  
906 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
907 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
908 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
909 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
910 - "description": "", ~/~/ Описание
911 - "data": "", ~/~/ Данные
912 - "overwrite": false, ~/~/ Флаг перезаписи
913 - "stage": "", ~/~/ Состояние, может быть null
914 -
915 915  (% style="color:#000000" %)}
916 916  
917 -(% style="color:#000000" %)Ответ:
524 +(% style="color:#000000" %)Ответ: {
918 918  
919 -(% style="color:#000000" %){
526 +(% class="western" %)
527 +{{{ "status": "", // значение статуса
528 + "date": "", // Дата смены статуса
529 + "description": "", // Описание
530 + "data": "", // Данные
531 + "overwrite": false, // Флаг перезаписи
532 + "stage": "", // Состояние}}}
920 920  
921 - "status": "", ~/~/ значение статуса
922 - "date": "", ~/~/ Дата смены статуса 
923 - "description": "", ~/~/ Описание
924 - "data": "", ~/~/ Данные
925 - "overwrite": false, ~/~/ Флаг перезаписи
926 - "stage": "", ~/~/ Состояние
927 -
928 928  (% style="text-align:left" %)
929 -(% style="color:#000000" %) }
535 +(% style="color:#000000" %)}
930 930  
931 931  
932 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
933 -
934 934  (% class="box warningmessage" %)
935 935  (((
936 -(% lang="en-US" %)**PUT /api/v3/vehicles**
540 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
937 937  )))
938 938  
939 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
543 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
940 940  
941 941  (% style="color:#000000" %)Метод запроса: **PUT**
942 942  
... ... @@ -946,133 +946,26 @@
946 946  
947 947  (% style="color:#000000" %)Параметры в теле запроса (JSON):
948 948  
949 -(% style="color:#000000" %){    
553 +(% 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»: «» //Сколько раз выполнить задание } ] }
950 950  
951 -(((
952 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
953 - "parentId": "", ~/~/ ID клиента
954 - "name": "", ~/~/ имя ТС
955 - "imei": "", ~/~/ IMEI
956 - "deviceTypeId": "", ~/~/ ID типа устройства
957 - "modelId": "", ~/~/ , ID модели    
958 - "unitId": "", ~/~/ подразделения
959 - "sim1": "", ~/~/ SIM 1
960 - "sim2": "", ~/~/ SIM2     (%%)
961 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
962 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
963 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
964 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
965 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
966 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
967 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
968 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
969 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
970 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
971 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
972 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
973 -(% style="color:#000000" %) "counters": 
974 - {
975 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
976 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
977 - "mileage": "", ~/~/ пробег, в метрах 
978 - "motohours": "" ~/~/ моточасы, в секундах
979 - }
980 - "cmsv6Parameters": ~/~/ параметры CMSv6
981 - {       
982 - "id": "", ~/~/ идентификатор
983 - "enabled": true, ~/~/ флаг включения
984 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
985 - "login": "", ~/~/ имя учетной записи
986 - "password": "", ~/~/ пароль учетной записи
987 - }
988 - "inspectionTasks": ~/~/ задания на ТО
989 - {
990 - "id": "", ~/~/ ID задания
991 - "enabled": false, ~/~/ Признак включения
992 - "name": "", ~/~/ Имя задания
993 - "description": "", ~/~/ Описание задания
994 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
995 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
996 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
997 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
998 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
999 - "kind": "", ~/~/ Вид периодичности по времени
1000 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1001 - } 
1002 -)))
1003 -
1004 -(% style="color:#000000" %)}
1005 -
1006 1006  (% style="color:#000000" %)Ответ:
1007 1007  
1008 1008  (% lang="en-US" style="text-align:left" %)
1009 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
558 +(% 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»: «» //Сколько раз выполнить задание } ] }
1010 1010  
1011 -(% lang="en-US" style="text-align:left" %)
1012 - "vehicleId": "", ~/~/ ID ТС
1013 - "parentId": "", ~/~/ ID клиента
1014 - "name": "", ~/~/ имя ТС
1015 - "imei": "", ~/~/ IMEI
1016 - "deviceTypeId": "", ~/~/ типа устройства
1017 - "modelId": "", ~/~/ ID модели
1018 - "unitId": "", ~/~/ ID подразделения
1019 - "sim1": "", ~/~/ SIM 1
1020 - "sim2": "", ~/~/ SIM2
1021 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1022 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1023 - "counters": 
1024 - {
1025 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1026 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1027 - "mileage": "", ~/~/ пробег
1028 - "motohours": "", ~/~/ моточасы
1029 - }
1030 - "cmsv6Parameters": ~/~/ параметры CMSv6
1031 - {
1032 - "id": ~/~/ идентификатор
1033 - "enabled": true, ~/~/ флаг включения
1034 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1035 - "login": "", ~/~/ имя учетной записи
1036 - "password": "", ~/~/ пароль учетной записи
1037 - }
1038 - "inspectionTasks": ~/~/ задания на ТО
1039 - {
1040 - "id": "", ~/~/ ID задания
1041 - "enabled": false, ~/~/ Признак включения
1042 - "name": "", ~/~/ Имя задания
1043 - "description": "", ~/~/ Описание задания
1044 - "mileageCondition": "", ~/~/ Условие по пробегу
1045 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1046 - "motohoursCondition": "", ~/~/ Условие по моточасам
1047 - "lastMotohours": "", ~/~/ Моточасы
1048 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1049 - "kind": "", ~/~/ Вид периодичности по времени
1050 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1051 - }
1052 1052  
1053 -(% lang="en-US" style="text-align:left" %)
1054 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1055 -
1056 -**валидация:**
1057 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1058 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1059 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1060 -
1061 -
1062 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1063 -
1064 1064  (% class="box errormessage" %)
1065 1065  (((
1066 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
563 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1067 1067  )))
1068 1068  
1069 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
566 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1070 1070  
1071 1071  (% style="color:#000000" %)Метод запроса: **DELETE**
1072 1072  
1073 1073  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1074 1074  
1075 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
572 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1076 1076  
1077 1077  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1078 1078  
... ... @@ -1080,17 +1080,17 @@
1080 1080  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1081 1081  
1082 1082  
1083 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
580 +(% class="box" lang="en-US" style="text-align: center;" %)
581 +(((
582 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
583 +)))
1084 1084  
1085 -
1086 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1087 -
1088 1088  (% class="box infomessage" %)
1089 1089  (((
1090 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
587 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1091 1091  )))
1092 1092  
1093 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
590 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1094 1094  
1095 1095  (% style="color:#000000" %)Метод запроса: **GET**
1096 1096  
... ... @@ -1098,28 +1098,29 @@
1098 1098  
1099 1099  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1100 1100  
1101 -(% style="color:#000000" %)Ответ:
598 +(% style="color:#000000" %)Ответ: [
1102 1102  
1103 -(% style="color:#000000" %){
600 +(% class="western" %)
601 +{{{ {
602 + "deviceTypeId" : "", // ID типа устройства
603 + "deviceTypeName" : "" // Название типа устройства
604 + },}}}
1104 1104  
1105 - "deviceTypeId" : "", ~/~/ ID типа устройства
1106 - "deviceTypeName" : "" ~/~/ Название типа устройства
1107 -
1108 1108  (% style="text-align:left" %)
1109 -(% style="color:#000000" %)}
607 +(% style="color:#000000" %)…** **]
1110 1110  
1111 1111  
1112 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
610 +(% class="box" style="text-align: center;" %)
611 +(((
612 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
613 +)))
1113 1113  
1114 -
1115 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1116 -
1117 1117  (% class="box infomessage" %)
1118 1118  (((
1119 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
617 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1120 1120  )))
1121 1121  
1122 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
620 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1123 1123  
1124 1124  (% style="color:#000000" %)Метод запроса: **GET**
1125 1125  
... ... @@ -1127,16 +1127,19 @@
1127 1127  
1128 1128  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1129 1129  
1130 -(% style="color:#000000" %)Ответ:
628 +(% style="color:#000000" %)Ответ: [
1131 1131  
1132 -(% style="color:#000000" %){
630 +(% class="western" style="margin-bottom:19px" %)
631 +{{{ {}}}
1133 1133  
1134 - "id": "", ~/~/ ID типа датчика 
1135 - "name": "", ~/~/ Название
1136 - "description": "", ~/~/ Описание
633 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1137 1137  
635 +(% class="western" %)
636 +{{{ "description": "" // Описание
637 + },}}}
638 +
1138 1138  (% style="text-align:left" %)
1139 -(% style="color:#000000" %)}
640 +(% style="color:#000000" %)… ]
1140 1140  
1141 1141  
1142 1142  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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