Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 20.2 >
edited by Артем Шемяков
on 2022/09/01 17:08
To version < 21.8 >
edited by Артем Шемяков
on 2022/09/02 09:34
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -34,8 +34,18 @@
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% lang="en-US" %)
37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
37 +(% style="color:#000000" %)**Ответ:**
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 +
39 39  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
40 40  
41 41  
... ... @@ -82,16 +82,18 @@
82 82  
83 83  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
84 84  
85 -(% style="color:#000000" %)Ответ: [ {
86 - "agentId": "", ~/~/ идентификатор клиента
87 - "parentId": "", ~/~/ идентификатор клиента-родителя
88 - "name": "", ~/~/ наименование клиента
89 - "fullName": "", ~/~/ полное наименование клиента
90 - "agentInfoType": "", ~/~/ тип клиента1
91 - "status": "", ~/~/ статус клиента
92 - }, … ]
95 +(% style="color:#000000" %)Ответ:
93 93  
97 +(% style="color:#000000" %){
98 + "agentId": "", ~/~/ идентификатор клиента
99 + "parentId": "", ~/~/ идентификатор клиента-родителя
100 + "name": "", ~/~/ наименование клиента
101 + "fullName": "", ~/~/ полное наименование клиента
102 + "agentInfoType": "", ~/~/ тип клиента1
103 + "status": "", ~/~/ статус клиента
104 + }
94 94  
106 +
95 95  (% 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" %)]
96 96  
97 97  
... ... @@ -113,12 +113,57 @@
113 113  
114 114  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
115 115  
116 -(% 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»: [ // группы пользователя «», //названия групп «», «» ] }
128 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
117 117  
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 + }
149 +
118 118  (% style="text-align:left" %)
119 -(% 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» //названия групп ] }
151 +(% style="color:#000000; font-weight:normal" %)Ответ:
120 120  
153 +(% style="text-align:left" %)
154 +(% style="color:#000000; font-weight:normal" %){    
121 121  
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» названия группы пользователя
174 +
175 +(% style="text-align:left" %)
176 +(% style="color:#000000; font-weight:normal" %) }
177 +
178 +
122 122  (% class="box successmessage" %)
123 123  (((
124 124  (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
... ... @@ -132,25 +132,38 @@
132 132  
133 133  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
134 134  
135 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
136 136  
137 -(% class="western" %)
138 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
139 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
140 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
141 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
194 +(% style="color:#000000" %){
142 142  
143 -(% style="color:#000000" %)}
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 - неважно
144 144  
145 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
201 +(% style="color:#000000" %) }
146 146  
147 -(% class="western" style="margin-bottom:19px" %)
148 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
203 +(% style="color:#000000" %)Ответ:
149 149  
150 -(% lang="en-US" style="text-align:left" %)
151 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
205 +(% style="color:#000000" %){         (%%)
152 152  
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 153  
221 +(% style="color:#000000" %) }
222 +
223 +
154 154  (% class="box warningmessage" %)
155 155  (((
156 156  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -165,9 +165,63 @@
165 165  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
166 166  
167 167  (% lang="en-US" style="text-align:left" %)
168 -(% 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» //названия групп ] }  //
238 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
169 169  
240 +(% lang="en-US" style="text-align:left" %)
241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
170 170  
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» названия группы пользователя
262 +
263 +(% lang="en-US" style="text-align:left" %)
264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
265 +
266 +(% lang="en-US" style="text-align:left" %)
267 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
268 +
269 +(% lang="en-US" style="text-align:left" %)
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{     //
271 +
272 +(% lang="en-US" style="text-align:left" %)
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "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» названия группы пользователя//
290 +
291 +(% lang="en-US" style="text-align:left" %)
292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
293 +
294 +
171 171  (% class="box warningmessage" %)
172 172  (((
173 173  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
... ... @@ -177,16 +177,22 @@
177 177  
178 178  (% style="color:#000000" %)Метод запроса: **PUT**
179 179  
180 -(% 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} Параметр запроса:
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}
181 181  
182 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
183 183  
184 -(% class="western" %)
185 -{{{ "description": "", // описание
186 - "data": "" // данные, связанные со сменой статуса}}}
308 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
187 187  
188 -(% style="color:#000000" %)}
310 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
189 189  
312 +(% style="color:#000000" %){
313 +
314 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
315 + "description": "" , ~/~/ описание
316 + "data": "" , ~/~/ данные, связанные со сменой статуса
317 +
318 + (% style="color:#000000" %)}
319 +
190 190  (% style="text-align:left" %)
191 191  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
192 192  
... ... @@ -202,8 +202,10 @@
202 202  
203 203  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
204 204  
205 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
206 206  
337 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
338 +
207 207  (% style="text-align:left" %)
208 208  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
209 209  
... ... @@ -238,24 +238,20 @@
238 238  
239 239  (% style="color:#000000" %){
240 240  
241 -(% class="western" %)
242 -{{{ "vehicleId": “”, // идентификатор объекта
243 - "name": "", // имя объекта
244 - "imei": "", // IMEI объекта
245 - "deviceTypeId": “”, // идентификатор устройства объекта
246 - "deviceTypeName": "" // наименование устройства объекта
247 - "parentId": "", // идентификатор клиента-родителя
248 - "parentName": "" // наименование клиента-родителя,
249 - "modelId": "", // идентификатор модели объекта
250 - "modelName": "" // наименование модели объекта,
251 - "unitId": "", // идентификатор подразделения
252 - "unitName": "", // наименование подразделения
253 - "status": “”, // статус объекта
254 - ...
255 - },
256 - ...}}}
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": "" , ~/~/ статус объекта
257 257  
258 -(% style="color:#000000" %)}
386 + }
259 259  
260 260  (% style="text-align:left" %)
261 261  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -277,95 +277,92 @@
277 277  
278 278  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
279 279  
280 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
408 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
281 281  
282 -(% class="western" %)
283 -{{{ "parentId": "", // ID клиента
284 - "name": "", // имя ТС
285 - "imei": "", // IMEI
286 - "deviceTypeId": "",// ID типа устройства
287 - "modelId": "",
288 - "unitId": "", // ID подразделения
289 - "sim1": "", // Номер SIM 1
290 - "sim2": "", // Номер SIM2
291 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
292 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
293 - "consumptionIdle": "",// Расход топлива на холостом ходу
294 - "counters": {
295 - "mileage": "", // пробег
296 - "mileageEnabled": true, // флаг активности счётчика "пробег"
297 - "motohours":"", // моточасы
298 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
299 - },
300 - "cmsv6Parameters": { // параметры CMSv6
301 - "enabled": true, // флаг включения
302 - //"id": "", // идентификатор
303 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
304 - "login": "", // имя учетной записи
305 - "password": "" // пароль учетной записи
306 - },
307 - "inspectionTasks": [ // задания на ТО
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": ~/~/ задания на ТО
308 308   {
309 - "enabled": "", // Признак включения
310 - "name": "", // Имя задания
311 - "description": "", // Описание задания
312 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
313 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
314 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
315 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
316 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
317 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
318 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
319 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
320 - },
321 - ]}}}
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 + }
322 322  
323 -(% style="color:#000000" %)… }
451 +(% style="color:#000000" %) }
324 324  
325 325  (% style="color:#000000" %)Ответ:
326 326  
327 327  (% style="color:#000000" %){
328 328  
329 -(% class="western" %)
330 -{{{ "vehicleId": "", //ID ТС
331 - "parentId": "", //Guid владельца ТС
332 - "name": "", //Имя объекта
333 - "imei": "", //IMEI
334 - "deviceTypeId": "", //ID типа устройства
335 - "modelId": "", //ID модели
336 - "unitId": "", //ID подразделения
337 - "sim1": "", //SIM1
338 - "sim2": "", //SIM2
339 - "consumptionPer100Km": "", //Расход топлива на 100 км
340 - "consumptionIdle": "", //Расход топлива на холостом ходу
341 - "counters": { //Счётчики
342 - "mileageEnabled": true,
343 - "motohoursEnabled": true,
344 - "mileage": "",
345 - "motohours": 345.0
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
346 346   },
347 - "cmsv6Parameters": { //Параметры CmsV6
348 - "id": null,
349 - "enabled": true, //флаг включения
350 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
351 - "login": "", // имя учетной записи
352 - "password": "" // пароль учетной записи
474 + "cmsv6Parameters": { ~/~/Параметры CmsV6
475 + "id": null,
476 + "enabled": true, ~/~/флаг включения
477 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
478 + "login": "", ~/~/ имя учетной записи
479 + "password": "" ~/~/ пароль учетной записи
353 353   },
354 - "inspectionTasks": [ // задания на ТО
355 - {
356 - "id": "", // ID задачи
357 - "enabled": false, // Признак включения
358 - "name": "", // Имя задания
359 - "description": "", // Описание задания
360 - "mileageCondition": "", // Условие по пробегу
361 - "lastMileage": "", // Пробег (в метрах)
362 - "motohoursCondition": "", // Условие по моточасам
363 - "lastMotohours": "", // Моточасы
364 - "periodicCondition": "", // Условие периодичности по времени
365 - "kind": "", // Вид периодичности по времени
366 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
367 - }
368 - ]}}}
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 + }
369 369  
370 370  (% style="text-align:left" %)
371 371  (% style="color:#000000" %)}
... ... @@ -384,11 +384,11 @@
384 384  
385 385  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
386 386  
387 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
512 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
388 388  
389 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
514 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
390 390  
391 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
516 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
392 392  
393 393  (% style="color:#000000" %)Метод запроса: **POST**
394 394  
... ... @@ -402,19 +402,41 @@
402 402  
403 403  (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
404 404  
405 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
530 +(% class="western" style="color:#000000" %)##{##
406 406  
407 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
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" %)}
408 408  
409 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
541 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
410 410  
411 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
543 +(% style="color:#000000" %)Ответ:
412 412  
413 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
545 +(% style="color:#000000" %){
414 414  
415 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
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" %)}
416 416  
417 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
564 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
418 418  
419 419  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
420 420  
... ... @@ -434,30 +434,32 @@
434 434  
435 435  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
436 436  
437 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
584 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
438 438  
439 -(% class="western" %)
440 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
441 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
442 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
443 - "date": "", // Дата смены статуса (null если сменить немедленно)
444 - "description": "", // Описание
445 - "data": "", // Данные
446 - "overwrite": false, // Флаг перезаписи
447 - "stage": "", // Состояние, может быть null}}}
586 +(% style="color:#000000" %){
448 448  
449 -(% style="color:#000000" %)}
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
450 450  
451 -(% style="color:#000000" %)Ответ: {
597 + (% style="color:#000000" %)}
452 452  
453 -(% class="western" %)
454 -{{{ "status": "", // значение статуса
455 - "date": "", // Дата смены статуса
456 - "description": "", // Описание
457 - "data": "", // Данные
458 - "overwrite": false, // Флаг перезаписи
459 - "stage": "", // Состояние}}}
599 +(% style="color:#000000" %)Ответ:
460 460  
601 +(% style="color:#000000" %){
602 +
603 + "status": "", ~/~/ значение статуса
604 + "date": "", ~/~/ Дата смены статуса 
605 + "description": "", ~/~/ Описание
606 + "data": "", ~/~/ Данные
607 + "overwrite": false, ~/~/ Флаг перезаписи
608 + "stage": "", ~/~/ Состояние
609 +
461 461  (% style="text-align:left" %)
462 462  (% style="color:#000000" %)}
463 463  

Меню

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