Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 35.1 >
edited by Илья Крайнов
on 2022/11/17 13:26
To version < 69.1 >
edited by Илья Крайнов
on 2022/11/30 14:00
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,31 +1,31 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
6 +{{toc/}}
7 +
8 +
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box successmessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
... ... @@ -38,9 +38,9 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}(%%)
42 -
41 +}
43 43  
43 +
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,13 +55,14 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,18 +72,16 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
77 -(((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 -)))
78 +== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
80 80  
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -110,18 +110,159 @@
110 110   "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 111  }
112 112  
112 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113 113  
114 -(% class="box" style="text-align: center;" %)
114 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
116 +**POST /api/v3/agents **
117 117  )))
118 118  
119 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
120 +
121 +Метод запроса: **POST**
122 +
123 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
124 +
125 +В заголовках запроса: X-Auth: Токен авторизации
126 +
127 +Параметры в теле запроса (JSON):
128 +
129 +{
130 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
131 + "name": "string", ~/~/ имя
132 + "fullName": "string", ~/~/ полное наименование
133 + "isForeign": true, ~/~/ иностранный контрагент
134 + "district": "string", ~/~/ округ
135 + "region": "string", ~/~/ регион
136 + "city": "string", ~/~/ город
137 + "inn": "string", ~/~/ ИНН
138 + "kpp": "string", ~/~/ КПП
139 + "address": "string", ~/~/ юридический адрес
140 + "addressFact": "string", ~/~/ фактический адрес
141 + "email": "string", ~/~/ email
142 + "director": "string", ~/~/ ФИО руководителя
143 + "bankName": "string", ~/~/ банк
144 + "bankBIK": "string", ~/~/ БИК
145 + "bankRS": "string", ~/~/ номер счёта
146 + "bankKS": "string" ~/~/ корр. счёт
147 +}
148 +
149 +
150 +Ответ:
151 +
152 +{
153 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
154 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
155 + "name": "string", ~/~/ имя
156 + "fullName": "string", ~/~/ полное наименование
157 + "isForeign": true, ~/~/ иностранный контрагент
158 + "district": "string", ~/~/ округ
159 + "region": "string", ~/~/ регион
160 + "city": "string", ~/~/ город
161 + "inn": "string", ~/~/ ИНН
162 + "kpp": "string", ~/~/ КПП
163 + "address": "string", ~/~/ юридический адрес
164 + "addressFact": "string", ~/~/ фактический адрес
165 + "email": "string", ~/~/ email
166 + "director": "string", ~/~/ ФИО руководителя
167 + "bankName": "string", ~/~/ банк
168 + "bankBIK": "string", ~/~/ БИК
169 + "bankRS": "string", ~/~/ номер счёта
170 + "bankKS": "string" ~/~/ корр. счёт
171 +}
172 +
173 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
174 +
175 +(% class="box warningmessage" %)
176 +(((
177 +**PUT /api/v3/agents**
178 +)))
179 +
180 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
181 +
182 +Метод запроса: **PUT**
183 +
184 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
185 +
186 +В заголовках запроса: X-Auth: Токен авторизации
187 +
188 +
189 +Параметры в теле запроса (JSON):
190 +
191 +{
192 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
193 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
194 + "name": "string", ~/~/ имя
195 + "fullName": "string", ~/~/ полное наименование
196 + "isForeign": true, ~/~/ иностранный контрагент
197 + "district": "string", ~/~/ округ
198 + "region": "string", ~/~/ регион
199 + "city": "string", ~/~/ город
200 + "inn": "string", ~/~/ ИНН
201 + "kpp": "string", ~/~/ КПП
202 + "address": "string", ~/~/ юридический адрес
203 + "addressFact": "string", ~/~/ фактический адрес
204 + "email": "string", ~/~/ email
205 + "director": "string", ~/~/ ФИО руководителя
206 + "bankName": "string", ~/~/ банк
207 + "bankBIK": "string", ~/~/ БИК
208 + "bankRS": "string", ~/~/ номер счёта
209 + "bankKS": "string" ~/~/ корр. счёт
210 +}
211 +
212 +
213 +Ответ:
214 +
215 +{
216 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
217 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
218 + "name": "string", ~/~/ имя
219 + "fullName": "string", ~/~/ полное наименование
220 + "isForeign": true, ~/~/ иностранный контрагент
221 + "district": "string", ~/~/ округ
222 + "region": "string", ~/~/ регион
223 + "city": "string", ~/~/ город
224 + "inn": "string", ~/~/ ИНН
225 + "kpp": "string", ~/~/ КПП
226 + "address": "string", ~/~/ юридический адрес
227 + "addressFact": "string", ~/~/ фактический адрес
228 + "email": "string", ~/~/ email
229 + "director": "string", ~/~/ ФИО руководителя
230 + "bankName": "string", ~/~/ банк
231 + "bankBIK": "string", ~/~/ БИК
232 + "bankRS": "string", ~/~/ номер счёта
233 + "bankKS": "string" ~/~/ корр. счёт
234 +}
235 +
236 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
237 +
238 +(% class="box errormessage" %)
239 +(((
240 +**DELETE /api/v3/agents/{clientId}**
241 +)))
242 +
243 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
244 +
245 +Метод запроса: **DELETE**
246 +
247 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
248 +
249 +Параметр запроса: **{clientId}** - Guid пользователя
250 +
251 +В заголовках запроса: X-Auth: Токен авторизации
252 +
253 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
254 +
255 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
256 +
257 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
258 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
261 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
264 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -137,9 +137,9 @@
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
280 + "login": "", ~/~/ логин (обязателен)
281 + "password": "", ~/~/ пароль (обязателен)
282 + "email": "", ~/~/ email (обязателен)
143 143   "description": "", ~/~/ описание
144 144   "isEnabled": "", ~/~/ признак включения
145 145   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -148,7 +148,7 @@
148 148   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 149   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 150   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": "" , ~/~/ группы пользователя, названия групп
291 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 152  }
153 153  
154 154  (% style="text-align:left" %)
... ... @@ -174,18 +174,19 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
317 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
181 181  
322 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 183  (% class="box successmessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
326 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
329 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -226,13 +226,63 @@
226 226  
227 227  (% style="color:#000000" %)}
228 228  
370 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
372 +(% class="box successmessage" %)
373 +(((
374 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
375 +)))
376 +
377 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
378 +
379 +(% style="color:#000000" %)Метод запроса: **GET**
380 +
381 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
382 +
383 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
384 +
385 +(% style="color:#000000" %)Ответ:
386 +
387 +(((
388 +(((
389 +{
390 + "id": "", ~/~/ GUID пользователя
391 + "lastName": "", ~/~/ Фамилия 
392 + "firstName": "", ~/~/ Имя
393 + "position": "", ~/~/ Должность
394 + "phone": "", ~/~/ Номер телефона
395 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
396 + "parentName": "", Наименование клиента, которому принадлежит пользователь
397 + "organization": "", ~/~/ Организация
398 + "login": "", ~/~/ Логин пользователя
399 + "email": "", ~/~/ Адрес электронной почты
400 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
401 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
402 + "description": "", ~/~/ Описание
403 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
404 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
405 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
406 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
407 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
408 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
409 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
410 + "groups": [], ~/~/ Список ролей пользователя
411 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
412 + "authDevices": [ ], ~/~/ Список авторизованных устройств
413 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
414 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
415 +}
416 +)))
417 +)))
418 +
419 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
420 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
423 +(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
426 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -253,10 +253,10 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
447 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
448 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
449 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
450 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -297,13 +297,14 @@
297 297  (% lang="en-US" style="text-align:left" %)
298 298  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
299 299  
491 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
300 300  
301 301  (% class="box warningmessage" %)
302 302  (((
303 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
495 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
498 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -326,10 +326,11 @@
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
521 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
329 329  
330 330  (% class="box warningmessage" %)
331 331  (((
332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
525 +**POST /api/v3/users/disable**
333 333  )))
334 334  
335 335  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -347,10 +347,11 @@
347 347  
348 348  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
349 349  
543 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
350 350  
351 351  (% class="box warningmessage" %)
352 352  (((
353 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
547 +**POST /api/v3/users/enable**
354 354  )))
355 355  
356 356  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -369,6 +369,7 @@
369 369  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 370  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371 371  
566 +(((
372 372  В теле ответа:
373 373  {
374 374   "errorMessages": [
... ... @@ -380,14 +380,16 @@
380 380  }
381 381  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 382  "users" - массив id пользователей, которых не удалось включить или отключить.
383 -
578 +)))
384 384  
580 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
581 +
385 385  (% class="box errormessage" %)
386 386  (((
387 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
584 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
388 388  )))
389 389  
390 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
587 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
391 391  
392 392  (% style="color:#000000" %)Метод запроса: **DELETE**
393 393  
... ... @@ -400,20 +400,18 @@
400 400  (% style="text-align:left" %)
401 401  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
402 402  
600 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
403 403  
404 -(% class="box" style="text-align: center;" %)
405 -(((
406 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
407 -)))
602 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
408 408  
409 409  (% class="box infomessage" %)
410 410  (((
411 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
606 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
412 412  )))
413 413  
414 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
609 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
415 415  
416 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
611 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
417 417  
418 418  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
419 419  
... ... @@ -429,75 +429,44 @@
429 429  
430 430  (% style="color:#000000" %)Ответ:
431 431  
627 +(((
432 432  {
433 -
434 - "vehicleId": ,
435 -
436 - "name": "",
437 -
438 - "imei": "",
439 -
440 - "deviceTypeId": ,
441 -
442 - "deviceTypeName": "",
443 -
444 - "sim1": "",
445 -
446 - "parentId": "",
447 -
448 - "parentName": "",
449 -
450 - "modelId": "",
451 -
452 - "modelName": "",
453 -
454 - "createdAt": "",
455 -
456 - "mileageCalcMethod": "",
457 -
458 - "counters": {
459 -
460 - "mileageEnabled": ,
461 -
462 - "motohoursEnabled": ,
463 -
464 - "mileage": 22438858.137653351, ~/~/ пробег по нормам в метрах
465 -
466 - "motohours": 54545302.0 ~/~/ моточасы по нормам, в секундах
467 -
629 + "vehicleId": "", ~/~/ ID объекта
630 + "name": "", ~/~/ Имя объекта
631 + "imei": "", ~/~/ IMEI объекта
632 + "deviceTypeId": , ~/~/ ID типа устройства
633 + "deviceTypeName": "", ~/~/ Название типа устройства
634 + "sim1": "", ~/~/ Номер SIM1
635 + "parentId": "", Номер SIM2
636 + "parentName": "", Наименование клиента-родителя
637 + "modelId": "", ID модели объекта
638 + "modelName": "", Имя модели объекта
639 + "createdAt": "", Дата создания объекта
640 + "mileageCalcMethod": "", Выбранный метод расчета пробега
641 + "counters": { ~/~/ Нормы
642 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
643 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
644 + "mileage": "", ~/~/ Пробег по нормам в метрах
645 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
468 468   },
469 -
470 - "inspectionTasks": [
471 -
647 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
472 472   {
473 -
474 - "id": "",
475 -
476 - "enabled": ,
477 -
478 - "name": "",
479 -
480 - "description": "",
481 -
482 - "mileageCondition": ,
483 -
484 - "lastMileage": ,
485 -
486 - "motohoursCondition": ,
487 -
488 - "lastMotohours": ,
489 -
490 - "periodicCondition": ,
491 -
492 - "kind": "",
493 -
494 - "lastInspectionDate": ""
495 -
649 + "id": "", ~/~/ ID  задания
650 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
651 + "name": "", ~/~/ Наименование задания
652 + "description": "", ~/~/ Описание задания
653 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
654 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
655 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
656 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
657 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
658 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
659 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
660 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
496 496   }
497 -
498 498   ]
499 -
500 500  }
664 +)))
501 501  
502 502  (% style="text-align:left" %)
503 503  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -505,13 +505,14 @@
505 505  (% style="text-align:left" %)
506 506  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
507 507  
672 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
508 508  
509 509  (% class="box successmessage" %)
510 510  (((
511 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
676 +(% lang="en-US" %)**POST /api/v3/vehicles**
512 512  )))
513 513  
514 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
679 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
515 515  
516 516  (% style="color:#000000" %)Метод запроса: **POST**
517 517  
... ... @@ -624,15 +624,16 @@
624 624  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
625 625  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
626 626  
792 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
627 627  
628 628  (% class="box successmessage" %)
629 629  (((
630 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
796 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
631 631  )))
632 632  
633 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
799 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
634 634  
635 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
801 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
636 636  
637 637  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
638 638  
... ... @@ -658,19 +658,19 @@
658 658  
659 659  (% style="color:#000000" %)Параметры в теле запроса (JSON):
660 660  
661 -(% class="western" style="color:#000000" %)##{##
827 +{
828 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
829 + "name": null, ~/~/ Имя ТС (string, опционально)
830 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
831 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
832 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
833 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
834 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
835 + "customFields": null ~/~/ значение любого из произвольных полей ТС
836 +}
662 662  
663 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
664 - "name": null, ~/~/ Имя ТС (string, опционально) 
665 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
666 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
667 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
668 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
669 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
670 -(% style="color:#000000" %)}
838 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
671 671  
672 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
673 -
674 674  (% style="color:#000000" %)Ответ:
675 675  
676 676  (% style="color:#000000" %){
... ... @@ -691,18 +691,28 @@
691 691   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
692 692   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
693 693   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
694 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
860 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
861 + "customFields": [ 
862 + {
863 + "id": "", ~/~/ идентификатор произвольного поля
864 + "name": "", ~/~/ имя произвольного поля
865 + "value": "", ~/~/ значение произвольного поля
866 + "forClient": true, ~/~/ право на отображение у клиента
867 + "forTooltip": false, ~/~/ право на отображение в подсказке
868 + "forReport": false ~/~/ право на отображение в отчетах
869 + }(%%)
695 695  (% style="color:#000000" %)}
696 696  
697 697  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
698 698  
874 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
699 699  
700 700  (% class="box successmessage" %)
701 701  (((
702 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
878 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
703 703  )))
704 704  
705 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
881 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
706 706  
707 707  (% style="color:#000000" %)Метод запроса: **POST**
708 708  
... ... @@ -741,13 +741,14 @@
741 741  (% style="text-align:left" %)
742 742  (% style="color:#000000" %) }
743 743  
920 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
744 744  
745 745  (% class="box warningmessage" %)
746 746  (((
747 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
924 +(% lang="en-US" %)**PUT /api/v3/vehicles**
748 748  )))
749 749  
750 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
927 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
751 751  
752 752  (% style="color:#000000" %)Метод запроса: **PUT**
753 753  
... ... @@ -869,13 +869,14 @@
869 869  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
870 870  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
871 871  
1049 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
872 872  
873 873  (% class="box errormessage" %)
874 874  (((
875 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1053 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
876 876  )))
877 877  
878 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1056 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
879 879  
880 880  (% style="color:#000000" %)Метод запроса: **DELETE**
881 881  
... ... @@ -888,18 +888,16 @@
888 888  (% style="text-align:left" %)
889 889  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
890 890  
1069 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
891 891  
892 -(% class="box" lang="en-US" style="text-align: center;" %)
893 -(((
894 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
895 -)))
1071 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
896 896  
897 897  (% class="box infomessage" %)
898 898  (((
899 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1075 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
900 900  )))
901 901  
902 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1078 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
903 903  
904 904  (% style="color:#000000" %)Метод запроса: **GET**
905 905  
... ... @@ -917,18 +917,16 @@
917 917  (% style="text-align:left" %)
918 918  (% style="color:#000000" %)}
919 919  
1096 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
920 920  
921 -(% class="box" style="text-align: center;" %)
922 -(((
923 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
924 -)))
1098 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
925 925  
926 926  (% class="box infomessage" %)
927 927  (((
928 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1102 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
929 929  )))
930 930  
931 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1105 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
932 932  
933 933  (% style="color:#000000" %)Метод запроса: **GET**
934 934  

Меню

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