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