<
From version < 21.10 >
edited by Артем Шемяков
on 2022/09/02 09:45
To version < 16.2 >
edited by Артем Шемяков
on 2022/09/01 16:25
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -34,18 +34,8 @@
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% lang="en-US" %)
37 -(% style="color:#000000" %)**Ответ:**
37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
38 38  
39 -(% lang="en-US" %)
40 -(% style="color:#000000" %){
41 -
42 -(% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
45 -
46 -(% lang="en-US" %)
47 - }
48 -
49 49  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50 50  
51 51  
... ... @@ -92,135 +92,98 @@
92 92  
93 93  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94 94  
95 -(% style="color:#000000" %)Ответ:
85 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
96 96  
97 -(% style="color:#000000" %){
98 - "agentId": "", ~/~/ идентификатор клиента
99 - "parentId": "", ~/~/ идентификатор клиента-родителя
100 - "name": "", ~/~/ наименование клиента
101 - "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента1
103 - "status": "", ~/~/ статус клиента
104 - }
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" %)]
105 105  
106 106  
107 -(% 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" %)]
108 -
109 -
110 -(% class="box" style="text-align: center;" %)
90 +(% class="box" lang="en-US" style="text-align: center;" %)
111 111  (((
112 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
92 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
113 113  )))
114 114  
115 -(% class="box successmessage" %)
95 +(% class="box infomessage" %)
116 116  (((
117 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
97 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
118 118  )))
119 119  
120 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
100 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
121 121  
122 -(% style="color:#000000" %)Метод запроса: **POST**
102 +(% style="color:#000000" %)Метод запроса: **GET**
123 123  
124 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
104 +(% 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]]
125 125  
126 126  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
127 127  
128 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
108 +(% style="color:#000000" %)Ответ: [
129 129  
130 -(% style="color:#000000" %){ 
131 - "lastName": "", ~/~/ фамилия
132 - "firstName": "", ~/~/ имя
133 - "position": "", ~/~/ должность
134 - "phone": "", ~/~/ телефон
135 - "organization": "", ~/~/ организация
136 - "login": "", ~/~/ логин
137 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 - "email": "", ~/~/ email
139 - "description": "", ~/~/ описание
140 - "isEnabled": "", ~/~/ признак включения
141 - "parentId": "", ~/~/ Guid родительского агента
142 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
143 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
144 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
145 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 - "groups": "" , ~/~/ группы пользователя, названия групп
148 - }
110 +(% class="western" %)
111 +{{{ {
112 + "deviceTypeId" : "", // ID типа устройства
113 + "deviceTypeName" : "" // Название типа устройства
114 + },}}}
149 149  
150 150  (% style="text-align:left" %)
151 -(% style="color:#000000; font-weight:normal" %)Ответ:
117 +(% style="color:#000000" %)…** **]
152 152  
153 -(% style="text-align:left" %)
154 -(% style="color:#000000; font-weight:normal" %){    
155 155  
156 -(% style="text-align:left" %)
157 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
158 - "lastName": "" , ~/~/ Фамилия ,
159 - "firstName": "" , ~/~/ Имя
160 - "position": "" , ~/~/ Должность
161 - "phone": "" , ~/~/ Телефон
162 - "organization": "" , ~/~/ Организация
163 - "login": "" , ~/~/ Логин
164 - "password": "" , ~/~/ Пароль
165 - "email": "" , ~/~/ Email
166 - "description": "" , ~/~/ Описание
167 - "isEnabled": "" , ~/~/ Признак включения
168 - "parentId": "" , ~/~/ Guid родительского агента
169 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
170 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
171 - "kind": "" , ~/~/ тип аутентификации
172 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
173 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
120 +(% class="box" style="text-align: center;" %)
121 +(((
122 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
123 +)))
174 174  
175 -(% style="text-align:left" %)
176 -(% style="color:#000000; font-weight:normal" %) }
177 -
178 -
179 -(% class="box successmessage" %)
125 +(% class="box infomessage" %)
180 180  (((
181 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
127 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
182 182  )))
183 183  
184 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
130 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
185 185  
186 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
132 +(% style="color:#000000" %)Метод запроса: **GET**
187 187  
188 -(% style="color:#000000" %)Метод запроса: **POST**
134 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
189 189  
190 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
136 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
191 191  
192 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
138 +(% style="color:#000000" %)Ответ: [
193 193  
194 -(% style="color:#000000" %){
140 +(% class="western" style="margin-bottom:19px" %)
141 +{{{ {}}}
195 195  
196 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
197 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
198 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
143 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
200 200  
201 -(% style="color:#000000" %) }
145 +(% class="western" %)
146 +{{{ "description": "" // Описание
147 + },}}}
202 202  
203 -(% style="color:#000000" %)Ответ:
149 +(% style="text-align:left" %)
150 +(% style="color:#000000" %)… ]
204 204  
205 -(% style="color:#000000" %){         (%%)
206 206  
207 - "id": "" , ~/~/ идентификатор пользователя
208 - "lastName": "" , ~/~/ фамилия
209 - "firstName": "" , ~/~/ имя
210 - "position": "" , ~/~/ должность
211 - "phone": "" , ~/~/ телефон
212 - "parentId": "" , ~/~/ идентификатор клиента-родителя
213 - "parentName": "" , ~/~/ наименование клиента-родителя
214 - "organization": "" , ~/~/ организация
215 - "login": "" , ~/~/ логин
216 - "email": "" , ~/~/ E-mail
217 - "sessionDuration":"", ~/~/ длительность сессии в минутах
218 - "status": "1",  ~/~/ статус пользователя
219 - "astLogged": "", ~/~/ дата/время последней авторизации
153 +(% class="box" style="text-align: center;" %)
154 +(((
155 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
156 +)))
220 220  
221 -(% style="color:#000000" %) }
158 +(% class="box successmessage" %)
159 +(((
160 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
161 +)))
222 222  
163 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
223 223  
165 +(% style="color:#000000" %)Метод запроса: **POST**
166 +
167 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
168 +
169 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
170 +
171 +(% 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»: [ // группы пользователя «», //названия групп «», «» ] }
172 +
173 +(% style="text-align:left" %)
174 +(% 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» //названия групп ] }
175 +
176 +
224 224  (% class="box warningmessage" %)
225 225  (((
226 226  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -235,90 +235,62 @@
235 235  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
236 236  
237 237  (% lang="en-US" style="text-align:left" %)
238 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
191 +(% 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» //названия групп ] }  //
239 239  
240 -(% lang="en-US" style="text-align:left" %)
241 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
242 242  
243 -(% lang="en-US" style="text-align:left" %)
244 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
245 - "lastName": "" , ~/~/ фамилия
246 - "firstName": "" , ~/~/ имя
247 - "position": "" , ~/~/ должность
248 - "phone": "" , ~/~/ телефон
249 - "organization": "" , ~/~/ организация
250 - "login": "" , ~/~/ логин
251 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
252 - "email": "" , ~/~/ email
253 - "description": "" , ~/~/ описание
254 - "isEnabled": "" , ~/~/ признак включения
255 - "parentId": "" , ~/~/ Guid родительского агента
256 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
257 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
258 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
259 - "kind": "" , ~/~/ тип аутентификации
260 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
261 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
194 +(% class="box warningmessage" %)
195 +(((
196 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
197 +)))
262 262  
263 -(% lang="en-US" style="text-align:left" %)
264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
199 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
265 265  
266 -(% lang="en-US" style="text-align:left" %)
267 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
201 +(% style="color:#000000" %)Метод запроса: **PUT**
268 268  
269 -(% lang="en-US" style="text-align:left" %)
270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{     //
203 +(% 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} Параметр запроса:
271 271  
272 -(% lang="en-US" style="text-align:left" %)
273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
274 - "lastName": "" , ~/~/ фамилия
275 - "firstName": "" , ~/~/ имя
276 - "position": "" , ~/~/ должность
277 - "phone": "" , ~/~/ телефон
278 - "organization": "" , ~/~/ организация
279 - "login": "" , ~/~/ логин
280 - "password": "" , ~/~/ пароль 
281 - "email": "" , ~/~/ email
282 - "description": "" , ~/~/ описание
283 - "isEnabled": "" , ~/~/ признак включения
284 - "parentId": "" , ~/~/ Guid родительского агента
285 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
286 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
287 - "kind": "" , ~/~/ тип аутентификации
288 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
205 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
290 290  
291 -(% lang="en-US" style="text-align:left" %)
292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
207 +(% class="western" %)
208 +{{{ "description": "", // описание
209 + "data": "" // данные, связанные со сменой статуса}}}
293 293  
211 +(% style="color:#000000" %)}
294 294  
295 -(% class="box warningmessage" %)
213 +(% style="text-align:left" %)
214 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
215 +
216 +
217 +(% class="box successmessage" %)
296 296  (((
297 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
219 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
298 298  )))
299 299  
300 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
222 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
301 301  
302 -(% style="color:#000000" %)Метод запроса: **PUT**
224 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
303 303  
304 -(% 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}
226 +(% style="color:#000000" %)Метод запроса: **POST**
305 305  
306 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
228 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
307 307  
308 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
230 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
309 309  
310 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
232 +(% class="western" %)
233 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
234 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
235 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
236 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
311 311  
312 -(% style="color:#000000" %){
238 +(% style="color:#000000" %)}
313 313  
314 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
315 - "description": "" , ~/~/ описание
316 - "data": "" , ~/~/ данные, связанные со сменой статуса
240 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
317 317  
318 - (% style="color:#000000" %)}
242 +(% class="western" style="margin-bottom:19px" %)
243 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
319 319  
320 -(% style="text-align:left" %)
321 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
245 +(% lang="en-US" style="text-align:left" %)
246 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
322 322  
323 323  
324 324  (% class="box errormessage" %)
... ... @@ -332,10 +332,8 @@
332 332  
333 333  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
334 334  
335 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
260 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
336 336  
337 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
338 -
339 339  (% style="text-align:left" %)
340 340  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
341 341  
... ... @@ -345,6 +345,25 @@
345 345  (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
346 346  )))
347 347  
271 +(% class="box errormessage" %)
272 +(((
273 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
274 +)))
275 +
276 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
277 +
278 +(% style="color:#000000" %)Метод запроса: **DELETE**
279 +
280 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
281 +
282 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
283 +
284 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
285 +
286 +(% style="text-align:left" %)
287 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
288 +
289 +
348 348  (% class="box infomessage" %)
349 349  (((
350 350  (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -370,20 +370,24 @@
370 370  
371 371  (% style="color:#000000" %){
372 372  
373 - "vehicleId": "" , ~/~/ идентификатор объекта
374 - "name": "" , ~/~/ имя объекта
375 - "imei": "" , ~/~/ IMEI объекта
376 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
377 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
378 - "parentId": "" , ~/~/ идентификатор клиента-родителя
379 - "parentName": "" , ~/~/ наименование клиента-родителя,
380 - "modelId": "" , ~/~/ идентификатор модели объекта
381 - "modelName": "" , ~/~/ наименование модели объекта,
382 - "unitId": "" , ~/~/ идентификатор подразделения
383 - "unitName": "" , ~/~/ наименование подразделения
384 - "status": "" , ~/~/ статус объекта
315 +(% class="western" %)
316 +{{{ "vehicleId": “”, // идентификатор объекта
317 + "name": "", // имя объекта
318 + "imei": "", // IMEI объекта
319 + "deviceTypeId": “”, // идентификатор устройства объекта
320 + "deviceTypeName": "" // наименование устройства объекта
321 + "parentId": "", // идентификатор клиента-родителя
322 + "parentName": "" // наименование клиента-родителя,
323 + "modelId": "", // идентификатор модели объекта
324 + "modelName": "" // наименование модели объекта,
325 + "unitId": "", // идентификатор подразделения
326 + "unitName": "", // наименование подразделения
327 + "status": “”, // статус объекта
328 + ...
329 + },
330 + ...}}}
385 385  
386 - }
332 +(% style="color:#000000" %)}
387 387  
388 388  (% style="text-align:left" %)
389 389  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -405,358 +405,237 @@
405 405  
406 406  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
407 407  
408 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
354 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
409 409  
410 -(% style="color:#000000" %){
411 -
412 - "parentId": "" , ~/~/ ID клиента
413 - "name": "" , ~/~/ имя ТС
414 - "imei": "" , ~/~/ IMEI
415 - "deviceTypeId": "" , ~/~/ ID типа устройства
416 - "modelId": "" , ~/~/ ID модели
417 - "unitId": "" , ~/~/ ID подразделения
418 - "sim1": "" , ~/~/ Номер SIM 1
419 - "sim2": "" , ~/~/ Номер SIM2
420 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
421 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
422 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
423 - "counters": {
424 - "mileage": "" , ~/~/ пробег
425 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
426 - "motohours": "" , ~/~/ моточасы
427 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
428 - },
429 - "cmsv6Parameters": { ~/~/ параметры CMSv6
430 - "enabled": true, ~/~/ флаг включения
431 - "id": "" , ~/~/ идентификатор
432 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
433 - "login": "" , ~/~/ имя учетной записи
434 - "password": "" ~/~/ пароль учетной записи
435 - },
436 - "inspectionTasks": ~/~/ задания на ТО
356 +(% class="western" %)
357 +{{{ "parentId": "", // ID клиента
358 + "name": "", // имя ТС
359 + "imei": "", // IMEI
360 + "deviceTypeId": "",// ID типа устройства
361 + "modelId": "",
362 + "unitId": "", // ID подразделения
363 + "sim1": "", // Номер SIM 1
364 + "sim2": "", // Номер SIM2
365 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
366 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
367 + "consumptionIdle": "",// Расход топлива на холостом ходу
368 + "counters": {
369 + "mileage": "", // пробег
370 + "mileageEnabled": true, // флаг активности счётчика "пробег"
371 + "motohours":"", // моточасы
372 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
373 + },
374 + "cmsv6Parameters": { // параметры CMSv6
375 + "enabled": true, // флаг включения
376 + //"id": "", // идентификатор
377 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
378 + "login": "", // имя учетной записи
379 + "password": "" // пароль учетной записи
380 + },
381 + "inspectionTasks": [ // задания на ТО
437 437   {
438 - "enabled": "" , ~/~/ Признак включения
439 - "name": "" , ~/~/ Имя задания
440 - "description": "" , ~/~/ Описание задания
441 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
442 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
443 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
444 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
445 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
446 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
447 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
448 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
449 - }
383 + "enabled": "", // Признак включения
384 + "name": "", // Имя задания
385 + "description": "", // Описание задания
386 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
387 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
388 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
389 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
390 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
391 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
392 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
393 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
394 + },
395 + ]}}}
450 450  
451 -(% style="color:#000000" %) }
397 +(% style="color:#000000" %) }
452 452  
453 453  (% style="color:#000000" %)Ответ:
454 454  
455 455  (% style="color:#000000" %){
456 456  
457 - "vehicleId": "", ~/~/ID ТС 
458 - "parentId": "", ~/~/Guid владельца ТС
459 - "name": "", ~/~/Имя объекта
460 - "imei": "", ~/~/IMEI
461 - "deviceTypeId": "", ~/~/ID типа устройства
462 - "modelId": "", ~/~/ID модели
463 - "unitId": "", ~/~/ID подразделения
464 - "sim1": "", ~/~/SIM1
465 - "sim2": "", ~/~/SIM2
466 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
467 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
468 - "counters": { ~/~/Счётчики
469 - "mileageEnabled": true,
470 - "motohoursEnabled": true,
471 - "mileage": "",
472 - "motohours": 345.0
403 +(% class="western" %)
404 +{{{ "vehicleId": "", //ID ТС
405 + "parentId": "", //Guid владельца ТС
406 + "name": "", //Имя объекта
407 + "imei": "", //IMEI
408 + "deviceTypeId": "", //ID типа устройства
409 + "modelId": "", //ID модели
410 + "unitId": "", //ID подразделения
411 + "sim1": "", //SIM1
412 + "sim2": "", //SIM2
413 + "consumptionPer100Km": "", //Расход топлива на 100 км
414 + "consumptionIdle": "", //Расход топлива на холостом ходу
415 + "counters": { //Счётчики
416 + "mileageEnabled": true,
417 + "motohoursEnabled": true,
418 + "mileage": "",
419 + "motohours": 345.0
473 473   },
474 - "cmsv6Parameters": { ~/~/Параметры CmsV6
475 - "id": null,
476 - "enabled": true, ~/~/флаг включения
477 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
478 - "login": "", ~/~/ имя учетной записи
479 - "password": "" ~/~/ пароль учетной записи
421 + "cmsv6Parameters": { //Параметры CmsV6
422 + "id": null,
423 + "enabled": true, //флаг включения
424 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
425 + "login": "", // имя учетной записи
426 + "password": "" // пароль учетной записи
480 480   },
481 - "inspectionTasks": { ~/~/ задания на ТО
482 - "id": "", ~/~/ ID задачи
483 - "enabled": false, ~/~/ Признак включения
484 - "name": "", ~/~/ Имя задания
485 - "description": "", ~/~/ Описание задания
486 - "mileageCondition": "", ~/~/ Условие по пробегу
487 - "lastMileage": "", ~/~/ Пробег (в метрах)
488 - "motohoursCondition": "", ~/~/ Условие по моточасам
489 - "lastMotohours": "", ~/~/ Моточасы
490 - "periodicCondition": "", ~/~/ Условие периодичности по времени
491 - "kind": "", ~/~/ Вид периодичности по времени 
492 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
493 - }
428 + "inspectionTasks": [ // задания на ТО
429 + {
430 + "id": "", // ID задачи
431 + "enabled": false, // Признак включения
432 + "name": "", // Имя задания
433 + "description": "", // Описание задания
434 + "mileageCondition": "", // Условие по пробегу
435 + "lastMileage": "", // Пробег (в метрах)
436 + "motohoursCondition": "", // Условие по моточасам
437 + "lastMotohours": "", // Моточасы
438 + "periodicCondition": "", // Условие периодичности по времени
439 + "kind": "", // Вид периодичности по времени
440 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
441 + }
442 + ]}}}
494 494  
495 495  (% style="text-align:left" %)
496 496  (% style="color:#000000" %)}
497 497  
498 498  
499 -(% class="box successmessage" %)
448 +(% class="box warningmessage" %)
500 500  (((
501 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
450 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
502 502  )))
503 503  
504 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиентодитель).
453 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
505 505  
506 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
455 +(% style="color:#000000" %)Метод запроса: **PUT**
507 507  
508 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
457 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
509 509  
510 -(% style="color:#000000" %) возвращает информацию об объектах с учетом заданных настроек видимости объектов;
459 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
511 511  
512 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
461 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
513 513  
514 -(% style="color:#000000" %) информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
463 +(% 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»: «» //Сколько раз выполнить задание } ] }
515 515  
516 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
517 -
518 -(% style="color:#000000" %)Метод запроса: **POST**
519 -
520 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
521 -
522 -(% style="color:#000000" %)В заголовках запроса:
523 -
524 -(% style="color:#000000" %)− Content-Type: application/json
525 -
526 -(% style="color:#000000" %)− X-Auth: Токен авторизации
527 -
528 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
529 -
530 -(% class="western" style="color:#000000" %)##{##
531 -
532 -(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
533 - "name": null, ~/~/ Имя ТС (string, опционально) 
534 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
535 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
536 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
537 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
538 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
539 -(% style="color:#000000" %)}
540 -
541 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
542 -
543 543  (% style="color:#000000" %)Ответ:
544 544  
545 -(% style="color:#000000" %){
467 +(% lang="en-US" style="text-align:left" %)
468 +(% 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»: «» //Сколько раз выполнить задание } ] }
546 546  
547 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
548 - "name": "" ~/~/ наименование объекта
549 - "imei": "" ~/~/ IMEI объекта
550 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
551 - "deviceTypeName": "" ~/~/ наименование типа устройства
552 - "sim1": "" ~/~/ первый номер телефона
553 - "sim2": "" ~/~/ второй номер телефона
554 - "parentId": "" ~/~/ идентификатор клиента-родителя
555 - "parentName": "" ~/~/ наименование клиента-родителя
556 - "modelId": "" ~/~/ идентификатор модели объекта
557 - "modelName": "" ~/~/ наименование модели объекта
558 - "unitId": "" ~/~/ идентификатор подразделения
559 - "unitName": "" ~/~/ наименование подразделения
560 - "status": "" ~/~/ статус объекта         
561 - "createdAt": "" ~/~/ дата создания объектов  (%%)
562 -(% style="color:#000000" %)}
563 563  
564 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
565 -
566 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
567 -
568 -
569 569  (% class="box successmessage" %)
570 570  (((
571 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
473 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
572 572  )))
573 573  
574 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
476 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
575 575  
576 -(% style="color:#000000" %)Метод запроса: **POST**
478 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
577 577  
578 -(% 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}
480 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
579 579  
580 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
482 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
581 581  
582 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
484 +(% style="color:#000000" %) информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
583 583  
584 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
486 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
585 585  
586 -(% style="color:#000000" %){
488 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
587 587  
588 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
589 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
590 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
591 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
592 - "description": "", ~/~/ Описание
593 - "data": "", ~/~/ Данные
594 - "overwrite": false, ~/~/ Флаг перезаписи
595 - "stage": "", ~/~/ Состояние, может быть null
490 +(% style="color:#000000" %)Метод запроса: **POST**
596 596  
597 - (% style="color:#000000" %)}
492 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
598 598  
599 -(% style="color:#000000" %)Ответ:
494 +(% style="color:#000000" %)В заголовках запроса:
600 600  
601 -(% style="color:#000000" %){
496 +(% style="color:#000000" %)− Content-Type: application/json
602 602  
603 - "status": "", ~/~/ значение статуса
604 - "date": "", ~/~/ Дата смены статуса 
605 - "description": "", ~/~/ Описание
606 - "data": "", ~/~/ Данные
607 - "overwrite": false, ~/~/ Флаг перезаписи
608 - "stage": "", ~/~/ Состояние
498 +(% style="color:#000000" %)− X-Auth: Токен авторизации
609 609  
610 -(% style="text-align:left" %)
611 -(% style="color:#000000" %)}
500 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
612 612  
502 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
613 613  
614 -(% class="box warningmessage" %)
615 -(((
616 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
617 -)))
504 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
618 618  
619 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
506 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
620 620  
621 -(% style="color:#000000" %)Метод запроса: **PUT**
508 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
622 622  
623 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
510 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
624 624  
625 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
512 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
626 626  
627 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
514 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
628 628  
629 -(% style="color:#000000" %) {
516 +(% style="color:#000000" %)0 - «Блокировка»
630 630  
631 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
632 - "parentId": "", ~/~/ ID клиента
633 - "name": "", ~/~/ имя ТС
634 - "imei": "", ~/~/ IMEI
635 - "deviceTypeId": "", ~/~/ ID типа устройства
636 - "modelId": "", ~/~/ , ID модели    
637 - "unitId": "", ~/~/ подразделения
638 - "sim1": "", ~/~/ SIM 1
639 - "sim2": "", ~/~/ SIM2
640 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
641 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
642 - "counters": 
643 - {
644 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
645 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
646 - "mileage": «», пробег
647 - "motohours": «» моточасы
648 - }
649 - "cmsv6Parameters": ~/~/ параметры CMSv6
650 - {       
651 - "id": "", ~/~/ идентификатор
652 - "enabled": true, ~/~/ флаг включения
653 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
654 - "login": "", ~/~/ имя учетной записи
655 - "password": "", ~/~/ пароль учетной записи
656 - }
657 - "inspectionTasks": ~/~/ задания на ТО
658 - {
659 - "id": "", ~/~/ ID задания
660 - "enabled": false, ~/~/ Признак включения
661 - "name": "", ~/~/ Имя задания
662 - "description": "", ~/~/ Описание задания
663 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
664 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
665 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
666 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
667 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
668 - "kind": "", ~/~/ Вид периодичности по времени
669 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
670 - }
518 +(% style="color:#000000" %)1 - «Активен»,
671 671  
672 -(% style="color:#000000" %)}
520 +(% style="color:#000000" %)2 - «Отменен»
673 673  
674 -(% style="color:#000000" %)Ответ:
522 +(% style="color:#000000" %)3 - «Оборудован»
675 675  
676 -(% lang="en-US" style="text-align:left" %)
677 -(% 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»: «» //Сколько раз выполнить задание } ] }
524 +(% style="color:#000000" %)4 - «Диагностика»
678 678  
526 +(% style="color:#000000" %)5 - «Сервис»
679 679  
680 -(% class="box errormessage" %)
681 -(((
682 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
683 -)))
528 +(% style="color:#000000" %)6 - «Демонтаж»
684 684  
685 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
530 +(% style="color:#000000" %)7 - «Монтаж»
686 686  
687 -(% style="color:#000000" %)Метод запроса: **DELETE**
532 +(% style="color:#000000" %)8 - «Дозаказ»
688 688  
689 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
534 +(% style="color:#000000" %)9 - «Обслужен»
690 690  
691 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
536 +(% style="color:#000000" %)10 - «Списан»
692 692  
693 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
538 +(% style="color:#000000" %)11 - «Неисправен»
694 694  
540 +(% style="color:#000000" %)12 - «Проверен»
541 +
695 695  (% style="text-align:left" %)
696 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
543 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
697 697  
698 698  
699 -(% class="box" lang="en-US" style="text-align: center;" %)
546 +(% class="box successmessage" %)
700 700  (((
701 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
548 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта**(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
702 702  )))
703 703  
704 -(% class="box infomessage" %)
705 -(((
706 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
707 -)))
551 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
708 708  
709 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
553 +(% style="color:#000000" %)Метод запроса: **POST**
710 710  
711 -(% style="color:#000000" %)Метод запроса: **GET**
555 +(% 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}
712 712  
713 -(% 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]]
557 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
714 714  
715 715  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
716 716  
717 -(% style="color:#000000" %)Ответ: [
561 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
718 718  
719 719  (% class="western" %)
720 -{{{ {
721 - "deviceTypeId" : "", // ID типа устройства
722 - "deviceTypeName" : "" // Название типа устройства
723 - },}}}
564 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
565 + "date": "", // Дата смены статуса (null если сменить немедленно)
566 + "description": "", // Описание
567 + "data": "", // Данные
568 + "overwrite": false, // Флаг перезаписи
569 + "stage": "", // Состояние, может быть null}}}
724 724  
725 -(% style="text-align:left" %)
726 -(% style="color:#000000" %)…** **]
571 +(% style="color:#000000" %)}
727 727  
573 +(% style="color:#000000" %)Ответ: {
728 728  
729 -(% class="box" style="text-align: center;" %)
730 -(((
731 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
732 -)))
733 -
734 -(% class="box infomessage" %)
735 -(((
736 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
737 -)))
738 -
739 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
740 -
741 -(% style="color:#000000" %)Метод запроса: **GET**
742 -
743 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
744 -
745 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
746 -
747 -(% style="color:#000000" %)Ответ: [
748 -
749 -(% class="western" style="margin-bottom:19px" %)
750 -{{{ {}}}
751 -
752 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
753 -
754 754  (% class="western" %)
755 -{{{ "description": "" // Описание
756 - },}}}
576 +{{{ "status": "", // значение статуса
577 + "date": "", // Дата смены статуса
578 + "description": "", // Описание
579 + "data": "", // Данные
580 + "overwrite": false, // Флаг перезаписи
581 + "stage": "", // Состояние}}}
757 757  
758 758  (% style="text-align:left" %)
759 -(% style="color:#000000" %)… ]
584 +(% style="color:#000000" %)}
760 760  
761 761  
762 762  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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