Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/17 16:44
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,5 +1,5 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API == 2 +== Описание ГЛОНАССSoft Public API 3.0 == 3 3 4 4 == == 5 5 ... ... @@ -17,40 +17,28 @@ 17 17 18 18 (% class="box" style="text-align: center;" %) 19 19 ((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 21 ))) 22 22 23 23 (% class="box infomessage" %) 24 24 ((( 25 -(% style="color:#000000" %)** Получение основных параметров клиента—**(% lang="en-US" %)**GET**(%%)**/(%lang="en-US" %)api/v3/agents(%%)**25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %) Метод позволяет получить о сновныепараметры клиентов: наименование,полноенаименование,тип, статусиидентификатор клиента-родителя.Методвозвращаетинформациюоклиентахс учетом настроекавторизованногопользователя,указанногов запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 31 - 32 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 33 - 34 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 35 - 36 36 (% style="color:#000000" %)Метод запроса: **GET** 37 37 38 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ag ents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>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]] 39 39 40 -(% style="color:#000000" %) Параметр запроса:<parentId>- идентификаторклиента-родителя (опционально)34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 41 41 42 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 36 +(% lang="en-US" %) 37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 43 43 44 - (% style="color:#000000"%)Ответ:[ { «agentId»: «», //идентификаторклиента«parentId»: «», //идентификаторклиента-родителя«name»: «», //наименованиеклиента«fullName»: «», //полноенаименованиеклиента«agentInfoType»: , //типклиента1«status»: //статус клиента }, … ]39 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 45 45 46 -(% 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" %)] 47 47 48 - 49 -(% class="box" style="text-align: center;" %) 50 -((( 51 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 52 -))) 53 - 54 54 (% class="box infomessage" %) 55 55 ((( 56 56 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** ... ... @@ -68,87 +68,45 @@ 68 68 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 69 69 70 70 71 -(% class="box infomessage" %)59 +(% class="box" style="text-align: center;" %) 72 72 ((( 73 -(% style="color:#000000; line-height:100%" %)**Авторизация**(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**61 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 74 74 ))) 75 75 76 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 77 - 78 -(% style="color:#000000" %)Метод запроса: **GET** 79 - 80 -(% 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]] 81 - 82 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 83 - 84 -(% lang="en-US" %) 85 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 86 - 87 -**Примечание: **Время жизни токена авторизации задается через настройки пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 88 - 89 -(% class="box" lang="en-US" style="text-align: center;" %) 90 -((( 91 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 92 -))) 93 - 94 94 (% class="box infomessage" %) 95 95 ((( 96 -(% style="color:#000000 ; line-height:100%" %)**Получение списка типовустройств **(%style="color:#000000" %)**—**(% lang="en-US" %)**GET /api/v3/devices/types**66 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 97 97 ))) 98 98 99 -(% style="color:#000000" %) Метод позволяет получить спи соктипов устройств. Метод возвращает информацию отипахустройствсучетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).69 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 100 100 101 -(% style="color:#000000" %) Методзапроса:**GET**71 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 102 102 103 -(% 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]]73 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 104 104 105 -(% style="color:#000000" %) Взаголовкахзапроса:X-Auth:Токенавторизации75 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 106 106 107 -(% style="color:#000000" %)Ответ: [ 108 - 109 -(% class="western" %) 110 -{{{ { 111 - "deviceTypeId" : "", // ID типа устройства 112 - "deviceTypeName" : "" // Название типа устройства 113 - },}}} 114 - 115 -(% style="text-align:left" %) 116 -(% style="color:#000000" %)…** **] 117 - 118 - 119 -(% class="box" style="text-align: center;" %) 120 -((( 121 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 122 -))) 123 - 124 -(% class="box infomessage" %) 125 -((( 126 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 127 -))) 128 - 129 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 130 - 131 131 (% style="color:#000000" %)Метод запроса: **GET** 132 132 133 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]79 +(% 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> 134 134 135 -(% style="color:#000000" %) В заголовкахзапроса:X-Auth:Токенвторизации81 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 136 136 137 -(% style="color:#000000" %) Ответ:[83 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 138 138 139 -(% class="western" style="margin-bottom:19px" %) 140 -{{{ {}}} 85 +(% style="color:#000000" %)Ответ: [ { 86 + "agentId": "", ~/~/ идентификатор клиента 87 + "parentId": "", ~/~/ идентификатор клиента-родителя 88 + "name": "", ~/~/ наименование клиента 89 + "fullName": "", ~/~/ полное наименование клиента 90 + "agentInfoType": "", ~/~/ тип клиента1 91 + "status": "", ~/~/ статус клиента 92 + }, … ] 141 141 142 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 143 143 144 -(% class="western" %) 145 -{{{ "description": "" // Описание 146 - },}}} 95 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] 147 147 148 -(% style="text-align:left" %) 149 -(% style="color:#000000" %)… ] 150 150 151 - 152 152 (% class="box" style="text-align: center;" %) 153 153 ((( 154 154 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -173,6 +173,38 @@ 173 173 (% 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» //названия групп ] } 174 174 175 175 122 +(% class="box successmessage" %) 123 +((( 124 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 125 +))) 126 + 127 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 128 + 129 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 130 + 131 +(% style="color:#000000" %)Метод запроса: **POST** 132 + 133 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 134 + 135 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 136 + 137 +(% class="western" %) 138 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 139 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 140 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 141 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 142 + 143 +(% style="color:#000000" %)} 144 + 145 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 146 + 147 +(% class="western" style="margin-bottom:19px" %) 148 +{{{ "sessionDuration":"", // длительность сессии в минутах}}} 149 + 150 +(% lang="en-US" style="text-align:left" %) 151 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 152 + 153 + 176 176 (% class="box warningmessage" %) 177 177 ((( 178 178 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -192,7 +192,7 @@ 192 192 193 193 (% class="box warningmessage" %) 194 194 ((( 195 -(% style="color:#000000" %)**Измени тьстатус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**173 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 196 196 ))) 197 197 198 198 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). ... ... @@ -213,38 +213,6 @@ 213 213 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 214 214 215 215 216 -(% class="box successmessage" %) 217 -((( 218 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 219 -))) 220 - 221 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 222 - 223 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 224 - 225 -(% style="color:#000000" %)Метод запроса: **POST** 226 - 227 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 228 - 229 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 230 - 231 -(% class="western" %) 232 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 233 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 234 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 235 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 236 - 237 -(% style="color:#000000" %)} 238 - 239 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 240 - 241 -(% class="western" style="margin-bottom:19px" %) 242 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 243 - 244 -(% lang="en-US" style="text-align:left" %) 245 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 246 - 247 - 248 248 (% class="box errormessage" %) 249 249 ((( 250 250 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -267,25 +267,6 @@ 267 267 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 268 268 ))) 269 269 270 -(% class="box errormessage" %) 271 -((( 272 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 273 -))) 274 - 275 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 276 - 277 -(% style="color:#000000" %)Метод запроса: **DELETE** 278 - 279 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 280 - 281 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 282 - 283 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 284 - 285 -(% style="text-align:left" %) 286 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 287 - 288 - 289 289 (% class="box infomessage" %) 290 290 ((( 291 291 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -444,32 +444,9 @@ 444 444 (% style="color:#000000" %)} 445 445 446 446 447 -(% class="box warningmessage" %) 448 -((( 449 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 450 -))) 451 - 452 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 453 - 454 -(% style="color:#000000" %)Метод запроса: **PUT** 455 - 456 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 457 - 458 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 459 - 460 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 461 - 462 -(% 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»: «» //Сколько раз выполнить задание } ] } 463 - 464 -(% style="color:#000000" %)Ответ: 465 - 466 -(% lang="en-US" style="text-align:left" %) 467 -(% 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»: «» //Сколько раз выполнить задание } ] } 468 - 469 - 470 470 (% class="box successmessage" %) 471 471 ((( 472 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**376 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** 473 473 ))) 474 474 475 475 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). ... ... @@ -512,36 +512,9 @@ 512 512 513 513 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 514 514 515 - (% style="color:#000000"%)0- «Блокировка»419 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 516 516 517 -(% style="color:#000000" %)1 - «Активен», 518 518 519 -(% style="color:#000000" %)2 - «Отменен» 520 - 521 -(% style="color:#000000" %)3 - «Оборудован» 522 - 523 -(% style="color:#000000" %)4 - «Диагностика» 524 - 525 -(% style="color:#000000" %)5 - «Сервис» 526 - 527 -(% style="color:#000000" %)6 - «Демонтаж» 528 - 529 -(% style="color:#000000" %)7 - «Монтаж» 530 - 531 -(% style="color:#000000" %)8 - «Дозаказ» 532 - 533 -(% style="color:#000000" %)9 - «Обслужен» 534 - 535 -(% style="color:#000000" %)10 - «Списан» 536 - 537 -(% style="color:#000000" %)11 - «Неисправен» 538 - 539 -(% style="color:#000000" %)12 - «Проверен» 540 - 541 -(% style="text-align:left" %) 542 -(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется» 543 - 544 - 545 545 (% class="box successmessage" %) 546 546 ((( 547 547 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** ... ... @@ -560,7 +560,9 @@ 560 560 (% style="color:#000000" %)Параметры в теле запроса (JSON): { 561 561 562 562 (% class="western" %) 563 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 440 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 441 + // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 442 + // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 564 564 "date": "", // Дата смены статуса (null если сменить немедленно) 565 565 "description": "", // Описание 566 566 "data": "", // Данные ... ... @@ -583,7 +583,112 @@ 583 583 (% style="color:#000000" %)} 584 584 585 585 465 +(% class="box warningmessage" %) 466 +((( 467 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 468 +))) 469 + 470 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 471 + 472 +(% style="color:#000000" %)Метод запроса: **PUT** 473 + 474 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 475 + 476 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 477 + 478 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 479 + 480 +(% 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»: «» //Сколько раз выполнить задание } ] } 481 + 482 +(% style="color:#000000" %)Ответ: 483 + 484 +(% lang="en-US" style="text-align:left" %) 485 +(% 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»: «» //Сколько раз выполнить задание } ] } 486 + 487 + 488 +(% class="box errormessage" %) 489 +((( 490 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 491 +))) 492 + 493 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 494 + 495 +(% style="color:#000000" %)Метод запроса: **DELETE** 496 + 497 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 498 + 499 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 500 + 501 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 502 + 503 +(% style="text-align:left" %) 504 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 505 + 506 + 586 586 (% class="box" lang="en-US" style="text-align: center;" %) 587 587 ((( 509 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 510 +))) 511 + 512 +(% class="box infomessage" %) 513 +((( 514 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 515 +))) 516 + 517 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 518 + 519 +(% style="color:#000000" %)Метод запроса: **GET** 520 + 521 +(% 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]] 522 + 523 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 524 + 525 +(% style="color:#000000" %)Ответ: [ 526 + 527 +(% class="western" %) 528 +{{{ { 529 + "deviceTypeId" : "", // ID типа устройства 530 + "deviceTypeName" : "" // Название типа устройства 531 + },}}} 532 + 533 +(% style="text-align:left" %) 534 +(% style="color:#000000" %)…** **] 535 + 536 + 537 +(% class="box" style="text-align: center;" %) 538 +((( 539 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 540 +))) 541 + 542 +(% class="box infomessage" %) 543 +((( 544 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 545 +))) 546 + 547 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 548 + 549 +(% style="color:#000000" %)Метод запроса: **GET** 550 + 551 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 552 + 553 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 554 + 555 +(% style="color:#000000" %)Ответ: [ 556 + 557 +(% class="western" style="margin-bottom:19px" %) 558 +{{{ {}}} 559 + 560 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 561 + 562 +(% class="western" %) 563 +{{{ "description": "" // Описание 564 + },}}} 565 + 566 +(% style="text-align:left" %) 567 +(% style="color:#000000" %)… ] 568 + 569 + 570 +(% class="box" lang="en-US" style="text-align: center;" %) 571 +((( 588 588 (% 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]] ** 589 589 )))