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