Last modified by Андрей Калиновский on 2025/03/28 11:43
<
From version < 36.1 >
edited by Илья Крайнов
on 2022/11/17 13:35
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
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -20,39 +20,22 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
31 31  
32 -(% 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]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 -
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}(%%)
42 -
43 -
44 -(% style="color:#000000" %)**Ответ:**
45 -
46 46  (% lang="en-US" %)
47 -(% style="color:#000000" %){
37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
48 48  
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
52 -
53 -(% lang="en-US" %)
54 -}
55 -
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 58  
... ... @@ -61,7 +61,7 @@
61 61  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
47 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -83,32 +83,25 @@
83 83  (% 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 113  
114 114  (% class="box" style="text-align: center;" %)
... ... @@ -121,7 +121,7 @@
121 121  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
100 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -129,110 +129,18 @@
129 129  
130 130  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
131 131  
132 -(% 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»: [ // группы пользователя «», //названия групп «», «» ] }
133 133  
134 -(% style="color:#000000" %){ 
135 - "lastName": "", ~/~/ фамилия
136 - "firstName": "", ~/~/ имя
137 - "position": "", ~/~/ должность
138 - "phone": "", ~/~/ телефон
139 - "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
143 - "description": "", ~/~/ описание
144 - "isEnabled": "", ~/~/ признак включения
145 - "parentId": "", ~/~/ Guid родительского агента
146 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": "" , ~/~/ группы пользователя, названия групп
152 -}
153 -
154 154  (% style="text-align:left" %)
155 -(% 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» //названия групп ] }
156 156  
157 -(% style="text-align:left" %)
158 -(% style="color:#000000; font-weight:normal" %){    
159 159  
160 -(% style="text-align:left" %)
161 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
162 - "lastName": "" , ~/~/ Фамилия ,
163 - "firstName": "" , ~/~/ Имя
164 - "position": "" , ~/~/ Должность
165 - "phone": "" , ~/~/ Телефон
166 - "organization": "" , ~/~/ Организация
167 - "login": "" , ~/~/ Логин
168 - "password": "" , ~/~/ Пароль
169 - "email": "" , ~/~/ Email
170 - "description": "" , ~/~/ Описание
171 - "isEnabled": "" , ~/~/ Признак включения
172 - "parentId": "" , ~/~/ Guid родительского агента
173 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
174 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 - "kind": "" , ~/~/ тип аутентификации
176 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
178 -
179 -(% style="text-align:left" %)
180 -(% style="color:#000000; font-weight:normal" %)}
181 -
182 -
183 -(% class="box successmessage" %)
184 -(((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
186 -)))
187 -
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 -
190 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 -
192 -(% style="color:#000000" %)Метод запроса: **POST**
193 -
194 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
195 -
196 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
197 -
198 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
199 -
200 -(% style="color:#000000" %){
201 -
202 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
206 -
207 -(% style="color:#000000" %)}
208 -
209 -(% style="color:#000000" %)Ответ:
210 -
211 -(% style="color:#000000" %){         (%%)
212 -
213 - "id": "" , ~/~/ идентификатор пользователя
214 - "lastName": "" , ~/~/ фамилия
215 - "firstName": "" , ~/~/ имя
216 - "position": "" , ~/~/ должность
217 - "phone": "" , ~/~/ телефон
218 - "parentId": "" , ~/~/ идентификатор клиента-родителя
219 - "parentName": "" , ~/~/ наименование клиента-родителя
220 - "organization": "" , ~/~/ организация
221 - "login": "" , ~/~/ логин
222 - "email": "" , ~/~/ E-mail
223 - "sessionDuration":"", ~/~/ длительность сессии в минутах
224 - "status": "1",  ~/~/ статус пользователя
225 - "astLogged": "", ~/~/ дата/время последней авторизации
226 -
227 -(% style="color:#000000" %)}
228 -
229 -
230 230  (% class="box warningmessage" %)
231 231  (((
232 232  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
119 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -241,86 +241,26 @@
241 241  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242 242  
243 243  (% lang="en-US" style="text-align:left" %)
244 -(% 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» //названия групп ] }  //
245 245  
246 -(% lang="en-US" style="text-align:left" %)
247 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
248 248  
249 -(% lang="en-US" style="text-align:left" %)
250 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
251 - "lastName": "" , ~/~/ фамилия
252 - "firstName": "" , ~/~/ имя
253 - "position": "" , ~/~/ должность
254 - "phone": "" , ~/~/ телефон
255 - "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
260 - "isEnabled": "" , ~/~/ признак включения
261 - "parentId": "" , ~/~/ Guid родительского агента
262 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 - "kind": "" , ~/~/ тип аутентификации
266 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
267 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
268 -
269 -(% lang="en-US" style="text-align:left" %)
270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
271 -
272 -(% lang="en-US" style="text-align:left" %)
273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
274 -
275 -(% lang="en-US" style="text-align:left" %)
276 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
277 -
278 -(% lang="en-US" style="text-align:left" %)
279 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
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 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 - "kind": "" , ~/~/ тип аутентификации
294 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
296 -
297 -(% lang="en-US" style="text-align:left" %)
298 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
299 -
300 -
301 301  (% class="box warningmessage" %)
302 302  (((
303 -(% 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}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
136 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
310 -(% 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} Параметр запроса:
311 311  
312 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
142 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
313 313  
314 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
144 +(% class="western" %)
145 +{{{ "description": "", // описание
146 + "data": "" // данные, связанные со сменой статуса}}}
315 315  
316 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
317 -
318 -(% style="color:#000000" %){
319 -
320 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
321 - "description": "" , ~/~/ описание
322 - "data": "" , ~/~/ данные, связанные со сменой статуса
323 -
324 324  (% style="color:#000000" %)}
325 325  
326 326  (% style="text-align:left" %)
... ... @@ -327,73 +327,72 @@
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
329 329  
330 -(% class="box warningmessage" %)
154 +(% class="box successmessage" %)
331 331  (((
332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
156 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
333 333  )))
334 334  
335 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
159 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
336 336  
337 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
161 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
338 338  
339 -(% 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**
340 340  
341 -(% 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]]
342 342  
343 - [ 
344 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
345 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
346 - ]
167 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
347 347  
348 -(% 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 - неважно}}}
349 349  
175 +(% style="color:#000000" %)}
350 350  
351 -(% 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" %)
352 352  (((
353 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
188 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
354 354  )))
355 355  
356 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
191 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
357 357  
358 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
193 +(% style="color:#000000" %)Метод запроса: **DELETE**
359 359  
360 -(% 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}
361 361  
362 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
197 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
363 363  
364 - [ 
365 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
366 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
367 - ]
199 +(% style="text-align:left" %)
200 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
368 368  
369 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371 371  
372 -В теле ответа:
373 -{
374 - "errorMessages": [
375 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
376 - ],
377 - "users": [
378 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
379 - ]
380 -}
381 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 -"users" - массив id пользователей, которых не удалось включить или отключить.
383 -
203 +(% class="box" style="text-align: center;" %)
204 +(((
205 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
206 +)))
384 384  
385 385  (% class="box errormessage" %)
386 386  (((
387 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
210 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
388 388  )))
389 389  
390 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
213 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
391 391  
392 392  (% style="color:#000000" %)Метод запроса: **DELETE**
393 393  
394 -(% 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}
395 395  
396 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
219 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
397 397  
398 398  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
399 399  
... ... @@ -401,11 +401,6 @@
401 401  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
402 402  
403 403  
404 -(% class="box" style="text-align: center;" %)
405 -(((
406 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
407 -)))
408 -
409 409  (% class="box infomessage" %)
410 410  (((
411 411  (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -413,94 +413,43 @@
413 413  
414 414  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
415 415  
416 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
234 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
417 417  
418 418  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
419 419  
420 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
238 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
421 421  
422 422  (% style="color:#000000" %)Метод запроса: **GET**
423 423  
424 424  (% 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>
425 425  
426 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
244 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
427 427  
428 428  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
429 429  
430 430  (% style="color:#000000" %)Ответ:
431 431  
432 -{
250 +(% style="color:#000000" %){
433 433  
434 - "vehicleId": "", ~/~/ ID объекта
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 + ...}}}
435 435  
436 - "name": "", ~/~/ Имя объекта
269 +(% style="color:#000000" %)}
437 437  
438 - "imei": "", ~/~/ IMEI объекта
439 -
440 - "deviceTypeId": , ~/~/ ID типа устройства
441 -
442 - "deviceTypeName": "", ~/~/ Название типа устройства
443 -
444 - "sim1": "", ~/~/ Номер SIM1
445 -
446 - "parentId": "", Номер SIM2
447 -
448 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
449 -
450 - "modelId": "", ID модели объекта
451 -
452 - "modelName": "", Имя модели объекта
453 -
454 - "createdAt": "", Дата создания объекта
455 -
456 - "mileageCalcMethod": "", Выбранный метод расчета пробега
457 -
458 - "counters": { ~/~/ Нормы
459 -
460 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
461 -
462 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
463 -
464 - "mileage": "", ~/~/ Пробег по нормам в метрах
465 -
466 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
467 -
468 - },
469 -
470 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471 -
472 - {
473 -
474 - "id": "", ~/~/ ID  задания
475 -
476 - "enabled": "", ~/~/ Флаг активности задания
477 -
478 - "name": "", ~/~/ Наименование задания
479 -
480 - "description": "", ~/~/ Описание задания
481 -
482 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
483 -
484 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
485 -
486 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
487 -
488 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
489 -
490 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491 -
492 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 -
494 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495 -
496 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497 -
498 - }
499 -
500 - ]
501 -
502 -}
503 -
504 504  (% style="text-align:left" %)
505 505  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
506 506  
... ... @@ -513,7 +513,7 @@
513 513  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
514 514  )))
515 515  
516 -(% 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**).
517 517  
518 518  (% style="color:#000000" %)Метод запроса: **POST**
519 519  
... ... @@ -521,130 +521,141 @@
521 521  
522 522  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
523 523  
524 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
291 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
525 525  
526 -(% style="color:#000000" %){
527 -
528 - "parentId": "" , ~/~/ ID клиента
529 - "name": "" , ~/~/ имя ТС
530 - "imei": "" , ~/~/ IMEI
531 - "deviceTypeId": "" , ~/~/ ID типа устройства
532 - "modelId": "" , ~/~/ ID модели
533 - "unitId": "" , ~/~/ ID подразделения
534 - "sim1": "" , ~/~/ Номер SIM 1
535 - "sim2": "" , ~/~/ Номер SIM2
536 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
537 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
538 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
539 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
540 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
541 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
542 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
543 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
544 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
545 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
546 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
547 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
548 - "counters": ~/~/ счетчики
549 - {
550 - "mileage": "" , ~/~/ пробег
551 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
552 - "motohours": "" , ~/~/ моточасы
553 - "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": "" // пароль учетной записи
554 554   },
555 - "cmsv6Parameters": { ~/~/ параметры CMSv6
556 - "enabled": true, ~/~/ флаг включения
557 - "id": "" , ~/~/ идентификатор
558 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
559 - "login": "" , ~/~/ имя учетной записи
560 - "password": "" ~/~/ пароль учетной записи
561 - },
562 - "inspectionTasks": ~/~/ задания на ТО
318 + "inspectionTasks": [ // задания на ТО
563 563   {
564 - "enabled": "" , ~/~/ Признак включения
565 - "name": "" , ~/~/ Имя задания
566 - "description": "" , ~/~/ Описание задания
567 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
568 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
569 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
570 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
571 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
572 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
573 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
574 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
575 - }
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 + ]}}}
576 576  
577 -(% style="color:#000000" %) }
334 +(% style="color:#000000" %)… }
578 578  
579 579  (% style="color:#000000" %)Ответ:
580 580  
581 581  (% style="color:#000000" %){
582 582  
583 - "vehicleId": "", ~/~/ID ТС 
584 - "parentId": "", ~/~/Guid владельца ТС
585 - "name": "", ~/~/Имя объекта
586 - "imei": "", ~/~/IMEI
587 - "deviceTypeId": "", ~/~/ID типа устройства
588 - "modelId": "", ~/~/ID модели
589 - "unitId": "", ~/~/ID подразделения
590 - "sim1": "", ~/~/SIM1
591 - "sim2": "", ~/~/SIM2
592 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
593 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
594 - "counters": { ~/~/Счётчики
595 - "mileageEnabled": true,
596 - "motohoursEnabled": true,
597 - "mileage": "",
598 - "motohours": 345.0
599 - },
600 - "cmsv6Parameters": { ~/~/Параметры CmsV6
601 - "id": null,
602 - "enabled": true, ~/~/флаг включения
603 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
604 - "login": "", ~/~/ имя учетной записи
605 - "password": "" ~/~/ пароль учетной записи
606 - },
607 - "inspectionTasks": { ~/~/ задания на ТО
608 - "id": "", ~/~/ ID задачи
609 - "enabled": false, ~/~/ Признак включения
610 - "name": "", ~/~/ Имя задания
611 - "description": "", ~/~/ Описание задания
612 - "mileageCondition": "", ~/~/ Условие по пробегу
613 - "lastMileage": "", ~/~/ Пробег (в метрах)
614 - "motohoursCondition": "", ~/~/ Условие по моточасам
615 - "lastMotohours": "", ~/~/ Моточасы
616 - "periodicCondition": "", ~/~/ Условие периодичности по времени
617 - "kind": "", ~/~/ Вид периодичности по времени 
618 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
619 - }
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 + ]}}}
620 620  
621 621  (% style="text-align:left" %)
622 622  (% style="color:#000000" %)}
623 623  
624 -**Валидация:**
625 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
626 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
627 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
628 628  
385 +(% class="box warningmessage" %)
386 +(((
387 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
388 +)))
629 629  
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 +
630 630  (% class="box successmessage" %)
631 631  (((
632 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
410 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
633 633  )))
634 634  
635 635  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
636 636  
637 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
415 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
638 638  
639 639  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
640 640  
641 641  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
642 642  
643 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
421 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
644 644  
645 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
423 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
646 646  
647 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
425 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
648 648  
649 649  (% style="color:#000000" %)Метод запроса: **POST**
650 650  
... ... @@ -652,243 +652,95 @@
652 652  
653 653  (% style="color:#000000" %)В заголовках запроса:
654 654  
655 -(% style="color:#000000" %)− Content-Type: __**application/json**__
433 +(% style="color:#000000" %)− Content-Type: application/json
656 656  
657 657  (% style="color:#000000" %)− X-Auth: Токен авторизации
658 658  
659 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
437 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
660 660  
661 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
439 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
662 662  
663 -(% class="western" style="color:#000000" %)##{##
441 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
664 664  
665 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
666 - "name": null, ~/~/ Имя ТС (string, опционально) 
667 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
668 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
669 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
670 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
671 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
672 -(% style="color:#000000" %)}
443 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
673 673  
674 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
445 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
675 675  
676 -(% style="color:#000000" %)Ответ:
447 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
677 677  
678 -(% style="color:#000000" %){
449 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
679 679  
680 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
681 - "name": "" ~/~/ наименование объекта
682 - "imei": "" ~/~/ IMEI объекта
683 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
684 - "deviceTypeName": "" ~/~/ наименование типа устройства
685 - "sim1": "" ~/~/ первый номер телефона
686 - "sim2": "" ~/~/ второй номер телефона
687 - "parentId": "" ~/~/ идентификатор клиента-родителя
688 - "parentName": "" ~/~/ наименование клиента-родителя
689 - "modelId": "" ~/~/ идентификатор модели объекта
690 - "modelName": "" ~/~/ наименование модели объекта
691 - "unitId": "" ~/~/ идентификатор подразделения
692 - "unitName": "" ~/~/ наименование подразделения
693 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
694 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
695 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
696 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
697 -(% style="color:#000000" %)}
451 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
698 698  
699 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
453 +(% style="color:#000000" %)0 - «Блокировка»
700 700  
455 +(% style="color:#000000" %)1 - «Активен»,
701 701  
702 -(% class="box successmessage" %)
703 -(((
704 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
705 -)))
457 +(% style="color:#000000" %)2 - «Отменен»
706 706  
707 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
459 +(% style="color:#000000" %)3 - «Оборудован»
708 708  
709 -(% style="color:#000000" %)Метод запроса: **POST**
461 +(% style="color:#000000" %)4 - «Диагностика»
710 710  
711 -(% 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}
463 +(% style="color:#000000" %)5 - «Сервис»
712 712  
713 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
465 +(% style="color:#000000" %)6 - «Демонтаж»
714 714  
715 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
467 +(% style="color:#000000" %)7 - «Монтаж»
716 716  
717 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
469 +(% style="color:#000000" %)8 - «Дозаказ»
718 718  
719 -(% style="color:#000000" %){
471 +(% style="color:#000000" %)9 - «Обслужен»
720 720  
721 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
722 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
723 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
724 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
725 - "description": "", ~/~/ Описание
726 - "data": "", ~/~/ Данные
727 - "overwrite": false, ~/~/ Флаг перезаписи
728 - "stage": "", ~/~/ Состояние, может быть null
473 +(% style="color:#000000" %)10 - «Списан»
729 729  
730 -(% style="color:#000000" %)}
475 +(% style="color:#000000" %)11 - «Неисправен»
731 731  
732 -(% style="color:#000000" %)Ответ:
477 +(% style="color:#000000" %)12 - «Проверен»
733 733  
734 -(% style="color:#000000" %){
735 -
736 - "status": "", ~/~/ значение статуса
737 - "date": "", ~/~/ Дата смены статуса 
738 - "description": "", ~/~/ Описание
739 - "data": "", ~/~/ Данные
740 - "overwrite": false, ~/~/ Флаг перезаписи
741 - "stage": "", ~/~/ Состояние
742 -
743 743  (% style="text-align:left" %)
744 -(% style="color:#000000" %) }
480 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
745 745  
746 746  
747 -(% class="box warningmessage" %)
483 +(% class="box successmessage" %)
748 748  (((
749 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
485 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
750 750  )))
751 751  
752 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
488 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
753 753  
754 -(% style="color:#000000" %)Метод запроса: **PUT**
490 +(% style="color:#000000" %)Метод запроса: **POST**
755 755  
756 -(% 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}
757 757  
494 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
495 +
758 758  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
759 759  
760 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
498 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
761 761  
762 -(% 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}}}
763 763  
764 -(((
765 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
766 - "parentId": "", ~/~/ ID клиента
767 - "name": "", ~/~/ имя ТС
768 - "imei": "", ~/~/ IMEI
769 - "deviceTypeId": "", ~/~/ ID типа устройства
770 - "modelId": "", ~/~/ , ID модели    
771 - "unitId": "", ~/~/ подразделения
772 - "sim1": "", ~/~/ SIM 1
773 - "sim2": "", ~/~/ SIM2     (%%)
774 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
775 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
776 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
777 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
778 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
779 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
780 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
781 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
782 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
783 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
784 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
785 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
786 -(% style="color:#000000" %) "counters": 
787 - {
788 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
789 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
790 - "mileage": "", ~/~/ пробег, в метрах 
791 - "motohours": "" ~/~/ моточасы, в секундах
792 - }
793 - "cmsv6Parameters": ~/~/ параметры CMSv6
794 - {       
795 - "id": "", ~/~/ идентификатор
796 - "enabled": true, ~/~/ флаг включения
797 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
798 - "login": "", ~/~/ имя учетной записи
799 - "password": "", ~/~/ пароль учетной записи
800 - }
801 - "inspectionTasks": ~/~/ задания на ТО
802 - {
803 - "id": "", ~/~/ ID задания
804 - "enabled": false, ~/~/ Признак включения
805 - "name": "", ~/~/ Имя задания
806 - "description": "", ~/~/ Описание задания
807 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
808 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
809 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
810 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
811 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
812 - "kind": "", ~/~/ Вид периодичности по времени
813 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
814 - } 
815 -)))
816 -
817 817  (% style="color:#000000" %)}
818 818  
819 -(% style="color:#000000" %)Ответ:
510 +(% style="color:#000000" %)Ответ: {
820 820  
821 -(% lang="en-US" style="text-align:left" %)
822 -(% 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": "", // Состояние}}}
823 823  
824 -(% lang="en-US" style="text-align:left" %)
825 - "vehicleId": "", ~/~/ ID ТС
826 - "parentId": "", ~/~/ ID клиента
827 - "name": "", ~/~/ имя ТС
828 - "imei": "", ~/~/ IMEI
829 - "deviceTypeId": "", ~/~/ типа устройства
830 - "modelId": "", ~/~/ ID модели
831 - "unitId": "", ~/~/ ID подразделения
832 - "sim1": "", ~/~/ SIM 1
833 - "sim2": "", ~/~/ SIM2
834 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
835 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
836 - "counters": 
837 - {
838 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
839 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
840 - "mileage": "", ~/~/ пробег
841 - "motohours": "", ~/~/ моточасы
842 - }
843 - "cmsv6Parameters": ~/~/ параметры CMSv6
844 - {
845 - "id": ~/~/ идентификатор
846 - "enabled": true, ~/~/ флаг включения
847 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
848 - "login": "", ~/~/ имя учетной записи
849 - "password": "", ~/~/ пароль учетной записи
850 - }
851 - "inspectionTasks": ~/~/ задания на ТО
852 - {
853 - "id": "", ~/~/ ID задания
854 - "enabled": false, ~/~/ Признак включения
855 - "name": "", ~/~/ Имя задания
856 - "description": "", ~/~/ Описание задания
857 - "mileageCondition": "", ~/~/ Условие по пробегу
858 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
859 - "motohoursCondition": "", ~/~/ Условие по моточасам
860 - "lastMotohours": "", ~/~/ Моточасы
861 - "periodicCondition": "", ~/~/ Условие периодичности по времени
862 - "kind": "", ~/~/ Вид периодичности по времени
863 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
864 - }
865 -
866 -(% lang="en-US" style="text-align:left" %)
867 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
868 -
869 -**валидация:**
870 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
871 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
872 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
873 -
874 -
875 -(% class="box errormessage" %)
876 -(((
877 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
878 -)))
879 -
880 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
881 -
882 -(% style="color:#000000" %)Метод запроса: **DELETE**
883 -
884 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
885 -
886 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
887 -
888 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
889 -
890 890  (% style="text-align:left" %)
891 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
521 +(% style="color:#000000" %)}
892 892  
893 893  
894 894  (% class="box" lang="en-US" style="text-align: center;" %)
... ... @@ -901,7 +901,7 @@
901 901  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
902 902  )))
903 903  
904 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
534 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
905 905  
906 906  (% style="color:#000000" %)Метод запроса: **GET**
907 907  
... ... @@ -909,15 +909,16 @@
909 909  
910 910  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911 911  
912 -(% style="color:#000000" %)Ответ:
542 +(% style="color:#000000" %)Ответ: [
913 913  
914 -(% style="color:#000000" %){
544 +(% class="western" %)
545 +{{{ {
546 + "deviceTypeId" : "", // ID типа устройства
547 + "deviceTypeName" : "" // Название типа устройства
548 + },}}}
915 915  
916 - "deviceTypeId" : "", ~/~/ ID типа устройства
917 - "deviceTypeName" : "" ~/~/ Название типа устройства
918 -
919 919  (% style="text-align:left" %)
920 -(% style="color:#000000" %)}
551 +(% style="color:#000000" %)…** **]
921 921  
922 922  
923 923  (% class="box" style="text-align: center;" %)
... ... @@ -930,7 +930,7 @@
930 930  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
931 931  )))
932 932  
933 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
564 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
934 934  
935 935  (% style="color:#000000" %)Метод запроса: **GET**
936 936  
... ... @@ -938,16 +938,19 @@
938 938  
939 939  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
940 940  
941 -(% style="color:#000000" %)Ответ:
572 +(% style="color:#000000" %)Ответ: [
942 942  
943 -(% style="color:#000000" %){
574 +(% class="western" style="margin-bottom:19px" %)
575 +{{{ {}}}
944 944  
945 - "id": "", ~/~/ ID типа датчика 
946 - "name": "", ~/~/ Название
947 - "description": "", ~/~/ Описание
577 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
948 948  
579 +(% class="western" %)
580 +{{{ "description": "" // Описание
581 + },}}}
582 +
949 949  (% style="text-align:left" %)
950 -(% style="color:#000000" %)}
584 +(% style="color:#000000" %)… ]
951 951  
952 952  
953 953  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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