Редактировал(а) Андрей Калиновский 2025/03/28 11:43
<
От версии < 18.1 >
отредактировано Артем Шемяков
на 2022/09/01 16:46
К версии < 50.1 >
отредактировано Илья Крайнов
на 2022/11/24 11:04
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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

Меню

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