Редактировал(а) Андрей Калиновский 2025/04/21 14:13
<
От версии < 42.1 >
отредактировано Илья Крайнов
на 2022/11/18 17:35
К версии < 13.1 >
отредактировано Артем Шемяков
на 2022/09/01 15:14
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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

Меню

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