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,1131 +1,436 @@ 1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 1 +== Описание ГЛОНАССSoft Public API == 3 3 3 +== == 4 4 5 -~{~{box cssClass="floatinginfobox" title="~*~*Contents~*~*"}}~{~{toc/}}~{~{/box}} 6 -\\= Level 1 7 -\\Hello 8 -\\== Level 2 5 + **Действующие ограничения** 9 9 7 +Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 10 10 11 -(% class="box" style="text-align: center;" %) 12 -((( 13 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 14 -))) 15 - 16 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 17 - 18 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 19 - 20 20 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 21 - 22 22 23 -(% class="box" style="text-align: center;" %) 24 -((( 25 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 26 -))) 11 + **Авторизация** 27 27 28 -(% class="box successmessage" %) 29 -((( 30 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login** 31 -))) 13 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 32 32 33 - (% style="color:#000000" %)Методпозволяет получить токенавторизации, который необходимо добавлять в заголовок для работы со всеми методами API. Впараметрах метода передается имя пользователяи пароль.15 +Метод запроса: GET 34 34 35 - (%style="color:#000000" %)Метод запроса:**POST**17 +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]] 36 36 37 - (%style="color:#000000" %)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]19 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 38 38 39 - (% style="color:#000000"%)Вслучаеуспешноговыполненияметода,поле«__**AuthId**__»содержиттокен авторизации «__**X-Auth**__».21 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ] 40 40 41 - (%style="color:#000000"%)Параметрывтелезапроса(JSON):23 + **Получение списка объектов** 42 42 43 -(% style="color:#000000" %){ 44 - "login": "testuser", 45 - "password": "testuser" 46 -}(%%) 47 - 25 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 48 48 49 - (%style="color:#000000"%)**Ответ:**27 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 50 50 51 -(% lang="en-US" %) 52 -(% style="color:#000000" %){ 29 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов; 53 53 54 -(% lang="en-US" %) 55 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 56 - "User": "testuser" , ~/~/ имя пользователя 31 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 57 57 58 -(% lang="en-US" %) 59 -} 33 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 60 60 61 - **Примечание: **Времяжизни токенаавторизации задаетсяв настройкахпользователя, таместьпараметрдлительность сессии.При каждом запросетокенпролонгируется.35 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 62 62 37 +Метод запроса: POST 63 63 64 -(% class="box infomessage" %) 65 -((( 66 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 67 -))) 39 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 68 68 69 - (%style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса- токен авторизации **«__X-Auth__»**).41 +В заголовках запроса: 70 70 71 - (% style="color:#000000" %)Метод запроса: **GET**43 +−Content-Type: application/json 72 72 73 - (% style="color:#000000"%)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]45 +−X-Auth: Токен авторизации 74 74 75 - (%style="color:#000000" %)В заголовкахзапроса:X-Auth: Токенавторизации47 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 76 76 77 -(% lang="en-US" %) 78 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 49 +{{{{"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, опционально)}}}} 79 79 51 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 80 80 81 -(% class="box" style="text-align: center;" %) 82 -((( 83 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 84 -))) 53 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 85 85 86 -(% class="box infomessage" %) 87 -((( 88 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 89 -))) 55 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 90 90 91 - (% style="color:#000000"%) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя.Метод возвращает информацию о клиентах с учетом настроекавторизованного пользователя, указанного в запросе (обязательный параметрвзаголовках запроса - токен авторизации **«__X-Auth__»**):57 +0 - «Блокировка» 92 92 93 - (%style="color:#000000"%)− информация оклиентах предоставляется приналичии права «Просмотр клиентов»;59 +1 - «Активен», 94 94 95 - (%style="color:#000000"%)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;61 +2 - «Отменен» 96 96 97 - (%style="color:#000000"%)− информация о клиенте типа«Партнер» и егоподклиентоввозвращается приналичии права «__**Доступ к партнёрским клиентам**__».63 +3 - «Оборудован» 98 98 99 - (%style="color:#000000"%)Метод запроса: **GET**65 +4 - «Диагностика» 100 100 101 - (%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>67 +5 - «Сервис» 102 102 103 - (%style="color:#000000" %)Параметр запроса: <__**parentId**__>-идентификатор клиента-родителя (опционально)69 +6 - «Демонтаж» 104 104 105 - (%style="color:#000000" %)В заголовках запроса: X-Auth:Токенавторизации71 +7 - «Монтаж» 106 106 107 - (%style="color:#000000"%)Ответ:73 +8 - «Дозаказ» 108 108 109 -(% style="color:#000000" %){ 110 - "agentId": "", ~/~/ идентификатор клиента 111 - "parentId": "", ~/~/ идентификатор клиента-родителя 112 - "name": "", ~/~/ наименование клиента 113 - "fullName": "", ~/~/ полное наименование клиента 114 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 115 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 116 -} 75 +9 - «Обслужен» 117 117 77 +10 - «Списан» 118 118 119 -(% class="box successmessage" %) 120 -((( 121 -**Добавление клиента — POST /api/v3/agents ** 122 -))) 79 +11 - «Неисправен» 123 123 124 - Методпозволяетдобавить клиента, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).81 +12 - «Проверен» 125 125 126 - Методзапроса: **POST**83 +13 - «Не эксплуатируется» 127 127 128 - URLзапроса:[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]85 + **Получение списка клиентов.** 129 129 130 - Взаголовках запроса:X-Auth:Токен авторизации87 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 131 131 132 - Параметрывтелезапроса(JSON):89 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»; 133 133 134 -{ 135 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 136 - "name": "string", ~/~/ имя 137 - "fullName": "string", ~/~/ полное наименование 138 - "isForeign": true, ~/~/ иностранный контрагент 139 - "district": "string", ~/~/ округ 140 - "region": "string", ~/~/ регион 141 - "city": "string", ~/~/ город 142 - "inn": "string", ~/~/ ИНН 143 - "kpp": "string", ~/~/ КПП 144 - "address": "string", ~/~/ юридический адрес 145 - "addressFact": "string", ~/~/ фактический адрес 146 - "email": "string", ~/~/ email 147 - "director": "string", ~/~/ ФИО руководителя 148 - "bankName": "string", ~/~/ банк 149 - "bankBIK": "string", ~/~/ БИК 150 - "bankRS": "string", ~/~/ номер счёта 151 - "bankKS": "string" ~/~/ корр. счёт 152 -} 91 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 153 153 93 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 154 154 155 - Ответ:95 +Метод запроса: GET 156 156 157 -{ 158 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 159 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 160 - "name": "string", ~/~/ имя 161 - "fullName": "string", ~/~/ полное наименование 162 - "isForeign": true, ~/~/ иностранный контрагент 163 - "district": "string", ~/~/ округ 164 - "region": "string", ~/~/ регион 165 - "city": "string", ~/~/ город 166 - "inn": "string", ~/~/ ИНН 167 - "kpp": "string", ~/~/ КПП 168 - "address": "string", ~/~/ юридический адрес 169 - "addressFact": "string", ~/~/ фактический адрес 170 - "email": "string", ~/~/ email 171 - "director": "string", ~/~/ ФИО руководителя 172 - "bankName": "string", ~/~/ банк 173 - "bankBIK": "string", ~/~/ БИК 174 - "bankRS": "string", ~/~/ номер счёта 175 - "bankKS": "string" ~/~/ корр. счёт 176 -} 97 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId> 177 177 99 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 178 178 179 -(% class="box warningmessage" %) 180 -((( 181 -**Редактирование клиента — PUT /api/v3/agents** 182 -))) 101 +В заголовках запроса: X-Auth: Токен авторизации 183 183 184 - Метод позволяетотредактироватьклиента,указанногов запросе (обязательныйпараметрвзаголовкахзапроса- токенвторизации«**X-Auth**»).103 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 185 185 186 - Методзапроса:**PUT**105 +Примечание. Возможные значение параметра agentInfoType: 187 187 188 - URLзапроса:[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]107 + **Получение списка пользователей.** 189 189 190 - Взаголовкахзапроса:X-Auth: Токен авторизации109 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр. 191 191 111 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей». 192 192 193 - Параметрыв телезапроса(JSON):113 +Метод запроса: POST 194 194 195 -{ 196 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 197 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 198 - "name": "string", ~/~/ имя 199 - "fullName": "string", ~/~/ полное наименование 200 - "isForeign": true, ~/~/ иностранный контрагент 201 - "district": "string", ~/~/ округ 202 - "region": "string", ~/~/ регион 203 - "city": "string", ~/~/ город 204 - "inn": "string", ~/~/ ИНН 205 - "kpp": "string", ~/~/ КПП 206 - "address": "string", ~/~/ юридический адрес 207 - "addressFact": "string", ~/~/ фактический адрес 208 - "email": "string", ~/~/ email 209 - "director": "string", ~/~/ ФИО руководителя 210 - "bankName": "string", ~/~/ банк 211 - "bankBIK": "string", ~/~/ БИК 212 - "bankRS": "string", ~/~/ номер счёта 213 - "bankKS": "string" ~/~/ корр. счёт 214 -} 115 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 215 215 117 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 216 216 217 -Ответ: 119 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 120 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 121 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 122 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 218 218 219 -{ 220 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 221 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 222 - "name": "string", ~/~/ имя 223 - "fullName": "string", ~/~/ полное наименование 224 - "isForeign": true, ~/~/ иностранный контрагент 225 - "district": "string", ~/~/ округ 226 - "region": "string", ~/~/ регион 227 - "city": "string", ~/~/ город 228 - "inn": "string", ~/~/ ИНН 229 - "kpp": "string", ~/~/ КПП 230 - "address": "string", ~/~/ юридический адрес 231 - "addressFact": "string", ~/~/ фактический адрес 232 - "email": "string", ~/~/ email 233 - "director": "string", ~/~/ ФИО руководителя 234 - "bankName": "string", ~/~/ банк 235 - "bankBIK": "string", ~/~/ БИК 236 - "bankRS": "string", ~/~/ номер счёта 237 - "bankKS": "string" ~/~/ корр. счёт 238 238 } 239 239 126 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 240 240 241 -(% class="box errormessage" %) 242 -((( 243 -**Удаление клиента — DELETE /api/v3/agents/{clientId}** 244 -))) 128 +{{{ "sessionDuration": "", // длительность сессии в минутах}}} 245 245 130 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ] 246 246 247 - Методпозволяетудалитьклиента,указанногов строкезапроса(обязательныйпараметр в заголовкахзапроса -токен авторизации «**X-Auth**»).132 + **Получение списка типов устройств** 248 248 249 -Метод запроса :**DELETE**134 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 250 250 251 - URLзапроса:[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**136 +Метод запроса: GET 252 252 253 - Параметрзапроса:**{clientId}** - Guidпользователя138 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 254 254 255 -В заголовках запроса: 140 +В заголовках запроса:X-Auth: Токен авторизации 256 256 257 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».142 +Ответ: [ 258 258 144 +{{{ { 145 + "deviceTypeId" : "", // ID типа устройства 146 + "deviceTypeName" : "" // Название типа устройства 147 + },}}} 259 259 149 +… ] 260 260 261 -(% class="box" style="text-align: center;" %) 262 -((( 263 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 264 -))) 151 + **Получение списка типов датчиков** 265 265 266 -(% class="box successmessage" %) 267 -((( 268 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 269 -))) 153 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 270 270 271 - (% style="color:#000000" %)Методпозволяет добавитьпользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательныйпараметр в заголовках запроса - токен авторизации **«__X-Auth__»**).155 +Метод запроса: GET 272 272 273 - (% style="color:#000000" %)Методзапроса:**POST**157 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 274 274 275 - (%style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]159 +В заголовках запроса:X-Auth: Токен авторизации 276 276 277 - (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации161 +Ответ: [ 278 278 279 - (%style="color:#000000"%)Параметрыв теле запроса (JSON):163 +{{{ {}}} 280 280 281 -(% style="color:#000000" %){ 282 - "lastName": "", ~/~/ фамилия 283 - "firstName": "", ~/~/ имя 284 - "position": "", ~/~/ должность 285 - "phone": "", ~/~/ телефон 286 - "organization": "", ~/~/ организация 287 - "login": "", ~/~/ логин (обязателен) 288 - "password": "", ~/~/ пароль (обязателен) 289 - "email": "", ~/~/ email (обязателен) 290 - "description": "", ~/~/ описание 291 - "isEnabled": "", ~/~/ признак включения 292 - "parentId": "", ~/~/ Guid родительского агента 293 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 294 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 295 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 296 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 297 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 298 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 299 -} 165 +«id»: «», //ID типа датчика «name»: «», //Название 300 300 301 - (%style="text-align:left"%)302 - (%style="color:#000000;font-weight:normal"%)Ответ:167 +{{{ "description": "" // Описание 168 + },}}} 303 303 304 -(% style="text-align:left" %) 305 -(% style="color:#000000; font-weight:normal" %){ 170 +… ] 306 306 307 -(% style="text-align:left" %) 308 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 309 - "lastName": "" , ~/~/ Фамилия , 310 - "firstName": "" , ~/~/ Имя 311 - "position": "" , ~/~/ Должность 312 - "phone": "" , ~/~/ Телефон 313 - "organization": "" , ~/~/ Организация 314 - "login": "" , ~/~/ Логин 315 - "password": "" , ~/~/ Пароль 316 - "email": "" , ~/~/ Email 317 - "description": "" , ~/~/ Описание 318 - "isEnabled": "" , ~/~/ Признак включения 319 - "parentId": "" , ~/~/ Guid родительского агента 320 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 321 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 322 - "kind": "" , ~/~/ тип аутентификации 323 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 324 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 172 + **Получение информации об объекте** 325 325 326 -(% style="text-align:left" %) 327 -(% style="color:#000000; font-weight:normal" %)} 174 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 328 328 176 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 329 329 330 -(% class="box successmessage" %) 331 -((( 332 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 333 -))) 178 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание». 334 334 335 - (% style="color:#000000" %)Методпозволяет получить основные параметрыпользователей: логин, имя, адрес электронной почты, номер телефона,статус,идентификатор клиента-родителя и прочее.180 +Метод запроса: GET 336 336 337 - (%style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов.Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.182 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID> 338 338 339 - (%style="color:#000000"%)Методзапроса: **POST**184 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 340 340 341 - (%style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]186 +В заголовках запроса: X-Auth: Токен авторизации 342 342 343 - (% style="color:#000000" %)Условия фильтрации объектовзадаются в теле запроса.188 +Ответ: 344 344 345 - (% style="color:#000000" %)Параметры в теле запроса (JSON):190 +{ 346 346 347 -(% style="color:#000000" %){ 192 +{{{ "vehicleId": “”, // идентификатор объекта 193 + "name": "", // имя объекта 194 + "imei": "", // IMEI объекта 195 + "deviceTypeId": “”, // идентификатор устройства объекта 196 + "deviceTypeName": "" // наименование устройства объекта 197 + "parentId": "", // идентификатор клиента-родителя 198 + "parentName": "" // наименование клиента-родителя, 199 + "modelId": "", // идентификатор модели объекта 200 + "modelName": "" // наименование модели объекта, 201 + "unitId": "", // идентификатор подразделения 202 + "unitName": "", // наименование подразделения 203 + "status": “”, // статус объекта 204 + ... 205 + }, 206 + ...}}} 348 348 349 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 350 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 351 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 352 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 353 - 354 -(% style="color:#000000" %)} 355 - 356 -(% style="color:#000000" %)Ответ: 357 - 358 -(% style="color:#000000" %){ (%%) 359 - 360 - "id": "" , ~/~/ идентификатор пользователя 361 - "lastName": "" , ~/~/ фамилия 362 - "firstName": "" , ~/~/ имя 363 - "position": "" , ~/~/ должность 364 - "phone": "" , ~/~/ телефон 365 - "parentId": "" , ~/~/ идентификатор клиента-родителя 366 - "parentName": "" , ~/~/ наименование клиента-родителя 367 - "organization": "" , ~/~/ организация 368 - "login": "" , ~/~/ логин 369 - "email": "" , ~/~/ E-mail 370 - "sessionDuration":"", ~/~/ длительность сессии в минутах 371 - "status": "1", ~/~/ статус пользователя 372 - "astLogged": "", ~/~/ дата/время последней авторизации 373 - 374 -(% style="color:#000000" %)} 375 - 376 - 377 -(% class="box successmessage" %) 378 -((( 379 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}** 380 -))) 381 - 382 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 383 - 384 -(% style="color:#000000" %)Метод запроса: **GET** 385 - 386 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 387 - 388 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 389 - 390 -(% style="color:#000000" %)Ответ: 391 - 392 -((( 393 -((( 394 -{ 395 - "id": "", ~/~/ GUID пользователя 396 - "lastName": "", ~/~/ Фамилия 397 - "firstName": "", ~/~/ Имя 398 - "position": "", ~/~/ Должность 399 - "phone": "", ~/~/ Номер телефона 400 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 401 - "parentName": "", Наименование клиента, которому принадлежит пользователь 402 - "organization": "", ~/~/ Организация 403 - "login": "", ~/~/ Логин пользователя 404 - "email": "", ~/~/ Адрес электронной почты 405 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 406 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 407 - "description": "", ~/~/ Описание 408 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 409 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 410 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 411 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 412 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 413 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 414 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 415 - "groups": [], ~/~/ Список ролей пользователя 416 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 417 - "authDevices": [ ], ~/~/ Список авторизованных устройств 418 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 419 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 420 420 } 421 -))) 422 -))) 423 423 210 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется» 424 424 425 -(% class="box warningmessage" %) 426 -((( 427 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 428 -))) 212 + **Добавление пользователя** 429 429 430 - (% style="color:#000000" %)Метод позволяетотредактировать пользователя. Метод позволяетотредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации**«__X-Auth__»**).214 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 431 431 432 - (% style="color:#000000" %)Метод запроса:**PUT**216 +Метод запроса: POST 433 433 434 - (% style="color:#000000" %)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]218 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 435 435 436 - (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации220 +В заголовках запроса: X-Auth: Токен авторизации 437 437 438 - **Приредактировании необходимо передавать всерыпользователявтеле запроса!Тепараметры, значениякоторыхне будут переданыбудутстерты!**222 +Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] } 439 439 440 -(% lang="en-US" style="text-align:left" %) 441 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 224 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 442 442 443 -(% lang="en-US" style="text-align:left" %) 444 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 226 + **Редактирование пользователя** 445 445 446 -(% lang="en-US" style="text-align:left" %) 447 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 448 - "lastName": "" , ~/~/ фамилия 449 - "firstName": "" , ~/~/ имя 450 - "position": "" , ~/~/ должность 451 - "phone": "" , ~/~/ телефон 452 - "organization": "" , ~/~/ организация 453 - "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 454 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 455 - "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 456 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 457 - "isEnabled": "" , ~/~/ признак включения 458 - "parentId": "" , ~/~/ Guid родительского агента 459 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 460 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 461 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 462 - "kind": "" , ~/~/ тип аутентификации 463 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 464 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 228 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 465 465 466 -(% lang="en-US" style="text-align:left" %) 467 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 230 +Метод запроса: PUT 468 468 469 -(% lang="en-US" style="text-align:left" %) 470 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 232 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 471 471 472 -(% lang="en-US" style="text-align:left" %) 473 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 234 +В заголовках запроса: X-Auth: Токен авторизации 474 474 475 -(% lang="en-US" style="text-align:left" %) 476 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 477 - "lastName": "" , ~/~/ фамилия 478 - "firstName": "" , ~/~/ имя 479 - "position": "" , ~/~/ должность 480 - "phone": "" , ~/~/ телефон 481 - "organization": "" , ~/~/ организация 482 - "login": "" , ~/~/ логин 483 - "password": "" , ~/~/ пароль 484 - "email": "" , ~/~/ email 485 - "description": "" , ~/~/ описание 486 - "isEnabled": "" , ~/~/ признак включения 487 - "parentId": "" , ~/~/ Guid родительского агента 488 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 489 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 490 - "kind": "" , ~/~/ тип аутентификации 491 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 492 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 236 +Параметры в теле запроса (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 - блокирован) 493 493 494 - (%lang="en-US"style="text-align:left"%)495 - (%lang="ru-RU"style="color:#000000;font-weight:normal"%)}238 +{{{ "description": "", // описание 239 + "data": "" // данные, связанные со сменой статуса}}} 496 496 497 - 498 -(% class="box warningmessage" %) 499 -((( 500 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 501 -))) 502 - 503 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 504 - 505 -(% style="color:#000000" %)Метод запроса: **PUT** 506 - 507 -(% 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} 508 - 509 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 510 - 511 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 512 - 513 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 514 - 515 -(% style="color:#000000" %){ 516 - 517 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 518 - "description": "" , ~/~/ описание 519 - "data": "" , ~/~/ данные, связанные со сменой статуса 520 - 521 -(% style="color:#000000" %)} 522 - 523 -(% style="text-align:left" %) 524 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 525 - 526 - 527 -(% class="box warningmessage" %) 528 -((( 529 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable** 530 -))) 531 - 532 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 533 - 534 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 535 - 536 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 537 - 538 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 539 - 540 - [ 541 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 542 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 543 - ] 544 - 545 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 546 - 547 - 548 -(% class="box warningmessage" %) 549 -((( 550 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable** 551 -))) 552 - 553 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 554 - 555 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 556 - 557 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 558 - 559 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 560 - 561 - [ 562 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 563 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 564 - ] 565 - 566 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 567 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 568 - 569 -((( 570 -В теле ответа: 571 -{ 572 - "errorMessages": [ 573 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 574 - ], 575 - "users": [ 576 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 577 - ] 578 578 } 579 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 580 -"users" - массив id пользователей, которых не удалось включить или отключить. 581 - 582 -))) 583 583 584 -(% class="box errormessage" %) 585 -((( 586 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 587 -))) 243 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 588 588 589 - (%style="color:#000000"%)Методпозволяет удалить пользователя.Методпозволяет удалитьпользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации**«__X-Auth__»**).245 + **Удаление пользователя** 590 590 591 - (%style="color:#000000"%)Метод запроса:**DELETE**247 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 592 592 593 - (%style="color:#000000" %)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}249 +Метод запроса: DELETE 594 594 595 - (% style="color:#000000" %)Параметрзапроса:{**__id__**} - Guidпользователя251 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id} 596 596 597 - (%style="color:#000000"%)В заголовках запроса: X-Auth: Токен авторизации253 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 598 598 599 -(% style="text-align:left" %) 600 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 601 601 257 + **Добавление объекта** 602 602 603 -(% class="box" style="text-align: center;" %) 604 -((( 605 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 606 -))) 259 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8) 607 607 608 -(% class="box infomessage" %) 609 -((( 610 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 611 -))) 261 +Метод запроса: POST 612 612 613 - (%style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта:ID, имя объекта,imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».263 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 614 614 615 - (%style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованногопользователя, указанного в запросе (обязательный параметр в заголовках запроса -токен авторизации**«__X-Auth__»**):265 +В заголовках запроса: X-Auth: Токен авторизации 616 616 617 - (% style="color:#000000" %)− возвращается информацияобобъектеклиента-родителяавторизованногопользователяиобъектеегодочернихклиентов;267 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 618 618 619 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 269 +{{{ "parentId": "", // ID клиента 270 + "name": "", // имя ТС 271 + "imei": "", // IMEI 272 + "deviceTypeId": "",// ID типа устройства 273 + "modelId": "", 274 + "unitId": "", // ID подразделения 275 + "sim1": "", // Номер SIM 1 276 + "sim2": "", // Номер SIM2 277 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 278 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 279 + "consumptionIdle": "",// Расход топлива на холостом ходу 280 + "counters": { 281 + "mileage": "", // пробег 282 + "mileageEnabled": true, // флаг активности счётчика "пробег" 283 + "motohours":"", // моточасы 284 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 285 + }, 286 + "cmsv6Parameters": { // параметры CMSv6 287 + "enabled": true, // флаг включения 288 + //"id": "", // идентификатор 289 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 290 + "login": "", // имя учетной записи 291 + "password": "" // пароль учетной записи 292 + }, 293 + "inspectionTasks": [ // задания на ТО 294 + { 295 + "enabled": "", // Признак включения 296 + "name": "", // Имя задания 297 + "description": "", // Описание задания 298 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 299 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 300 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 301 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 302 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 303 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 304 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 305 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 306 + }, 307 + ]}}} 620 620 621 - (%style="color:#000000" %)Метод запроса: **GET**309 +… } 622 622 623 - (% 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>311 +Ответ: 624 624 625 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально) 626 - 627 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 628 - 629 -(% style="color:#000000" %)Ответ: 630 - 631 -((( 632 632 { 633 - "vehicleId": "", ~/~/ ID объекта 634 - "name": "", ~/~/ Имя объекта 635 - "imei": "", ~/~/ IMEI объекта 636 - "deviceTypeId": , ~/~/ ID типа устройства 637 - "deviceTypeName": "", ~/~/ Название типа устройства 638 - "sim1": "", ~/~/ Номер SIM1 639 - "parentId": "", Номер SIM2 640 - "parentName": "", Наименование клиента-родителя 641 - "modelId": "", ID модели объекта 642 - "modelName": "", Имя модели объекта 643 - "createdAt": "", Дата создания объекта 644 - "mileageCalcMethod": "", Выбранный метод расчета пробега 645 - "counters": { ~/~/ Нормы 646 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 647 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 648 - "mileage": "", ~/~/ Пробег по нормам в метрах 649 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 650 - }, 651 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 652 - { 653 - "id": "", ~/~/ ID задания 654 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 655 - "name": "", ~/~/ Наименование задания 656 - "description": "", ~/~/ Описание задания 657 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 658 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 659 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 660 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 661 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 662 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 663 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 664 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 665 - } 666 - ] 667 -} 668 -))) 669 669 670 -(% style="text-align:left" %) 671 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 672 - 673 -(% style="text-align:left" %) 674 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 675 - 676 - 677 -(% class="box successmessage" %) 678 -((( 679 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 680 -))) 681 - 682 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 683 - 684 -(% style="color:#000000" %)Метод запроса: **POST** 685 - 686 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 687 - 688 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 689 - 690 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 691 - 692 -(% style="color:#000000" %){ 693 - 694 - "parentId": "" , ~/~/ ID клиента 695 - "name": "" , ~/~/ имя ТС 696 - "imei": "" , ~/~/ IMEI 697 - "deviceTypeId": "" , ~/~/ ID типа устройства 698 - "modelId": "" , ~/~/ ID модели 699 - "unitId": "" , ~/~/ ID подразделения 700 - "sim1": "" , ~/~/ Номер SIM 1 701 - "sim2": "" , ~/~/ Номер SIM2 702 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 703 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 704 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 705 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 706 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 707 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 708 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 709 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 710 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 711 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 712 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 713 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 714 - "counters": ~/~/ счетчики 315 +{{{ "vehicleId": "", //ID ТС 316 + "parentId": "", //Guid владельца ТС 317 + "name": "", //Имя объекта 318 + "imei": "", //IMEI 319 + "deviceTypeId": "", //ID типа устройства 320 + "modelId": "", //ID модели 321 + "unitId": "", //ID подразделения 322 + "sim1": "", //SIM1 323 + "sim2": "", //SIM2 324 + "consumptionPer100Km": "", //Расход топлива на 100 км 325 + "consumptionIdle": "", //Расход топлива на холостом ходу 326 + "counters": { //Счётчики 327 + "mileageEnabled": true, 328 + "motohoursEnabled": true, 329 + "mileage": "", 330 + "motohours": 345.0 331 + }, 332 + "cmsv6Parameters": { //Параметры CmsV6 333 + "id": null, 334 + "enabled": true, //флаг включения 335 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 336 + "login": "", // имя учетной записи 337 + "password": "" // пароль учетной записи 338 + }, 339 + "inspectionTasks": [ // задания на ТО 715 715 { 716 - "mileage": "" , ~/~/ пробег 717 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 718 - "motohours": "" , ~/~/ моточасы 719 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 720 - }, 721 - "cmsv6Parameters": { ~/~/ параметры CMSv6 722 - "enabled": true, ~/~/ флаг включения 723 - "id": "" , ~/~/ идентификатор 724 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 725 - "login": "" , ~/~/ имя учетной записи 726 - "password": "" ~/~/ пароль учетной записи 727 - }, 728 - "inspectionTasks": ~/~/ задания на ТО 729 - { 730 - "enabled": "" , ~/~/ Признак включения 731 - "name": "" , ~/~/ Имя задания 732 - "description": "" , ~/~/ Описание задания 733 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 734 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 735 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 736 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 737 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 738 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 739 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 740 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 341 + "id": "", // ID задачи 342 + "enabled": false, // Признак включения 343 + "name": "", // Имя задания 344 + "description": "", // Описание задания 345 + "mileageCondition": "", // Условие по пробегу 346 + "lastMileage": "", // Пробег (в метрах) 347 + "motohoursCondition": "", // Условие по моточасам 348 + "lastMotohours": "", // Моточасы 349 + "periodicCondition": "", // Условие периодичности по времени}}} 350 + 351 +{{{ "kind": "", // Вид периодичности по времени 352 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 741 741 } 354 + ]}}} 742 742 743 -(% style="color:#000000" %) } 744 - 745 -(% style="color:#000000" %)Ответ: 746 - 747 -(% style="color:#000000" %){ 748 - 749 - "vehicleId": "", ~/~/ID ТС 750 - "parentId": "", ~/~/Guid владельца ТС 751 - "name": "", ~/~/Имя объекта 752 - "imei": "", ~/~/IMEI 753 - "deviceTypeId": "", ~/~/ID типа устройства 754 - "modelId": "", ~/~/ID модели 755 - "unitId": "", ~/~/ID подразделения 756 - "sim1": "", ~/~/SIM1 757 - "sim2": "", ~/~/SIM2 758 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 759 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 760 - "counters": { ~/~/Счётчики 761 - "mileageEnabled": true, 762 - "motohoursEnabled": true, 763 - "mileage": "", 764 - "motohours": 345.0 765 - }, 766 - "cmsv6Parameters": { ~/~/Параметры CmsV6 767 - "id": null, 768 - "enabled": true, ~/~/флаг включения 769 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 770 - "login": "", ~/~/ имя учетной записи 771 - "password": "" ~/~/ пароль учетной записи 772 - }, 773 - "inspectionTasks": { ~/~/ задания на ТО 774 - "id": "", ~/~/ ID задачи 775 - "enabled": false, ~/~/ Признак включения 776 - "name": "", ~/~/ Имя задания 777 - "description": "", ~/~/ Описание задания 778 - "mileageCondition": "", ~/~/ Условие по пробегу 779 - "lastMileage": "", ~/~/ Пробег (в метрах) 780 - "motohoursCondition": "", ~/~/ Условие по моточасам 781 - "lastMotohours": "", ~/~/ Моточасы 782 - "periodicCondition": "", ~/~/ Условие периодичности по времени 783 - "kind": "", ~/~/ Вид периодичности по времени 784 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 785 - } 786 - 787 -(% style="text-align:left" %) 788 -(% style="color:#000000" %)} 789 - 790 -**Валидация:** 791 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 792 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 793 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 794 - 795 - 796 -(% class="box successmessage" %) 797 -((( 798 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** 799 -))) 800 - 801 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 802 - 803 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 804 - 805 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 806 - 807 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 808 - 809 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 810 - 811 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 812 - 813 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 814 - 815 -(% style="color:#000000" %)Метод запроса: **POST** 816 - 817 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 818 - 819 -(% style="color:#000000" %)В заголовках запроса: 820 - 821 -(% style="color:#000000" %)− Content-Type: __**application/json**__ 822 - 823 -(% style="color:#000000" %)− X-Auth: Токен авторизации 824 - 825 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 826 - 827 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 828 - 829 -{ 830 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 831 - "name": null, ~/~/ Имя ТС (string, опционально) 832 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 833 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 834 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 835 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 836 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 837 - "customFields": null ~/~/ значение любого из произвольных полей ТС 838 838 } 839 839 840 - (%style="color:#000000"%)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра«__**sim**__»осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.358 + **Удаление объекта** 841 841 842 - (%style="color:#000000"%)Ответ:360 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 843 843 844 - (%style="color:#000000"%){362 +Метод запроса: DELETE 845 845 846 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 847 - "name": "" ~/~/ наименование объекта 848 - "imei": "" ~/~/ IMEI объекта 849 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 850 - "deviceTypeName": "" ~/~/ наименование типа устройства 851 - "sim1": "" ~/~/ первый номер телефона 852 - "sim2": "" ~/~/ второй номер телефона 853 - "parentId": "" ~/~/ идентификатор клиента-родителя 854 - "parentName": "" ~/~/ наименование клиента-родителя 855 - "modelId": "" ~/~/ идентификатор модели объекта 856 - "modelName": "" ~/~/ наименование модели объекта 857 - "unitId": "" ~/~/ идентификатор подразделения 858 - "unitName": "" ~/~/ наименование подразделения 859 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 860 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 861 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 862 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 863 - "customFields": [ 864 - { 865 - "id": "", ~/~/ идентификатор произвольного поля 866 - "name": "", ~/~/ имя произвольного поля 867 - "value": "", ~/~/ значение произвольного поля 868 - "forClient": true, ~/~/ право на отображение у клиента 869 - "forTooltip": false, ~/~/ право на отображение в подсказке 870 - "forReport": false ~/~/ право на отображение в отчетах 871 - }(%%) 872 -(% style="color:#000000" %)} 364 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId} 873 873 874 - (% style="color:#000000" %)Параметры«__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованногопользователя права **«__Просмотрномеровтелефоновобъектов__»**. Параметр «__**status**__»содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.366 +Параметр запроса: {id} - Guid объекта 875 875 368 +В заголовках запроса: X-Auth: Токен авторизации 876 876 877 -(% class="box successmessage" %) 878 -((( 879 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 880 -))) 370 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 881 881 882 - (%style="color:#000000"%)Методпозволяет изменить статус объекта. Метод позволяет изменитьстатусобъекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации**«__X-Auth__»**).372 + **Редактирование объекта** 883 883 884 - (%style="color:#000000"%)Метод запроса:**POST**374 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 885 885 886 - (%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}376 +Метод запроса: PUT 887 887 888 - (%style="color:#000000" %)Параметр запроса:{__**vehicleId**__} - ID ТС378 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 889 889 890 - (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации380 +В заголовках запроса: X-Auth: Токен авторизации 891 891 892 - (% style="color:#000000" %)Параметры в теле запроса (JSON):382 +Параметры в теле запроса (JSON): 893 893 894 - (%style="color:#000000"%){384 +//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] } 895 895 896 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 897 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 898 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 899 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 900 - "description": "", ~/~/ Описание 901 - "data": "", ~/~/ Данные 902 - "overwrite": false, ~/~/ Флаг перезаписи 903 - "stage": "", ~/~/ Состояние, может быть null 386 +Ответ: 904 904 905 - (%style="color:#000000"%)}388 +{ «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»: «» //Сколько раз выполнить задание } ] } 906 906 907 - (%style="color:#000000"%)Ответ:390 + **Изменение статуса объекта** 908 908 909 -( %style="color:#000000"%){392 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 910 910 911 - "status": "", ~/~/ значение статуса 912 - "date": "", ~/~/ Дата смены статуса 913 - "description": "", ~/~/ Описание 914 - "data": "", ~/~/ Данные 915 - "overwrite": false, ~/~/ Флаг перезаписи 916 - "stage": "", ~/~/ Состояние 394 +Метод запроса: POST 917 917 918 -(% style="text-align:left" %) 919 -(% style="color:#000000" %) } 396 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId} 920 920 398 +Параметр запроса: {vehicleId} - ID ТС 921 921 922 -(% class="box warningmessage" %) 923 -((( 924 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 925 -))) 400 +В заголовках запроса: X-Auth: Токен авторизации 926 926 927 - (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанныйвзапросе (обязательный параметрвзаголовках запроса- токен авторизации **«__X-Auth__»**).402 +Параметры в теле запроса (JSON): { 928 928 929 -(% style="color:#000000" %)Метод запроса: **PUT** 404 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 405 + "date": "", // Дата смены статуса (null если сменить немедленно) 406 + "description": "", // Описание 407 + "data": "", // Данные 408 + "overwrite": false, // Флаг перезаписи 409 + "stage": "", // Состояние, может быть null}}} 930 930 931 - (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]411 +} 932 932 933 - (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации413 +Ответ: { 934 934 935 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 415 +{{{ "status": "", // значение статуса 416 + "date": "", // Дата смены статуса 417 + "description": "", // Описание 418 + "data": "", // Данные 419 + "overwrite": false, // Флаг перезаписи 420 + "stage": "", // Состояние}}} 936 936 937 - (% style="color:#000000" %){422 +} 938 938 939 -((( 940 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 941 - "parentId": "", ~/~/ ID клиента 942 - "name": "", ~/~/ имя ТС 943 - "imei": "", ~/~/ IMEI 944 - "deviceTypeId": "", ~/~/ ID типа устройства 945 - "modelId": "", ~/~/ , ID модели 946 - "unitId": "", ~/~/ подразделения 947 - "sim1": "", ~/~/ SIM 1 948 - "sim2": "", ~/~/ SIM2 (%%) 949 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 950 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 951 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 952 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 953 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 954 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 955 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 956 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 957 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 958 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 959 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 960 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 961 -(% style="color:#000000" %) "counters": 962 - { 963 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 964 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 965 - "mileage": "", ~/~/ пробег, в метрах 966 - "motohours": "" ~/~/ моточасы, в секундах 967 - } 968 - "cmsv6Parameters": ~/~/ параметры CMSv6 969 - { 970 - "id": "", ~/~/ идентификатор 971 - "enabled": true, ~/~/ флаг включения 972 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 973 - "login": "", ~/~/ имя учетной записи 974 - "password": "", ~/~/ пароль учетной записи 975 - } 976 - "inspectionTasks": ~/~/ задания на ТО 977 - { 978 - "id": "", ~/~/ ID задания 979 - "enabled": false, ~/~/ Признак включения 980 - "name": "", ~/~/ Имя задания 981 - "description": "", ~/~/ Описание задания 982 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 983 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 984 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 985 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 986 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 987 - "kind": "", ~/~/ Вид периодичности по времени 988 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 989 - } 990 -))) 424 + **Проверка авторизации** 991 991 992 -( %style="color:#000000"%)}426 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth» 993 993 994 - (% style="color:#000000" %)Ответ:428 +Метод запроса: GET 995 995 996 -(% lang="en-US" style="text-align:left" %) 997 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 430 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]] 998 998 999 -(% lang="en-US" style="text-align:left" %) 1000 - "vehicleId": "", ~/~/ ID ТС 1001 - "parentId": "", ~/~/ ID клиента 1002 - "name": "", ~/~/ имя ТС 1003 - "imei": "", ~/~/ IMEI 1004 - "deviceTypeId": "", ~/~/ типа устройства 1005 - "modelId": "", ~/~/ ID модели 1006 - "unitId": "", ~/~/ ID подразделения 1007 - "sim1": "", ~/~/ SIM 1 1008 - "sim2": "", ~/~/ SIM2 1009 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1010 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1011 - "counters": 1012 - { 1013 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1014 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1015 - "mileage": "", ~/~/ пробег 1016 - "motohours": "", ~/~/ моточасы 1017 - } 1018 - "cmsv6Parameters": ~/~/ параметры CMSv6 1019 - { 1020 - "id": ~/~/ идентификатор 1021 - "enabled": true, ~/~/ флаг включения 1022 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1023 - "login": "", ~/~/ имя учетной записи 1024 - "password": "", ~/~/ пароль учетной записи 1025 - } 1026 - "inspectionTasks": ~/~/ задания на ТО 1027 - { 1028 - "id": "", ~/~/ ID задания 1029 - "enabled": false, ~/~/ Признак включения 1030 - "name": "", ~/~/ Имя задания 1031 - "description": "", ~/~/ Описание задания 1032 - "mileageCondition": "", ~/~/ Условие по пробегу 1033 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1034 - "motohoursCondition": "", ~/~/ Условие по моточасам 1035 - "lastMotohours": "", ~/~/ Моточасы 1036 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1037 - "kind": "", ~/~/ Вид периодичности по времени 1038 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1039 - } 432 +В заголовках запроса: X-Auth: Токен авторизации 1040 1040 1041 -(% lang="en-US" style="text-align:left" %) 1042 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 434 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401» 1043 1043 1044 -**валидация:** 1045 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1046 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1047 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1048 - 1049 - 1050 -(% class="box errormessage" %) 1051 -((( 1052 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1053 -))) 1054 - 1055 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1056 - 1057 -(% style="color:#000000" %)Метод запроса: **DELETE** 1058 - 1059 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 1060 - 1061 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 1062 - 1063 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1064 - 1065 -(% style="text-align:left" %) 1066 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1067 - 1068 - 1069 -(% class="box" lang="en-US" style="text-align: center;" %) 1070 -((( 1071 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 1072 -))) 1073 - 1074 -(% class="box infomessage" %) 1075 -((( 1076 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 1077 -))) 1078 - 1079 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1080 - 1081 -(% style="color:#000000" %)Метод запроса: **GET** 1082 - 1083 -(% 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]] 1084 - 1085 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1086 - 1087 -(% style="color:#000000" %)Ответ: 1088 - 1089 -(% style="color:#000000" %){ 1090 - 1091 - "deviceTypeId" : "", ~/~/ ID типа устройства 1092 - "deviceTypeName" : "" ~/~/ Название типа устройства 1093 - 1094 -(% style="text-align:left" %) 1095 -(% style="color:#000000" %)} 1096 - 1097 - 1098 -(% class="box" style="text-align: center;" %) 1099 -((( 1100 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 1101 -))) 1102 - 1103 -(% class="box infomessage" %) 1104 -((( 1105 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 1106 -))) 1107 - 1108 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1109 - 1110 -(% style="color:#000000" %)Метод запроса: **GET** 1111 - 1112 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1113 - 1114 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1115 - 1116 -(% style="color:#000000" %)Ответ: 1117 - 1118 -(% style="color:#000000" %){ 1119 - 1120 - "id": "", ~/~/ ID типа датчика 1121 - "name": "", ~/~/ Название 1122 - "description": "", ~/~/ Описание 1123 - 1124 -(% style="text-align:left" %) 1125 -(% style="color:#000000" %)} 1126 - 1127 - 1128 -(% class="box" lang="en-US" style="text-align: center;" %) 1129 -((( 1130 -(% 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]] ** 1131 -))) 436 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**