Last modified by Андрей Калиновский on 2025/03/28 11:43
<
From version < 59.1 >
edited by Илья Крайнов
on 2022/11/24 11:31
To version < 18.2 >
edited by Артем Шемяков
on 2022/09/01 16:49
>
Change comment: There is no comment for this version

Summary

Details

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

Меню

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