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 1 +Методы API для работы с ГЛОНАССSoft - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.krainovim - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,436 +1,1411 @@ 1 -== Описание ГЛОНАССSoft Public API == 1 +(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 +((( 3 +**Содержание страницы:** 4 +))) 2 2 3 - == ==6 +{{toc/}} 4 4 5 - **Действующие ограничения** 6 6 7 - ДляработысовсемиметодамиAPI необходимов заголовок добавлять X-Auth (токенавторизации, получаемый методом auth/login).9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 8 8 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 + 13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 + 9 9 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 10 10 11 - **Авторизация**17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 12 12 13 - Методпозволяетполучитьтокенавторизации, который необходимо добавлятьвзаголовок для работы совсеми методами API. В параметрах метода передаетсяимя пользователяи пароль.19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 14 14 15 - Методзапроса:GET21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 16 16 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]] 23 +(% class="box infomessage" %) 24 +((( 25 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 +))) 18 18 19 - Вслучаеуспешноговыполненияметода,поле«AuthId»содержиттокенавторизации«X-Auth».28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 20 20 21 - Ответ:[ { «AuthId»:«», //токен авторизации «User»: «», // имяпользователя}, … ]30 +(% style="color:#000000" %)Метод запроса: **POST** 22 22 23 - **Получениеспискаобъектов**32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 24 24 25 - Методпозволяетполучить основные параметрыобъектов: наименование, IMEI, типустройства, модель объекта,подразделение, номера телефонови идентификатор клиента, к которомуприкрепленобъект (клиент-родитель): Метод возвращает информациюоб объектах с учетомнастроек авторизованногопользователя,указанногов запросе (обязательный параметрв заголовках запроса -токен авторизации «X-Auth»):34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 26 26 27 - −возвращается информацияобобъектах клиента-родителяавторизованногопользователяи объектах его дочерних клиентов;36 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 28 28 29 -−возвращает информацию об объектах с учетом заданных настроек видимости объектов; 38 +(% style="color:#000000" %){ 39 + "login": "testuser", 40 + "password": "testuser" 41 +} 30 30 31 -−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 32 32 33 - −информацияотелефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;44 +(% style="color:#000000" %)**Ответ:** 34 34 35 -−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 46 +(% lang="en-US" %) 47 +(% style="color:#000000" %){ 36 36 37 -Метод запроса: POST 49 +(% lang="en-US" %) 50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 + "User": "testuser" , ~/~/ имя пользователя 38 38 39 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 53 +(% lang="en-US" %) 54 +} 40 40 41 -В за головках запроса:56 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 42 42 43 - −Content-Type:application/json58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 44 44 45 -−X-Auth: Токен авторизации 60 +(% class="box infomessage" %) 61 +((( 62 +(% lang="en-US" %)**GET /api/v3/auth/check** 63 +))) 46 46 47 - Условияфильтрацииобъектов задаютсявтелезапроса. Параметрыв телезапроса(JSON):65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 48 48 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, опционально)}}}}67 +(% style="color:#000000" %)Метод запроса: **GET** 50 50 51 - Фильтрацияосуществляетсяпо точному совпадениюзначенийпараметров«vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim».Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».69 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]] 52 52 53 - Ответ:[ { «vehicleId»:«», //идентификаторобъекта«name»: «», // наименованиеобъекта«imei»: «», // IMEI объекта«deviceTypeId»: «», // идентификатор типа устройства«deviceTypeName»:«», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»:«», //наименованиеклиента-родителя«modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификаторподразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ]71 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 54 54 55 -Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 73 +(% lang="en-US" %) 74 +(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 56 56 57 -0 - «Блокировка»76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 58 58 59 - 1-«Активен»,78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 60 60 61 -2 - «Отменен» 80 +(% class="box infomessage" %) 81 +((( 82 +**GET api/v3/agents/{id}** 83 +))) 62 62 63 - 3-«Оборудован»85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 64 64 65 - 4-«Диагностика»87 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 66 66 67 - 5-«Сервис»89 +(% style="color:#000000" %)Метод запроса: **GET** 68 68 69 - 6-«Демонтаж»91 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 70 70 71 - 7-«Монтаж»93 +Запрос должен содержать данные параметра "**agentId**" 72 72 73 -8 - «Дозаказ» 95 +(% style="color:#000000" %)Ответ: 96 +А 97 +{ 98 + "agentId": "", ~/~/ идентификатор клиента (%%) 99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 + "isForeign": true/false, ~/~/ Иностранный контрагент 105 + "district": "string", ~/~/ округ 106 + "region": "string", ~/~/ регион 107 + "city": "string", ~/~/ город 108 + "inn": "string", ~/~/ ИНН клиента 109 + "kpp": "string", ~/~/ КПП клиента 110 + "address": "string", ~/~/ юридический адрес 111 + "addressFact": "string", ~/~/ фактический адрес 112 + "email": "string", ~/~/ почта 113 + "director": "string", ~/~/ ФИО руководителя 114 + "bankName": "string", ~/~/ Банк 115 + "bankBIK": "string", ~/~/ БИК 116 + "bankRS": "string", ~/~/ Номер счета 117 + "bankKS": "string" ~/~/ Корр. счет 118 + } 74 74 75 - 9-«Обслужен»120 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 76 76 77 -10 - «Списан» 122 +(% class="box infomessage" %) 123 +((( 124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 125 +))) 78 78 79 - 11-«Неисправен»127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 80 80 81 - 12-«Проверен»129 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 82 82 83 - 13-«Неэксплуатируется»131 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 84 84 85 - **Получение списка клиентов.**133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 86 86 87 - Методпозволяет получить основные параметры клиентов:наименование, полное наименование, тип, статус и идентификатор клиента-родителя.Методвозвращает информацию о клиентах с учетом настроек авторизованногопользователя, указанного в запросе (обязательныйпараметр в заголовках запроса - токен авторизации «X-Auth»)135 +(% style="color:#000000" %)Метод запроса: **POST** 88 88 89 - −информацияоклиентахпредоставлетсяпри наличии права «Просмотр клиентов»;137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 90 90 91 - −возвращаетсяинформацияо клиенте, которому принадлежитавторизованныйпользователь, и его дочерних клиентах;139 +(% style="color:#000000" %)Параметр запроса: 92 92 93 -−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 94 94 95 - Методзапроса:GET145 +(% style="color:#000000" %)Ответ: 96 96 97 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId> 147 +{ 148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 155 +} 98 98 99 - Параметрзапроса:<parentId>-идентификаторклиента-родителя(опционально)157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 100 100 159 +(% class="box successmessage" %) 160 +((( 161 +**POST /api/v3/agents ** 162 +))) 163 + 164 +Метод позволяет добавить клиента, указанного в запросе. 165 + 166 +Метод запроса: **POST** 167 + 168 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 169 + 101 101 В заголовках запроса: X-Auth: Токен авторизации 102 102 103 - Ответ: [ { «agentId»: «», //идентификаторклиента«parentId»: «», //идентификаторклиента-родителя «name»: «», //наименованиеклиента «fullName»: «», //полноенаименование клиента«agentInfoType»: , //тип клиента1 «status»: //статусклиента }, … ]172 +Параметры в теле запроса (JSON): 104 104 105 -Примечание. Возможные значение параметра agentInfoType: 174 +{ 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 + "name": "string", ~/~/ имя 177 + "fullName": "string", ~/~/ полное наименование 178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 179 + "isForeign": true, ~/~/ иностранный контрагент 180 + "district": "string", ~/~/ округ 181 + "region": "string", ~/~/ регион 182 + "city": "string", ~/~/ город 183 + "inn": "string", ~/~/ ИНН 184 + "kpp": "string", ~/~/ КПП 185 + "address": "string", ~/~/ юридический адрес 186 + "addressFact": "string", ~/~/ фактический адрес 187 + "email": "string", ~/~/ email 188 + "director": "string", ~/~/ ФИО руководителя 189 + "bankName": "string", ~/~/ банк 190 + "bankBIK": "string", ~/~/ БИК 191 + "bankRS": "string", ~/~/ номер счёта 192 + "bankKS": "string" ~/~/ корр. счёт 193 +} 106 106 107 - **Получение списка пользователей.** 108 108 109 - Метод позволяетполучить основные параметры пользователей:логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.196 +Ответ: 110 110 111 -Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей». 198 +{ 199 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 200 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 201 + "name": "string", ~/~/ имя 202 + "fullName": "string", ~/~/ полное наименование 203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 204 + "isForeign": true, ~/~/ иностранный контрагент 205 + "district": "string", ~/~/ округ 206 + "region": "string", ~/~/ регион 207 + "city": "string", ~/~/ город 208 + "inn": "string", ~/~/ ИНН 209 + "kpp": "string", ~/~/ КПП 210 + "address": "string", ~/~/ юридический адрес 211 + "addressFact": "string", ~/~/ фактический адрес 212 + "email": "string", ~/~/ email 213 + "director": "string", ~/~/ ФИО руководителя 214 + "bankName": "string", ~/~/ банк 215 + "bankBIK": "string", ~/~/ БИК 216 + "bankRS": "string", ~/~/ номер счёта 217 + "bankKS": "string" ~/~/ корр. счёт 218 +} 112 112 113 - Методзапроса:POST220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 114 114 115 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 222 +(% class="box warningmessage" %) 223 +((( 224 +**PUT /api/v3/agents** 225 +))) 116 116 117 - Условияфильтрацииобъектовзадаютсяв теле запроса.Параметрывтелезапроса (JSON): {227 +Метод позволяет отредактировать клиента, указанного в запросе. 118 118 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 - неважно}}} 229 +Метод запроса: **PUT** 123 123 231 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 232 + 233 +В заголовках запроса: X-Auth: Токен авторизации 234 + 235 + 236 +Параметры в теле запроса (JSON): 237 + 238 +{ 239 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 240 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 241 + "name": "string", ~/~/ имя 242 + "fullName": "string", ~/~/ полное наименование 243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 244 + "isForeign": true, ~/~/ иностранный контрагент 245 + "district": "string", ~/~/ округ 246 + "region": "string", ~/~/ регион 247 + "city": "string", ~/~/ город 248 + "inn": "string", ~/~/ ИНН 249 + "kpp": "string", ~/~/ КПП 250 + "address": "string", ~/~/ юридический адрес 251 + "addressFact": "string", ~/~/ фактический адрес 252 + "email": "string", ~/~/ email 253 + "director": "string", ~/~/ ФИО руководителя 254 + "bankName": "string", ~/~/ банк 255 + "bankBIK": "string", ~/~/ БИК 256 + "bankRS": "string", ~/~/ номер счёта 257 + "bankKS": "string" ~/~/ корр. счёт 124 124 } 125 125 126 -Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 127 127 128 - {{{ "sessionDuration": "", // длительность сессии в минутах}}}261 +Ответ: 129 129 130 - «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ] 263 +{ 264 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 265 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 266 + "name": "string", ~/~/ имя 267 + "fullName": "string", ~/~/ полное наименование 268 + "isForeign": true, ~/~/ иностранный контрагент 269 + "district": "string", ~/~/ округ 270 + "region": "string", ~/~/ регион 271 + "city": "string", ~/~/ город 272 + "inn": "string", ~/~/ ИНН 273 + "kpp": "string", ~/~/ КПП 274 + "address": "string", ~/~/ юридический адрес 275 + "addressFact": "string", ~/~/ фактический адрес 276 + "email": "string", ~/~/ email 277 + "director": "string", ~/~/ ФИО руководителя 278 + "bankName": "string", ~/~/ банк 279 + "bankBIK": "string", ~/~/ БИК 280 + "bankRS": "string", ~/~/ номер счёта 281 + "bankKS": "string" ~/~/ корр. счёт 282 +} 131 131 132 - Получениесписка типов устройств**284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 133 133 134 -Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 286 +(% class="box errormessage" %) 287 +((( 288 +**DELETE /api/v3/agents/{clientId}** 289 +))) 135 135 136 -Метод запроса : GET291 +Метод позволяет удалить клиента, указанного в строке запроса. 137 137 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]]293 +Метод запроса: **DELETE** 139 139 140 - Взаголовках запроса:X-Auth:Токен авторизации295 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 141 141 142 - Ответ:[297 +Параметр запроса: **{clientId}** - Guid пользователя 143 143 144 -{{{ { 145 - "deviceTypeId" : "", // ID типа устройства 146 - "deviceTypeName" : "" // Название типа устройства 147 - },}}} 299 +В заголовках запроса: X-Auth: Токен авторизации 148 148 149 - …]301 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 150 150 151 - **Пол учение списка типовдатчиков**303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 152 152 153 - Методпозволяетполучитьсписоктипов датчиков. Метод возвращает информацию о типах датчиков с учетомнастроек авторизованногопользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 154 154 155 -Метод запроса: GET 307 +(% class="box successmessage" %) 308 +((( 309 +(% lang="en-US" %)**POST /api/v3/users** 310 +))) 156 156 157 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 158 158 159 - Взаголовкахзапроса:X-Auth:Токен авторизации314 +(% style="color:#000000" %)Метод запроса: **POST** 160 160 161 - Ответ: [316 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 162 162 163 - {{{{}}}318 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 164 164 165 - «id»:«», //ID типадатчика«name»:«»,//Название320 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 166 166 167 -{{{ "description": "" // Описание 168 - },}}} 322 +(% style="color:#000000" %) 323 +{ 324 + "lastName": "", ~/~/ фамилия 325 + "firstName": "", ~/~/ имя 326 + "position": "", ~/~/ должность 327 + "phone": "", ~/~/ телефон 328 + "organization": "", ~/~/ организация 329 + "login": "", ~/~/ логин (обязателен) 330 + "password": "", ~/~/ пароль (обязателен) 331 + "email": "", ~/~/ email (обязателен) 332 + "description": "string", ~/~/ Описание 333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 336 + "parentId": "", ~/~/ Guid родительского агента 337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 339 + "doubleAuth": 340 + { 341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 343 + }, 344 + "groups": 345 + [ 346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 347 + ], 348 + "customGroups": 349 + [ 350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 + ], 352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 +} 169 169 170 -… ] 355 +{ 356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 + "lastName": "string", 358 + "firstName": "string", 359 + "position": "string", 360 + "phone": "string", 361 + "organization": "string", 362 + "login": "string", 363 + "password": "string", 364 + "email": "string", 171 171 172 - **Получение информации об объекте** 173 173 174 -Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 367 +(% style="text-align:left" %) 368 +(% style="color:#000000; font-weight:normal" %)Ответ: 175 175 176 -Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 370 +(% style="text-align:left" %) 371 +(% style="color:#000000; font-weight:normal" %){ 177 177 178 -−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание». 373 +(% style="text-align:left" %) 374 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 375 + "lastName": "" , ~/~/ Фамилия , 376 + "firstName": "" , ~/~/ Имя 377 + "position": "" , ~/~/ Должность 378 + "phone": "" , ~/~/ Телефон 379 + "organization": "" , ~/~/ Организация 380 + "login": "" , ~/~/ Логин 381 + "password": "" , ~/~/ Пароль 382 + "email": "" , ~/~/ Email 383 + "description": "" , ~/~/ Описание 384 + "isEnabled": "" , ~/~/ Признак включения 385 + "parentId": "" , ~/~/ Guid родительского агента 386 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 387 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 388 + "kind": "" , ~/~/ тип аутентификации 389 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 179 179 180 -Метод запроса: GET 392 +(% style="text-align:left" %) 393 +(% style="color:#000000; font-weight:normal" %)} 181 181 182 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 183 183 184 -Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 397 +(% class="box infomessage" %) 398 +((( 399 +(% lang="en-US" %)**POST /api/v3/users/find** 400 +))) 185 185 186 - Взаголовкахзапроса:X-Auth: Токен авторизации402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 187 187 188 - Ответ:404 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 189 189 190 - {406 +(% style="color:#000000" %)Метод запроса: **POST** 191 191 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 - ...}}} 408 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 207 207 410 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 411 + 412 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 413 + 414 +(% style="color:#000000" %){ 415 + 416 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 + 421 +(% style="color:#000000" %)} 422 + 423 +(% style="color:#000000" %)Ответ: 424 + 425 +(% style="color:#000000" %){ (%%) 426 + 427 + "id": "" , ~/~/ идентификатор пользователя 428 + "lastName": "" , ~/~/ фамилия 429 + "firstName": "" , ~/~/ имя 430 + "position": "" , ~/~/ должность 431 + "phone": "" , ~/~/ телефон 432 + "parentId": "" , ~/~/ идентификатор клиента-родителя 433 + "parentName": "" , ~/~/ наименование клиента-родителя 434 + "organization": "" , ~/~/ организация 435 + "login": "" , ~/~/ логин 436 + "email": "" , ~/~/ E-mail 437 + "sessionDuration":"", ~/~/ длительность сессии в минутах 438 + "status": "1", ~/~/ статус пользователя 439 + "astLogged": "", ~/~/ дата/время последней авторизации 440 + 441 +(% style="color:#000000" %)} 442 + 443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 444 + 445 +(% class="box infomessage" %) 446 +((( 447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 448 +))) 449 + 450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 451 + 452 +(% style="color:#000000" %)Метод запроса: **GET** 453 + 454 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 455 + 456 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 457 + 458 +(% style="color:#000000" %)Ответ: 459 + 460 +((( 461 +((( 462 +{ 463 + "id": "", ~/~/ GUID пользователя 464 + "lastName": "", ~/~/ Фамилия 465 + "firstName": "", ~/~/ Имя 466 + "position": "", ~/~/ Должность 467 + "phone": "", ~/~/ Номер телефона 468 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 469 + "parentName": "", Наименование клиента, которому принадлежит пользователь 470 + "organization": "", ~/~/ Организация 471 + "login": "", ~/~/ Логин пользователя 472 + "email": "", ~/~/ Адрес электронной почты 473 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 474 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 475 + "description": "", ~/~/ Описание 476 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен 477 + "doubleAuth": 478 + { 479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 481 + }, 482 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 483 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 484 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 485 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 486 + "groups": [], ~/~/ Список ролей пользователя 487 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 488 + "authDevices": [ ], ~/~/ Список авторизованных устройств 489 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 490 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 208 208 } 492 +))) 493 +))) 209 209 210 - Параметр«status»содержитidстатуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис»6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 211 211 212 - **Добавление пользователя** 497 +(% class="box warningmessage" %) 498 +((( 499 +(% lang="en-US" %)**PUT /api/v3/users** 500 +))) 213 213 214 -Метод позволяет добавить пользователя. Метод позволяетдобавить пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 215 215 216 -Метод запроса: P OST504 +(% style="color:#000000" %)Метод запроса: **PUT** 217 217 218 -URL запроса: 506 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 219 219 220 -В заголовках запроса: X-Auth: Токен авторизации 508 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 221 221 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»: [ // группы пользователя «», //названия групп «», «» ] } 510 +(% lang="en-US" style="text-align:left" %) 511 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 223 223 224 -Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 513 +(% lang="en-US" style="text-align:left" %) 514 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 225 225 226 - **Редактирование пользователя** 516 +(% lang="en-US" style="text-align:left" %) 517 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 518 + "lastName": "" , ~/~/ фамилия 519 + "firstName": "" , ~/~/ имя 520 + "position": "" , ~/~/ должность 521 + "phone": "" , ~/~/ телефон 522 + "organization": "" , ~/~/ организация 523 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 527 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 528 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 529 + "isEnabled": "" , ~/~/ признак включения 530 + "parentId": "" , ~/~/ Guid родительского агента 531 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 532 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 533 + "doubleAuth": 534 + { 535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 + }, 538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 227 227 228 -Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 541 +(% lang="en-US" style="text-align:left" %) 542 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 229 229 230 -Метод запроса: PUT 544 +(% lang="en-US" style="text-align:left" %) 545 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 231 231 232 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 547 +(% lang="en-US" style="text-align:left" %) 548 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 233 233 234 -В заголовках запроса: X-Auth: Токен авторизации 550 +(% lang="en-US" style="text-align:left" %) 551 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 552 + "lastName": "" , ~/~/ фамилия 553 + "firstName": "" , ~/~/ имя 554 + "position": "" , ~/~/ должность 555 + "phone": "" , ~/~/ телефон 556 + "organization": "" , ~/~/ организация 557 + "login": "" , ~/~/ логин 558 + "password": "" , ~/~/ пароль 559 + "email": "" , ~/~/ email 560 + "description": "" , ~/~/ описание 561 + "isEnabled": "" , ~/~/ признак включения 562 + "parentId": "" , ~/~/ Guid родительского агента 563 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 564 + "doubleAuth": 565 + { 566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 + }, 569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 235 235 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 - блокирован) 573 +(% lang="en-US" style="text-align:left" %) 574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 237 237 238 -{{{ "description": "", // описание 239 - "data": "" // данные, связанные со сменой статуса}}} 576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 240 240 578 +(% class="box warningmessage" %) 579 +((( 580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 581 +))) 582 + 583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 584 + 585 +(% style="color:#000000" %)Метод запроса: **PUT** 586 + 587 +(% 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} 588 + 589 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 590 + 591 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 592 + 593 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 594 + 595 +(% style="color:#000000" %){ 596 + 597 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 + "description": "" , ~/~/ описание 599 + "data": "" , ~/~/ данные, связанные со сменой статуса 600 + 601 +(% style="color:#000000" %)} 602 + 603 +(% style="text-align:left" %) 604 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 605 + 606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 607 + 608 +(% class="box warningmessage" %) 609 +((( 610 +**POST /api/v3/users/disable** 611 +))) 612 + 613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 614 + 615 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 616 + 617 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 618 + 619 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 + 621 + [ 622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 + ] 625 + 626 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 627 + 628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 629 + 630 +(% class="box warningmessage" %) 631 +((( 632 +**POST /api/v3/users/enable** 633 +))) 634 + 635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 636 + 637 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 638 + 639 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 640 + 641 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 642 + 643 + [ 644 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 645 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 646 + ] 647 + 648 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 649 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 650 + 651 +((( 652 +В теле ответа: 653 +{ 654 + "errorMessages": [ 655 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 656 + ], 657 + "users": [ 658 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 659 + ] 241 241 } 661 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 662 +"users" - массив id пользователей, которых не удалось включить или отключить. 663 +))) 242 242 243 - Ответ:ВслучаеуспешноговыполнениязапросавернетсяHTTP ответ «200»665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 244 244 245 - **Удаление пользователя** 667 +(% class="box errormessage" %) 668 +((( 669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 670 +))) 246 246 247 -Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 248 248 249 -Метод запроса: DELETE 674 +(% style="color:#000000" %)Метод запроса: **DELETE** 250 250 251 -URL запроса: 676 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 252 252 253 -Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации678 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 254 254 255 - Ответ: Вслучае успешноговыполнениязапросавернетсяHTTP ответ«200»680 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 256 256 257 - **Добавление объекта** 682 +(% style="text-align:left" %) 683 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 258 258 259 - Методпозволяетдобавитьобъект.Метод позволяетдобавить объект,указанный в запросе (обязательный параметрв заголовках запроса -токен авторизации«X-Auth», Content-Type: application/json;charset=utf-8)685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 260 260 261 - Методзапроса:POST687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 262 262 263 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 689 +(% class="box infomessage" %) 690 +((( 691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 692 +))) 264 264 265 - Взаголовкахзапроса:X-Auth:Токен авторизации694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 266 266 267 - Параметрывтелезапроса(JSON): //Обязательныепараметрынаименованиеи модельбъекта//Втелезапроса-объект JSON {696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 268 268 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 - ]}}} 698 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 308 308 309 - …}700 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 310 310 311 - Ответ:702 +(% style="color:#000000" %)Метод запроса: **GET** 312 312 704 +(% 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> 705 + 706 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально) 707 + 708 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 709 + 710 +(% style="color:#000000" %)Ответ: 711 + 712 +((( 313 313 { 714 + "vehicleId": "", ~/~/ ID объекта 715 + "name": "", ~/~/ Имя объекта 716 + "imei": "", ~/~/ IMEI объекта 717 + "deviceTypeId": , ~/~/ ID типа устройства 718 + "deviceTypeName": "", ~/~/ Название типа устройства 719 + "sim1": "", ~/~/ Номер SIM1 720 + "parentId": "", Номер SIM2 721 + "parentName": "", Наименование клиента-родителя 722 + "modelId": "", ID модели объекта 723 + "modelName": "", Имя модели объекта 724 + "createdAt": "", Дата создания объекта 725 + "mileageCalcMethod": "", Выбранный метод расчета пробега 726 + "counters": { ~/~/ Нормы 727 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 728 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 729 + "mileage": "", ~/~/ Пробег по нормам в метрах 730 + "motohours": "" ~/~/ Моточасы по нормам, в секундах 731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 733 + }, 734 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 735 + { 736 + "id": "", ~/~/ ID задания 737 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 738 + "name": "", ~/~/ Наименование задания 739 + "description": "", ~/~/ Описание задания 740 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 741 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 742 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 743 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 744 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 745 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 746 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 747 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 748 + } 749 + ] 750 +} 751 +))) 314 314 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": [ // задания на ТО 340 - { 341 - "id": "", // ID задачи 342 - "enabled": false, // Признак включения 343 - "name": "", // Имя задания 344 - "description": "", // Описание задания 345 - "mileageCondition": "", // Условие по пробегу 346 - "lastMileage": "", // Пробег (в метрах) 347 - "motohoursCondition": "", // Условие по моточасам 348 - "lastMotohours": "", // Моточасы 349 - "periodicCondition": "", // Условие периодичности по времени}}} 753 +(% style="text-align:left" %) 754 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 350 350 351 -{{{ "kind": "", // Вид периодичности по времени 352 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 756 +(% style="text-align:left" %) 757 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 758 + 759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 760 + 761 +(% class="box successmessage" %) 762 +((( 763 +(% lang="en-US" %)**POST /api/v3/vehicles** 764 +))) 765 + 766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе. 767 + 768 +(% style="color:#000000" %)Метод запроса: **POST** 769 + 770 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 771 + 772 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 773 + 774 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 775 + 776 +(% style="color:#000000" %){ 777 + 778 + "parentId": "" , ~/~/ ID клиента 779 + "name": "" , ~/~/ имя ТС 780 + "imei": "" , ~/~/ IMEI 781 + "deviceTypeId": "" , ~/~/ ID типа устройства 782 + "modelId": "" , ~/~/ ID модели 783 + "unitId": "" , ~/~/ ID подразделения 784 + "sim1": "" , ~/~/ Номер SIM 1 785 + "sim2": "" , ~/~/ Номер SIM2 786 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 787 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 788 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 789 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 790 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 791 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 792 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 793 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 794 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 795 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 796 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 797 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 798 + "counters": ~/~/ счетчики 799 + { 800 + "mileage": "" , ~/~/ пробег 801 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 802 + "motohours": "" , ~/~/ моточасы 803 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 804 + }, 805 + "cmsv6Parameters": { ~/~/ параметры CMSv6 806 + "enabled": true, ~/~/ флаг включения 807 + "id": "" , ~/~/ идентификатор 808 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 809 + "login": "" , ~/~/ имя учетной записи 810 + "password": "" ~/~/ пароль учетной записи 811 + }, 812 + "inspectionTasks": ~/~/ задания на ТО 813 + { 814 + "enabled": "" , ~/~/ Признак включения 815 + "name": "" , ~/~/ Имя задания 816 + "description": "" , ~/~/ Описание задания 817 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 818 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 819 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 820 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 821 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 822 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 823 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 824 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 353 353 } 354 - ]}}} 355 355 827 +(% style="color:#000000" %) } 828 + 829 +(% style="color:#000000" %)Ответ: 830 + 831 +(% style="color:#000000" %){ 832 + 833 + "vehicleId": "", ~/~/ID ТС 834 + "parentId": "", ~/~/Guid владельца ТС 835 + "name": "", ~/~/Имя объекта 836 + "imei": "", ~/~/IMEI 837 + "deviceTypeId": "", ~/~/ID типа устройства 838 + "modelId": "", ~/~/ID модели 839 + "unitId": "", ~/~/ID подразделения 840 + "sim1": "", ~/~/SIM1 841 + "sim2": "", ~/~/SIM2 842 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 843 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 844 + "counters": { ~/~/Счётчики 845 + "mileageEnabled": true, 846 + "motohoursEnabled": true, 847 + "mileage": "", 848 + "motohours": 345.0 849 + }, 850 + "cmsv6Parameters": { ~/~/Параметры CmsV6 851 + "id": null, 852 + "enabled": true, ~/~/флаг включения 853 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 854 + "login": "", ~/~/ имя учетной записи 855 + "password": "" ~/~/ пароль учетной записи 856 + }, 857 + "inspectionTasks": { ~/~/ задания на ТО 858 + "id": "", ~/~/ ID задачи 859 + "enabled": false, ~/~/ Признак включения 860 + "name": "", ~/~/ Имя задания 861 + "description": "", ~/~/ Описание задания 862 + "mileageCondition": "", ~/~/ Условие по пробегу 863 + "lastMileage": "", ~/~/ Пробег (в метрах) 864 + "motohoursCondition": "", ~/~/ Условие по моточасам 865 + "lastMotohours": "", ~/~/ Моточасы 866 + "periodicCondition": "", ~/~/ Условие периодичности по времени 867 + "kind": "", ~/~/ Вид периодичности по времени 868 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 869 + } 870 + 871 +(% style="text-align:left" %) 872 +(% style="color:#000000" %)} 873 + 874 +**Валидация:** 875 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 876 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 877 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 878 + 879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 880 + 881 +(% class="box infomessage" %) 882 +((( 883 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 884 +))) 885 + 886 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 887 + 888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 889 + 890 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 891 + 892 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 893 + 894 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 895 + 896 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 897 + 898 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 899 + 900 +(% style="color:#000000" %)Метод запроса: **POST** 901 + 902 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 903 + 904 +(% style="color:#000000" %)В заголовках запроса: 905 + 906 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 907 + 908 +(% style="color:#000000" %)− X-Auth: Токен авторизации 909 + 910 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 911 + 912 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 913 + 914 +{ 915 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 916 + "name": null, ~/~/ Имя ТС (string, опционально) 917 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 918 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 919 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 920 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 921 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 922 + "customFields": null ~/~/ значение любого из произвольных полей ТС 356 356 } 357 357 358 - ** Удаление объекта**925 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 359 359 360 - Методпозволяетудалить объект. Метод позволяетудалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)927 +(% style="color:#000000" %)Ответ: 361 361 362 - Методзапроса:DELETE929 +(% style="color:#000000" %){ 363 363 364 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId} 931 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 932 + "name": "" ~/~/ наименование объекта 933 + "imei": "" ~/~/ IMEI объекта 934 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 935 + "deviceTypeName": "" ~/~/ наименование типа устройства 936 + "sim1": "" ~/~/ первый номер телефона 937 + "sim2": "" ~/~/ второй номер телефона 938 + "parentId": "" ~/~/ идентификатор клиента-родителя 939 + "parentName": "" ~/~/ наименование клиента-родителя 940 + "modelId": "" ~/~/ идентификатор модели объекта 941 + "modelName": "" ~/~/ наименование модели объекта 942 + "unitId": "" ~/~/ идентификатор подразделения 943 + "unitName": "" ~/~/ наименование подразделения 944 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 945 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 946 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 947 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 948 + "customFields": [ 949 + { 950 + "id": "", ~/~/ идентификатор произвольного поля 951 + "name": "", ~/~/ имя произвольного поля 952 + "value": "", ~/~/ значение произвольного поля 953 + "forClient": true, ~/~/ право на отображение у клиента 954 + "forTooltip": false, ~/~/ право на отображение в подсказке 955 + "forReport": false ~/~/ право на отображение в отчетах 956 + }(%%) 957 +(% style="color:#000000" %)} 365 365 366 -Параметр запрос а:{id}-Guidобъекта959 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 367 367 368 - Взаголовкахзапроса:X-Auth:Токен авторизации961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 369 369 370 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 963 +(% class="box successmessage" %) 964 +((( 965 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 966 +))) 371 371 372 - **Редактирование объекта**968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 373 373 374 - Методпозволяетотредактировать объект.Методпозволяет отредактировать объект, указанный в запросе (обязательныйпараметр в заголовках запроса - токен авторизации «X-Auth»)970 +(% style="color:#000000" %)Метод запроса: **POST** 375 375 376 - Методзапроса:PUT972 +(% 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} 377 377 378 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]974 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 379 379 380 -В заголовках запроса: X-Auth: Токен авторизации 976 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 381 381 382 -Параметры в теле запроса (JSON): 978 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 383 383 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»: «» //Сколько раз выполнить задание } ] }980 +(% style="color:#000000" %){ 385 385 386 -Ответ: 982 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 983 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 984 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 985 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 986 + "description": "", ~/~/ Описание 987 + "data": "", ~/~/ Данные 988 + "overwrite": false, ~/~/ Флаг перезаписи 989 + "stage": "", ~/~/ Состояние, может быть null 387 387 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»: «» //Сколько раз выполнить задание}] }991 +(% style="color:#000000" %)} 389 389 390 - **Изменение статуса объекта**993 +(% style="color:#000000" %)Ответ: 391 391 392 - Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе(обязательныйпараметр в заголовках запроса - токен авторизации «X-Auth»)995 +(% style="color:#000000" %){ 393 393 394 -Метод запроса: POST 997 + "status": "", ~/~/ значение статуса 998 + "date": "", ~/~/ Дата смены статуса 999 + "description": "", ~/~/ Описание 1000 + "data": "", ~/~/ Данные 1001 + "overwrite": false, ~/~/ Флаг перезаписи 1002 + "stage": "", ~/~/ Состояние 395 395 396 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId} 1004 +(% style="text-align:left" %) 1005 +(% style="color:#000000" %) } 397 397 398 - Параметрзапроса:{vehicleId}-IDТС1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 399 399 400 -В заголовках запроса: X-Auth: Токен авторизации 1009 +(% class="box warningmessage" %) 1010 +((( 1011 +(% lang="en-US" %)**PUT /api/v3/vehicles** 1012 +))) 401 401 402 - Параметрыв теле запроса (JSON): {1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе. 403 403 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}}} 1016 +(% style="color:#000000" %)Метод запроса: **PUT** 410 410 1018 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 1019 + 1020 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1021 + 1022 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 1023 + 1024 +(% style="color:#000000" %){ 1025 + 1026 +((( 1027 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 1028 + "parentId": "", ~/~/ ID клиента 1029 + "name": "", ~/~/ имя ТС 1030 + "imei": "", ~/~/ IMEI 1031 + "deviceTypeId": "", ~/~/ ID типа устройства 1032 + "modelId": "", ~/~/ , ID модели 1033 + "unitId": "", ~/~/ подразделения 1034 + "sim1": "", ~/~/ SIM 1 1035 + "sim2": "", ~/~/ SIM2 (%%) 1036 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1037 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1038 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1039 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1040 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1041 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1042 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1043 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1044 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1045 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1046 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1047 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1048 +(% style="color:#000000" %) "counters": 1049 + { 1050 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1051 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1052 + "mileage": "", ~/~/ пробег, в метрах 1053 + "motohours": "" ~/~/ моточасы, в секундах 1054 + } 1055 + "cmsv6Parameters": ~/~/ параметры CMSv6 1056 + { 1057 + "id": "", ~/~/ идентификатор 1058 + "enabled": true, ~/~/ флаг включения 1059 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1060 + "login": "", ~/~/ имя учетной записи 1061 + "password": "", ~/~/ пароль учетной записи 1062 + } 1063 + "inspectionTasks": ~/~/ задания на ТО 1064 + { 1065 + "id": "", ~/~/ ID задания 1066 + "enabled": false, ~/~/ Признак включения 1067 + "name": "", ~/~/ Имя задания 1068 + "description": "", ~/~/ Описание задания 1069 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1070 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1071 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1072 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1073 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1074 + "kind": "", ~/~/ Вид периодичности по времени 1075 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1076 + } 1077 +))) 1078 + 1079 +(% style="color:#000000" %)} 1080 + 1081 +(% style="color:#000000" %)Ответ: 1082 + 1083 +(% lang="en-US" style="text-align:left" %) 1084 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1085 + 1086 +(% lang="en-US" style="text-align:left" %) 1087 + "vehicleId": "", ~/~/ ID ТС 1088 + "parentId": "", ~/~/ ID клиента 1089 + "name": "", ~/~/ имя ТС 1090 + "imei": "", ~/~/ IMEI 1091 + "deviceTypeId": "", ~/~/ типа устройства 1092 + "modelId": "", ~/~/ ID модели 1093 + "unitId": "", ~/~/ ID подразделения 1094 + "sim1": "", ~/~/ SIM 1 1095 + "sim2": "", ~/~/ SIM2 1096 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1097 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1098 + "counters": 1099 + { 1100 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1101 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1102 + "mileage": "", ~/~/ пробег 1103 + "motohours": "", ~/~/ моточасы 1104 + } 1105 + "cmsv6Parameters": ~/~/ параметры CMSv6 1106 + { 1107 + "id": ~/~/ идентификатор 1108 + "enabled": true, ~/~/ флаг включения 1109 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1110 + "login": "", ~/~/ имя учетной записи 1111 + "password": "", ~/~/ пароль учетной записи 1112 + } 1113 + "inspectionTasks": ~/~/ задания на ТО 1114 + { 1115 + "id": "", ~/~/ ID задания 1116 + "enabled": false, ~/~/ Признак включения 1117 + "name": "", ~/~/ Имя задания 1118 + "description": "", ~/~/ Описание задания 1119 + "mileageCondition": "", ~/~/ Условие по пробегу 1120 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1121 + "motohoursCondition": "", ~/~/ Условие по моточасам 1122 + "lastMotohours": "", ~/~/ Моточасы 1123 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1124 + "kind": "", ~/~/ Вид периодичности по времени 1125 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1126 + } 1127 + 1128 +(% lang="en-US" style="text-align:left" %) 1129 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1130 + 1131 +**Валидация:** 1132 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1133 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1134 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1135 + 1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1137 + 1138 +(% class="box errormessage" %) 1139 +((( 1140 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1141 +))) 1142 + 1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса. 1144 + 1145 +(% style="color:#000000" %)Метод запроса: **DELETE** 1146 + 1147 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 1148 + 1149 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 1150 + 1151 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1152 + 1153 +(% style="text-align:left" %) 1154 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1155 + 1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1157 + 1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1159 + 1160 +(% class="box infomessage" %) 1161 +((( 1162 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1163 +))) 1164 + 1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1166 + 1167 +(% style="color:#000000" %)Метод запроса: **GET** 1168 + 1169 +(% 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]] 1170 + 1171 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1172 + 1173 +(% style="color:#000000" %)Ответ: 1174 + 1175 +(% style="color:#000000" %){ 1176 + 1177 + "deviceTypeId" : "", ~/~/ ID типа устройства 1178 + "deviceTypeName" : "" ~/~/ Название типа устройства 1179 + 1180 +(% style="text-align:left" %) 1181 +(% style="color:#000000" %)} 1182 + 1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1184 + 1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1186 + 1187 +(% class="box infomessage" %) 1188 +((( 1189 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1190 +))) 1191 + 1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1193 + 1194 +(% style="color:#000000" %)Метод запроса: **GET** 1195 + 1196 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1197 + 1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1199 + 1200 +(% style="color:#000000" %)Ответ: 1201 + 1202 +(% style="color:#000000" %){ 1203 + 1204 + "id": "", ~/~/ ID типа датчика 1205 + "name": "", ~/~/ Название 1206 + "description": "", ~/~/ Описание 1207 + 1208 +(% style="text-align:left" %) 1209 +(% style="color:#000000" %)} 1210 + 1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1212 + 1213 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1214 + 1215 +(% class="box infomessage" style="text-align: left;" %) 1216 +((( 1217 +**POST /api/v3/terminalMessages/count** 1218 +))) 1219 + 1220 +(% style="text-align: left;" %) 1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1222 + 1223 +(% style="text-align: left;" %) 1224 +Метод запроса **POST** 1225 + 1226 +(% style="text-align: left;" %) 1227 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1228 + 1229 +(% style="text-align: left;" %) 1230 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1231 + 1232 +(% style="text-align: left;" %) 1233 +{ 1234 + "vehicleIds": [ 1235 + id ~/~/ здесь передается список идентификаторов объектов 1236 + ], 1237 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1238 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 411 411 } 412 412 413 -Ответ: { 1241 +(% style="text-align: left;" %) 1242 +Ответ: 414 414 415 -{{{ "status": "", // значение статуса 416 - "date": "", // Дата смены статуса 417 - "description": "", // Описание 418 - "data": "", // Данные 419 - "overwrite": false, // Флаг перезаписи 420 - "stage": "", // Состояние}}} 1244 +(% style="text-align: left;" %) 1245 +[ 1246 + { 1247 + "vehicleId": 0, ~/~/ идентификатор объекта 1248 + "count": 0 ~/~/ количество сообщений за период 1249 + } 1250 +] 421 421 1252 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1253 + 1254 +(% class="box infomessage" %) 1255 +((( 1256 +**POST /api/v3/terminalMessages** 1257 +))) 1258 + 1259 +Метод возвращает список сообщений терминала объекта за выбранный период. 1260 + 1261 +(% style="text-align: left;" %) 1262 +Метод запроса **POST** 1263 + 1264 +(% style="text-align: left;" %) 1265 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1266 + 1267 +(% style="text-align: left;" %) 1268 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1269 + 1270 +{ 1271 + "vehicleId": 0, ~/~/ id объекта 1272 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1273 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 422 422 } 423 423 424 - **Проверка авторизации**1276 +Ответ: 425 425 426 -Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth» 1278 +[ 1279 + { 1280 + "messages": [ 1281 + { 1282 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1283 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1284 + "speed": 0, ~/~/ Скорость, км/ч 1285 + "altitude": 0, ~/~/ Высота, м 1286 + "latitude": 0, ~/~/ Широта [-90°;90°] 1287 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1288 + "satellites": 0, ~/~/ Кол-во спутников 1289 + "voltage": 0, ~/~/ Напряжение 1290 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1291 + "additionalProp1": "string", 1292 + "additionalProp2": "string", 1293 + "additionalProp3": "string" 1294 + }, 1295 + "photoCount": 0 ~/~/ Кол-во фото 1296 + } 1297 + ] 1298 + } 1299 +] 427 427 428 - Методзапроса:GET1301 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 429 429 430 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]1303 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 431 431 432 - Взаголовках запроса: X-Auth: Токен авторизации1305 +POST /api/v3/notifications/find 433 433 434 - Ответ:В случаееслисессия активнаHTTPответ«200» В случаеесли сессия разорванаHTTPответ«401»1307 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 435 435 436 -**Расширенное описание API доступно по запросу на support@glonasssoft.ru** 1309 +(% style="text-align: left;" %) 1310 +Метод запроса **POST** 1311 + 1312 +(% style="text-align: left;" %) 1313 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 1314 + 1315 +(% style="text-align: left;" %) 1316 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1317 + 1318 +{ 1319 + "parentId": "" ~/~/ id клиента 1320 +} 1321 + 1322 +Ответ: 1323 + 1324 +[ 1325 + { 1326 + "id": 0, 1327 + "name": "string", 1328 + "active": true, 1329 + "type": 0, 1330 + "userId": "", 1331 + "parentId": "", 1332 + "parentName": "string" 1333 + } 1334 +] 1335 + 1336 + 1337 +Запрос настроек уведомления 1338 + 1339 +GET /api/v3/notifications/{id} 1340 + 1341 +Метод возвращает данные правил формирования выбранного уведомления. 1342 + 1343 +(% style="text-align: left;" %) 1344 +Метод запроса **GET** 1345 + 1346 +(% style="text-align: left;" %) 1347 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]] 1348 + 1349 +(% style="text-align: left;" %) 1350 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 1351 + 1352 +(% style="text-align: left;" %) 1353 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1354 + 1355 +(% style="text-align: left;" %) 1356 +(% style="color:#000000" %)Ответ: 1357 + 1358 +(% style="text-align: left;" %) 1359 +(% style="color:#000000" %){ 1360 + "id": 0, 1361 + "type": 0, 1362 + "userId": "", 1363 + "parentId": "", 1364 + "parentName": "string", 1365 + "name": "string", 1366 + "active": true, 1367 + "vehicleIds": [ 1368 + 0 1369 + ], 1370 + "geoids": [ 1371 + 0 1372 + ], 1373 + "fieldids": [ 1374 + 0 1375 + ], 1376 + "settings": { 1377 + "additionalProp1": "string", 1378 + "additionalProp2": "string", 1379 + "additionalProp3": "string" 1380 + }, 1381 + "toEmail": true, 1382 + "recipientIds": [ 1383 + "" 1384 + ], 1385 + "enableSideEmails": true, 1386 + "sideEmails": [ 1387 + "string" 1388 + ], 1389 + "toTelegram": true, 1390 + "telegrams": [ 1391 + { 1392 + "id": 0, 1393 + "info": "string" 1394 + } 1395 + ], 1396 + "toMobile": true, 1397 + "toClient": true, 1398 + "stored": true, 1399 + "kind": 0, 1400 + "activationMode": 0, 1401 + "activationTime": "2023-03-29T09:57:48.932Z", 1402 + "timezone": 0, 1403 + "validity": 0, 1404 + "autoProlongation": true 1405 +} 1406 + 1407 + 1408 +(% class="box" lang="en-US" style="text-align: center;" %) 1409 +((( 1410 +(% 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]] ** 1411 +)))