Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/21 14:13
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - МетодыAPIдля работы с ГЛОНАССSoft1 +API - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Tags
-
... ... @@ -1,1 +1,0 @@ 1 -Public API|API - Content
-
... ... @@ -1,888 +1,440 @@ 1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 1 +== Описание ГЛОНАССSoft Public API == 3 3 4 4 == == 5 5 6 -(% class="box" style="text-align: center;" %) 7 -((( 8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 9 -))) 5 + **Действующие ограничения** 6 + 10 10 11 - (%style="color:#000000" %)−(%%)Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).8 +- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов) 12 12 13 - (%style="color:#000000" %)−(%%)Для работы со всеми методами API необходимо в заголовок добавлять__**X-Auth**__(токен авторизации, получаемый методом__**auth/login**__).10 +- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 - 13 +\\ 17 17 18 -(% class="box" style="text-align: center;" %) 19 -((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 -))) 15 + **Авторизация** 22 22 23 -(% class="box successmessage" %) 24 -((( 25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login** 26 -))) 17 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 27 27 28 - (% style="color:#000000" %)Методпозволяет получить токенавторизации, который необходимо добавлять в заголовок для работы со всеми методами API. Впараметрах метода передается имя пользователяи пароль.19 +Метод запроса: GET 29 29 30 - (%style="color:#000000" %)Метод запроса:**POST**21 +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]] 31 31 32 - (%style="color:#000000" %)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]23 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 33 33 34 - (% style="color:#000000"%)Вслучаеуспешноговыполненияметода,поле«__**AuthId**__»содержиттокен авторизации «__**X-Auth**__».25 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ] 35 35 36 - (%style="color:#000000"%)Параметрывтелезапроса(JSON):27 + **Получение списка объектов** 37 37 38 -(% style="color:#000000" %){ 39 - "login": "testuser", 40 - "password": "testuser" 41 -}(%%) 42 - 29 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 43 43 44 - (%style="color:#000000"%)**Ответ:**31 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 45 45 46 -(% lang="en-US" %) 47 -(% style="color:#000000" %){ 33 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов; 48 48 49 -(% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 - "User": "testuser" , ~/~/ имя пользователя 35 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 52 52 53 -(% lang="en-US" %) 54 -} 37 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 55 55 56 - **Примечание: **Времяжизни токенаавторизации задаетсяв настройкахпользователя, таместьпараметрдлительность сессии.При каждом запросетокенпролонгируется.39 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 57 57 41 +Метод запроса: POST 58 58 59 -(% class="box infomessage" %) 60 -((( 61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 62 -))) 43 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 63 63 64 - (%style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса- токен авторизации **«__X-Auth__»**).45 +В заголовках запроса: 65 65 66 - (% style="color:#000000" %)Метод запроса: **GET**47 +−Content-Type: application/json 67 67 68 - (% style="color:#000000"%)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]49 +−X-Auth: Токен авторизации 69 69 70 - (%style="color:#000000" %)В заголовкахзапроса:X-Auth: Токенавторизации51 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 71 71 72 -(% lang="en-US" %) 73 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 53 +{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}} 74 74 55 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 75 75 76 -(% class="box" style="text-align: center;" %) 77 -((( 78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 79 -))) 57 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 80 80 81 -(% class="box infomessage" %) 82 -((( 83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 84 -))) 59 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 85 85 86 - (% style="color:#000000"%) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя.Метод возвращает информацию о клиентах с учетом настроекавторизованного пользователя, указанного в запросе (обязательный параметрвзаголовках запроса - токен авторизации **«__X-Auth__»**):61 +0 - «Блокировка» 87 87 88 - (%style="color:#000000"%)− информация оклиентах предоставляется приналичии права «Просмотр клиентов»;63 +1 - «Активен», 89 89 90 - (%style="color:#000000"%)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;65 +2 - «Отменен» 91 91 92 - (%style="color:#000000"%)− информация о клиенте типа«Партнер» и егоподклиентоввозвращается приналичии права «__**Доступ к партнёрским клиентам**__».67 +3 - «Оборудован» 93 93 94 - (%style="color:#000000"%)Метод запроса: **GET**69 +4 - «Диагностика» 95 95 96 - (%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>71 +5 - «Сервис» 97 97 98 - (%style="color:#000000" %)Параметр запроса: <__**parentId**__>-идентификатор клиента-родителя (опционально)73 +6 - «Демонтаж» 99 99 100 - (%style="color:#000000" %)В заголовках запроса: X-Auth:Токенавторизации75 +7 - «Монтаж» 101 101 102 - (%style="color:#000000"%)Ответ:77 +8 - «Дозаказ» 103 103 104 -(% style="color:#000000" %){ 105 - "agentId": "", ~/~/ идентификатор клиента 106 - "parentId": "", ~/~/ идентификатор клиента-родителя 107 - "name": "", ~/~/ наименование клиента 108 - "fullName": "", ~/~/ полное наименование клиента 109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 111 -} 79 +9 - «Обслужен» 112 112 81 +10 - «Списан» 113 113 114 -(% class="box" style="text-align: center;" %) 115 -((( 116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 117 -))) 83 +11 - «Неисправен» 118 118 119 -(% class="box successmessage" %) 120 -((( 121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 122 -))) 85 +12 - «Проверен» 123 123 124 - (%style="color:#000000"%) Методпозволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).87 +13 - «Не эксплуатируется» 125 125 126 - (%style="color:#000000"%)Методзапроса:**POST**89 + **Получение списка клиентов.** 127 127 128 - (%style="color:#000000"%)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]91 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 129 129 130 - (% style="color:#000000" %)В заголовкахзапроса:X-Auth:Токен авторизации93 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»; 131 131 132 - (% style="color:#000000" %)Параметрывтеле запроса(JSON):95 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 133 133 134 -(% style="color:#000000" %){ 135 - "lastName": "", ~/~/ фамилия 136 - "firstName": "", ~/~/ имя 137 - "position": "", ~/~/ должность 138 - "phone": "", ~/~/ телефон 139 - "organization": "", ~/~/ организация 140 - "login": "", ~/~/ логин 141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 142 - "email": "", ~/~/ email 143 - "description": "", ~/~/ описание 144 - "isEnabled": "", ~/~/ признак включения 145 - "parentId": "", ~/~/ Guid родительского агента 146 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 147 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 148 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 149 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 150 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 151 - "groups": "" , ~/~/ группы пользователя, названия групп 152 -} 97 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 153 153 154 -(% style="text-align:left" %) 155 -(% style="color:#000000; font-weight:normal" %)Ответ: 99 +Метод запроса: GET 156 156 157 -(% style="text-align:left" %) 158 -(% style="color:#000000; font-weight:normal" %){ 101 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId> 159 159 160 -(% style="text-align:left" %) 161 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 162 - "lastName": "" , ~/~/ Фамилия , 163 - "firstName": "" , ~/~/ Имя 164 - "position": "" , ~/~/ Должность 165 - "phone": "" , ~/~/ Телефон 166 - "organization": "" , ~/~/ Организация 167 - "login": "" , ~/~/ Логин 168 - "password": "" , ~/~/ Пароль 169 - "email": "" , ~/~/ Email 170 - "description": "" , ~/~/ Описание 171 - "isEnabled": "" , ~/~/ Признак включения 172 - "parentId": "" , ~/~/ Guid родительского агента 173 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 174 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 175 - "kind": "" , ~/~/ тип аутентификации 176 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 103 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 178 178 179 -(% style="text-align:left" %) 180 -(% style="color:#000000; font-weight:normal" %)} 105 +В заголовках запроса: X-Auth: Токен авторизации 181 181 107 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 182 182 183 -(% class="box successmessage" %) 184 -((( 185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 186 -))) 109 +Примечание. Возможные значение параметра agentInfoType: 187 187 188 - (%style="color:#000000"%)Метод позволяет получить основные параметрыпользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.111 + **Получение списка пользователей.** 189 189 190 - (% style="color:#000000" %)Методвозвращаетинформацию опользователяхклиента-родителяавторизованногопользователяи пользователях егодочернихклиентов. Информацияопользователях предоставляетсяприаличии права **«__Просмотрпользователей__»**.113 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр. 191 191 192 - (%style="color:#000000"%)Метод запроса:**POST**115 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей». 193 193 194 - (%style="color:#000000" %)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]117 +Метод запроса: POST 195 195 196 - (% style="color:#000000" %)Условия фильтрации объектовзадаются в теле запроса.119 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 197 197 198 - (%style="color:#000000"%)Параметры в теле запроса (JSON):121 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 199 199 200 -(% style="color:#000000" %){ 123 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 124 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 125 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 126 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 201 201 202 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 203 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 204 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 205 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 128 +} 206 206 207 - (%style="color:#000000"%)}130 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 208 208 209 - (%style="color:#000000"%)Ответ:132 +{{{ "sessionDuration": "", // длительность сессии в минутах}}} 210 210 211 - (%style="color:#000000" %){(%%)134 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ] 212 212 213 - "id": "" , ~/~/ идентификатор пользователя 214 - "lastName": "" , ~/~/ фамилия 215 - "firstName": "" , ~/~/ имя 216 - "position": "" , ~/~/ должность 217 - "phone": "" , ~/~/ телефон 218 - "parentId": "" , ~/~/ идентификатор клиента-родителя 219 - "parentName": "" , ~/~/ наименование клиента-родителя 220 - "organization": "" , ~/~/ организация 221 - "login": "" , ~/~/ логин 222 - "email": "" , ~/~/ E-mail 223 - "sessionDuration":"", ~/~/ длительность сессии в минутах 224 - "status": "1", ~/~/ статус пользователя 225 - "astLogged": "", ~/~/ дата/время последней авторизации 136 + **Получение списка типов устройств** 226 226 227 -( %style="color:#000000"%)}138 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 228 228 140 +Метод запроса: GET 229 229 230 -(% class="box warningmessage" %) 231 -((( 232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 233 -))) 142 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 234 234 235 - (%style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанногов запросе (обязательный параметр в заголовках запросатокен авторизации**«__X-Auth__»**).144 +В заголовках запроса:X-Auth: Токен авторизации 236 236 237 - (% style="color:#000000" %)Метод запроса:**PUT**146 +Ответ: [ 238 238 239 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 148 +{{{ { 149 + "deviceTypeId" : "", // ID типа устройства 150 + "deviceTypeName" : "" // Название типа устройства 151 + },}}} 240 240 241 - (%style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации153 +… ] 242 242 243 -(% lang="en-US" style="text-align:left" %) 244 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 155 + **Получение списка типов датчиков** 245 245 246 -(% lang="en-US" style="text-align:left" %) 247 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 157 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 248 248 249 -(% lang="en-US" style="text-align:left" %) 250 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 251 - "lastName": "" , ~/~/ фамилия 252 - "firstName": "" , ~/~/ имя 253 - "position": "" , ~/~/ должность 254 - "phone": "" , ~/~/ телефон 255 - "organization": "" , ~/~/ организация 256 - "login": "" , ~/~/ логин 257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 258 - "email": "" , ~/~/ email 259 - "description": "" , ~/~/ описание 260 - "isEnabled": "" , ~/~/ признак включения 261 - "parentId": "" , ~/~/ Guid родительского агента 262 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 263 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 264 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 265 - "kind": "" , ~/~/ тип аутентификации 266 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 267 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 159 +Метод запроса: GET 268 268 269 -(% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 161 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 271 271 272 -(% lang="en-US" style="text-align:left" %) 273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 163 +В заголовках запроса:X-Auth: Токен авторизации 274 274 275 -(% lang="en-US" style="text-align:left" %) 276 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 165 +Ответ: [ 277 277 278 -(% lang="en-US" style="text-align:left" %) 279 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 280 - "lastName": "" , ~/~/ фамилия 281 - "firstName": "" , ~/~/ имя 282 - "position": "" , ~/~/ должность 283 - "phone": "" , ~/~/ телефон 284 - "organization": "" , ~/~/ организация 285 - "login": "" , ~/~/ логин 286 - "password": "" , ~/~/ пароль 287 - "email": "" , ~/~/ email 288 - "description": "" , ~/~/ описание 289 - "isEnabled": "" , ~/~/ признак включения 290 - "parentId": "" , ~/~/ Guid родительского агента 291 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 293 - "kind": "" , ~/~/ тип аутентификации 294 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 295 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 167 +{{{ {}}} 296 296 297 -(% lang="en-US" style="text-align:left" %) 298 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 169 +«id»: «», //ID типа датчика «name»: «», //Название 299 299 171 +{{{ "description": "" // Описание 172 + },}}} 300 300 301 -(% class="box warningmessage" %) 302 -((( 303 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 304 -))) 174 +… ] 305 305 306 - (%style="color:#000000"%)Метод позволяет изменить статус пользователя,указанного в запросе (обязательный параметр в заголовкахзапроса- токен авторизации**«__X-Auth__»**).176 + **Получение информации об объекте** 307 307 308 - (%style="color:#000000"%)Метод запроса:**PUT**178 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 309 309 310 -( %style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}180 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 311 311 312 - (% style="color:#000000" %)Параметр запроса:{__**id**__}-Guidпользователя182 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание». 313 313 314 - (% style="color:#000000" %)В заголовкахзапроса:X-Auth: Токен авторизации184 +Метод запроса: GET 315 315 316 - (%style="color:#000000" %)Параметры в теле запроса (JSON):186 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID> 317 317 318 - (%style="color:#000000"%){188 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 319 319 320 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 321 - "description": "" , ~/~/ описание 322 - "data": "" , ~/~/ данные, связанные со сменой статуса 190 +В заголовках запроса: X-Auth: Токен авторизации 323 323 324 - (% style="color:#000000" %)}192 +Ответ: 325 325 326 -(% style="text-align:left" %) 327 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 194 +{ 328 328 196 +{{{ "vehicleId": “”, // идентификатор объекта 197 + "name": "", // имя объекта 198 + "imei": "", // IMEI объекта 199 + "deviceTypeId": “”, // идентификатор устройства объекта 200 + "deviceTypeName": "" // наименование устройства объекта 201 + "parentId": "", // идентификатор клиента-родителя 202 + "parentName": "" // наименование клиента-родителя, 203 + "modelId": "", // идентификатор модели объекта 204 + "modelName": "" // наименование модели объекта, 205 + "unitId": "", // идентификатор подразделения 206 + "unitName": "", // наименование подразделения 207 + "status": “”, // статус объекта 208 + ... 209 + }, 210 + ...}}} 329 329 330 -(% class="box warningmessage" %) 331 -((( 332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable** 333 -))) 212 +} 334 334 335 - Методапозволяет выполнитьмассовуюблокировку пользователей (%style="color:#000000"%)(обязательныйпараметрвзаголовкахзапроса - токенавторизации**«__X-Auth__»**).214 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется» 336 336 337 - (%style="color:#000000"%)Методзапроса: (% style="color:#000000; line-height:100%" %)**POST**216 + **Добавление пользователя** 338 338 339 -( %style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]218 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 340 340 341 - (% style="color:#000000" %)В телезапросаперечисляете массив id пользователей (JSON):220 +Метод запроса: POST 342 342 343 - [ 344 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 345 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 346 - ] 222 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 347 347 348 - (% style="color:#000000" %)**Ответ:Вслучае успешноговыполнениязапросавернетсяHTTP ответ«200»**224 +В заголовках запроса: X-Auth: Токен авторизации 349 349 226 +Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] } 350 350 351 -(% class="box warningmessage" %) 352 -((( 353 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/find** 354 -))) 228 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 355 355 356 - Методапозволяетвыполнитьмассовуюразблокировкупользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации**«__X-Auth__»**).230 + **Редактирование пользователя** 357 357 358 - (%style="color:#000000"%)Метод запроса:(%style="color:#000000;line-height:100%"%)**POST**232 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 359 359 360 - (%style="color:#000000" %)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]234 +Метод запроса: PUT 361 361 362 - (% style="color:#000000" %)В телезапросаперечисляете массивid пользователей (JSON):236 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 363 363 364 - [ 365 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 366 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 367 - ] 238 +В заголовках запроса: X-Auth: Токен авторизации 368 368 369 -( %style="color:#000000"%)**Ответ:Вслучае успешного выполнения запроса вернетсяHTTP ответ «200»**240 +Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 370 370 242 +{{{ "description": "", // описание 243 + "data": "" // данные, связанные со сменой статуса}}} 371 371 372 -(% class="box errormessage" %) 373 -((( 374 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 375 -))) 245 +} 376 376 377 - (% style="color:#000000" %) Метод позволяетудалитьпользователя.Метод позволяетудалитьпользователя, указанного встроке запроса(обязательный параметр в заголовках запроса-токен авторизации**«__X-Auth__»**).247 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 378 378 379 - (%style="color:#000000"%)Методзапроса:**DELETE**249 + **Удаление пользователя** 380 380 381 - (%style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}251 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 382 382 383 - (% style="color:#000000" %)Параметрзапроса:{**__id__**} - Guid пользователя253 +Метод запроса: DELETE 384 384 385 - (% style="color:#000000" %)Взаголовках запроса:X-Auth:Токен авторизации255 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id} 386 386 387 -(% style="text-align:left" %) 388 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 257 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 389 389 259 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 390 390 391 -(% class="box" style="text-align: center;" %) 392 -((( 393 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 394 -))) 261 + **Добавление объекта** 395 395 396 -(% class="box infomessage" %) 397 -((( 398 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 399 -))) 263 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8) 400 400 401 - (% style="color:#000000" %)Методпозволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, типустройства,SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».265 +Метод запроса: POST 402 402 403 - (%style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):267 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 404 404 405 - (%style="color:#000000" %)− возвращаетсяинформацияобобъектеклиента-родителяавторизованного пользователяиобъекте его дочерних клиентов;269 +В заголовках запроса: X-Auth: Токен авторизации 406 406 407 - (% style="color:#000000" %)− информацияоТОпредоставляетсяс учётомправна**«__Просмотр заданийна техобслуживание__»**.271 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 408 408 409 -(% style="color:#000000" %)Метод запроса: **GET** 410 - 411 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID> 412 - 413 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально) 414 - 415 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 416 - 417 -(% style="color:#000000" %)Ответ: 418 - 419 -(% style="color:#000000" %){ 420 - 421 - "vehicleId": "" , ~/~/ идентификатор объекта 422 - "name": "" , ~/~/ имя объекта 423 - "imei": "" , ~/~/ IMEI объекта 424 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 425 - "deviceTypeName": "" , ~/~/ наименование устройства объекта 426 - "parentId": "" , ~/~/ идентификатор клиента-родителя 427 - "parentName": "" , ~/~/ наименование клиента-родителя, 428 - "modelId": "" , ~/~/ идентификатор модели объекта 429 - "modelName": "" , ~/~/ наименование модели объекта, 430 - "unitId": "" , ~/~/ идентификатор подразделения 431 - "unitName": "" , ~/~/ наименование подразделения 432 - "status": "" , ~/~/ статус объекта 433 - 434 -} 435 - 436 -(% style="text-align:left" %) 437 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 438 - 439 -(% style="text-align:left" %) 440 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 441 - 442 - 443 -(% class="box successmessage" %) 444 -((( 445 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 446 -))) 447 - 448 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 449 - 450 -(% style="color:#000000" %)Метод запроса: **POST** 451 - 452 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 453 - 454 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 455 - 456 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 457 - 458 -(% style="color:#000000" %){ 459 - 460 - "parentId": "" , ~/~/ ID клиента 461 - "name": "" , ~/~/ имя ТС 462 - "imei": "" , ~/~/ IMEI 463 - "deviceTypeId": "" , ~/~/ ID типа устройства 464 - "modelId": "" , ~/~/ ID модели 465 - "unitId": "" , ~/~/ ID подразделения 466 - "sim1": "" , ~/~/ Номер SIM 1 467 - "sim2": "" , ~/~/ Номер SIM2 468 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 469 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 470 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 471 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 472 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 473 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 474 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 475 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 476 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 477 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 478 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 479 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 480 - "counters": ~/~/ счетчики 481 - { 482 - "mileage": "" , ~/~/ пробег 483 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 484 - "motohours": "" , ~/~/ моточасы 485 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 273 +{{{ "parentId": "", // ID клиента 274 + "name": "", // имя ТС 275 + "imei": "", // IMEI 276 + "deviceTypeId": "",// ID типа устройства 277 + "modelId": "", 278 + "unitId": "", // ID подразделения 279 + "sim1": "", // Номер SIM 1 280 + "sim2": "", // Номер SIM2 281 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 282 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 283 + "consumptionIdle": "",// Расход топлива на холостом ходу 284 + "counters": { 285 + "mileage": "", // пробег 286 + "mileageEnabled": true, // флаг активности счётчика "пробег" 287 + "motohours":"", // моточасы 288 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 289 + }, 290 + "cmsv6Parameters": { // параметры CMSv6 291 + "enabled": true, // флаг включения 292 + //"id": "", // идентификатор 293 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 294 + "login": "", // имя учетной записи 295 + "password": "" // пароль учетной записи 486 486 }, 487 - "cmsv6Parameters": { ~/~/ параметры CMSv6 488 - "enabled": true, ~/~/ флаг включения 489 - "id": "" , ~/~/ идентификатор 490 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 491 - "login": "" , ~/~/ имя учетной записи 492 - "password": "" ~/~/ пароль учетной записи 493 - }, 494 - "inspectionTasks": ~/~/ задания на ТО 297 + "inspectionTasks": [ // задания на ТО 495 495 { 496 - "enabled": "" , ~/~/ Признак включения 497 - "name": "" , ~/~/ Имя задания 498 - "description": "" , ~/~/ Описание задания 499 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 500 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 501 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 502 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 503 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 504 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 505 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 506 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 507 - } 299 + "enabled": "", // Признак включения 300 + "name": "", // Имя задания 301 + "description": "", // Описание задания 302 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 303 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 304 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 305 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 306 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 307 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 308 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 309 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 310 + }, 311 + ]}}} 508 508 509 - (%style="color:#000000" %)}313 +… } 510 510 511 - (% style="color:#000000" %)Ответ:315 +Ответ: 512 512 513 - (% style="color:#000000" %){317 +{ 514 514 515 - "vehicleId": "", ~/~/ID ТС 516 - "parentId": "", ~/~/Guid владельца ТС 517 - "name": "", ~/~/Имя объекта 518 - "imei": "", ~/~/IMEI 519 - "deviceTypeId": "", ~/~/ID типа устройства 520 - "modelId": "", ~/~/ID модели 521 - "unitId": "", ~/~/ID подразделения 522 - "sim1": "", ~/~/SIM1 523 - "sim2": "", ~/~/SIM2 524 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 525 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 526 - "counters": { ~/~/Счётчики 527 - "mileageEnabled": true, 528 - "motohoursEnabled": true, 529 - "mileage": "", 530 - "motohours": 345.0 531 - }, 532 - "cmsv6Parameters": { ~/~/Параметры CmsV6 533 - "id": null, 534 - "enabled": true, ~/~/флаг включения 535 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 536 - "login": "", ~/~/ имя учетной записи 537 - "password": "" ~/~/ пароль учетной записи 538 - }, 539 - "inspectionTasks": { ~/~/ задания на ТО 540 - "id": "", ~/~/ ID задачи 541 - "enabled": false, ~/~/ Признак включения 542 - "name": "", ~/~/ Имя задания 543 - "description": "", ~/~/ Описание задания 544 - "mileageCondition": "", ~/~/ Условие по пробегу 545 - "lastMileage": "", ~/~/ Пробег (в метрах) 546 - "motohoursCondition": "", ~/~/ Условие по моточасам 547 - "lastMotohours": "", ~/~/ Моточасы 548 - "periodicCondition": "", ~/~/ Условие периодичности по времени 549 - "kind": "", ~/~/ Вид периодичности по времени 550 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 551 - } 319 +{{{ "vehicleId": "", //ID ТС 320 + "parentId": "", //Guid владельца ТС 321 + "name": "", //Имя объекта 322 + "imei": "", //IMEI 323 + "deviceTypeId": "", //ID типа устройства 324 + "modelId": "", //ID модели 325 + "unitId": "", //ID подразделения 326 + "sim1": "", //SIM1 327 + "sim2": "", //SIM2 328 + "consumptionPer100Km": "", //Расход топлива на 100 км 329 + "consumptionIdle": "", //Расход топлива на холостом ходу 330 + "counters": { //Счётчики 331 + "mileageEnabled": true, 332 + "motohoursEnabled": true, 333 + "mileage": "", 334 + "motohours": 345.0 335 + }, 336 + "cmsv6Parameters": { //Параметры CmsV6 337 + "id": null, 338 + "enabled": true, //флаг включения 339 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 340 + "login": "", // имя учетной записи 341 + "password": "" // пароль учетной записи 342 + }, 343 + "inspectionTasks": [ // задания на ТО 344 + { 345 + "id": "", // ID задачи 346 + "enabled": false, // Признак включения 347 + "name": "", // Имя задания 348 + "description": "", // Описание задания 349 + "mileageCondition": "", // Условие по пробегу 350 + "lastMileage": "", // Пробег (в метрах) 351 + "motohoursCondition": "", // Условие по моточасам 352 + "lastMotohours": "", // Моточасы 353 + "periodicCondition": "", // Условие периодичности по времени}}} 552 552 553 -(% style="text-align:left" %) 554 -(% style="color:#000000" %)} 355 +{{{ "kind": "", // Вид периодичности по времени 356 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 357 + } 358 + ]}}} 555 555 556 -**Валидация:** 557 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 558 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 559 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 360 +} 560 560 362 + **Удаление объекта** 561 561 562 -(% class="box successmessage" %) 563 -((( 564 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** 565 -))) 364 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 566 566 567 - (% style="color:#000000" %)Методпозволяет получить основные параметры объектов: наименование, IMEI, типустройства,модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).366 +Метод запроса: DELETE 568 568 569 - (%style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):368 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId} 570 570 571 - (% style="color:#000000" %)− возвращается информация об объектах клиента-родителяавторизованногопользователяиобъектах его дочерних клиентов;370 +Параметр запроса: {id} - Guid объекта 572 572 573 - (%style="color:#000000" %)− возвращает информациюоб объектахс учетомзаданныхнастроек видимостиобъектов;372 +В заголовках запроса: X-Auth: Токен авторизации 574 574 575 - (% style="color:#000000" %)− информация предоставляетсясучетомналичия прав на просмотр объектов заблокированных договоров(объекты,принадлежащиезаблокированному договору возвращаютсяпри наличии любого из прав **«__Видимость объектов заблокированныхдоговоров в панели управления__»**или**«__Видимость объектовзаблокированных договоров в мониторинге__»**;374 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 576 576 577 - (%style="color:#000000"%)−информацияотелефонах SIM1/SIM2 предоставляется приналичии права**«__Просмотрномеровтелефонов объектов__»**;376 + **Редактирование объекта** 578 578 579 - (%style="color:#000000"%)− информацияостатусеобъектапредоставляетсяпри наличииправа**«__Просмотрстатуса объекта__»**.378 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 580 580 581 - (% style="color:#000000" %)Метод запроса:**POST**380 +Метод запроса: PUT 582 582 583 - (% style="color:#000000" %)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]382 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 584 584 585 - (% style="color:#000000" %)В заголовках запроса:384 +В заголовках запроса: X-Auth: Токен авторизации 586 586 587 - (%style="color:#000000"%)−Content-Type:__**application/json**__386 +Параметры в теле запроса (JSON): 588 588 589 - (%style="color:#000000"%)−X-Auth:Токен авторизации388 +//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] } 590 590 591 - (% style="color:#000000" %)Условия фильтрации объектовзадаются в теле запроса.390 +Ответ: 592 592 593 - (%style="color:#000000"%)Параметрывтеле запроса (JSON):392 +{ «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»: «» //Сколько раз выполнить задание } ] } 594 594 595 - (%class="western"style="color:#000000"%)##{##394 + **Изменение статуса объекта** 596 596 597 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 598 - "name": null, ~/~/ Имя ТС (string, опционально) 599 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 600 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 601 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 602 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 603 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%) 604 -(% style="color:#000000" %)} 396 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 605 605 606 - (% style="color:#000000" %) Фильтрация осуществляется поточному совпадениюзначенийпараметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрацияпо значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.398 +Метод запроса: POST 607 607 608 - (%style="color:#000000" %)Ответ:400 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId} 609 609 610 - (%style="color:#000000"%){402 +Параметр запроса: {vehicleId} - ID ТС 611 611 612 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 613 - "name": "" ~/~/ наименование объекта 614 - "imei": "" ~/~/ IMEI объекта 615 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 616 - "deviceTypeName": "" ~/~/ наименование типа устройства 617 - "sim1": "" ~/~/ первый номер телефона 618 - "sim2": "" ~/~/ второй номер телефона 619 - "parentId": "" ~/~/ идентификатор клиента-родителя 620 - "parentName": "" ~/~/ наименование клиента-родителя 621 - "modelId": "" ~/~/ идентификатор модели объекта 622 - "modelName": "" ~/~/ наименование модели объекта 623 - "unitId": "" ~/~/ идентификатор подразделения 624 - "unitName": "" ~/~/ наименование подразделения 625 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 626 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 627 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 628 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов (%%) 629 -(% style="color:#000000" %)} 404 +В заголовках запроса: X-Auth: Токен авторизации 630 630 631 - (% style="color:#000000" %)Параметры«__**sim1**__» и «__**sim2**__» содержатсявответе при наличии у авторизованного пользователяправа **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованногопользователя права **«__Просмотр статусаобъекта__»**.406 +Параметры в теле запроса (JSON): { 632 632 408 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 409 + "date": "", // Дата смены статуса (null если сменить немедленно) 410 + "description": "", // Описание 411 + "data": "", // Данные 412 + "overwrite": false, // Флаг перезаписи 413 + "stage": "", // Состояние, может быть null}}} 633 633 634 -(% class="box successmessage" %) 635 -((( 636 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 637 -))) 415 +} 638 638 639 - (% style="color:#000000" %) Метод позволяетизменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).417 +Ответ: { 640 640 641 -(% style="color:#000000" %)Метод запроса: **POST** 419 +{{{ "status": "", // значение статуса 420 + "date": "", // Дата смены статуса 421 + "description": "", // Описание 422 + "data": "", // Данные 423 + "overwrite": false, // Флаг перезаписи 424 + "stage": "", // Состояние}}} 642 642 643 - (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}426 +} 644 644 645 - (%style="color:#000000"%)Параметрзапроса: {__**vehicleId**__} - ID ТС428 + **Проверка авторизации** 646 646 647 -( %style="color:#000000"%)Взаголовках запроса:X-Auth:Токен авторизации430 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth» 648 648 649 - (% style="color:#000000" %)Параметрыв телезапроса(JSON):432 +Метод запроса: GET 650 650 651 - (%style="color:#000000" %){434 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]] 652 652 653 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 654 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 655 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 656 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 657 - "description": "", ~/~/ Описание 658 - "data": "", ~/~/ Данные 659 - "overwrite": false, ~/~/ Флаг перезаписи 660 - "stage": "", ~/~/ Состояние, может быть null 436 +В заголовках запроса: X-Auth: Токен авторизации 661 661 662 - (% style="color:#000000"%)}438 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401» 663 663 664 -(% style="color:#000000" %)Ответ: 665 - 666 -(% style="color:#000000" %){ 667 - 668 - "status": "", ~/~/ значение статуса 669 - "date": "", ~/~/ Дата смены статуса 670 - "description": "", ~/~/ Описание 671 - "data": "", ~/~/ Данные 672 - "overwrite": false, ~/~/ Флаг перезаписи 673 - "stage": "", ~/~/ Состояние 674 - 675 -(% style="text-align:left" %) 676 -(% style="color:#000000" %) } 677 - 678 - 679 -(% class="box warningmessage" %) 680 -((( 681 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 682 -))) 683 - 684 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 685 - 686 -(% style="color:#000000" %)Метод запроса: **PUT** 687 - 688 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 689 - 690 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 691 - 692 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 693 - 694 -(% style="color:#000000" %){ 695 - 696 -((( 697 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 698 - "parentId": "", ~/~/ ID клиента 699 - "name": "", ~/~/ имя ТС 700 - "imei": "", ~/~/ IMEI 701 - "deviceTypeId": "", ~/~/ ID типа устройства 702 - "modelId": "", ~/~/ , ID модели 703 - "unitId": "", ~/~/ подразделения 704 - "sim1": "", ~/~/ SIM 1 705 - "sim2": "", ~/~/ SIM2 (%%) 706 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 707 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 708 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 709 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 710 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 711 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 712 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 713 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 714 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 715 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 716 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 717 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 718 -(% style="color:#000000" %) "counters": 719 - { 720 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 721 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 722 - "mileage": «», пробег 723 - "motohours": «» моточасы 724 - } 725 - "cmsv6Parameters": ~/~/ параметры CMSv6 726 - { 727 - "id": "", ~/~/ идентификатор 728 - "enabled": true, ~/~/ флаг включения 729 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 730 - "login": "", ~/~/ имя учетной записи 731 - "password": "", ~/~/ пароль учетной записи 732 - } 733 - "inspectionTasks": ~/~/ задания на ТО 734 - { 735 - "id": "", ~/~/ ID задания 736 - "enabled": false, ~/~/ Признак включения 737 - "name": "", ~/~/ Имя задания 738 - "description": "", ~/~/ Описание задания 739 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 740 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 741 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 742 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 743 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 744 - "kind": "", ~/~/ Вид периодичности по времени 745 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 746 - } 747 -))) 748 - 749 -(% style="color:#000000" %)} 750 - 751 -(% style="color:#000000" %)Ответ: 752 - 753 -(% lang="en-US" style="text-align:left" %) 754 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 755 - 756 -(% lang="en-US" style="text-align:left" %) 757 - "vehicleId": "", ~/~/ ID ТС 758 - "parentId": "", ~/~/ ID клиента 759 - "name": "", ~/~/ имя ТС 760 - "imei": "", ~/~/ IMEI 761 - "deviceTypeId": "", ~/~/ типа устройства 762 - "modelId": "", ~/~/ ID модели 763 - "unitId": "", ~/~/ ID подразделения 764 - "sim1": "", ~/~/ SIM 1 765 - "sim2": "", ~/~/ SIM2 766 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 767 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 768 - "counters": 769 - { 770 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 771 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 772 - "mileage": "", ~/~/ пробег 773 - "motohours": "", ~/~/ моточасы 774 - } 775 - "cmsv6Parameters": ~/~/ параметры CMSv6 776 - { 777 - "id": ~/~/ идентификатор 778 - "enabled": true, ~/~/ флаг включения 779 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 780 - "login": "", ~/~/ имя учетной записи 781 - "password": "", ~/~/ пароль учетной записи 782 - } 783 - "inspectionTasks": ~/~/ задания на ТО 784 - { 785 - "id": "", ~/~/ ID задания 786 - "enabled": false, ~/~/ Признак включения 787 - "name": "", ~/~/ Имя задания 788 - "description": "", ~/~/ Описание задания 789 - "mileageCondition": "", ~/~/ Условие по пробегу 790 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 791 - "motohoursCondition": "", ~/~/ Условие по моточасам 792 - "lastMotohours": "", ~/~/ Моточасы 793 - "periodicCondition": "", ~/~/ Условие периодичности по времени 794 - "kind": "", ~/~/ Вид периодичности по времени 795 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 796 - } 797 - 798 -(% lang="en-US" style="text-align:left" %) 799 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 800 - 801 -**валидация:** 802 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 803 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 804 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 805 - 806 - 807 -(% class="box errormessage" %) 808 -((( 809 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 810 -))) 811 - 812 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 813 - 814 -(% style="color:#000000" %)Метод запроса: **DELETE** 815 - 816 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 817 - 818 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 819 - 820 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 821 - 822 -(% style="text-align:left" %) 823 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 824 - 825 - 826 -(% class="box" lang="en-US" style="text-align: center;" %) 827 -((( 828 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 829 -))) 830 - 831 -(% class="box infomessage" %) 832 -((( 833 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 834 -))) 835 - 836 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 837 - 838 -(% style="color:#000000" %)Метод запроса: **GET** 839 - 840 -(% 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]] 841 - 842 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 843 - 844 -(% style="color:#000000" %)Ответ: 845 - 846 -(% style="color:#000000" %){ 847 - 848 - "deviceTypeId" : "", ~/~/ ID типа устройства 849 - "deviceTypeName" : "" ~/~/ Название типа устройства 850 - 851 -(% style="text-align:left" %) 852 -(% style="color:#000000" %)} 853 - 854 - 855 -(% class="box" style="text-align: center;" %) 856 -((( 857 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 858 -))) 859 - 860 -(% class="box infomessage" %) 861 -((( 862 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 863 -))) 864 - 865 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 866 - 867 -(% style="color:#000000" %)Метод запроса: **GET** 868 - 869 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 870 - 871 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 872 - 873 -(% style="color:#000000" %)Ответ: 874 - 875 -(% style="color:#000000" %){ 876 - 877 - "id": "", ~/~/ ID типа датчика 878 - "name": "", ~/~/ Название 879 - "description": "", ~/~/ Описание 880 - 881 -(% style="text-align:left" %) 882 -(% style="color:#000000" %)} 883 - 884 - 885 -(% class="box" lang="en-US" style="text-align: center;" %) 886 -((( 887 -(% 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]] ** 888 -))) 440 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**