Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 25.5 >
edited by Артем Шемяков
on 2022/09/05 11:13
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,13 +1,12 @@
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 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
... ... @@ -15,25 +15,27 @@
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  
26 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
27 +
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% lang="en-US" %)
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,8 +40,8 @@
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 47  }
... ... @@ -100,10 +100,152 @@
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 102   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформление, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
104 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
104 104  }
105 105  
106 106  
108 +(% class="box successmessage" %)
109 +(((
110 +**Добавление клиента — POST /api/v3/agents **
111 +)))
112 +
113 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
114 +
115 +Метод запроса: **POST**
116 +
117 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
118 +
119 +В заголовках запроса: X-Auth: Токен авторизации
120 +
121 +Параметры в теле запроса (JSON):
122 +
123 +{
124 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
125 + "name": "string", ~/~/ имя
126 + "fullName": "string", ~/~/ полное наименование
127 + "isForeign": true, ~/~/ иностранный контрагент
128 + "district": "string", ~/~/ округ
129 + "region": "string", ~/~/ регион
130 + "city": "string", ~/~/ город
131 + "inn": "string", ~/~/ ИНН
132 + "kpp": "string", ~/~/ КПП
133 + "address": "string", ~/~/ юридический адрес
134 + "addressFact": "string", ~/~/ фактический адрес
135 + "email": "string", ~/~/ email
136 + "director": "string", ~/~/ ФИО руководителя
137 + "bankName": "string", ~/~/ банк
138 + "bankBIK": "string", ~/~/ БИК
139 + "bankRS": "string", ~/~/ номер счёта
140 + "bankKS": "string" ~/~/ корр. счёт
141 +}
142 +
143 +
144 +Ответ:
145 +
146 +{
147 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
148 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
149 + "name": "string", ~/~/ имя
150 + "fullName": "string", ~/~/ полное наименование
151 + "isForeign": true, ~/~/ иностранный контрагент
152 + "district": "string", ~/~/ округ
153 + "region": "string", ~/~/ регион
154 + "city": "string", ~/~/ город
155 + "inn": "string", ~/~/ ИНН
156 + "kpp": "string", ~/~/ КПП
157 + "address": "string", ~/~/ юридический адрес
158 + "addressFact": "string", ~/~/ фактический адрес
159 + "email": "string", ~/~/ email
160 + "director": "string", ~/~/ ФИО руководителя
161 + "bankName": "string", ~/~/ банк
162 + "bankBIK": "string", ~/~/ БИК
163 + "bankRS": "string", ~/~/ номер счёта
164 + "bankKS": "string" ~/~/ корр. счёт
165 +}
166 +
167 +
168 +(% class="box warningmessage" %)
169 +(((
170 +**Редактирование клиента — PUT /api/v3/agents**
171 +)))
172 +
173 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
174 +
175 +Метод запроса: **PUT**
176 +
177 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
178 +
179 +В заголовках запроса: X-Auth: Токен авторизации
180 +
181 +
182 +Параметры в теле запроса (JSON):
183 +
184 +{
185 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
186 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
187 + "name": "string", ~/~/ имя
188 + "fullName": "string", ~/~/ полное наименование
189 + "isForeign": true, ~/~/ иностранный контрагент
190 + "district": "string", ~/~/ округ
191 + "region": "string", ~/~/ регион
192 + "city": "string", ~/~/ город
193 + "inn": "string", ~/~/ ИНН
194 + "kpp": "string", ~/~/ КПП
195 + "address": "string", ~/~/ юридический адрес
196 + "addressFact": "string", ~/~/ фактический адрес
197 + "email": "string", ~/~/ email
198 + "director": "string", ~/~/ ФИО руководителя
199 + "bankName": "string", ~/~/ банк
200 + "bankBIK": "string", ~/~/ БИК
201 + "bankRS": "string", ~/~/ номер счёта
202 + "bankKS": "string" ~/~/ корр. счёт
203 +}
204 +
205 +
206 +Ответ:
207 +
208 +{
209 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
210 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
211 + "name": "string", ~/~/ имя
212 + "fullName": "string", ~/~/ полное наименование
213 + "isForeign": true, ~/~/ иностранный контрагент
214 + "district": "string", ~/~/ округ
215 + "region": "string", ~/~/ регион
216 + "city": "string", ~/~/ город
217 + "inn": "string", ~/~/ ИНН
218 + "kpp": "string", ~/~/ КПП
219 + "address": "string", ~/~/ юридический адрес
220 + "addressFact": "string", ~/~/ фактический адрес
221 + "email": "string", ~/~/ email
222 + "director": "string", ~/~/ ФИО руководителя
223 + "bankName": "string", ~/~/ банк
224 + "bankBIK": "string", ~/~/ БИК
225 + "bankRS": "string", ~/~/ номер счёта
226 + "bankKS": "string" ~/~/ корр. счёт
227 +}
228 +
229 +
230 +(% class="box errormessage" %)
231 +(((
232 +**Удаление клиента — DELETE /api/v3/agents/{clientId}**
233 +)))
234 +
235 +
236 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
237 +
238 +Метод запроса: **DELETE**
239 +
240 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
241 +
242 +Параметр запроса: **{clientId}** - Guid пользователя
243 +
244 +В заголовках запроса: X-Auth: Токен авторизации
245 +
246 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
247 +
248 +
249 +
107 107  (% class="box" style="text-align: center;" %)
108 108  (((
109 109  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -130,9 +130,9 @@
130 130   "position": "", ~/~/ должность
131 131   "phone": "", ~/~/ телефон
132 132   "organization": "", ~/~/ организация
133 - "login": "", ~/~/ логин
134 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 - "email": "", ~/~/ email
276 + "login": "", ~/~/ логин (обязателен)
277 + "password": "", ~/~/ пароль (обязателен)
278 + "email": "", ~/~/ email (обязателен)
136 136   "description": "", ~/~/ описание
137 137   "isEnabled": "", ~/~/ признак включения
138 138   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -141,7 +141,7 @@
141 141   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
142 142   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 143   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 - "groups": "" , ~/~/ группы пользователя, названия групп
287 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
145 145  }
146 146  
147 147  (% style="text-align:left" %)
... ... @@ -167,7 +167,7 @@
167 167   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
168 168   "kind": "" , ~/~/ тип аутентификации
169 169   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
170 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
313 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
171 171  
172 172  (% style="text-align:left" %)
173 173  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -220,6 +220,54 @@
220 220  (% style="color:#000000" %)}
221 221  
222 222  
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 +
223 223  (% class="box warningmessage" %)
224 224  (((
225 225  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -233,6 +233,8 @@
233 233  
234 234  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
235 235  
427 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
428 +
236 236  (% lang="en-US" style="text-align:left" %)
237 237  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
238 238  
... ... @@ -246,10 +246,10 @@
246 246   "position": "" , ~/~/ должность
247 247   "phone": "" , ~/~/ телефон
248 248   "organization": "" , ~/~/ организация
249 - "login": "" , ~/~/ логин
250 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 - "email": "" , ~/~/ email
252 - "description": "" , ~/~/ описание
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": "" , ~/~/ описание
253 253   "isEnabled": "" , ~/~/ признак включения
254 254   "parentId": "" , ~/~/ Guid родительского агента
255 255   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -296,7 +296,7 @@
296 296  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
297 297  )))
298 298  
299 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
492 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
300 300  
301 301  (% style="color:#000000" %)Метод запроса: **PUT**
302 302  
... ... @@ -320,6 +320,63 @@
320 320  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
321 321  
322 322  
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 +
323 323  (% class="box errormessage" %)
324 324  (((
325 325  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -367,22 +367,44 @@
367 367  
368 368  (% style="color:#000000" %)Ответ:
369 369  
370 -(% style="color:#000000" %){
371 -
372 - "vehicleId": "" , ~/~/ идентификатор объекта
373 - "name": "" , ~/~/ имя объекта
374 - "imei": "" , ~/~/ IMEI объекта
375 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
376 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
377 - "parentId": "" , ~/~/ идентификатор клиента-родителя
378 - "parentName": "" , ~/~/ наименование клиента-родителя,
379 - "modelId": "" , ~/~/ идентификатор модели объекта
380 - "modelName": "" , ~/~/ наименование модели объекта,
381 - "unitId": "" , ~/~/ идентификатор подразделения
382 - "unitName": "" , ~/~/ наименование подразделения
383 - "status": "" , ~/~/ статус объекта
384 -
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 + ]
385 385  }
657 +)))
386 386  
387 387  (% style="text-align:left" %)
388 388  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -418,12 +418,22 @@
418 418   "sim2": "" , ~/~/ Номер SIM2
419 419   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
420 420   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
421 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 - "counters": {
423 - "mileage": "" , ~/~/ пробег
424 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 - "motohours": "" , ~/~/ моточасы
426 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
693 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
694 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
695 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
696 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
697 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
698 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
699 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
700 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
701 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
702 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
703 + "counters": ~/~/ счетчики
704 + {
705 + "mileage": "" , ~/~/ пробег
706 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
707 + "motohours": "" , ~/~/ моточасы
708 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
427 427   },
428 428   "cmsv6Parameters": { ~/~/ параметры CMSv6
429 429   "enabled": true, ~/~/ флаг включения
... ... @@ -494,7 +494,12 @@
494 494  (% style="text-align:left" %)
495 495  (% style="color:#000000" %)}
496 496  
779 +**Валидация:**
780 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
781 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
782 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
497 497  
784 +
498 498  (% class="box successmessage" %)
499 499  (((
500 500  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -528,17 +528,17 @@
528 528  
529 529  (% style="color:#000000" %)Параметры в теле запроса (JSON):
530 530  
531 -(% class="western" style="color:#000000" %)##{##
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 +}
532 532  
533 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
534 - "name": null, ~/~/ Имя ТС (string, опционально) 
535 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
536 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
537 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
538 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
539 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
540 -(% style="color:#000000" %)}
541 -
542 542  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
543 543  
544 544  (% style="color:#000000" %)Ответ:
... ... @@ -561,7 +561,16 @@
561 561   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
562 562   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
563 563   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
564 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
851 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
852 + "customFields": [ 
853 + {
854 + "id": "", ~/~/ идентификатор произвольного поля
855 + "name": "", ~/~/ имя произвольного поля
856 + "value": "", ~/~/ значение произвольного поля
857 + "forClient": true, ~/~/ право на отображение у клиента
858 + "forTooltip": false, ~/~/ право на отображение в подсказке
859 + "forReport": false ~/~/ право на отображение в отчетах
860 + }(%%)
565 565  (% style="color:#000000" %)}
566 566  
567 567  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
... ... @@ -629,6 +629,7 @@
629 629  
630 630  (% style="color:#000000" %){    
631 631  
928 +(((
632 632  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
633 633   "parentId": "", ~/~/ ID клиента
634 634   "name": "", ~/~/ имя ТС
... ... @@ -637,15 +637,25 @@
637 637   "modelId": "", ~/~/ , ID модели    
638 638   "unitId": "", ~/~/ подразделения
639 639   "sim1": "", ~/~/ SIM 1
640 - "sim2": "", ~/~/ SIM2
641 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
642 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
643 - "counters": 
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": 
644 644   {
645 645   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
646 646   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
647 - "mileage": «», пробег
648 - "motohours": «» моточасы
954 + "mileage": "", ~/~/ пробег, в метрах 
955 + "motohours": "" ~/~/ моточасы, в секундах
649 649   }
650 650   "cmsv6Parameters": ~/~/ параметры CMSv6
651 651   {       
... ... @@ -669,6 +669,7 @@
669 669   "kind": "", ~/~/ Вид периодичности по времени
670 670   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
671 671   } 
979 +)))
672 672  
673 673  (% style="color:#000000" %)}
674 674  
... ... @@ -722,7 +722,12 @@
722 722  (% lang="en-US" style="text-align:left" %)
723 723  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
724 724  
1033 +**валидация:**
1034 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1035 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1036 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
725 725  
1038 +
726 726  (% class="box errormessage" %)
727 727  (((
728 728  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

Меню

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