Last modified by Андрей Калиновский on 2025/04/21 14:13
<
From version < 68.1 >
edited by Илья Крайнов
on 2022/11/30 14:00
To version < 17.1 >
edited by Артем Шемяков
on 2022/09/01 16:30
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -1,73 +1,50 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -**Содержание страницы:**
4 -)))
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
5 5  
6 -(% class="western" %)
4 +== ==
5 +
6 +(% class="box" style="text-align: center;" %)
7 7  (((
8 -
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 9  )))
10 10  
11 -{{toc/}}
12 -
13 -
14 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
15 -
16 16  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
17 17  
18 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
19 19  
20 20  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 +
21 21  
22 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 +)))
23 23  
24 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
25 -
26 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
27 -
28 28  (% class="box infomessage" %)
29 29  (((
30 -(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
31 31  )))
32 32  
33 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
34 34  
35 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
36 36  
37 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
38 38  
39 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
40 40  
41 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
42 -
43 -(% style="color:#000000" %){
44 - "login": "testuser",
45 - "password": "testuser"
46 -}
47 -
48 -
49 -(% style="color:#000000" %)**Ответ:**
50 -
51 51  (% lang="en-US" %)
52 -(% style="color:#000000" %){
37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
53 53  
54 -(% lang="en-US" %)
55 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
56 - "User": "testuser" , ~/~/ имя пользователя
57 -
58 -(% lang="en-US" %)
59 -}
60 -
61 61  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
62 62  
63 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
66 66  (((
67 -(% lang="en-US" %)**GET /api/v3/auth/check**
44 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
68 68  )))
69 69  
70 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
47 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
71 71  
72 72  (% style="color:#000000" %)Метод запроса: **GET**
73 73  
... ... @@ -78,195 +78,49 @@
78 78  (% lang="en-US" %)
79 79  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
80 80  
81 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
82 82  
83 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
59 +(% class="box" style="text-align: center;" %)
60 +(((
61 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
62 +)))
84 84  
85 85  (% class="box infomessage" %)
86 86  (((
87 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
66 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
88 88  )))
89 89  
90 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
69 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
91 91  
92 92  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
93 93  
94 94  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
95 95  
96 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
75 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
97 97  
98 98  (% style="color:#000000" %)Метод запроса: **GET**
99 99  
100 100  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
101 101  
102 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
81 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
103 103  
104 104  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
105 105  
106 -(% style="color:#000000" %)Ответ:
85 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
107 107  
108 -(% style="color:#000000" %){
109 - "agentId": "", ~/~/ идентификатор клиента
110 - "parentId": "", ~/~/ идентификатор клиента-родителя
111 - "name": "", ~/~/ наименование клиента
112 - "fullName": "", ~/~/ полное наименование клиента
113 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
114 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
115 -}
87 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
116 116  
117 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
118 118  
119 -(% class="box successmessage" %)
90 +(% class="box" style="text-align: center;" %)
120 120  (((
121 -**POST /api/v3/agents **
92 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
122 122  )))
123 123  
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 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
179 -
180 -(% class="box warningmessage" %)
181 -(((
182 -**PUT /api/v3/agents**
183 -)))
184 -
185 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
186 -
187 -Метод запроса: **PUT**
188 -
189 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
190 -
191 -В заголовках запроса: X-Auth: Токен авторизации
192 -
193 -
194 -Параметры в теле запроса (JSON):
195 -
196 -{
197 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
198 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
199 - "name": "string", ~/~/ имя
200 - "fullName": "string", ~/~/ полное наименование
201 - "isForeign": true, ~/~/ иностранный контрагент
202 - "district": "string", ~/~/ округ
203 - "region": "string", ~/~/ регион
204 - "city": "string", ~/~/ город
205 - "inn": "string", ~/~/ ИНН
206 - "kpp": "string", ~/~/ КПП
207 - "address": "string", ~/~/ юридический адрес
208 - "addressFact": "string", ~/~/ фактический адрес
209 - "email": "string", ~/~/ email
210 - "director": "string", ~/~/ ФИО руководителя
211 - "bankName": "string", ~/~/ банк
212 - "bankBIK": "string", ~/~/ БИК
213 - "bankRS": "string", ~/~/ номер счёта
214 - "bankKS": "string" ~/~/ корр. счёт
215 -}
216 -
217 -
218 -Ответ:
219 -
220 -{
221 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
222 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
223 - "name": "string", ~/~/ имя
224 - "fullName": "string", ~/~/ полное наименование
225 - "isForeign": true, ~/~/ иностранный контрагент
226 - "district": "string", ~/~/ округ
227 - "region": "string", ~/~/ регион
228 - "city": "string", ~/~/ город
229 - "inn": "string", ~/~/ ИНН
230 - "kpp": "string", ~/~/ КПП
231 - "address": "string", ~/~/ юридический адрес
232 - "addressFact": "string", ~/~/ фактический адрес
233 - "email": "string", ~/~/ email
234 - "director": "string", ~/~/ ФИО руководителя
235 - "bankName": "string", ~/~/ банк
236 - "bankBIK": "string", ~/~/ БИК
237 - "bankRS": "string", ~/~/ номер счёта
238 - "bankKS": "string" ~/~/ корр. счёт
239 -}
240 -
241 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
242 -
243 -(% class="box errormessage" %)
244 -(((
245 -**DELETE /api/v3/agents/{clientId}**
246 -)))
247 -
248 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
249 -
250 -Метод запроса: **DELETE**
251 -
252 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
253 -
254 -Параметр запроса: **{clientId}** - Guid пользователя
255 -
256 -В заголовках запроса: X-Auth: Токен авторизации
257 -
258 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
259 -
260 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
261 -
262 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
263 -
264 264  (% class="box successmessage" %)
265 265  (((
266 -(% lang="en-US" %)**POST /api/v3/users**
97 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
267 267  )))
268 268  
269 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
100 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
270 270  
271 271  (% style="color:#000000" %)Метод запроса: **POST**
272 272  
... ... @@ -274,161 +274,18 @@
274 274  
275 275  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
276 276  
277 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
108 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
278 278  
279 -(% style="color:#000000" %){ 
280 - "lastName": "", ~/~/ фамилия
281 - "firstName": "", ~/~/ имя
282 - "position": "", ~/~/ должность
283 - "phone": "", ~/~/ телефон
284 - "organization": "", ~/~/ организация
285 - "login": "", ~/~/ логин (обязателен)
286 - "password": "", ~/~/ пароль (обязателен)
287 - "email": "", ~/~/ email (обязателен)
288 - "description": "", ~/~/ описание
289 - "isEnabled": "", ~/~/ признак включения
290 - "parentId": "", ~/~/ Guid родительского агента
291 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
292 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
293 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
294 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
295 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
296 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
297 -}
298 -
299 299  (% style="text-align:left" %)
300 -(% style="color:#000000; font-weight:normal" %)Ответ:
111 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
301 301  
302 -(% style="text-align:left" %)
303 -(% style="color:#000000; font-weight:normal" %){    
304 304  
305 -(% style="text-align:left" %)
306 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
307 - "lastName": "" , ~/~/ Фамилия ,
308 - "firstName": "" , ~/~/ Имя
309 - "position": "" , ~/~/ Должность
310 - "phone": "" , ~/~/ Телефон
311 - "organization": "" , ~/~/ Организация
312 - "login": "" , ~/~/ Логин
313 - "password": "" , ~/~/ Пароль
314 - "email": "" , ~/~/ Email
315 - "description": "" , ~/~/ Описание
316 - "isEnabled": "" , ~/~/ Признак включения
317 - "parentId": "" , ~/~/ Guid родительского агента
318 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
319 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
320 - "kind": "" , ~/~/ тип аутентификации
321 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
322 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
323 -
324 -(% style="text-align:left" %)
325 -(% style="color:#000000; font-weight:normal" %)}
326 -
327 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
328 -
329 -(% class="box successmessage" %)
330 -(((
331 -(% lang="en-US" %)**POST /api/v3/users/find**
332 -)))
333 -
334 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
335 -
336 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
337 -
338 -(% style="color:#000000" %)Метод запроса: **POST**
339 -
340 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
341 -
342 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
343 -
344 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
345 -
346 -(% style="color:#000000" %){
347 -
348 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
349 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
350 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
351 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
352 -
353 -(% style="color:#000000" %)}
354 -
355 -(% style="color:#000000" %)Ответ:
356 -
357 -(% style="color:#000000" %){         (%%)
358 -
359 - "id": "" , ~/~/ идентификатор пользователя
360 - "lastName": "" , ~/~/ фамилия
361 - "firstName": "" , ~/~/ имя
362 - "position": "" , ~/~/ должность
363 - "phone": "" , ~/~/ телефон
364 - "parentId": "" , ~/~/ идентификатор клиента-родителя
365 - "parentName": "" , ~/~/ наименование клиента-родителя
366 - "organization": "" , ~/~/ организация
367 - "login": "" , ~/~/ логин
368 - "email": "" , ~/~/ E-mail
369 - "sessionDuration":"", ~/~/ длительность сессии в минутах
370 - "status": "1",  ~/~/ статус пользователя
371 - "astLogged": "", ~/~/ дата/время последней авторизации
372 -
373 -(% style="color:#000000" %)}
374 -
375 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
376 -
377 -(% class="box successmessage" %)
378 -(((
379 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
380 -)))
381 -
382 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
383 -
384 -(% style="color:#000000" %)Метод запроса: **GET**
385 -
386 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
387 -
388 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
389 -
390 -(% style="color:#000000" %)Ответ:
391 -
392 -(((
393 -(((
394 -{
395 - "id": "", ~/~/ GUID пользователя
396 - "lastName": "", ~/~/ Фамилия 
397 - "firstName": "", ~/~/ Имя
398 - "position": "", ~/~/ Должность
399 - "phone": "", ~/~/ Номер телефона
400 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
401 - "parentName": "", Наименование клиента, которому принадлежит пользователь
402 - "organization": "", ~/~/ Организация
403 - "login": "", ~/~/ Логин пользователя
404 - "email": "", ~/~/ Адрес электронной почты
405 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
406 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
407 - "description": "", ~/~/ Описание
408 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
409 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
410 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
411 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
412 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
413 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
414 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
415 - "groups": [], ~/~/ Список ролей пользователя
416 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
417 - "authDevices": [ ], ~/~/ Список авторизованных устройств
418 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
419 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
420 -}
421 -)))
422 -)))
423 -
424 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
425 -
426 426  (% class="box warningmessage" %)
427 427  (((
428 -(% lang="en-US" %)**PUT /api/v3/users**
116 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
429 429  )))
430 430  
431 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
119 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
432 432  
433 433  (% style="color:#000000" %)Метод запроса: **PUT**
434 434  
... ... @@ -437,165 +437,98 @@
437 437  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
438 438  
439 439  (% lang="en-US" style="text-align:left" %)
440 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
128 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
441 441  
442 -(% lang="en-US" style="text-align:left" %)
443 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
444 444  
445 -(% lang="en-US" style="text-align:left" %)
446 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
447 - "lastName": "" , ~/~/ фамилия
448 - "firstName": "" , ~/~/ имя
449 - "position": "" , ~/~/ должность
450 - "phone": "" , ~/~/ телефон
451 - "organization": "" , ~/~/ организация
452 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
454 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
455 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
456 - "isEnabled": "" , ~/~/ признак включения
457 - "parentId": "" , ~/~/ Guid родительского агента
458 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
459 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
460 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
461 - "kind": "" , ~/~/ тип аутентификации
462 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
463 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
464 -
465 -(% lang="en-US" style="text-align:left" %)
466 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
467 -
468 -(% lang="en-US" style="text-align:left" %)
469 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
470 -
471 -(% lang="en-US" style="text-align:left" %)
472 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
473 -
474 -(% lang="en-US" style="text-align:left" %)
475 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
476 - "lastName": "" , ~/~/ фамилия
477 - "firstName": "" , ~/~/ имя
478 - "position": "" , ~/~/ должность
479 - "phone": "" , ~/~/ телефон
480 - "organization": "" , ~/~/ организация
481 - "login": "" , ~/~/ логин
482 - "password": "" , ~/~/ пароль 
483 - "email": "" , ~/~/ email
484 - "description": "" , ~/~/ описание
485 - "isEnabled": "" , ~/~/ признак включения
486 - "parentId": "" , ~/~/ Guid родительского агента
487 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
488 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
489 - "kind": "" , ~/~/ тип аутентификации
490 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
491 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
492 -
493 -(% lang="en-US" style="text-align:left" %)
494 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
495 -
496 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
497 -
498 498  (% class="box warningmessage" %)
499 499  (((
500 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
133 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
501 501  )))
502 502  
503 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
136 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
504 504  
505 505  (% style="color:#000000" %)Метод запроса: **PUT**
506 506  
507 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
140 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:
508 508  
509 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
142 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
510 510  
511 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
144 +(% class="western" %)
145 +{{{ "description": "", // описание
146 + "data": "" // данные, связанные со сменой статуса}}}
512 512  
513 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
514 -
515 -(% style="color:#000000" %){
516 -
517 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
518 - "description": "" , ~/~/ описание
519 - "data": "" , ~/~/ данные, связанные со сменой статуса
520 -
521 521  (% style="color:#000000" %)}
522 522  
523 523  (% style="text-align:left" %)
524 524  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
525 525  
526 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
527 527  
528 -(% class="box warningmessage" %)
154 +(% class="box successmessage" %)
529 529  (((
530 -**POST /api/v3/users/disable**
156 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
531 531  )))
532 532  
533 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
159 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
534 534  
535 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
161 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
536 536  
537 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
163 +(% style="color:#000000" %)Метод запроса: **POST**
538 538  
539 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
165 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
540 540  
541 - [ 
542 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
543 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
544 - ]
167 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
545 545  
546 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
169 +(% class="western" %)
170 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
171 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
172 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
173 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
547 547  
548 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
175 +(% style="color:#000000" %)}
549 549  
550 -(% class="box warningmessage" %)
177 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
178 +
179 +(% class="western" style="margin-bottom:19px" %)
180 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
181 +
182 +(% lang="en-US" style="text-align:left" %)
183 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
184 +
185 +
186 +(% class="box errormessage" %)
551 551  (((
552 -**POST /api/v3/users/enable**
188 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
553 553  )))
554 554  
555 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
191 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
556 556  
557 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
193 +(% style="color:#000000" %)Метод запроса: **DELETE**
558 558  
559 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
195 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
560 560  
561 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
197 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
562 562  
563 - [ 
564 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
565 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
566 - ]
199 +(% style="text-align:left" %)
200 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
567 567  
568 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
569 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
570 570  
203 +(% class="box" style="text-align: center;" %)
571 571  (((
572 -В теле ответа:
573 -{
574 - "errorMessages": [
575 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
576 - ],
577 - "users": [
578 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
579 - ]
580 -}
581 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
582 -"users" - массив id пользователей, которых не удалось включить или отключить.
205 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
583 583  )))
584 584  
585 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
586 -
587 587  (% class="box errormessage" %)
588 588  (((
589 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
210 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
590 590  )))
591 591  
592 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
213 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
593 593  
594 594  (% style="color:#000000" %)Метод запроса: **DELETE**
595 595  
596 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
217 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
597 597  
598 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
219 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
599 599  
600 600  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
601 601  
... ... @@ -602,72 +602,51 @@
602 602  (% style="text-align:left" %)
603 603  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
604 604  
605 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
606 606  
607 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
608 -
609 609  (% class="box infomessage" %)
610 610  (((
611 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
229 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
612 612  )))
613 613  
614 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
232 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
615 615  
616 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
234 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
617 617  
618 618  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
619 619  
620 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
238 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
621 621  
622 622  (% style="color:#000000" %)Метод запроса: **GET**
623 623  
624 624  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
625 625  
626 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
244 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
627 627  
628 628  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
629 629  
630 630  (% style="color:#000000" %)Ответ:
631 631  
632 -(((
633 -{
634 - "vehicleId": "", ~/~/ ID объекта
635 - "name": "", ~/~/ Имя объекта
636 - "imei": "", ~/~/ IMEI объекта
637 - "deviceTypeId": , ~/~/ ID типа устройства
638 - "deviceTypeName": "", ~/~/ Название типа устройства
639 - "sim1": "", ~/~/ Номер SIM1
640 - "parentId": "", Номер SIM2
641 - "parentName": "", Наименование клиента-родителя
642 - "modelId": "", ID модели объекта
643 - "modelName": "", Имя модели объекта
644 - "createdAt": "", Дата создания объекта
645 - "mileageCalcMethod": "", Выбранный метод расчета пробега
646 - "counters": { ~/~/ Нормы
647 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
648 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
649 - "mileage": "", ~/~/ Пробег по нормам в метрах
650 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
651 - },
652 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
653 - {
654 - "id": "", ~/~/ ID  задания
655 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
656 - "name": "", ~/~/ Наименование задания
657 - "description": "", ~/~/ Описание задания
658 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
659 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
660 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
661 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
662 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
663 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
664 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
665 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
666 - }
667 - ]
668 -}
669 -)))
250 +(% style="color:#000000" %){
670 670  
252 +(% class="western" %)
253 +{{{ "vehicleId": “”, // идентификатор объекта
254 + "name": "", // имя объекта
255 + "imei": "", // IMEI объекта
256 + "deviceTypeId": “”, // идентификатор устройства объекта
257 + "deviceTypeName": "" // наименование устройства объекта
258 + "parentId": "", // идентификатор клиента-родителя
259 + "parentName": "" // наименование клиента-родителя,
260 + "modelId": "", // идентификатор модели объекта
261 + "modelName": "" // наименование модели объекта,
262 + "unitId": "", // идентификатор подразделения
263 + "unitName": "", // наименование подразделения
264 + "status": “”, // статус объекта
265 + ...
266 + },
267 + ...}}}
268 +
269 +(% style="color:#000000" %)}
270 +
671 671  (% style="text-align:left" %)
672 672  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
673 673  
... ... @@ -674,14 +674,13 @@
674 674  (% style="text-align:left" %)
675 675  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
676 676  
677 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
678 678  
679 679  (% class="box successmessage" %)
680 680  (((
681 -(% lang="en-US" %)**POST /api/v3/vehicles**
280 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
682 682  )))
683 683  
684 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
283 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
685 685  
686 686  (% style="color:#000000" %)Метод запроса: **POST**
687 687  
... ... @@ -689,131 +689,141 @@
689 689  
690 690  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
691 691  
692 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
291 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
693 693  
694 -(% style="color:#000000" %){
695 -
696 - "parentId": "" , ~/~/ ID клиента
697 - "name": "" , ~/~/ имя ТС
698 - "imei": "" , ~/~/ IMEI
699 - "deviceTypeId": "" , ~/~/ ID типа устройства
700 - "modelId": "" , ~/~/ ID модели
701 - "unitId": "" , ~/~/ ID подразделения
702 - "sim1": "" , ~/~/ Номер SIM 1
703 - "sim2": "" , ~/~/ Номер SIM2
704 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
705 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
706 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
707 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
708 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
709 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
710 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
711 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
712 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
713 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
714 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
715 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
716 - "counters": ~/~/ счетчики
717 - {
718 - "mileage": "" , ~/~/ пробег
719 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
720 - "motohours": "" , ~/~/ моточасы
721 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
293 +(% class="western" %)
294 +{{{ "parentId": "", // ID клиента
295 + "name": "", // имя ТС
296 + "imei": "", // IMEI
297 + "deviceTypeId": "",// ID типа устройства
298 + "modelId": "",
299 + "unitId": "", // ID подразделения
300 + "sim1": "", // Номер SIM 1
301 + "sim2": "", // Номер SIM2
302 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
303 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
304 + "consumptionIdle": "",// Расход топлива на холостом ходу
305 + "counters": {
306 + "mileage": "", // пробег
307 + "mileageEnabled": true, // флаг активности счётчика "пробег"
308 + "motohours":"", // моточасы
309 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
310 + },
311 + "cmsv6Parameters": { // параметры CMSv6
312 + "enabled": true, // флаг включения
313 + //"id": "", // идентификатор
314 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
315 + "login": "", // имя учетной записи
316 + "password": "" // пароль учетной записи
722 722   },
723 - "cmsv6Parameters": { ~/~/ параметры CMSv6
724 - "enabled": true, ~/~/ флаг включения
725 - "id": "" , ~/~/ идентификатор
726 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
727 - "login": "" , ~/~/ имя учетной записи
728 - "password": "" ~/~/ пароль учетной записи
729 - },
730 - "inspectionTasks": ~/~/ задания на ТО
318 + "inspectionTasks": [ // задания на ТО
731 731   {
732 - "enabled": "" , ~/~/ Признак включения
733 - "name": "" , ~/~/ Имя задания
734 - "description": "" , ~/~/ Описание задания
735 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
736 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
737 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
738 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
739 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
740 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
741 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
742 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
743 - }
320 + "enabled": "", // Признак включения
321 + "name": "", // Имя задания
322 + "description": "", // Описание задания
323 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
324 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
325 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
326 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
327 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
328 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
329 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
330 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
331 + },
332 + ]}}}
744 744  
745 -(% style="color:#000000" %) }
334 +(% style="color:#000000" %)… }
746 746  
747 747  (% style="color:#000000" %)Ответ:
748 748  
749 749  (% style="color:#000000" %){
750 750  
751 - "vehicleId": "", ~/~/ID ТС 
752 - "parentId": "", ~/~/Guid владельца ТС
753 - "name": "", ~/~/Имя объекта
754 - "imei": "", ~/~/IMEI
755 - "deviceTypeId": "", ~/~/ID типа устройства
756 - "modelId": "", ~/~/ID модели
757 - "unitId": "", ~/~/ID подразделения
758 - "sim1": "", ~/~/SIM1
759 - "sim2": "", ~/~/SIM2
760 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
761 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
762 - "counters": { ~/~/Счётчики
763 - "mileageEnabled": true,
764 - "motohoursEnabled": true,
765 - "mileage": "",
766 - "motohours": 345.0
767 - },
768 - "cmsv6Parameters": { ~/~/Параметры CmsV6
769 - "id": null,
770 - "enabled": true, ~/~/флаг включения
771 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
772 - "login": "", ~/~/ имя учетной записи
773 - "password": "" ~/~/ пароль учетной записи
774 - },
775 - "inspectionTasks": { ~/~/ задания на ТО
776 - "id": "", ~/~/ ID задачи
777 - "enabled": false, ~/~/ Признак включения
778 - "name": "", ~/~/ Имя задания
779 - "description": "", ~/~/ Описание задания
780 - "mileageCondition": "", ~/~/ Условие по пробегу
781 - "lastMileage": "", ~/~/ Пробег (в метрах)
782 - "motohoursCondition": "", ~/~/ Условие по моточасам
783 - "lastMotohours": "", ~/~/ Моточасы
784 - "periodicCondition": "", ~/~/ Условие периодичности по времени
785 - "kind": "", ~/~/ Вид периодичности по времени 
786 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
787 - }
340 +(% class="western" %)
341 +{{{ "vehicleId": "", //ID ТС
342 + "parentId": "", //Guid владельца ТС
343 + "name": "", //Имя объекта
344 + "imei": "", //IMEI
345 + "deviceTypeId": "", //ID типа устройства
346 + "modelId": "", //ID модели
347 + "unitId": "", //ID подразделения
348 + "sim1": "", //SIM1
349 + "sim2": "", //SIM2
350 + "consumptionPer100Km": "", //Расход топлива на 100 км
351 + "consumptionIdle": "", //Расход топлива на холостом ходу
352 + "counters": { //Счётчики
353 + "mileageEnabled": true,
354 + "motohoursEnabled": true,
355 + "mileage": "",
356 + "motohours": 345.0
357 + },
358 + "cmsv6Parameters": { //Параметры CmsV6
359 + "id": null,
360 + "enabled": true, //флаг включения
361 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
362 + "login": "", // имя учетной записи
363 + "password": "" // пароль учетной записи
364 + },
365 + "inspectionTasks": [ // задания на ТО
366 + {
367 + "id": "", // ID задачи
368 + "enabled": false, // Признак включения
369 + "name": "", // Имя задания
370 + "description": "", // Описание задания
371 + "mileageCondition": "", // Условие по пробегу
372 + "lastMileage": "", // Пробег (в метрах)
373 + "motohoursCondition": "", // Условие по моточасам
374 + "lastMotohours": "", // Моточасы
375 + "periodicCondition": "", // Условие периодичности по времени
376 + "kind": "", // Вид периодичности по времени
377 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
378 + }
379 + ]}}}
788 788  
789 789  (% style="text-align:left" %)
790 790  (% style="color:#000000" %)}
791 791  
792 -**Валидация:**
793 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
794 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
795 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
796 796  
797 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
385 +(% class="box warningmessage" %)
386 +(((
387 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
388 +)))
798 798  
390 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
391 +
392 +(% style="color:#000000" %)Метод запроса: **PUT**
393 +
394 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
395 +
396 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
397 +
398 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
399 +
400 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
401 +
402 +(% style="color:#000000" %)Ответ:
403 +
404 +(% lang="en-US" style="text-align:left" %)
405 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
406 +
407 +
799 799  (% class="box successmessage" %)
800 800  (((
801 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
410 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
802 802  )))
803 803  
804 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
413 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
805 805  
806 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
415 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
807 807  
808 808  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
809 809  
810 810  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
811 811  
812 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
421 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
813 813  
814 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
423 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
815 815  
816 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
425 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
817 817  
818 818  (% style="color:#000000" %)Метод запроса: **POST**
819 819  
... ... @@ -821,266 +821,108 @@
821 821  
822 822  (% style="color:#000000" %)В заголовках запроса:
823 823  
824 -(% style="color:#000000" %)− Content-Type: __**application/json**__
433 +(% style="color:#000000" %)− Content-Type: application/json
825 825  
826 826  (% style="color:#000000" %)− X-Auth: Токен авторизации
827 827  
828 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
437 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
829 829  
830 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
439 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
831 831  
832 -{
833 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
834 - "name": null, ~/~/ Имя ТС (string, опционально)
835 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
836 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
837 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
838 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
839 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
840 - "customFields": null ~/~/ значение любого из произвольных полей ТС
841 -}
441 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
842 842  
843 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
443 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
844 844  
845 -(% style="color:#000000" %)Ответ:
445 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
846 846  
847 -(% style="color:#000000" %){
447 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
848 848  
849 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
850 - "name": "" ~/~/ наименование объекта
851 - "imei": "" ~/~/ IMEI объекта
852 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
853 - "deviceTypeName": "" ~/~/ наименование типа устройства
854 - "sim1": "" ~/~/ первый номер телефона
855 - "sim2": "" ~/~/ второй номер телефона
856 - "parentId": "" ~/~/ идентификатор клиента-родителя
857 - "parentName": "" ~/~/ наименование клиента-родителя
858 - "modelId": "" ~/~/ идентификатор модели объекта
859 - "modelName": "" ~/~/ наименование модели объекта
860 - "unitId": "" ~/~/ идентификатор подразделения
861 - "unitName": "" ~/~/ наименование подразделения
862 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
863 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
864 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
865 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
866 - "customFields": [ 
867 - {
868 - "id": "", ~/~/ идентификатор произвольного поля
869 - "name": "", ~/~/ имя произвольного поля
870 - "value": "", ~/~/ значение произвольного поля
871 - "forClient": true, ~/~/ право на отображение у клиента
872 - "forTooltip": false, ~/~/ право на отображение в подсказке
873 - "forReport": false ~/~/ право на отображение в отчетах
874 - }(%%)
875 -(% style="color:#000000" %)}
449 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
876 876  
877 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
451 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
878 878  
879 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
453 +(% style="color:#000000" %)0 - «Блокировка»
880 880  
881 -(% class="box successmessage" %)
882 -(((
883 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
884 -)))
455 +(% style="color:#000000" %)1 - «Активен»,
885 885  
886 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
457 +(% style="color:#000000" %)2 - «Отменен»
887 887  
888 -(% style="color:#000000" %)Метод запроса: **POST**
459 +(% style="color:#000000" %)3 - «Оборудован»
889 889  
890 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
461 +(% style="color:#000000" %)4 - «Диагностика»
891 891  
892 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
463 +(% style="color:#000000" %)5 - «Сервис»
893 893  
894 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
465 +(% style="color:#000000" %)6 - «Демонтаж»
895 895  
896 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
467 +(% style="color:#000000" %)7 - «Монтаж»
897 897  
898 -(% style="color:#000000" %){
469 +(% style="color:#000000" %)8 - «Дозаказ»
899 899  
900 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
901 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
902 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
903 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
904 - "description": "", ~/~/ Описание
905 - "data": "", ~/~/ Данные
906 - "overwrite": false, ~/~/ Флаг перезаписи
907 - "stage": "", ~/~/ Состояние, может быть null
471 +(% style="color:#000000" %)9 - «Обслужен»
908 908  
909 -(% style="color:#000000" %)}
473 +(% style="color:#000000" %)10 - «Списан»
910 910  
911 -(% style="color:#000000" %)Ответ:
475 +(% style="color:#000000" %)11 - «Неисправен»
912 912  
913 -(% style="color:#000000" %){
477 +(% style="color:#000000" %)12 - «Проверен»
914 914  
915 - "status": "", ~/~/ значение статуса
916 - "date": "", ~/~/ Дата смены статуса 
917 - "description": "", ~/~/ Описание
918 - "data": "", ~/~/ Данные
919 - "overwrite": false, ~/~/ Флаг перезаписи
920 - "stage": "", ~/~/ Состояние
921 -
922 922  (% style="text-align:left" %)
923 -(% style="color:#000000" %) }
480 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
924 924  
925 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
926 926  
927 -(% class="box warningmessage" %)
483 +(% class="box successmessage" %)
928 928  (((
929 -(% lang="en-US" %)**PUT /api/v3/vehicles**
485 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
930 930  )))
931 931  
932 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
488 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
933 933  
934 -(% style="color:#000000" %)Метод запроса: **PUT**
490 +(% style="color:#000000" %)Метод запроса: **POST**
935 935  
936 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
492 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
937 937  
494 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
495 +
938 938  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
939 939  
940 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
498 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
941 941  
942 -(% style="color:#000000" %){    
500 +(% class="western" %)
501 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
502 + "date": "", // Дата смены статуса (null если сменить немедленно)
503 + "description": "", // Описание
504 + "data": "", // Данные
505 + "overwrite": false, // Флаг перезаписи
506 + "stage": "", // Состояние, может быть null}}}
943 943  
944 -(((
945 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
946 - "parentId": "", ~/~/ ID клиента
947 - "name": "", ~/~/ имя ТС
948 - "imei": "", ~/~/ IMEI
949 - "deviceTypeId": "", ~/~/ ID типа устройства
950 - "modelId": "", ~/~/ , ID модели    
951 - "unitId": "", ~/~/ подразделения
952 - "sim1": "", ~/~/ SIM 1
953 - "sim2": "", ~/~/ SIM2     (%%)
954 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
955 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
956 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
957 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
958 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
959 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
960 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
961 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
962 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
963 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
964 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
965 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
966 -(% style="color:#000000" %) "counters": 
967 - {
968 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
969 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
970 - "mileage": "", ~/~/ пробег, в метрах 
971 - "motohours": "" ~/~/ моточасы, в секундах
972 - }
973 - "cmsv6Parameters": ~/~/ параметры CMSv6
974 - {       
975 - "id": "", ~/~/ идентификатор
976 - "enabled": true, ~/~/ флаг включения
977 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
978 - "login": "", ~/~/ имя учетной записи
979 - "password": "", ~/~/ пароль учетной записи
980 - }
981 - "inspectionTasks": ~/~/ задания на ТО
982 - {
983 - "id": "", ~/~/ ID задания
984 - "enabled": false, ~/~/ Признак включения
985 - "name": "", ~/~/ Имя задания
986 - "description": "", ~/~/ Описание задания
987 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
988 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
989 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
990 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
991 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
992 - "kind": "", ~/~/ Вид периодичности по времени
993 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
994 - } 
995 -)))
996 -
997 997  (% style="color:#000000" %)}
998 998  
999 -(% style="color:#000000" %)Ответ:
510 +(% style="color:#000000" %)Ответ: {
1000 1000  
1001 -(% lang="en-US" style="text-align:left" %)
1002 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
512 +(% class="western" %)
513 +{{{ "status": "", // значение статуса
514 + "date": "", // Дата смены статуса
515 + "description": "", // Описание
516 + "data": "", // Данные
517 + "overwrite": false, // Флаг перезаписи
518 + "stage": "", // Состояние}}}
1003 1003  
1004 -(% lang="en-US" style="text-align:left" %)
1005 - "vehicleId": "", ~/~/ ID ТС
1006 - "parentId": "", ~/~/ ID клиента
1007 - "name": "", ~/~/ имя ТС
1008 - "imei": "", ~/~/ IMEI
1009 - "deviceTypeId": "", ~/~/ типа устройства
1010 - "modelId": "", ~/~/ ID модели
1011 - "unitId": "", ~/~/ ID подразделения
1012 - "sim1": "", ~/~/ SIM 1
1013 - "sim2": "", ~/~/ SIM2
1014 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1015 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1016 - "counters": 
1017 - {
1018 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1019 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1020 - "mileage": "", ~/~/ пробег
1021 - "motohours": "", ~/~/ моточасы
1022 - }
1023 - "cmsv6Parameters": ~/~/ параметры CMSv6
1024 - {
1025 - "id": ~/~/ идентификатор
1026 - "enabled": true, ~/~/ флаг включения
1027 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1028 - "login": "", ~/~/ имя учетной записи
1029 - "password": "", ~/~/ пароль учетной записи
1030 - }
1031 - "inspectionTasks": ~/~/ задания на ТО
1032 - {
1033 - "id": "", ~/~/ ID задания
1034 - "enabled": false, ~/~/ Признак включения
1035 - "name": "", ~/~/ Имя задания
1036 - "description": "", ~/~/ Описание задания
1037 - "mileageCondition": "", ~/~/ Условие по пробегу
1038 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1039 - "motohoursCondition": "", ~/~/ Условие по моточасам
1040 - "lastMotohours": "", ~/~/ Моточасы
1041 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1042 - "kind": "", ~/~/ Вид периодичности по времени
1043 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1044 - }
520 +(% style="text-align:left" %)
521 +(% style="color:#000000" %)}
1045 1045  
1046 -(% lang="en-US" style="text-align:left" %)
1047 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1048 1048  
1049 -**валидация:**
1050 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1051 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1052 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1053 -
1054 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1055 -
1056 -(% class="box errormessage" %)
524 +(% class="box" lang="en-US" style="text-align: center;" %)
1057 1057  (((
1058 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
526 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1059 1059  )))
1060 1060  
1061 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1062 -
1063 -(% style="color:#000000" %)Метод запроса: **DELETE**
1064 -
1065 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1066 -
1067 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1068 -
1069 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1070 -
1071 -(% style="text-align:left" %)
1072 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1073 -
1074 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1075 -
1076 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1077 -
1078 1078  (% class="box infomessage" %)
1079 1079  (((
1080 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
531 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1081 1081  )))
1082 1082  
1083 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
534 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1084 1084  
1085 1085  (% style="color:#000000" %)Метод запроса: **GET**
1086 1086  
... ... @@ -1088,26 +1088,29 @@
1088 1088  
1089 1089  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1090 1090  
1091 -(% style="color:#000000" %)Ответ:
542 +(% style="color:#000000" %)Ответ: [
1092 1092  
1093 -(% style="color:#000000" %){
544 +(% class="western" %)
545 +{{{ {
546 + "deviceTypeId" : "", // ID типа устройства
547 + "deviceTypeName" : "" // Название типа устройства
548 + },}}}
1094 1094  
1095 - "deviceTypeId" : "", ~/~/ ID типа устройства
1096 - "deviceTypeName" : "" ~/~/ Название типа устройства
1097 -
1098 1098  (% style="text-align:left" %)
1099 -(% style="color:#000000" %)}
551 +(% style="color:#000000" %)…** **]
1100 1100  
1101 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1102 1102  
1103 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
554 +(% class="box" style="text-align: center;" %)
555 +(((
556 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
557 +)))
1104 1104  
1105 1105  (% class="box infomessage" %)
1106 1106  (((
1107 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
561 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1108 1108  )))
1109 1109  
1110 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
564 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1111 1111  
1112 1112  (% style="color:#000000" %)Метод запроса: **GET**
1113 1113  
... ... @@ -1115,16 +1115,19 @@
1115 1115  
1116 1116  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1117 1117  
1118 -(% style="color:#000000" %)Ответ:
572 +(% style="color:#000000" %)Ответ: [
1119 1119  
1120 -(% style="color:#000000" %){
574 +(% class="western" style="margin-bottom:19px" %)
575 +{{{ {}}}
1121 1121  
1122 - "id": "", ~/~/ ID типа датчика 
1123 - "name": "", ~/~/ Название
1124 - "description": "", ~/~/ Описание
577 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1125 1125  
579 +(% class="western" %)
580 +{{{ "description": "" // Описание
581 + },}}}
582 +
1126 1126  (% style="text-align:left" %)
1127 -(% style="color:#000000" %)}
584 +(% style="color:#000000" %)… ]
1128 1128  
1129 1129  
1130 1130  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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