Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Likes
Change comment:
There is no comment for this version
Summary
Details
-
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,209 +92,118 @@ 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" %)**POSTusers**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" %)**POSTusers/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" %) } 222 - 223 - 224 -(% class="box warningmessage" %) 158 +(% class="box successmessage" %) 225 225 ((( 226 -(% style="color:#000000; line-height:100%" %)** Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**160 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 227 227 ))) 228 228 229 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяетотредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).163 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 230 230 231 -(% style="color:#000000" %)Метод запроса: **P UT**165 +(% style="color:#000000" %)Метод запроса: **POST** 232 232 233 233 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 234 234 235 235 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 236 236 237 -(% lang="en-US" style="text-align:left" %) 238 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 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»: [ // группы пользователя «», //названия групп «», «» ] } 239 239 240 -(% lang="en-US"style="text-align:left" %)241 -(% lang="ru-RU"style="color:#000000; font-weight:normal" %){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» //названия групп ] } 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» названия группы пользователя 262 262 263 -(% lang="en-US" style="text-align:left" %) 264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 177 +(% class="box warningmessage" %) 178 +((( 179 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 180 +))) 265 265 266 -(% lang="en-US" style="text-align:left" %) 267 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 182 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 268 268 269 -(% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 184 +(% style="color:#000000" %)Метод запроса: **PUT** 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» названия группы пользователя// 186 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 290 290 188 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 189 + 291 291 (% lang="en-US" style="text-align:left" %) 292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 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» //названия групп ] } // 293 293 294 294 295 295 (% class="box warningmessage" %) 296 296 ((( 297 -(% 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}** 298 298 ))) 299 299 300 300 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). ... ... @@ -315,6 +315,38 @@ 315 315 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 316 316 317 317 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 + 318 318 (% class="box errormessage" %) 319 319 ((( 320 320 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -337,6 +337,25 @@ 337 337 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 338 338 ))) 339 339 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 + 340 340 (% class="box infomessage" %) 341 341 ((( 342 342 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -495,9 +495,32 @@ 495 495 (% style="color:#000000" %)} 496 496 497 497 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 + 498 498 (% class="box successmessage" %) 499 499 ((( 500 -(% 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** 501 501 ))) 502 502 503 503 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). ... ... @@ -540,9 +540,36 @@ 540 540 541 541 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 542 542 543 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».516 +(% style="color:#000000" %)0 - «Блокировка» 544 544 518 +(% style="color:#000000" %)1 - «Активен», 545 545 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 + 546 546 (% class="box successmessage" %) 547 547 ((( 548 548 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** ... ... @@ -561,9 +561,7 @@ 561 561 (% style="color:#000000" %)Параметры в теле запроса (JSON): { 562 562 563 563 (% class="western" %) 564 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 565 - // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 566 - // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 564 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 567 567 "date": "", // Дата смены статуса (null если сменить немедленно) 568 568 "description": "", // Описание 569 569 "data": "", // Данные ... ... @@ -586,112 +586,7 @@ 586 586 (% style="color:#000000" %)} 587 587 588 588 589 -(% class="box warningmessage" %) 590 -((( 591 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 592 -))) 593 - 594 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 595 - 596 -(% style="color:#000000" %)Метод запроса: **PUT** 597 - 598 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 599 - 600 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 601 - 602 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 603 - 604 -(% 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»: «» //Сколько раз выполнить задание } ] } 605 - 606 -(% style="color:#000000" %)Ответ: 607 - 608 -(% lang="en-US" style="text-align:left" %) 609 -(% 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»: «» //Сколько раз выполнить задание } ] } 610 - 611 - 612 -(% class="box errormessage" %) 613 -((( 614 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 615 -))) 616 - 617 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 618 - 619 -(% style="color:#000000" %)Метод запроса: **DELETE** 620 - 621 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 622 - 623 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 624 - 625 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 626 - 627 -(% style="text-align:left" %) 628 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 629 - 630 - 631 631 (% class="box" lang="en-US" style="text-align: center;" %) 632 632 ((( 633 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 634 -))) 635 - 636 -(% class="box infomessage" %) 637 -((( 638 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 639 -))) 640 - 641 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 642 - 643 -(% style="color:#000000" %)Метод запроса: **GET** 644 - 645 -(% 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]] 646 - 647 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 648 - 649 -(% style="color:#000000" %)Ответ: [ 650 - 651 -(% class="western" %) 652 -{{{ { 653 - "deviceTypeId" : "", // ID типа устройства 654 - "deviceTypeName" : "" // Название типа устройства 655 - },}}} 656 - 657 -(% style="text-align:left" %) 658 -(% style="color:#000000" %)…** **] 659 - 660 - 661 -(% class="box" style="text-align: center;" %) 662 -((( 663 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 664 -))) 665 - 666 -(% class="box infomessage" %) 667 -((( 668 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 669 -))) 670 - 671 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 672 - 673 -(% style="color:#000000" %)Метод запроса: **GET** 674 - 675 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 676 - 677 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 678 - 679 -(% style="color:#000000" %)Ответ: [ 680 - 681 -(% class="western" style="margin-bottom:19px" %) 682 -{{{ {}}} 683 - 684 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 685 - 686 -(% class="western" %) 687 -{{{ "description": "" // Описание 688 - },}}} 689 - 690 -(% style="text-align:left" %) 691 -(% style="color:#000000" %)… ] 692 - 693 - 694 -(% class="box" lang="en-US" style="text-align: center;" %) 695 -((( 696 696 (% 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]] ** 697 697 )))