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