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
-
... ... @@ -1,5 +1,5 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0==2 +== Описание ГЛОНАССSoft Public API == 3 3 4 4 == == 5 5 ... ... @@ -17,28 +17,40 @@ 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 - ; line-height:100%" %)**Авторизация**(%style="color:#000000" %)**—**(% lang="en-US" %)**GET /api/v3/auth/login**25 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 26 26 ))) 27 27 28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации,которыйнеобходимодобавлятьвзаголовокдляработы со всеми методамиAPI.Впараметрахметодапередаетсяимяпользователяипароль.28 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 29 29 30 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 31 + 32 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 33 + 34 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 35 + 30 30 (% style="color:#000000" %)Метод запроса: **GET** 31 31 32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/a uth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]38 +(% 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> 33 33 34 -(% style="color:#000000" %) В случае успешного выполненияметода,поле«AuthId»содержиттокенавторизации «X-Auth».40 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 35 35 36 -(% lang="en-US" %) 37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 42 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 38 38 39 - **Примечание:**Времяжизнивторизации задаетсявнастройкахпользователя,тамсть параметрдлительностьсессии.При каждомзапросетокен пролонгируется.44 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 40 40 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" %)] 41 41 48 + 49 +(% class="box" style="text-align: center;" %) 50 +((( 51 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 52 +))) 53 + 42 42 (% class="box infomessage" %) 43 43 ((( 44 44 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** ... ... @@ -56,37 +56,86 @@ 56 56 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 57 57 58 58 59 -(% class="box "style="text-align: center;" %)71 +(% class="box infomessage" %) 60 60 ((( 61 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**73 +(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login** 62 62 ))) 63 63 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 +(% class="box" lang="en-US" style="text-align: center;" %) 89 +((( 90 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 91 +))) 92 + 64 64 (% class="box infomessage" %) 65 65 ((( 66 -(% style="color:#000000" %)**Получение основныхпараметровклиента —**(% lang="en-US" %)**GET**(%%)**/(%lang="en-US" %)api/v3/agents(%%)**95 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 67 67 ))) 68 68 69 -(% style="color:#000000" %) Метод позволяет получить основныепараметры клиентов:наименование,полное наименование,тип, статуси идентификаторклиента-родителя. Метод возвращает информацию оклиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):98 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 70 70 71 -(% style="color:#000000" %) − информация о клиентах предоставляетсяпри наличииправа «Просмотрклиентов»;100 +(% style="color:#000000" %)Метод запроса: **GET** 72 72 73 -(% style="color:#000000" %) − возвращается информация о клиенте, которомупринадлежит авторизованныйпользователь, и его дочерних клиентах;102 +(% 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]] 74 74 75 -(% style="color:#000000" %) −информация о клиенте типа «Партнер» и егоподклиентоввозвращаетсяпри наличииправа«Доступкпартнёрским клиентам».104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 76 76 106 +(% style="color:#000000" %)Ответ: [ 107 + 108 +(% class="western" %) 109 +{{{ { 110 + "deviceTypeId" : "", // ID типа устройства 111 + "deviceTypeName" : "" // Название типа устройства 112 + },}}} 113 + 114 +(% style="text-align:left" %) 115 +(% style="color:#000000" %)…** **] 116 + 117 + 118 +(% class="box" style="text-align: center;" %) 119 +((( 120 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 121 +))) 122 + 123 +(% class="box infomessage" %) 124 +((( 125 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 126 +))) 127 + 128 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 129 + 77 77 (% style="color:#000000" %)Метод запроса: **GET** 78 78 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>132 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 80 80 81 -(% style="color:#000000" %) Параметрзапроса:<parentId>- идентификаторклиента-родителя (опционально)134 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 82 82 83 -(% style="color:#000000" %) В заголовках запроса: X-Auth: Токен авторизации136 +(% style="color:#000000" %)Ответ: [ 84 84 85 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 138 +(% class="western" style="margin-bottom:19px" %) 139 +{{{ {}}} 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" %)]141 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 88 88 143 +(% class="western" %) 144 +{{{ "description": "" // Описание 145 + },}}} 89 89 147 +(% style="text-align:left" %) 148 +(% style="color:#000000" %)… ] 149 + 150 + 90 90 (% class="box" style="text-align: center;" %) 91 91 ((( 92 92 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -111,38 +111,6 @@ 111 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» //названия групп ] } 112 112 113 113 114 -(% class="box successmessage" %) 115 -((( 116 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 117 -))) 118 - 119 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 120 - 121 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 122 - 123 -(% style="color:#000000" %)Метод запроса: **POST** 124 - 125 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 126 - 127 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 128 - 129 -(% class="western" %) 130 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 131 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 132 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 133 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 134 - 135 -(% style="color:#000000" %)} 136 - 137 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 138 - 139 -(% class="western" style="margin-bottom:19px" %) 140 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 141 - 142 -(% lang="en-US" style="text-align:left" %) 143 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 144 - 145 - 146 146 (% class="box warningmessage" %) 147 147 ((( 148 148 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -162,7 +162,7 @@ 162 162 163 163 (% class="box warningmessage" %) 164 164 ((( 165 -(% style="color:#000000" %)**Измен ениестатусапользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**194 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 166 166 ))) 167 167 168 168 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). ... ... @@ -183,6 +183,38 @@ 183 183 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 184 184 185 185 215 +(% class="box successmessage" %) 216 +((( 217 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 218 +))) 219 + 220 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 221 + 222 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 223 + 224 +(% style="color:#000000" %)Метод запроса: **POST** 225 + 226 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 227 + 228 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 229 + 230 +(% class="western" %) 231 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 232 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 233 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 234 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 235 + 236 +(% style="color:#000000" %)} 237 + 238 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 239 + 240 +(% class="western" style="margin-bottom:19px" %) 241 +{{{ "sessionDuration":"", // длительность сессии в минутах}}} 242 + 243 +(% lang="en-US" style="text-align:left" %) 244 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 245 + 246 + 186 186 (% class="box errormessage" %) 187 187 ((( 188 188 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -205,6 +205,25 @@ 205 205 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 206 206 ))) 207 207 269 +(% class="box errormessage" %) 270 +((( 271 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 272 +))) 273 + 274 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 275 + 276 +(% style="color:#000000" %)Метод запроса: **DELETE** 277 + 278 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 279 + 280 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 281 + 282 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 283 + 284 +(% style="text-align:left" %) 285 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 286 + 287 + 208 208 (% class="box infomessage" %) 209 209 ((( 210 210 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -363,9 +363,32 @@ 363 363 (% style="color:#000000" %)} 364 364 365 365 446 +(% class="box warningmessage" %) 447 +((( 448 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 449 +))) 450 + 451 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 452 + 453 +(% style="color:#000000" %)Метод запроса: **PUT** 454 + 455 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 456 + 457 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 458 + 459 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 460 + 461 +(% 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»: «» //Сколько раз выполнить задание } ] } 462 + 463 +(% style="color:#000000" %)Ответ: 464 + 465 +(% lang="en-US" style="text-align:left" %) 466 +(% 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»: «» //Сколько раз выполнить задание } ] } 467 + 468 + 366 366 (% class="box successmessage" %) 367 367 ((( 368 -(% style="color:#000000; line-height:100%" %)**Получение па раметровобъектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**471 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles** 369 369 ))) 370 370 371 371 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). ... ... @@ -408,34 +408,34 @@ 408 408 409 409 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 410 410 411 -(% style="color:#000000" %)0 - «Блокировка» ;514 +(% style="color:#000000" %)0 - «Блокировка» 412 412 413 -(% style="color:#000000" %)1 - «Активен» ;516 +(% style="color:#000000" %)1 - «Активен», 414 414 415 -(% style="color:#000000" %)2 - «Отменен» ;518 +(% style="color:#000000" %)2 - «Отменен» 416 416 417 -(% style="color:#000000" %)3 - «Оборудован» ;520 +(% style="color:#000000" %)3 - «Оборудован» 418 418 419 -(% style="color:#000000" %)4 - «Диагностика» ;522 +(% style="color:#000000" %)4 - «Диагностика» 420 420 421 -(% style="color:#000000" %)5 - «Сервис» ;524 +(% style="color:#000000" %)5 - «Сервис» 422 422 423 -(% style="color:#000000" %)6 - «Демонтаж» ;526 +(% style="color:#000000" %)6 - «Демонтаж» 424 424 425 -(% style="color:#000000" %)7 - «Монтаж» ;528 +(% style="color:#000000" %)7 - «Монтаж» 426 426 427 -(% style="color:#000000" %)8 - «Дозаказ» ;530 +(% style="color:#000000" %)8 - «Дозаказ» 428 428 429 -(% style="color:#000000" %)9 - «Обслужен» ;532 +(% style="color:#000000" %)9 - «Обслужен» 430 430 431 -(% style="color:#000000" %)10 - «Списан» ;534 +(% style="color:#000000" %)10 - «Списан» 432 432 433 -(% style="color:#000000" %)11 - «Неисправен» ;536 +(% style="color:#000000" %)11 - «Неисправен» 434 434 435 -(% style="color:#000000" %)12 - «Проверен» ;538 +(% style="color:#000000" %)12 - «Проверен» 436 436 437 437 (% style="text-align:left" %) 438 -(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется» .541 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется» 439 439 440 440 441 441 (% class="box successmessage" %) ... ... @@ -479,112 +479,7 @@ 479 479 (% style="color:#000000" %)} 480 480 481 481 482 -(% class="box warningmessage" %) 483 -((( 484 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 485 -))) 486 - 487 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 488 - 489 -(% style="color:#000000" %)Метод запроса: **PUT** 490 - 491 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 492 - 493 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 494 - 495 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 496 - 497 -(% 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»: «» //Сколько раз выполнить задание } ] } 498 - 499 -(% style="color:#000000" %)Ответ: 500 - 501 -(% lang="en-US" style="text-align:left" %) 502 -(% 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»: «» //Сколько раз выполнить задание } ] } 503 - 504 - 505 -(% class="box errormessage" %) 506 -((( 507 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 508 -))) 509 - 510 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 511 - 512 -(% style="color:#000000" %)Метод запроса: **DELETE** 513 - 514 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 515 - 516 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 517 - 518 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 519 - 520 -(% style="text-align:left" %) 521 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 522 - 523 - 524 524 (% class="box" lang="en-US" style="text-align: center;" %) 525 525 ((( 526 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 527 -))) 528 - 529 -(% class="box infomessage" %) 530 -((( 531 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 532 -))) 533 - 534 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 535 - 536 -(% style="color:#000000" %)Метод запроса: **GET** 537 - 538 -(% 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]] 539 - 540 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 541 - 542 -(% style="color:#000000" %)Ответ: [ 543 - 544 -(% class="western" %) 545 -{{{ { 546 - "deviceTypeId" : "", // ID типа устройства 547 - "deviceTypeName" : "" // Название типа устройства 548 - },}}} 549 - 550 -(% style="text-align:left" %) 551 -(% style="color:#000000" %)…** **] 552 - 553 - 554 -(% class="box" style="text-align: center;" %) 555 -((( 556 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 557 -))) 558 - 559 -(% class="box infomessage" %) 560 -((( 561 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 562 -))) 563 - 564 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 565 - 566 -(% style="color:#000000" %)Метод запроса: **GET** 567 - 568 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 569 - 570 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 571 - 572 -(% style="color:#000000" %)Ответ: [ 573 - 574 -(% class="western" style="margin-bottom:19px" %) 575 -{{{ {}}} 576 - 577 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 578 - 579 -(% class="western" %) 580 -{{{ "description": "" // Описание 581 - },}}} 582 - 583 -(% style="text-align:left" %) 584 -(% style="color:#000000" %)… ] 585 - 586 - 587 -(% class="box" lang="en-US" style="text-align: center;" %) 588 -((( 589 589 (% 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]] ** 590 590 )))