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