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

Меню

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