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

Меню

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