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