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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,39 +1,40 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 -== ==
5 5  
6 -(% class="box" style="text-align: center;" %)
7 -(((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 -)))
5 +{{toc/}}
10 10  
7 +
8 +=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) ===
9 +
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  
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ====
22 22  
23 -(% class="box infomessage" %)
24 -(((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 -)))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
20 +===== (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**(%%) =====
29 29  
30 -(% style="color:#000000" %)Метод запроса: **GET**
22 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
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]]
24 +(% style="color:#000000" %)Метод запроса: **POST**
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
26 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
35 35  
36 -(% lang="en-US" %)
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 +
37 37  (% style="color:#000000" %)**Ответ:**
38 38  
39 39  (% lang="en-US" %)
... ... @@ -40,11 +40,11 @@
40 40  (% style="color:#000000" %){
41 41  
42 42  (% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
44 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
45 + "User": "testuser" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 - }
48 +}
48 48  
49 49  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50 50  
... ... @@ -54,7 +54,7 @@
54 54  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
55 55  )))
56 56  
57 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
58 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
58 58  
59 59  (% style="color:#000000" %)Метод запроса: **GET**
60 60  
... ... @@ -76,19 +76,19 @@
76 76  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
77 77  )))
78 78  
79 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
80 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
80 80  
81 81  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82 82  
83 83  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 84  
85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
86 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
86 86  
87 87  (% style="color:#000000" %)Метод запроса: **GET**
88 88  
89 89  (% 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>
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
92 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
92 92  
93 93  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94 94  
... ... @@ -99,14 +99,153 @@
99 99   "parentId": "", ~/~/ идентификатор клиента-родителя
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента1
103 - "status": "", ~/~/ статус клиента
104 - }
103 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
104 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
105 +}
105 105  
106 106  
107 -(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
108 +(% class="box successmessage" %)
109 +(((
110 +**Добавление клиента — POST /api/v3/agents **
111 +)))
108 108  
113 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
109 109  
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 +
110 110  (% class="box" style="text-align: center;" %)
111 111  (((
112 112  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -117,7 +117,7 @@
117 117  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
118 118  )))
119 119  
120 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
260 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
121 121  
122 122  (% style="color:#000000" %)Метод запроса: **POST**
123 123  
... ... @@ -133,9 +133,9 @@
133 133   "position": "", ~/~/ должность
134 134   "phone": "", ~/~/ телефон
135 135   "organization": "", ~/~/ организация
136 - "login": "", ~/~/ логин
137 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 - "email": "", ~/~/ email
276 + "login": "", ~/~/ логин (обязателен)
277 + "password": "", ~/~/ пароль (обязателен)
278 + "email": "", ~/~/ email (обязателен)
139 139   "description": "", ~/~/ описание
140 140   "isEnabled": "", ~/~/ признак включения
141 141   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -144,14 +144,14 @@
144 144   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
145 145   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 146   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 - "groups": "" , ~/~/ группы пользователя, названия групп
148 - }
287 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
288 +}
149 149  
150 150  (% style="text-align:left" %)
151 151  (% style="color:#000000; font-weight:normal" %)Ответ:
152 152  
153 153  (% style="text-align:left" %)
154 -(% style="color:#000000; font-weight:normal" %){
294 +(% style="color:#000000; font-weight:normal" %){    
155 155  
156 156  (% style="text-align:left" %)
157 157  (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
... ... @@ -170,10 +170,10 @@
170 170   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
171 171   "kind": "" , ~/~/ тип аутентификации
172 172   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
173 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
313 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
174 174  
175 175  (% style="text-align:left" %)
176 -(% style="color:#000000; font-weight:normal" %) }
316 +(% style="color:#000000; font-weight:normal" %)}
177 177  
178 178  
179 179  (% class="box successmessage" %)
... ... @@ -183,14 +183,16 @@
183 183  
184 184  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
185 185  
186 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
326 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
187 187  
188 188  (% style="color:#000000" %)Метод запроса: **POST**
189 189  
190 190  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
191 191  
192 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
332 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
193 193  
334 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
335 +
194 194  (% style="color:#000000" %){
195 195  
196 196   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -198,11 +198,11 @@
198 198   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 199   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
200 200  
201 -(% style="color:#000000" %) }
343 +(% style="color:#000000" %)}
202 202  
203 203  (% style="color:#000000" %)Ответ:
204 204  
205 -(% style="color:#000000" %){ (%%)
347 +(% style="color:#000000" %){         (%%)
206 206  
207 207   "id": "" , ~/~/ идентификатор пользователя
208 208   "lastName": "" , ~/~/ фамилия
... ... @@ -218,15 +218,63 @@
218 218   "status": "1",  ~/~/ статус пользователя
219 219   "astLogged": "", ~/~/ дата/время последней авторизации
220 220  
221 -(% style="color:#000000" %) }
363 +(% style="color:#000000" %)}
222 222  
223 223  
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 +
224 224  (% class="box warningmessage" %)
225 225  (((
226 226  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
227 227  )))
228 228  
229 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
419 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
230 230  
231 231  (% style="color:#000000" %)Метод запроса: **PUT**
232 232  
... ... @@ -234,27 +234,89 @@
234 234  
235 235  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
236 236  
427 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
428 +
237 237  (% lang="en-US" style="text-align:left" %)
238 -(% 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» //названия групп ] }  //
430 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
239 239  
432 +(% lang="en-US" style="text-align:left" %)
433 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
240 240  
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 +
241 241  (% class="box warningmessage" %)
242 242  (((
243 243  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
244 244  )))
245 245  
246 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
492 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
247 247  
248 248  (% style="color:#000000" %)Метод запроса: **PUT**
249 249  
250 -(% 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} Параметр запроса:
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}
251 251  
252 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
498 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
253 253  
254 -(% class="western" %)
255 -{{{ "description": "", // описание
256 - "data": "" // данные, связанные со сменой статуса}}}
500 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
257 257  
502 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
503 +
504 +(% style="color:#000000" %){
505 +
506 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
507 + "description": "" , ~/~/ описание
508 + "data": "" , ~/~/ данные, связанные со сменой статуса
509 +
258 258  (% style="color:#000000" %)}
259 259  
260 260  (% style="text-align:left" %)
... ... @@ -261,19 +261,78 @@
261 261  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
262 262  
263 263  
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 +
264 264  (% class="box errormessage" %)
265 265  (((
266 266  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
267 267  )))
268 268  
269 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
578 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
270 270  
271 271  (% style="color:#000000" %)Метод запроса: **DELETE**
272 272  
273 273  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
274 274  
275 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
584 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
276 276  
586 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
587 +
277 277  (% style="text-align:left" %)
278 278  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
279 279  
... ... @@ -290,43 +290,61 @@
290 290  
291 291  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
292 292  
293 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
604 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
294 294  
295 295  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
296 296  
297 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
608 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
298 298  
299 299  (% style="color:#000000" %)Метод запроса: **GET**
300 300  
301 301  (% 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>
302 302  
303 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
614 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
304 304  
305 305  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
306 306  
307 307  (% style="color:#000000" %)Ответ:
308 308  
309 -(% style="color:#000000" %){
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 +)))
310 310  
311 -(% class="western" %)
312 -{{{ "vehicleId": “”, // идентификатор объекта
313 - "name": "", // имя объекта
314 - "imei": "", // IMEI объекта
315 - "deviceTypeId": “”, // идентификатор устройства объекта
316 - "deviceTypeName": "" // наименование устройства объекта
317 - "parentId": "", // идентификатор клиента-родителя
318 - "parentName": "" // наименование клиента-родителя,
319 - "modelId": "", // идентификатор модели объекта
320 - "modelName": "" // наименование модели объекта,
321 - "unitId": "", // идентификатор подразделения
322 - "unitName": "", // наименование подразделения
323 - "status": “”, // статус объекта
324 - ...
325 - },
326 - ...}}}
327 -
328 -(% style="color:#000000" %)}
329 -
330 330  (% style="text-align:left" %)
331 331  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
332 332  
... ... @@ -339,7 +339,7 @@
339 339  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
340 340  )))
341 341  
342 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
671 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
343 343  
344 344  (% style="color:#000000" %)Метод запроса: **POST**
345 345  
... ... @@ -347,100 +347,112 @@
347 347  
348 348  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
349 349  
350 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
679 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
351 351  
352 -(% class="western" %)
353 -{{{ "parentId": "", // ID клиента
354 - "name": "", // имя ТС
355 - "imei": "", // IMEI
356 - "deviceTypeId": "",// ID типа устройства
357 - "modelId": "",
358 - "unitId": "", // ID подразделения
359 - "sim1": "", // Номер SIM 1
360 - "sim2": "", // Номер SIM2
361 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
362 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
363 - "consumptionIdle": "",// Расход топлива на холостом ходу
364 - "counters": {
365 - "mileage": "", // пробег
366 - "mileageEnabled": true, // флаг активности счётчика "пробег"
367 - "motohours":"", // моточасы
368 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
369 - },
370 - "cmsv6Parameters": { // параметры CMSv6
371 - "enabled": true, // флаг включения
372 - //"id": "", // идентификатор
373 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
374 - "login": "", // имя учетной записи
375 - "password": "" // пароль учетной записи
376 - },
377 - "inspectionTasks": [ // задания на ТО
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": ~/~/ счетчики
378 378   {
379 - "enabled": "", // Признак включения
380 - "name": "", // Имя задания
381 - "description": "", // Описание задания
382 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
383 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
384 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
385 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
386 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
387 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
388 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
389 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
705 + "mileage": "" , ~/~/ пробег
706 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
707 + "motohours": "" , ~/~/ моточасы
708 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
390 390   },
391 - ]}}}
710 + "cmsv6Parameters": { ~/~/ параметры CMSv6
711 + "enabled": true, ~/~/ флаг включения
712 + "id": "" , ~/~/ идентификатор
713 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
714 + "login": "" , ~/~/ имя учетной записи
715 + "password": "" ~/~/ пароль учетной записи
716 + },
717 + "inspectionTasks": ~/~/ задания на ТО
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 + }
392 392  
393 -(% style="color:#000000" %)… }
732 +(% style="color:#000000" %) }
394 394  
395 395  (% style="color:#000000" %)Ответ:
396 396  
397 397  (% style="color:#000000" %){
398 398  
399 -(% class="western" %)
400 -{{{ "vehicleId": "", //ID ТС
401 - "parentId": "", //Guid владельца ТС
402 - "name": "", //Имя объекта
403 - "imei": "", //IMEI
404 - "deviceTypeId": "", //ID типа устройства
405 - "modelId": "", //ID модели
406 - "unitId": "", //ID подразделения
407 - "sim1": "", //SIM1
408 - "sim2": "", //SIM2
409 - "consumptionPer100Km": "", //Расход топлива на 100 км
410 - "consumptionIdle": "", //Расход топлива на холостом ходу
411 - "counters": { //Счётчики
412 - "mileageEnabled": true,
413 - "motohoursEnabled": true,
414 - "mileage": "",
415 - "motohours": 345.0
416 - },
417 - "cmsv6Parameters": { //Параметры CmsV6
418 - "id": null,
419 - "enabled": true, //флаг включения
420 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
421 - "login": "", // имя учетной записи
422 - "password": "" // пароль учетной записи
423 - },
424 - "inspectionTasks": [ // задания на ТО
425 - {
426 - "id": "", // ID задачи
427 - "enabled": false, // Признак включения
428 - "name": "", // Имя задания
429 - "description": "", // Описание задания
430 - "mileageCondition": "", // Условие по пробегу
431 - "lastMileage": "", // Пробег (в метрах)
432 - "motohoursCondition": "", // Условие по моточасам
433 - "lastMotohours": "", // Моточасы
434 - "periodicCondition": "", // Условие периодичности по времени
435 - "kind": "", // Вид периодичности по времени
436 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
437 - }
438 - ]}}}
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 + }
439 439  
440 440  (% style="text-align:left" %)
441 441  (% style="color:#000000" %)}
442 442  
779 +**Валидация:**
780 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
781 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
782 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
443 443  
784 +
444 444  (% class="box successmessage" %)
445 445  (((
446 446  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -448,17 +448,17 @@
448 448  
449 449  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
450 450  
451 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
792 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
452 452  
453 453  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
454 454  
455 455  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
456 456  
457 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
798 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
458 458  
459 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
800 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
460 460  
461 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
802 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
462 462  
463 463  (% style="color:#000000" %)Метод запроса: **POST**
464 464  
... ... @@ -466,70 +466,105 @@
466 466  
467 467  (% style="color:#000000" %)В заголовках запроса:
468 468  
469 -(% style="color:#000000" %)− Content-Type: application/json
810 +(% style="color:#000000" %)− Content-Type: __**application/json**__
470 470  
471 471  (% style="color:#000000" %)− X-Auth: Токен авторизации
472 472  
473 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
814 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
474 474  
475 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
816 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
476 476  
477 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
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 +}
478 478  
479 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
829 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
480 480  
481 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
831 +(% style="color:#000000" %)Ответ:
482 482  
483 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
833 +(% style="color:#000000" %){
484 484  
485 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
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" %)}
486 486  
487 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
863 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
488 488  
489 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
490 490  
491 -
492 492  (% class="box successmessage" %)
493 493  (((
494 494  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
495 495  )))
496 496  
497 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
871 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
498 498  
499 499  (% style="color:#000000" %)Метод запроса: **POST**
500 500  
501 501  (% 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}
502 502  
503 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
877 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
504 504  
505 505  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
506 506  
507 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
881 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
508 508  
509 -(% class="western" %)
510 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
511 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
512 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
513 - "date": "", // Дата смены статуса (null если сменить немедленно)
514 - "description": "", // Описание
515 - "data": "", // Данные
516 - "overwrite": false, // Флаг перезаписи
517 - "stage": "", // Состояние, может быть null}}}
883 +(% style="color:#000000" %){
518 518  
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 +
519 519  (% style="color:#000000" %)}
520 520  
521 -(% style="color:#000000" %)Ответ: {
896 +(% style="color:#000000" %)Ответ:
522 522  
523 -(% class="western" %)
524 -{{{ "status": "", // значение статуса
525 - "date": "", // Дата смены статуса
526 - "description": "", // Описание
527 - "data": "", // Данные
528 - "overwrite": false, // Флаг перезаписи
529 - "stage": "", // Состояние}}}
898 +(% style="color:#000000" %){
530 530  
900 + "status": "", ~/~/ значение статуса
901 + "date": "", ~/~/ Дата смены статуса 
902 + "description": "", ~/~/ Описание
903 + "data": "", ~/~/ Данные
904 + "overwrite": false, ~/~/ Флаг перезаписи
905 + "stage": "", ~/~/ Состояние
906 +
531 531  (% style="text-align:left" %)
532 -(% style="color:#000000" %)}
908 +(% style="color:#000000" %) }
533 533  
534 534  
535 535  (% class="box warningmessage" %)
... ... @@ -537,7 +537,7 @@
537 537  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
538 538  )))
539 539  
540 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
916 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
541 541  
542 542  (% style="color:#000000" %)Метод запроса: **PUT**
543 543  
... ... @@ -547,26 +547,131 @@
547 547  
548 548  (% style="color:#000000" %)Параметры в теле запроса (JSON):
549 549  
550 -(% 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»: «» //Сколько раз выполнить задание } ] }
926 +(% style="color:#000000" %){    
551 551  
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 +
552 552  (% style="color:#000000" %)Ответ:
553 553  
554 554  (% lang="en-US" style="text-align:left" %)
555 -(% 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»: «» //Сколько раз выполнить задание } ] }
986 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
556 556  
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 + }
557 557  
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 +
558 558  (% class="box errormessage" %)
559 559  (((
560 560  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
561 561  )))
562 562  
563 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1044 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
564 564  
565 565  (% style="color:#000000" %)Метод запроса: **DELETE**
566 566  
567 567  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
568 568  
569 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1050 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
570 570  
571 571  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
572 572  
... ... @@ -584,7 +584,7 @@
584 584  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
585 585  )))
586 586  
587 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1068 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
588 588  
589 589  (% style="color:#000000" %)Метод запроса: **GET**
590 590  
... ... @@ -592,16 +592,15 @@
592 592  
593 593  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
594 594  
595 -(% style="color:#000000" %)Ответ: [
1076 +(% style="color:#000000" %)Ответ:
596 596  
597 -(% class="western" %)
598 -{{{ {
599 - "deviceTypeId" : "", // ID типа устройства
600 - "deviceTypeName" : "" // Название типа устройства
601 - },}}}
1078 +(% style="color:#000000" %){
602 602  
1080 + "deviceTypeId" : "", ~/~/ ID типа устройства
1081 + "deviceTypeName" : "" ~/~/ Название типа устройства
1082 +
603 603  (% style="text-align:left" %)
604 -(% style="color:#000000" %)…** **]
1084 +(% style="color:#000000" %)}
605 605  
606 606  
607 607  (% class="box" style="text-align: center;" %)
... ... @@ -614,7 +614,7 @@
614 614  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
615 615  )))
616 616  
617 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1097 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
618 618  
619 619  (% style="color:#000000" %)Метод запроса: **GET**
620 620  
... ... @@ -622,19 +622,16 @@
622 622  
623 623  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
624 624  
625 -(% style="color:#000000" %)Ответ: [
1105 +(% style="color:#000000" %)Ответ:
626 626  
627 -(% class="western" style="margin-bottom:19px" %)
628 -{{{ {}}}
1107 +(% style="color:#000000" %){
629 629  
630 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1109 + "id": "", ~/~/ ID типа датчика 
1110 + "name": "", ~/~/ Название
1111 + "description": "", ~/~/ Описание
631 631  
632 -(% class="western" %)
633 -{{{ "description": "" // Описание
634 - },}}}
635 -
636 636  (% style="text-align:left" %)
637 -(% style="color:#000000" %)… ]
1114 +(% style="color:#000000" %)}
638 638  
639 639  
640 640  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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