Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 30.1 >
edited by Илья Крайнов
on 2022/10/24 14:18
To version < 63.1 >
edited by Илья Крайнов
on 2022/11/24 13:08
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,31 +1,32 @@
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**__).
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 -)))
16 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box successmessage" %)
18 +
19 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Авторизация**(%%) ====
20 +
21 +
22 +===== (% style="color:#000000; line-height:100%" %)**Авторизация**(%%) =====
23 +
24 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
... ... @@ -56,12 +56,14 @@
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 58  
60 +===== (% style="color:#000000; line-height:100%" %)**Проверка авторизации**(%%) =====
61 +
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**
64 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
67 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -73,17 +73,17 @@
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
75 75  
76 -(% class="box" style="text-align: center;" %)
77 -(((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 -)))
79 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Клиенты**(%%) ====
80 80  
81 +
82 +===== (% style="color:#000000" %)**Получение основных параметров клиента**(%%) =====
83 +
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
86 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
89 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -111,17 +111,163 @@
111 111  }
112 112  
113 113  
114 -(% class="box" style="text-align: center;" %)
117 +===== **Добавление клиента** =====
118 +
119 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
121 +**POST /api/v3/agents **
117 117  )))
118 118  
124 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
125 +
126 +Метод запроса: **POST**
127 +
128 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
129 +
130 +В заголовках запроса: X-Auth: Токен авторизации
131 +
132 +Параметры в теле запроса (JSON):
133 +
134 +{
135 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
136 + "name": "string", ~/~/ имя
137 + "fullName": "string", ~/~/ полное наименование
138 + "isForeign": true, ~/~/ иностранный контрагент
139 + "district": "string", ~/~/ округ
140 + "region": "string", ~/~/ регион
141 + "city": "string", ~/~/ город
142 + "inn": "string", ~/~/ ИНН
143 + "kpp": "string", ~/~/ КПП
144 + "address": "string", ~/~/ юридический адрес
145 + "addressFact": "string", ~/~/ фактический адрес
146 + "email": "string", ~/~/ email
147 + "director": "string", ~/~/ ФИО руководителя
148 + "bankName": "string", ~/~/ банк
149 + "bankBIK": "string", ~/~/ БИК
150 + "bankRS": "string", ~/~/ номер счёта
151 + "bankKS": "string" ~/~/ корр. счёт
152 +}
153 +
154 +
155 +Ответ:
156 +
157 +{
158 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
159 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
160 + "name": "string", ~/~/ имя
161 + "fullName": "string", ~/~/ полное наименование
162 + "isForeign": true, ~/~/ иностранный контрагент
163 + "district": "string", ~/~/ округ
164 + "region": "string", ~/~/ регион
165 + "city": "string", ~/~/ город
166 + "inn": "string", ~/~/ ИНН
167 + "kpp": "string", ~/~/ КПП
168 + "address": "string", ~/~/ юридический адрес
169 + "addressFact": "string", ~/~/ фактический адрес
170 + "email": "string", ~/~/ email
171 + "director": "string", ~/~/ ФИО руководителя
172 + "bankName": "string", ~/~/ банк
173 + "bankBIK": "string", ~/~/ БИК
174 + "bankRS": "string", ~/~/ номер счёта
175 + "bankKS": "string" ~/~/ корр. счёт
176 +}
177 +
178 +
179 +===== **Редактирование клиента** =====
180 +
181 +(% class="box warningmessage" %)
182 +(((
183 +**PUT /api/v3/agents**
184 +)))
185 +
186 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
187 +
188 +Метод запроса: **PUT**
189 +
190 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
191 +
192 +В заголовках запроса: X-Auth: Токен авторизации
193 +
194 +
195 +Параметры в теле запроса (JSON):
196 +
197 +{
198 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
199 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
200 + "name": "string", ~/~/ имя
201 + "fullName": "string", ~/~/ полное наименование
202 + "isForeign": true, ~/~/ иностранный контрагент
203 + "district": "string", ~/~/ округ
204 + "region": "string", ~/~/ регион
205 + "city": "string", ~/~/ город
206 + "inn": "string", ~/~/ ИНН
207 + "kpp": "string", ~/~/ КПП
208 + "address": "string", ~/~/ юридический адрес
209 + "addressFact": "string", ~/~/ фактический адрес
210 + "email": "string", ~/~/ email
211 + "director": "string", ~/~/ ФИО руководителя
212 + "bankName": "string", ~/~/ банк
213 + "bankBIK": "string", ~/~/ БИК
214 + "bankRS": "string", ~/~/ номер счёта
215 + "bankKS": "string" ~/~/ корр. счёт
216 +}
217 +
218 +
219 +Ответ:
220 +
221 +{
222 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
223 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
224 + "name": "string", ~/~/ имя
225 + "fullName": "string", ~/~/ полное наименование
226 + "isForeign": true, ~/~/ иностранный контрагент
227 + "district": "string", ~/~/ округ
228 + "region": "string", ~/~/ регион
229 + "city": "string", ~/~/ город
230 + "inn": "string", ~/~/ ИНН
231 + "kpp": "string", ~/~/ КПП
232 + "address": "string", ~/~/ юридический адрес
233 + "addressFact": "string", ~/~/ фактический адрес
234 + "email": "string", ~/~/ email
235 + "director": "string", ~/~/ ФИО руководителя
236 + "bankName": "string", ~/~/ банк
237 + "bankBIK": "string", ~/~/ БИК
238 + "bankRS": "string", ~/~/ номер счёта
239 + "bankKS": "string" ~/~/ корр. счёт
240 +}
241 +
242 +
243 +===== **Удаление клиента** =====
244 +
245 +(% class="box errormessage" %)
246 +(((
247 +**DELETE /api/v3/agents/{clientId}**
248 +)))
249 +
250 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
251 +
252 +Метод запроса: **DELETE**
253 +
254 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
255 +
256 +Параметр запроса: **{clientId}** - Guid пользователя
257 +
258 +В заголовках запроса: X-Auth: Токен авторизации
259 +
260 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
261 +
262 +
263 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Пользователи**(%%) ====
264 +
265 +
266 +===== (% style="color:#000000; line-height:100%" %)**Добавление пользователя**(%%) =====
267 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
270 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
273 +(% 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
289 + "login": "", ~/~/ логин (обязателен)
290 + "password": "", ~/~/ пароль (обязателен)
291 + "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": "" , ~/~/ группы пользователя, названия групп
300 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 152  }
153 153  
154 154  (% style="text-align:left" %)
... ... @@ -174,18 +174,20 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
326 + "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  
182 182  
332 +===== (% style="color:#000000; line-height:100%" %)**Получение списка пользователей**(%%) =====
333 +
183 183  (% class="box successmessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
336 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
339 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -227,12 +227,64 @@
227 227  (% style="color:#000000" %)}
228 228  
229 229  
381 +===== (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе**(%%) =====
382 +
383 +(% class="box successmessage" %)
384 +(((
385 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
386 +)))
387 +
388 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
389 +
390 +(% style="color:#000000" %)Метод запроса: **GET**
391 +
392 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
393 +
394 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
395 +
396 +(% style="color:#000000" %)Ответ:
397 +
398 +(((
399 +(((
400 +{
401 + "id": "", ~/~/ GUID пользователя
402 + "lastName": "", ~/~/ Фамилия 
403 + "firstName": "", ~/~/ Имя
404 + "position": "", ~/~/ Должность
405 + "phone": "", ~/~/ Номер телефона
406 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
407 + "parentName": "", Наименование клиента, которому принадлежит пользователь
408 + "organization": "", ~/~/ Организация
409 + "login": "", ~/~/ Логин пользователя
410 + "email": "", ~/~/ Адрес электронной почты
411 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
412 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
413 + "description": "", ~/~/ Описание
414 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
415 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
416 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
417 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
418 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
419 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
420 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
421 + "groups": [], ~/~/ Список ролей пользователя
422 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
423 + "authDevices": [ ], ~/~/ Список авторизованных устройств
424 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
425 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
426 +}
427 +)))
428 +)))
429 +
430 +
431 +===== (% style="color:#000000; line-height:100%" %)**Редактирование пользователя**(%%) =====
432 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
435 +(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
438 +(% 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": "" , ~/~/ описание
459 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
460 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
461 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
462 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -298,12 +298,14 @@
298 298  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
299 299  
300 300  
504 +===== (% style="color:#000000" %)**Изменение статуса пользователя**(%%) =====
505 +
301 301  (% class="box warningmessage" %)
302 302  (((
303 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
508 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
511 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -327,9 +327,11 @@
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
329 329  
535 +===== **Блокировка пользователей** =====
536 +
330 330  (% class="box warningmessage" %)
331 331  (((
332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
539 +**POST /api/v3/users/disable**
333 333  )))
334 334  
335 335  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -345,10 +345,14 @@
345 345   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
346 346   ]
347 347  
555 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
348 348  
557 +
558 +===== **Разблокировка пользователей** =====
559 +
349 349  (% class="box warningmessage" %)
350 350  (((
351 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/find**
562 +**POST /api/v3/users/enable**
352 352  )))
353 353  
354 354  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -364,13 +364,32 @@
364 364   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
365 365   ]
366 366  
578 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
579 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
367 367  
581 +(((
582 +В теле ответа:
583 +{
584 + "errorMessages": [
585 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
586 + ],
587 + "users": [
588 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
589 + ]
590 +}
591 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
592 +"users" - массив id пользователей, которых не удалось включить или отключить.
593 +
594 +
595 +===== (% style="color:#000000; line-height:100%" %)**Удаление пользователя**(%%) =====
596 +)))
597 +
368 368  (% class="box errormessage" %)
369 369  (((
370 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
600 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
371 371  )))
372 372  
373 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
603 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
374 374  
375 375  (% style="color:#000000" %)Метод запроса: **DELETE**
376 376  
... ... @@ -384,19 +384,19 @@
384 384  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
385 385  
386 386  
387 -(% class="box" style="text-align: center;" %)
388 -(((
389 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
390 -)))
617 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Транспортные средства**(%%) ====
391 391  
619 +
620 +===== (% style="color:#000000; line-height:100%" %)**Получение информации об объекте**(%%) =====
621 +
392 392  (% class="box infomessage" %)
393 393  (((
394 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
624 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
395 395  )))
396 396  
397 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
627 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
398 398  
399 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
629 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
400 400  
401 401  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
402 402  
... ... @@ -412,22 +412,44 @@
412 412  
413 413  (% style="color:#000000" %)Ответ:
414 414  
415 -(% style="color:#000000" %){
416 -
417 - "vehicleId": "" , ~/~/ идентификатор объекта
418 - "name": "" , ~/~/ имя объекта
419 - "imei": "" , ~/~/ IMEI объекта
420 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
421 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
422 - "parentId": "" , ~/~/ идентификатор клиента-родителя
423 - "parentName": "" , ~/~/ наименование клиента-родителя,
424 - "modelId": "" , ~/~/ идентификатор модели объекта
425 - "modelName": "" , ~/~/ наименование модели объекта,
426 - "unitId": "" , ~/~/ идентификатор подразделения
427 - "unitName": "" , ~/~/ наименование подразделения
428 - "status": "" , ~/~/ статус объекта
429 -
645 +(((
646 +{
647 + "vehicleId": "", ~/~/ ID объекта
648 + "name": "", ~/~/ Имя объекта
649 + "imei": "", ~/~/ IMEI объекта
650 + "deviceTypeId": , ~/~/ ID типа устройства
651 + "deviceTypeName": "", ~/~/ Название типа устройства
652 + "sim1": "", ~/~/ Номер SIM1
653 + "parentId": "", Номер SIM2
654 + "parentName": "", Наименование клиента-родителя
655 + "modelId": "", ID модели объекта
656 + "modelName": "", Имя модели объекта
657 + "createdAt": "", Дата создания объекта
658 + "mileageCalcMethod": "", Выбранный метод расчета пробега
659 + "counters": { ~/~/ Нормы
660 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
661 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
662 + "mileage": "", ~/~/ Пробег по нормам в метрах
663 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
664 + },
665 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
666 + {
667 + "id": "", ~/~/ ID  задания
668 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
669 + "name": "", ~/~/ Наименование задания
670 + "description": "", ~/~/ Описание задания
671 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
672 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
673 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
674 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
675 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
676 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
677 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
678 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
679 + }
680 + ]
430 430  }
682 +)))
431 431  
432 432  (% style="text-align:left" %)
433 433  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -436,12 +436,14 @@
436 436  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
437 437  
438 438  
691 +===== (% style="color:#000000; line-height:100%" %)**Добавление объекта**(%%) =====
692 +
439 439  (% class="box successmessage" %)
440 440  (((
441 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
695 +(% lang="en-US" %)**POST /api/v3/vehicles**
442 442  )))
443 443  
444 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
698 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
445 445  
446 446  (% style="color:#000000" %)Метод запроса: **POST**
447 447  
... ... @@ -555,14 +555,16 @@
555 555  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
556 556  
557 557  
812 +===== (% style="color:#000000; line-height:100%" %)**Получение параметров объектов**(%%) =====
813 +
558 558  (% class="box successmessage" %)
559 559  (((
560 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
816 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
561 561  )))
562 562  
563 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
819 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
564 564  
565 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
821 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
566 566  
567 567  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
568 568  
... ... @@ -588,19 +588,19 @@
588 588  
589 589  (% style="color:#000000" %)Параметры в теле запроса (JSON):
590 590  
591 -(% class="western" style="color:#000000" %)##{##
847 +{
848 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
849 + "name": null, ~/~/ Имя ТС (string, опционально)
850 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
851 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
852 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
853 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
854 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
855 + "customFields": null ~/~/ значение любого из произвольных полей ТС
856 +}
592 592  
593 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
594 - "name": null, ~/~/ Имя ТС (string, опционально) 
595 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
596 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
597 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
598 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
599 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
600 -(% style="color:#000000" %)}
858 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
601 601  
602 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
603 -
604 604  (% style="color:#000000" %)Ответ:
605 605  
606 606  (% style="color:#000000" %){
... ... @@ -621,18 +621,29 @@
621 621   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
622 622   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
623 623   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
624 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
880 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
881 + "customFields": [ 
882 + {
883 + "id": "", ~/~/ идентификатор произвольного поля
884 + "name": "", ~/~/ имя произвольного поля
885 + "value": "", ~/~/ значение произвольного поля
886 + "forClient": true, ~/~/ право на отображение у клиента
887 + "forTooltip": false, ~/~/ право на отображение в подсказке
888 + "forReport": false ~/~/ право на отображение в отчетах
889 + }(%%)
625 625  (% style="color:#000000" %)}
626 626  
627 627  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
628 628  
629 629  
895 +===== (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта**(%%) =====
896 +
630 630  (% class="box successmessage" %)
631 631  (((
632 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
899 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
633 633  )))
634 634  
635 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
902 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
636 636  
637 637  (% style="color:#000000" %)Метод запроса: **POST**
638 638  
... ... @@ -672,12 +672,14 @@
672 672  (% style="color:#000000" %) }
673 673  
674 674  
942 +===== (% style="color:#000000; line-height:100%" %)**Редактирование объекта**(%%) =====
943 +
675 675  (% class="box warningmessage" %)
676 676  (((
677 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
946 +(% lang="en-US" %)**PUT /api/v3/vehicles**
678 678  )))
679 679  
680 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
949 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
681 681  
682 682  (% style="color:#000000" %)Метод запроса: **PUT**
683 683  
... ... @@ -715,8 +715,8 @@
715 715   {
716 716   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
717 717   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
718 - "mileage": «», пробег
719 - "motohours": «» моточасы
987 + "mileage": "", ~/~/ пробег, в метрах 
988 + "motohours": "" ~/~/ моточасы, в секундах
720 720   }
721 721   "cmsv6Parameters": ~/~/ параметры CMSv6
722 722   {       
... ... @@ -800,12 +800,14 @@
800 800  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
801 801  
802 802  
1072 +===== (% style="color:#000000; line-height:100%" %)**Удаление объекта**(%%) =====
1073 +
803 803  (% class="box errormessage" %)
804 804  (((
805 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1076 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
806 806  )))
807 807  
808 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1079 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
809 809  
810 810  (% style="color:#000000" %)Метод запроса: **DELETE**
811 811  
... ... @@ -819,17 +819,17 @@
819 819  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
820 820  
821 821  
822 -(% class="box" lang="en-US" style="text-align: center;" %)
823 -(((
824 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
825 -)))
1093 +(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
826 826  
1095 +
1096 +===== (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств**(%%) =====
1097 +
827 827  (% class="box infomessage" %)
828 828  (((
829 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1100 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
830 830  )))
831 831  
832 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1103 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
833 833  
834 834  (% style="color:#000000" %)Метод запроса: **GET**
835 835  
... ... @@ -848,17 +848,17 @@
848 848  (% style="color:#000000" %)}
849 849  
850 850  
851 -(% class="box" style="text-align: center;" %)
852 -(((
853 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
854 -)))
1122 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Датчики**(%%) ====
855 855  
1124 +
1125 +===== (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков**(%%) =====
1126 +
856 856  (% class="box infomessage" %)
857 857  (((
858 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1129 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
859 859  )))
860 860  
861 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1132 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
862 862  
863 863  (% style="color:#000000" %)Метод запроса: **GET**
864 864  

Меню

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