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

Summary

Details

Icon Page properties
Content
... ... @@ -1,31 +1,30 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
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:16px" %)**Действующие ограничения**(%%) =
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 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
19 +
20 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
21 +
22 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
24 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
27 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
... ... @@ -39,8 +39,8 @@
39 39   "login": "testuser",
40 40   "password": "testuser"
41 41  }(%%)
42 -
43 43  
42 +
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,13 +55,14 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
57 +== (% 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**
61 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
64 +(% 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  
75 += (% 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 -)))
77 +== (% 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(%%)**
81 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
84 +(% 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;" %)
112 +== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
113 +
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 +
174 +== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
175 +
176 +(% class="box warningmessage" %)
177 +(((
178 +**PUT /api/v3/agents**
179 +)))
180 +
181 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
182 +
183 +Метод запроса: **PUT**
184 +
185 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
186 +
187 +В заголовках запроса: X-Auth: Токен авторизации
188 +
189 +
190 +Параметры в теле запроса (JSON):
191 +
192 +{
193 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
194 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
195 + "name": "string", ~/~/ имя
196 + "fullName": "string", ~/~/ полное наименование
197 + "isForeign": true, ~/~/ иностранный контрагент
198 + "district": "string", ~/~/ округ
199 + "region": "string", ~/~/ регион
200 + "city": "string", ~/~/ город
201 + "inn": "string", ~/~/ ИНН
202 + "kpp": "string", ~/~/ КПП
203 + "address": "string", ~/~/ юридический адрес
204 + "addressFact": "string", ~/~/ фактический адрес
205 + "email": "string", ~/~/ email
206 + "director": "string", ~/~/ ФИО руководителя
207 + "bankName": "string", ~/~/ банк
208 + "bankBIK": "string", ~/~/ БИК
209 + "bankRS": "string", ~/~/ номер счёта
210 + "bankKS": "string" ~/~/ корр. счёт
211 +}
212 +
213 +
214 +Ответ:
215 +
216 +{
217 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
218 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
219 + "name": "string", ~/~/ имя
220 + "fullName": "string", ~/~/ полное наименование
221 + "isForeign": true, ~/~/ иностранный контрагент
222 + "district": "string", ~/~/ округ
223 + "region": "string", ~/~/ регион
224 + "city": "string", ~/~/ город
225 + "inn": "string", ~/~/ ИНН
226 + "kpp": "string", ~/~/ КПП
227 + "address": "string", ~/~/ юридический адрес
228 + "addressFact": "string", ~/~/ фактический адрес
229 + "email": "string", ~/~/ email
230 + "director": "string", ~/~/ ФИО руководителя
231 + "bankName": "string", ~/~/ банк
232 + "bankBIK": "string", ~/~/ БИК
233 + "bankRS": "string", ~/~/ номер счёта
234 + "bankKS": "string" ~/~/ корр. счёт
235 +}
236 +
237 +
238 +== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
239 +
240 +(% class="box errormessage" %)
241 +(((
242 +**DELETE /api/v3/agents/{clientId}**
243 +)))
244 +
245 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
246 +
247 +Метод запроса: **DELETE**
248 +
249 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
250 +
251 +Параметр запроса: **{clientId}** - Guid пользователя
252 +
253 +В заголовках запроса: X-Auth: Токен авторизации
254 +
255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
256 +
257 +
258 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
259 +
260 +
261 +== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
262 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
265 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
268 +(% 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
284 + "login": "", ~/~/ логин (обязателен)
285 + "password": "", ~/~/ пароль (обязателен)
286 + "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": "" , ~/~/ группы пользователя, названия групп
295 + "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» названия группы пользователя
321 + "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  
327 +== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
328 +
183 183  (% class="box successmessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
331 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
334 +(% 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  
376 +== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
377 +
378 +(% class="box successmessage" %)
379 +(((
380 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
381 +)))
382 +
383 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
384 +
385 +(% style="color:#000000" %)Метод запроса: **GET**
386 +
387 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
388 +
389 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
390 +
391 +(% style="color:#000000" %)Ответ:
392 +
393 +(((
394 +(((
395 +{
396 + "id": "", ~/~/ GUID пользователя
397 + "lastName": "", ~/~/ Фамилия 
398 + "firstName": "", ~/~/ Имя
399 + "position": "", ~/~/ Должность
400 + "phone": "", ~/~/ Номер телефона
401 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
402 + "parentName": "", Наименование клиента, которому принадлежит пользователь
403 + "organization": "", ~/~/ Организация
404 + "login": "", ~/~/ Логин пользователя
405 + "email": "", ~/~/ Адрес электронной почты
406 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
407 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
408 + "description": "", ~/~/ Описание
409 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
410 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
411 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
412 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
413 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
414 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
415 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
416 + "groups": [], ~/~/ Список ролей пользователя
417 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
418 + "authDevices": [ ], ~/~/ Список авторизованных устройств
419 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
420 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
421 +}
422 +)))
423 +)))
424 +
425 +
426 +== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
427 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
430 +(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
433 +(% 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": "" , ~/~/ описание
454 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
455 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
456 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
457 +(% 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  
499 +== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
500 +
301 301  (% class="box warningmessage" %)
302 302  (((
303 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
503 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
506 +(% 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  
530 +== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
531 +
330 330  (% class="box warningmessage" %)
331 331  (((
332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
534 +**POST /api/v3/users/disable**
333 333  )))
334 334  
335 335  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -348,9 +348,11 @@
348 348  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
349 349  
350 350  
553 +== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
554 +
351 351  (% class="box warningmessage" %)
352 352  (((
353 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/find**
557 +**POST /api/v3/users/enable**
354 354  )))
355 355  
356 356  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -366,15 +366,32 @@
366 366   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
367 367   ]
368 368  
369 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
573 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
574 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
370 370  
576 +(((
577 +В теле ответа:
578 +{
579 + "errorMessages": [
580 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
581 + ],
582 + "users": [
583 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
584 + ]
585 +}
586 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
587 +"users" - массив id пользователей, которых не удалось включить или отключить.
588 +
371 371  
590 +== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
591 +)))
592 +
372 372  (% class="box errormessage" %)
373 373  (((
374 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
595 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
375 375  )))
376 376  
377 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
598 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
378 378  
379 379  (% style="color:#000000" %)Метод запроса: **DELETE**
380 380  
... ... @@ -388,19 +388,19 @@
388 388  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
389 389  
390 390  
391 -(% class="box" style="text-align: center;" %)
392 -(((
393 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
394 -)))
612 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
395 395  
614 +
615 +== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
616 +
396 396  (% class="box infomessage" %)
397 397  (((
398 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
619 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
399 399  )))
400 400  
401 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
622 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
402 402  
403 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
624 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
404 404  
405 405  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
406 406  
... ... @@ -416,22 +416,44 @@
416 416  
417 417  (% style="color:#000000" %)Ответ:
418 418  
419 -(% style="color:#000000" %){
420 -
421 - "vehicleId": "" , ~/~/ идентификатор объекта
422 - "name": "" , ~/~/ имя объекта
423 - "imei": "" , ~/~/ IMEI объекта
424 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
425 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
426 - "parentId": "" , ~/~/ идентификатор клиента-родителя
427 - "parentName": "" , ~/~/ наименование клиента-родителя,
428 - "modelId": "" , ~/~/ идентификатор модели объекта
429 - "modelName": "" , ~/~/ наименование модели объекта,
430 - "unitId": "" , ~/~/ идентификатор подразделения
431 - "unitName": "" , ~/~/ наименование подразделения
432 - "status": "" , ~/~/ статус объекта
433 -
640 +(((
641 +{
642 + "vehicleId": "", ~/~/ ID объекта
643 + "name": "", ~/~/ Имя объекта
644 + "imei": "", ~/~/ IMEI объекта
645 + "deviceTypeId": , ~/~/ ID типа устройства
646 + "deviceTypeName": "", ~/~/ Название типа устройства
647 + "sim1": "", ~/~/ Номер SIM1
648 + "parentId": "", Номер SIM2
649 + "parentName": "", Наименование клиента-родителя
650 + "modelId": "", ID модели объекта
651 + "modelName": "", Имя модели объекта
652 + "createdAt": "", Дата создания объекта
653 + "mileageCalcMethod": "", Выбранный метод расчета пробега
654 + "counters": { ~/~/ Нормы
655 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
656 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
657 + "mileage": "", ~/~/ Пробег по нормам в метрах
658 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
659 + },
660 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
661 + {
662 + "id": "", ~/~/ ID  задания
663 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
664 + "name": "", ~/~/ Наименование задания
665 + "description": "", ~/~/ Описание задания
666 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
667 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
668 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
669 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
671 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
672 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
673 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
674 + }
675 + ]
434 434  }
677 +)))
435 435  
436 436  (% style="text-align:left" %)
437 437  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -440,12 +440,14 @@
440 440  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
441 441  
442 442  
686 +== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
687 +
443 443  (% class="box successmessage" %)
444 444  (((
445 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
690 +(% lang="en-US" %)**POST /api/v3/vehicles**
446 446  )))
447 447  
448 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
693 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
449 449  
450 450  (% style="color:#000000" %)Метод запроса: **POST**
451 451  
... ... @@ -559,14 +559,16 @@
559 559  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
560 560  
561 561  
807 +== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
808 +
562 562  (% class="box successmessage" %)
563 563  (((
564 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
811 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
565 565  )))
566 566  
567 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
814 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
568 568  
569 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
816 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
570 570  
571 571  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
572 572  
... ... @@ -592,19 +592,19 @@
592 592  
593 593  (% style="color:#000000" %)Параметры в теле запроса (JSON):
594 594  
595 -(% class="western" style="color:#000000" %)##{##
842 +{
843 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
844 + "name": null, ~/~/ Имя ТС (string, опционально)
845 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
846 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
847 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
848 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
849 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
850 + "customFields": null ~/~/ значение любого из произвольных полей ТС
851 +}
596 596  
597 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
598 - "name": null, ~/~/ Имя ТС (string, опционально) 
599 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
600 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
601 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
602 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
603 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
604 -(% style="color:#000000" %)}
853 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
605 605  
606 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
607 -
608 608  (% style="color:#000000" %)Ответ:
609 609  
610 610  (% style="color:#000000" %){
... ... @@ -625,18 +625,29 @@
625 625   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
626 626   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
627 627   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
628 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
875 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
876 + "customFields": [ 
877 + {
878 + "id": "", ~/~/ идентификатор произвольного поля
879 + "name": "", ~/~/ имя произвольного поля
880 + "value": "", ~/~/ значение произвольного поля
881 + "forClient": true, ~/~/ право на отображение у клиента
882 + "forTooltip": false, ~/~/ право на отображение в подсказке
883 + "forReport": false ~/~/ право на отображение в отчетах
884 + }(%%)
629 629  (% style="color:#000000" %)}
630 630  
631 631  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
632 632  
633 633  
890 +== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
891 +
634 634  (% class="box successmessage" %)
635 635  (((
636 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
894 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
637 637  )))
638 638  
639 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
897 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
640 640  
641 641  (% style="color:#000000" %)Метод запроса: **POST**
642 642  
... ... @@ -676,12 +676,14 @@
676 676  (% style="color:#000000" %) }
677 677  
678 678  
937 +== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
938 +
679 679  (% class="box warningmessage" %)
680 680  (((
681 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
941 +(% lang="en-US" %)**PUT /api/v3/vehicles**
682 682  )))
683 683  
684 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
944 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
685 685  
686 686  (% style="color:#000000" %)Метод запроса: **PUT**
687 687  
... ... @@ -719,8 +719,8 @@
719 719   {
720 720   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
721 721   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
722 - "mileage": «», пробег
723 - "motohours": «» моточасы
982 + "mileage": "", ~/~/ пробег, в метрах 
983 + "motohours": "" ~/~/ моточасы, в секундах
724 724   }
725 725   "cmsv6Parameters": ~/~/ параметры CMSv6
726 726   {       
... ... @@ -804,12 +804,14 @@
804 804  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
805 805  
806 806  
1067 +== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1068 +
807 807  (% class="box errormessage" %)
808 808  (((
809 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1071 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
810 810  )))
811 811  
812 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1074 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
813 813  
814 814  (% style="color:#000000" %)Метод запроса: **DELETE**
815 815  
... ... @@ -823,17 +823,17 @@
823 823  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
824 824  
825 825  
826 -(% class="box" lang="en-US" style="text-align: center;" %)
827 -(((
828 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
829 -)))
1088 +(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
830 830  
1090 +
1091 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1092 +
831 831  (% class="box infomessage" %)
832 832  (((
833 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1095 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
834 834  )))
835 835  
836 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1098 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
837 837  
838 838  (% style="color:#000000" %)Метод запроса: **GET**
839 839  
... ... @@ -852,17 +852,17 @@
852 852  (% style="color:#000000" %)}
853 853  
854 854  
855 -(% class="box" style="text-align: center;" %)
856 -(((
857 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
858 -)))
1117 += (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
859 859  
1119 +
1120 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1121 +
860 860  (% class="box infomessage" %)
861 861  (((
862 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1124 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
863 863  )))
864 864  
865 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1127 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
866 866  
867 867  (% style="color:#000000" %)Метод запроса: **GET**
868 868  

Меню

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