<
From version < 20.3 >
edited by Артем Шемяков
on 2022/09/01 17:21
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
... ... @@ -82,120 +82,98 @@
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 - }, … ]
85 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
93 93  
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" %)]
94 94  
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 -
98 -(% class="box" style="text-align: center;" %)
90 +(% class="box" lang="en-US" style="text-align: center;" %)
99 99  (((
100 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
92 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
101 101  )))
102 102  
103 -(% class="box successmessage" %)
95 +(% class="box infomessage" %)
104 104  (((
105 -(% 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**
106 106  )))
107 107  
108 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
100 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
109 109  
110 -(% style="color:#000000" %)Метод запроса: **POST**
102 +(% style="color:#000000" %)Метод запроса: **GET**
111 111  
112 -(% 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]]
113 113  
114 114  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
115 115  
116 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
108 +(% style="color:#000000" %)Ответ: [
117 117  
118 -(% style="color:#000000" %){ 
119 - "lastName": "", ~/~/ фамилия
120 - "firstName": "", ~/~/ имя
121 - "position": "", ~/~/ должность
122 - "phone": "", ~/~/ телефон
123 - "organization": "", ~/~/ организация
124 - "login": "", ~/~/ логин
125 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
126 - "email": "", ~/~/ email
127 - "description": "", ~/~/ описание
128 - "isEnabled": "", ~/~/ признак включения
129 - "parentId": "", ~/~/ Guid родительского агента
130 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
131 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
132 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
133 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
134 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
135 - "groups": "" , ~/~/ группы пользователя, названия групп
136 - }
110 +(% class="western" %)
111 +{{{ {
112 + "deviceTypeId" : "", // ID типа устройства
113 + "deviceTypeName" : "" // Название типа устройства
114 + },}}}
137 137  
138 138  (% style="text-align:left" %)
139 -(% style="color:#000000; font-weight:normal" %)Ответ:
117 +(% style="color:#000000" %)…** **]
140 140  
141 -(% style="text-align:left" %)
142 -(% style="color:#000000; font-weight:normal" %){
143 143  
144 -(% style="text-align:left" %)
145 -(% style="color:#000000; font-weight:normal" %)"id": "" , ~/~/ ID пользователя
146 - "lastName": "" , ~/~/ Фамилия ,
147 - "firstName": "" , ~/~/ Имя
148 - "position": "" , ~/~/ Должность
149 - "phone": "" , ~/~/ Телефон
150 - "organization": "" , ~/~/ Организация
151 - "login": "" , ~/~/ Логин
152 - "password": "" , ~/~/ Пароль
153 - "email": "" , ~/~/ Email
154 - "description": "" , ~/~/ Описание
155 - "isEnabled": "" , ~/~/ Признак включения
156 - "parentId": "" , ~/~/ Guid родительского агента
157 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
158 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
159 - "kind": "" , ~/~/ тип аутентификации
160 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
161 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
120 +(% class="box" style="text-align: center;" %)
121 +(((
122 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
123 +)))
162 162  
163 -(% style="text-align:left" %)
164 -(% style="color:#000000; font-weight:normal" %)}
165 -
166 -
167 -(% class="box successmessage" %)
125 +(% class="box infomessage" %)
168 168  (((
169 -(% 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**
170 170  )))
171 171  
172 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
130 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
173 173  
174 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
132 +(% style="color:#000000" %)Метод запроса: **GET**
175 175  
176 -(% 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]]
177 177  
178 -(% 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: Токен авторизации
179 179  
180 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
138 +(% style="color:#000000" %)Ответ: [
181 181  
140 +(% class="western" style="margin-bottom:19px" %)
141 +{{{ {}}}
142 +
143 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
144 +
182 182  (% class="western" %)
183 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
184 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
185 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
186 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
146 +{{{ "description": "" // Описание
147 + },}}}
187 187  
188 -(% style="color:#000000" %)}
149 +(% style="text-align:left" %)
150 +(% style="color:#000000" %)… ]
189 189  
190 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
191 191  
192 -(% class="western" style="margin-bottom:19px" %)
193 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
153 +(% class="box" style="text-align: center;" %)
154 +(((
155 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
156 +)))
194 194  
195 -(% lang="en-US" style="text-align:left" %)
196 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
158 +(% class="box successmessage" %)
159 +(((
160 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
161 +)))
197 197  
163 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
198 198  
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 +
199 199  (% class="box warningmessage" %)
200 200  (((
201 201  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -215,7 +215,7 @@
215 215  
216 216  (% class="box warningmessage" %)
217 217  (((
218 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
196 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
219 219  )))
220 220  
221 221  (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
... ... @@ -236,6 +236,38 @@
236 236  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
237 237  
238 238  
217 +(% class="box successmessage" %)
218 +(((
219 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
220 +)))
221 +
222 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
223 +
224 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
225 +
226 +(% style="color:#000000" %)Метод запроса: **POST**
227 +
228 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
229 +
230 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
231 +
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 - неважно}}}
237 +
238 +(% style="color:#000000" %)}
239 +
240 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
241 +
242 +(% class="western" style="margin-bottom:19px" %)
243 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
244 +
245 +(% lang="en-US" style="text-align:left" %)
246 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
247 +
248 +
239 239  (% class="box errormessage" %)
240 240  (((
241 241  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -258,6 +258,25 @@
258 258  (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
259 259  )))
260 260  
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 +
261 261  (% class="box infomessage" %)
262 262  (((
263 263  (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -416,9 +416,32 @@
416 416  (% style="color:#000000" %)}
417 417  
418 418  
448 +(% class="box warningmessage" %)
449 +(((
450 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
451 +)))
452 +
453 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
454 +
455 +(% style="color:#000000" %)Метод запроса: **PUT**
456 +
457 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
458 +
459 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
460 +
461 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
462 +
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»: «» //Сколько раз выполнить задание } ] }
464 +
465 +(% style="color:#000000" %)Ответ:
466 +
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»: «» //Сколько раз выполнить задание } ] }
469 +
470 +
419 419  (% class="box successmessage" %)
420 420  (((
421 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
473 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
422 422  )))
423 423  
424 424  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
... ... @@ -461,9 +461,36 @@
461 461  
462 462  (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
463 463  
464 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
516 +(% style="color:#000000" %)0 - «Блокировка»
465 465  
518 +(% style="color:#000000" %)1 - «Активен»,
466 466  
520 +(% style="color:#000000" %)2 - «Отменен»
521 +
522 +(% style="color:#000000" %)3 - «Оборудован»
523 +
524 +(% style="color:#000000" %)4 - «Диагностика»
525 +
526 +(% style="color:#000000" %)5 - «Сервис»
527 +
528 +(% style="color:#000000" %)6 - «Демонтаж»
529 +
530 +(% style="color:#000000" %)7 - «Монтаж»
531 +
532 +(% style="color:#000000" %)8 - «Дозаказ»
533 +
534 +(% style="color:#000000" %)9 - «Обслужен»
535 +
536 +(% style="color:#000000" %)10 - «Списан»
537 +
538 +(% style="color:#000000" %)11 - «Неисправен»
539 +
540 +(% style="color:#000000" %)12 - «Проверен»
541 +
542 +(% style="text-align:left" %)
543 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
544 +
545 +
467 467  (% class="box successmessage" %)
468 468  (((
469 469  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
... ... @@ -482,9 +482,7 @@
482 482  (% style="color:#000000" %)Параметры в теле запроса (JSON): {
483 483  
484 484  (% class="western" %)
485 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
486 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
487 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
564 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
488 488   "date": "", // Дата смены статуса (null если сменить немедленно)
489 489   "description": "", // Описание
490 490   "data": "", // Данные
... ... @@ -507,112 +507,7 @@
507 507  (% style="color:#000000" %)}
508 508  
509 509  
510 -(% class="box warningmessage" %)
511 -(((
512 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
513 -)))
514 -
515 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
516 -
517 -(% style="color:#000000" %)Метод запроса: **PUT**
518 -
519 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
520 -
521 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
522 -
523 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
524 -
525 -(% 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»: «» //Сколько раз выполнить задание } ] }
526 -
527 -(% style="color:#000000" %)Ответ:
528 -
529 -(% lang="en-US" style="text-align:left" %)
530 -(% 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»: «» //Сколько раз выполнить задание } ] }
531 -
532 -
533 -(% class="box errormessage" %)
534 -(((
535 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
536 -)))
537 -
538 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
539 -
540 -(% style="color:#000000" %)Метод запроса: **DELETE**
541 -
542 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
543 -
544 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
545 -
546 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
547 -
548 -(% style="text-align:left" %)
549 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
550 -
551 -
552 552  (% class="box" lang="en-US" style="text-align: center;" %)
553 553  (((
554 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
555 -)))
556 -
557 -(% class="box infomessage" %)
558 -(((
559 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
560 -)))
561 -
562 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
563 -
564 -(% style="color:#000000" %)Метод запроса: **GET**
565 -
566 -(% 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]]
567 -
568 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
569 -
570 -(% style="color:#000000" %)Ответ: [
571 -
572 -(% class="western" %)
573 -{{{ {
574 - "deviceTypeId" : "", // ID типа устройства
575 - "deviceTypeName" : "" // Название типа устройства
576 - },}}}
577 -
578 -(% style="text-align:left" %)
579 -(% style="color:#000000" %)…** **]
580 -
581 -
582 -(% class="box" style="text-align: center;" %)
583 -(((
584 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
585 -)))
586 -
587 -(% class="box infomessage" %)
588 -(((
589 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
590 -)))
591 -
592 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
593 -
594 -(% style="color:#000000" %)Метод запроса: **GET**
595 -
596 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
597 -
598 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
599 -
600 -(% style="color:#000000" %)Ответ: [
601 -
602 -(% class="western" style="margin-bottom:19px" %)
603 -{{{ {}}}
604 -
605 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
606 -
607 -(% class="western" %)
608 -{{{ "description": "" // Описание
609 - },}}}
610 -
611 -(% style="text-align:left" %)
612 -(% style="color:#000000" %)… ]
613 -
614 -
615 -(% class="box" lang="en-US" style="text-align: center;" %)
616 -(((
617 617  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
618 618  )))

Меню

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