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
-
... ... @@ -84,65 +84,96 @@ 84 84 85 85 (% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 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" %)]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" %)] 88 88 89 89 90 -(% class="box" style="text-align: center;" %) 90 +(% class="box" lang="en-US" style="text-align: center;" %) 91 91 ((( 92 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**92 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 93 93 ))) 94 94 95 -(% class="box successmessage" %)95 +(% class="box infomessage" %) 96 96 ((( 97 -(% style="color:#000000; line-height:100%" %)** Добавление пользователя— **(% lang="en-US" %)**POSTusers**97 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 98 98 ))) 99 99 100 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Методпозволяетдобавитьпользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).100 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 101 101 102 -(% style="color:#000000" %)Метод запроса: ** POST**102 +(% style="color:#000000" %)Метод запроса: **GET** 103 103 104 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 104 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 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»:[// группы пользователя «», //названия групп «», «» ] }108 +(% style="color:#000000" %)Ответ: [ 109 109 110 +(% class="western" %) 111 +{{{ { 112 + "deviceTypeId" : "", // ID типа устройства 113 + "deviceTypeName" : "" // Название типа устройства 114 + },}}} 115 + 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» //названия групп]}117 +(% style="color:#000000" %)…** **] 112 112 113 113 114 -(% class="box s uccessmessage" %)120 +(% class="box" style="text-align: center;" %) 115 115 ((( 116 -(% style="color:#000000; line-height:100%" %)**Получение спискапользователей—**(% lang="en-US" %)**POST /api/v3/users/find**122 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 117 117 ))) 118 118 119 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 125 +(% class="box infomessage" %) 126 +((( 127 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 128 +))) 120 120 121 -(% style="color:#000000" %)Метод возвращает информацию о п ользователяхклиента-родителяавторизованного пользователяи пользователяхегодочернихклиентов.Информацияопользователях предоставляется приналичииправа**«Просмотр пользователей»**.130 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 122 122 123 -(% style="color:#000000" %)Метод запроса: ** POST**132 +(% style="color:#000000" %)Метод запроса: **GET** 124 124 125 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]134 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 126 126 127 -(% style="color:#000000" %) Условияфильтрацииобъектовзадаютсяв телезапроса.Параметрывелезапроса (JSON): {136 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 128 128 138 +(% style="color:#000000" %)Ответ: [ 139 + 140 +(% class="western" style="margin-bottom:19px" %) 141 +{{{ {}}} 142 + 143 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 144 + 129 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 - неважно}}} 146 +{{{ "description": "" // Описание 147 + },}}} 134 134 135 -(% style="color:#000000" %)} 149 +(% style="text-align:left" %) 150 +(% style="color:#000000" %)… ] 136 136 137 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 138 138 139 -(% class="western" style="margin-bottom:19px" %) 140 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 153 +(% class="box" style="text-align: center;" %) 154 +((( 155 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 156 +))) 141 141 142 -(% lang="en-US" style="text-align:left" %) 143 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 158 +(% class="box successmessage" %) 159 +((( 160 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 161 +))) 144 144 163 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 145 145 165 +(% style="color:#000000" %)Метод запроса: **POST** 166 + 167 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 168 + 169 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 170 + 171 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } 172 + 173 +(% style="text-align:left" %) 174 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 175 + 176 + 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}**196 +(% 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 217 +(% class="box successmessage" %) 218 +((( 219 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 220 +))) 221 + 222 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 223 + 224 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 225 + 226 +(% style="color:#000000" %)Метод запроса: **POST** 227 + 228 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 229 + 230 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 231 + 232 +(% class="western" %) 233 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 234 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 235 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 236 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 237 + 238 +(% style="color:#000000" %)} 239 + 240 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 241 + 242 +(% class="western" style="margin-bottom:19px" %) 243 +{{{ "sessionDuration":"", // длительность сессии в минутах}}} 244 + 245 +(% lang="en-US" style="text-align:left" %) 246 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 247 + 248 + 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 271 +(% class="box errormessage" %) 272 +((( 273 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 274 +))) 275 + 276 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 277 + 278 +(% style="color:#000000" %)Метод запроса: **DELETE** 279 + 280 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 281 + 282 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 283 + 284 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 285 + 286 +(% style="text-align:left" %) 287 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 288 + 289 + 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 448 +(% class="box warningmessage" %) 449 +((( 450 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 451 +))) 452 + 453 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 454 + 455 +(% style="color:#000000" %)Метод запроса: **PUT** 456 + 457 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 458 + 459 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 460 + 461 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 462 + 463 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 464 + 465 +(% style="color:#000000" %)Ответ: 466 + 467 +(% lang="en-US" style="text-align:left" %) 468 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 469 + 470 + 366 366 (% class="box successmessage" %) 367 367 ((( 368 -(% style="color:#000000; line-height:100%" %)**Получение па раметровобъектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**473 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles** 369 369 ))) 370 370 371 371 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). ... ... @@ -408,9 +408,36 @@ 408 408 409 409 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 410 410 411 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».516 +(% style="color:#000000" %)0 - «Блокировка» 412 412 518 +(% style="color:#000000" %)1 - «Активен», 413 413 520 +(% style="color:#000000" %)2 - «Отменен» 521 + 522 +(% style="color:#000000" %)3 - «Оборудован» 523 + 524 +(% style="color:#000000" %)4 - «Диагностика» 525 + 526 +(% style="color:#000000" %)5 - «Сервис» 527 + 528 +(% style="color:#000000" %)6 - «Демонтаж» 529 + 530 +(% style="color:#000000" %)7 - «Монтаж» 531 + 532 +(% style="color:#000000" %)8 - «Дозаказ» 533 + 534 +(% style="color:#000000" %)9 - «Обслужен» 535 + 536 +(% style="color:#000000" %)10 - «Списан» 537 + 538 +(% style="color:#000000" %)11 - «Неисправен» 539 + 540 +(% style="color:#000000" %)12 - «Проверен» 541 + 542 +(% style="text-align:left" %) 543 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется» 544 + 545 + 414 414 (% class="box successmessage" %) 415 415 ((( 416 416 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** ... ... @@ -452,112 +452,7 @@ 452 452 (% style="color:#000000" %)} 453 453 454 454 455 -(% class="box warningmessage" %) 456 -((( 457 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 458 -))) 459 - 460 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 461 - 462 -(% style="color:#000000" %)Метод запроса: **PUT** 463 - 464 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 465 - 466 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 467 - 468 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 469 - 470 -(% 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»: «» //Сколько раз выполнить задание } ] } 471 - 472 -(% style="color:#000000" %)Ответ: 473 - 474 -(% lang="en-US" style="text-align:left" %) 475 -(% 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»: «» //Сколько раз выполнить задание } ] } 476 - 477 - 478 -(% class="box errormessage" %) 479 -((( 480 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 481 -))) 482 - 483 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 484 - 485 -(% style="color:#000000" %)Метод запроса: **DELETE** 486 - 487 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 488 - 489 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 490 - 491 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 492 - 493 -(% style="text-align:left" %) 494 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 495 - 496 - 497 497 (% class="box" lang="en-US" style="text-align: center;" %) 498 498 ((( 499 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 500 -))) 501 - 502 -(% class="box infomessage" %) 503 -((( 504 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 505 -))) 506 - 507 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 508 - 509 -(% style="color:#000000" %)Метод запроса: **GET** 510 - 511 -(% 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]] 512 - 513 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 514 - 515 -(% style="color:#000000" %)Ответ: [ 516 - 517 -(% class="western" %) 518 -{{{ { 519 - "deviceTypeId" : "", // ID типа устройства 520 - "deviceTypeName" : "" // Название типа устройства 521 - },}}} 522 - 523 -(% style="text-align:left" %) 524 -(% style="color:#000000" %)…** **] 525 - 526 - 527 -(% class="box" style="text-align: center;" %) 528 -((( 529 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 530 -))) 531 - 532 -(% class="box infomessage" %) 533 -((( 534 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 535 -))) 536 - 537 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 538 - 539 -(% style="color:#000000" %)Метод запроса: **GET** 540 - 541 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 542 - 543 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 544 - 545 -(% style="color:#000000" %)Ответ: [ 546 - 547 -(% class="western" style="margin-bottom:19px" %) 548 -{{{ {}}} 549 - 550 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 551 - 552 -(% class="western" %) 553 -{{{ "description": "" // Описание 554 - },}}} 555 - 556 -(% style="text-align:left" %) 557 -(% style="color:#000000" %)… ] 558 - 559 - 560 -(% class="box" lang="en-US" style="text-align: center;" %) 561 -((( 562 562 (% 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]] ** 563 563 )))