Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -34,8 +34,18 @@ 34 34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% lang="en-US" %) 37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**37 +(% style="color:#000000" %)**Ответ:** 38 38 39 +(% lang="en-US" %) 40 +(% style="color:#000000" %){ 41 + 42 +(% lang="en-US" %) 43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 + "User": "" , ~/~/ имя пользователя 45 + 46 +(% lang="en-US" %) 47 + } 48 + 39 39 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 40 40 41 41 ... ... @@ -82,11 +82,21 @@ 82 82 83 83 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 84 84 85 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ]95 +(% style="color:#000000" %)Ответ: 86 86 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" %)] 97 +(% style="color:#000000" %){ 98 + "agentId": "", ~/~/ идентификатор клиента 99 + "parentId": "", ~/~/ идентификатор клиента-родителя 100 + "name": "", ~/~/ наименование клиента 101 + "fullName": "", ~/~/ полное наименование клиента 102 + "agentInfoType": "", ~/~/ тип клиента1 103 + "status": "", ~/~/ статус клиента 104 + } 88 88 89 89 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 + 90 90 (% class="box" style="text-align: center;" %) 91 91 ((( 92 92 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -105,12 +105,102 @@ 105 105 106 106 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 107 107 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»: [ // группы пользователя «», //названия групп «», «» ] }128 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 109 109 130 +(% style="color:#000000" %){ 131 + "lastName": "", ~/~/ фамилия 132 + "firstName": "", ~/~/ имя 133 + "position": "", ~/~/ должность 134 + "phone": "", ~/~/ телефон 135 + "organization": "", ~/~/ организация 136 + "login": "", ~/~/ логин 137 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 138 + "email": "", ~/~/ email 139 + "description": "", ~/~/ описание 140 + "isEnabled": "", ~/~/ признак включения 141 + "parentId": "", ~/~/ Guid родительского агента 142 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 143 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 144 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 145 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 + "groups": "" , ~/~/ группы пользователя, названия групп 148 + } 149 + 110 110 (% style="text-align:left" %) 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» //названия групп ] }151 +(% style="color:#000000; font-weight:normal" %)Ответ: 112 112 153 +(% style="text-align:left" %) 154 +(% style="color:#000000; font-weight:normal" %){ 113 113 156 +(% style="text-align:left" %) 157 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 158 + "lastName": "" , ~/~/ Фамилия , 159 + "firstName": "" , ~/~/ Имя 160 + "position": "" , ~/~/ Должность 161 + "phone": "" , ~/~/ Телефон 162 + "organization": "" , ~/~/ Организация 163 + "login": "" , ~/~/ Логин 164 + "password": "" , ~/~/ Пароль 165 + "email": "" , ~/~/ Email 166 + "description": "" , ~/~/ Описание 167 + "isEnabled": "" , ~/~/ Признак включения 168 + "parentId": "" , ~/~/ Guid родительского агента 169 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 170 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 171 + "kind": "" , ~/~/ тип аутентификации 172 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 173 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 174 + 175 +(% style="text-align:left" %) 176 +(% style="color:#000000; font-weight:normal" %) } 177 + 178 + 179 +(% class="box successmessage" %) 180 +((( 181 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 182 +))) 183 + 184 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 185 + 186 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 187 + 188 +(% style="color:#000000" %)Метод запроса: **POST** 189 + 190 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 191 + 192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 193 + 194 +(% style="color:#000000" %){ 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 - неважно 200 + 201 +(% style="color:#000000" %) } 202 + 203 +(% style="color:#000000" %)Ответ: 204 + 205 +(% style="color:#000000" %){ (%%) 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": "", ~/~/ дата/время последней авторизации 220 + 221 +(% style="color:#000000" %) } 222 + 223 + 114 114 (% class="box warningmessage" %) 115 115 ((( 116 116 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -125,62 +125,90 @@ 125 125 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 126 126 127 127 (% lang="en-US" style="text-align:left" %) 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 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 129 129 240 +(% lang="en-US" style="text-align:left" %) 241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 130 130 131 -(% class="box warningmessage" %) 132 -((( 133 -(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 134 -))) 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» названия группы пользователя 135 135 136 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 263 +(% lang="en-US" style="text-align:left" %) 264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 137 137 138 -(% style="color:#000000" %)Метод запроса: **PUT** 266 +(% lang="en-US" style="text-align:left" %) 267 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 139 139 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} Параметр запроса: 269 +(% lang="en-US" style="text-align:left" %) 270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 141 141 142 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 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» названия группы пользователя// 143 143 144 -(% class="western" %) 145 -{{{ "description": "", // описание 146 - "data": "" // данные, связанные со сменой статуса}}} 291 +(% lang="en-US" style="text-align:left" %) 292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 147 147 148 -(% style="color:#000000" %)} 149 149 150 -(% style="text-align:left" %) 151 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 152 - 153 - 154 -(% class="box successmessage" %) 295 +(% class="box warningmessage" %) 155 155 ((( 156 -(% style="color:#000000 ; line-height:100%" %)**Получение списка пользователей— **(% lang="en-US" %)**POST /api/v3/users/find**297 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 157 157 ))) 158 158 159 -(% style="color:#000000" %) Метод позволяет получитьосновные параметрыпользователей:логин,имя,адресэлектроннойпочты,номертелефона,статус,идентификаторклиента-родителяипрочее.300 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 160 160 161 -(% style="color:#000000" %)Метод возвращает информацию опользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляетсяпри наличии права**«Просмотр пользователей»**.302 +(% style="color:#000000" %)Метод запроса: **PUT** 162 162 163 -(% style="color:#000000" %) Методзапроса:**POST**304 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 164 164 165 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 166 166 167 -(% style="color:#000000" %) Условияфильтрацииобъектовзадаютсяв телезапроса.Параметрывелезапроса (JSON): {308 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 168 168 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 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 174 174 175 -(% style="color:#000000" %) }312 +(% style="color:#000000" %){ 176 176 177 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 314 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 315 + "description": "" , ~/~/ описание 316 + "data": "" , ~/~/ данные, связанные со сменой статуса 178 178 179 -(% class="western" style="margin-bottom:19px" %) 180 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 318 + (% style="color:#000000" %)} 181 181 182 -(% lang="en-US"style="text-align:left" %)183 -(% style="color:#000000" %) «status»:1, //статусльзователя«lastLogged»: «» //дата/время последнейавторизации}, … ]**320 +(% style="text-align:left" %) 321 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 184 184 185 185 186 186 (% class="box errormessage" %) ... ... @@ -194,8 +194,10 @@ 194 194 195 195 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 196 196 197 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 198 198 337 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 338 + 199 199 (% style="text-align:left" %) 200 200 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 201 201 ... ... @@ -205,25 +205,6 @@ 205 205 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 206 206 ))) 207 207 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 - 227 227 (% class="box infomessage" %) 228 228 ((( 229 229 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -382,32 +382,9 @@ 382 382 (% style="color:#000000" %)} 383 383 384 384 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 - 408 408 (% class="box successmessage" %) 409 409 ((( 410 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**508 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** 411 411 ))) 412 412 413 413 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). ... ... @@ -450,36 +450,9 @@ 450 450 451 451 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 452 452 453 - (% style="color:#000000"%)0- «Блокировка»551 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 454 454 455 -(% style="color:#000000" %)1 - «Активен», 456 456 457 -(% style="color:#000000" %)2 - «Отменен» 458 - 459 -(% style="color:#000000" %)3 - «Оборудован» 460 - 461 -(% style="color:#000000" %)4 - «Диагностика» 462 - 463 -(% style="color:#000000" %)5 - «Сервис» 464 - 465 -(% style="color:#000000" %)6 - «Демонтаж» 466 - 467 -(% style="color:#000000" %)7 - «Монтаж» 468 - 469 -(% style="color:#000000" %)8 - «Дозаказ» 470 - 471 -(% style="color:#000000" %)9 - «Обслужен» 472 - 473 -(% style="color:#000000" %)10 - «Списан» 474 - 475 -(% style="color:#000000" %)11 - «Неисправен» 476 - 477 -(% style="color:#000000" %)12 - «Проверен» 478 - 479 -(% style="text-align:left" %) 480 -(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется» 481 - 482 - 483 483 (% class="box successmessage" %) 484 484 ((( 485 485 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** ... ... @@ -498,7 +498,9 @@ 498 498 (% style="color:#000000" %)Параметры в теле запроса (JSON): { 499 499 500 500 (% class="western" %) 501 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 572 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 573 + // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 574 + // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 502 502 "date": "", // Дата смены статуса (null если сменить немедленно) 503 503 "description": "", // Описание 504 504 "data": "", // Данные ... ... @@ -521,6 +521,48 @@ 521 521 (% style="color:#000000" %)} 522 522 523 523 597 +(% class="box warningmessage" %) 598 +((( 599 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 600 +))) 601 + 602 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 603 + 604 +(% style="color:#000000" %)Метод запроса: **PUT** 605 + 606 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 607 + 608 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 609 + 610 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 611 + 612 +(% 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»: «» //Сколько раз выполнить задание } ] } 613 + 614 +(% style="color:#000000" %)Ответ: 615 + 616 +(% lang="en-US" style="text-align:left" %) 617 +(% 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»: «» //Сколько раз выполнить задание } ] } 618 + 619 + 620 +(% class="box errormessage" %) 621 +((( 622 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 623 +))) 624 + 625 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 626 + 627 +(% style="color:#000000" %)Метод запроса: **DELETE** 628 + 629 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 630 + 631 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 632 + 633 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 634 + 635 +(% style="text-align:left" %) 636 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 637 + 638 + 524 524 (% class="box" lang="en-US" style="text-align: center;" %) 525 525 ((( 526 526 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**