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 6 (% class="box" style="text-align: center;" %) 7 7 ((( 8 -(% style="color: #000000; font-size:18.6667px" %)**Действующие ограничения**8 +(% style="color: rgb(0, 0, 0); font-size: 18.6667px" %)**Действующие ограничения** 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,209 +70,111 @@ 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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 118 +(% class="box" style="text-align: center;" %) 119 +((( 120 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 121 +))) 178 178 179 -(% style="text-align:left" %) 180 -(% style="color:#000000; font-weight:normal" %)} 181 - 182 - 183 -(% class="box successmessage" %) 123 +(% class="box infomessage" %) 184 184 ((( 185 -(% style="color:#000000; line-height:100%" %)**Получение списка по льзователей— **(% lang="en-US" %)**POSTusers/find**125 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 186 186 ))) 187 187 188 -(% style="color:#000000" %) Метод позволяет получить основныепараметрыпользователей:логин, имя,адресэлектроннойпочты, номер телефона,статус,идентификаторклиента-родителяипрочее.128 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 189 189 190 -(% style="color:#000000" %)Метод возвращает информацию опользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляетсяпри наличии права**«__Просмотр пользователей__»**.130 +(% style="color:#000000" %)Метод запроса: **GET** 191 191 192 -(% style="color:#000000" %) Методзапроса:**POST**132 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 193 193 194 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]134 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 195 195 196 -(% style="color:#000000" %) Условия фильтрации объектовзадаются в теле запроса.136 +(% style="color:#000000" %)Ответ: [ 197 197 198 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 138 +(% class="western" style="margin-bottom:19px" %) 139 +{{{ {}}} 199 199 200 -(% style="color:#000000" %) {141 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 201 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 - неважно 143 +(% class="western" %) 144 +{{{ "description": "" // Описание 145 + },}}} 206 206 207 -(% style="color:#000000" %)} 147 +(% style="text-align:left" %) 148 +(% style="color:#000000" %)… ] 208 208 209 -(% style="color:#000000" %)Ответ: 210 210 211 -(% style="color:#000000" %){ (%%) 151 +(% class="box" style="text-align: center;" %) 152 +((( 153 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 154 +))) 212 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 230 (% class="box successmessage" %) 231 231 ((( 232 -(% style="color:#000000; line-height:100%" %)** Получениеинформации опользователе— **(% lang="en-US" %)**GET /api/v3/users/{GUID}**158 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 233 233 ))) 234 234 235 -(% style="color:#000000" %) возвращаетподробную информациюопользователеклиента-родителяавторизованногопользователяилипользователяегодочернихклиентов.Информацияопользователепредоставляется приналичииправа**«__Просмотр пользователей__»**.161 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 236 236 237 -(% style="color:#000000" %)Метод запроса: ** GET**163 +(% style="color:#000000" %)Метод запроса: **POST** 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}]]165 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 240 240 241 241 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 242 242 243 -(% style="color:#000000" %) Ответ: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»: [ // группы пользователя «», //названия групп «», «» ] } 244 244 245 -((( 246 -((( 247 -{ 248 - "id": "", ~/~/ GUID пользователя 249 - "lastName": "", ~/~/ Фамилия 250 - "firstName": "", ~/~/ Имя 251 - "position": "", ~/~/ Должность 252 - "phone": "", ~/~/ Номер телефона 253 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 254 - "parentName": "", Наименование клиента, которому принадлежит пользователь 255 - "organization": "", ~/~/ Организация 256 - "login": "", ~/~/ Логин пользователя 257 - "email": "", ~/~/ Адрес электронной почты 258 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 259 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 260 - "description": "", ~/~/ Описание 261 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 262 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 263 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 264 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 265 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 266 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 267 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 268 - "groups": [], ~/~/ Список ролей пользователя 269 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 270 - "authDevices": [ ], ~/~/ Список авторизованных устройств 271 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 272 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 273 -} 274 -))) 275 -))) 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» //названия групп ] } 276 276 277 277 278 278 (% class="box warningmessage" %) ... ... @@ -280,7 +280,7 @@ 280 280 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 281 281 ))) 282 282 283 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).180 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 284 284 285 285 (% style="color:#000000" %)Метод запроса: **PUT** 286 286 ... ... @@ -288,89 +288,27 @@ 288 288 289 289 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 290 290 291 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!** 292 - 293 293 (% lang="en-US" style="text-align:left" %) 294 -(% 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» //названия групп ] } // 295 295 296 -(% lang="en-US" style="text-align:left" %) 297 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 298 298 299 -(% lang="en-US" style="text-align:left" %) 300 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 301 - "lastName": "" , ~/~/ фамилия 302 - "firstName": "" , ~/~/ имя 303 - "position": "" , ~/~/ должность 304 - "phone": "" , ~/~/ телефон 305 - "organization": "" , ~/~/ организация 306 - "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 307 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 308 - "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 309 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 310 - "isEnabled": "" , ~/~/ признак включения 311 - "parentId": "" , ~/~/ Guid родительского агента 312 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 313 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 314 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 315 - "kind": "" , ~/~/ тип аутентификации 316 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 317 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 318 - 319 -(% lang="en-US" style="text-align:left" %) 320 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 321 - 322 -(% lang="en-US" style="text-align:left" %) 323 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 324 - 325 -(% lang="en-US" style="text-align:left" %) 326 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 327 - 328 -(% lang="en-US" style="text-align:left" %) 329 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 330 - "lastName": "" , ~/~/ фамилия 331 - "firstName": "" , ~/~/ имя 332 - "position": "" , ~/~/ должность 333 - "phone": "" , ~/~/ телефон 334 - "organization": "" , ~/~/ организация 335 - "login": "" , ~/~/ логин 336 - "password": "" , ~/~/ пароль 337 - "email": "" , ~/~/ email 338 - "description": "" , ~/~/ описание 339 - "isEnabled": "" , ~/~/ признак включения 340 - "parentId": "" , ~/~/ Guid родительского агента 341 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 342 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 343 - "kind": "" , ~/~/ тип аутентификации 344 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 345 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 346 - 347 -(% lang="en-US" style="text-align:left" %) 348 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 349 - 350 - 351 351 (% class="box warningmessage" %) 352 352 ((( 353 -(% 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}** 354 354 ))) 355 355 356 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).197 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 357 357 358 358 (% style="color:#000000" %)Метод запроса: **PUT** 359 359 360 -(% 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} Параметр запроса: 361 361 362 -(% style="color:#000000" %)Параметр запроса: { __**id**__}- Guidпользователя203 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 363 363 364 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 205 +(% class="western" %) 206 +{{{ "description": "", // описание 207 + "data": "" // данные, связанные со сменой статуса}}} 365 365 366 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 367 - 368 -(% style="color:#000000" %){ 369 - 370 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 371 - "description": "" , ~/~/ описание 372 - "data": "" , ~/~/ данные, связанные со сменой статуса 373 - 374 374 (% style="color:#000000" %)} 375 375 376 376 (% style="text-align:left" %) ... ... @@ -377,75 +377,72 @@ 377 377 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 378 378 379 379 380 -(% class="box warningmessage" %)215 +(% class="box successmessage" %) 381 381 ((( 382 - **Блокировка пользователей**(% style="color:#000000; line-height:100%" %)**—disable**217 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 383 383 ))) 384 384 385 -Метод апозволяетвыполнитьмассовуюблокировкупользователей(% style="color:#000000"%)(обязательный параметрв заголовкахзапроса-токенвторизации**«__X-Auth__»**).220 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 386 386 387 -(% style="color:#000000" %)Метод запроса :(%style="color:#000000;line-height:100%"%)**POST**222 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 388 388 389 -(% 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** 390 390 391 -(% 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]] 392 392 393 - [ 394 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 395 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 396 - ] 228 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 397 397 398 -(% 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 - неважно}}} 399 399 236 +(% style="color:#000000" %)} 400 400 401 -(% 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" %) 402 402 ((( 403 - **Разблокировка пользователей**(% 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}** 404 404 ))) 405 405 406 -Метод апозволяетвыполнитьмассовую разблокировку пользователей (%style="color:#000000"%)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).252 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 407 407 408 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**254 +(% style="color:#000000" %)Метод запроса: **DELETE** 409 409 410 -(% 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} 411 411 412 -(% style="color:#000000" %) В телезапросаперечисляетемассивid пользователей(JSON):258 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 413 413 414 - [ 415 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 416 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 417 - ] 260 +(% style="text-align:left" %) 261 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 418 418 419 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 420 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 421 421 264 +(% class="box" style="text-align: center;" %) 422 422 ((( 423 -В теле ответа: 424 -{ 425 - "errorMessages": [ 426 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 427 - ], 428 - "users": [ 429 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 430 - ] 431 -} 432 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 433 -"users" - массив id пользователей, которых не удалось включить или отключить. 434 - 266 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 435 435 ))) 436 436 437 437 (% class="box errormessage" %) 438 438 ((( 439 -(% 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}** 440 440 ))) 441 441 442 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанногов строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).274 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 443 443 444 444 (% style="color:#000000" %)Метод запроса: **DELETE** 445 445 446 -(% 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} 447 447 448 -(% style="color:#000000" %)Параметр запроса: { **__id__**} - Guidпользователя280 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 449 449 450 450 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 451 451 ... ... @@ -453,11 +453,6 @@ 453 453 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 454 454 455 455 456 -(% class="box" style="text-align: center;" %) 457 -((( 458 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 459 -))) 460 - 461 461 (% class="box infomessage" %) 462 462 ((( 463 463 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -465,61 +465,43 @@ 465 465 466 466 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 467 467 468 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):295 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 469 469 470 470 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 471 471 472 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **« __Просмотр заданий на техобслуживание__»**.299 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 473 473 474 474 (% style="color:#000000" %)Метод запроса: **GET** 475 475 476 476 (% 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> 477 477 478 -(% style="color:#000000" %)Параметр запроса: < __**vehicleid**__> - идентификатор объекта (опционально)305 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 479 479 480 480 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 481 481 482 482 (% style="color:#000000" %)Ответ: 483 483 484 -((( 485 -{ 486 - "vehicleId": "", ~/~/ ID объекта 487 - "name": "", ~/~/ Имя объекта 488 - "imei": "", ~/~/ IMEI объекта 489 - "deviceTypeId": , ~/~/ ID типа устройства 490 - "deviceTypeName": "", ~/~/ Название типа устройства 491 - "sim1": "", ~/~/ Номер SIM1 492 - "parentId": "", Номер SIM2 493 - "parentName": "", Наименование клиента-родителя 494 - "modelId": "", ID модели объекта 495 - "modelName": "", Имя модели объекта 496 - "createdAt": "", Дата создания объекта 497 - "mileageCalcMethod": "", Выбранный метод расчета пробега 498 - "counters": { ~/~/ Нормы 499 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 500 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 501 - "mileage": "", ~/~/ Пробег по нормам в метрах 502 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 503 - }, 504 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 505 - { 506 - "id": "", ~/~/ ID задания 507 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 508 - "name": "", ~/~/ Наименование задания 509 - "description": "", ~/~/ Описание задания 510 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 511 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 512 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 513 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 514 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 515 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 516 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 517 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 518 - } 519 - ] 520 -} 521 -))) 311 +(% style="color:#000000" %){ 522 522 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 + ...}}} 329 + 330 +(% style="color:#000000" %)} 331 + 523 523 (% style="text-align:left" %) 524 524 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 525 525 ... ... @@ -532,7 +532,7 @@ 532 532 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 533 533 ))) 534 534 535 -(% 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**). 536 536 537 537 (% style="color:#000000" %)Метод запроса: **POST** 538 538 ... ... @@ -540,431 +540,229 @@ 540 540 541 541 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 542 542 543 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 352 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 544 544 545 -(% style="color:#000000" %){ 546 - 547 - "parentId": "" , ~/~/ ID клиента 548 - "name": "" , ~/~/ имя ТС 549 - "imei": "" , ~/~/ IMEI 550 - "deviceTypeId": "" , ~/~/ ID типа устройства 551 - "modelId": "" , ~/~/ ID модели 552 - "unitId": "" , ~/~/ ID подразделения 553 - "sim1": "" , ~/~/ Номер SIM 1 554 - "sim2": "" , ~/~/ Номер SIM2 555 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 556 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 557 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 558 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 559 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 560 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 561 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 562 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 563 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 564 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 565 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 566 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 567 - "counters": ~/~/ счетчики 568 - { 569 - "mileage": "" , ~/~/ пробег 570 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 571 - "motohours": "" , ~/~/ моточасы 572 - "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": "" // пароль учетной записи 573 573 }, 574 - "cmsv6Parameters": { ~/~/ параметры CMSv6 575 - "enabled": true, ~/~/ флаг включения 576 - "id": "" , ~/~/ идентификатор 577 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 578 - "login": "" , ~/~/ имя учетной записи 579 - "password": "" ~/~/ пароль учетной записи 580 - }, 581 - "inspectionTasks": ~/~/ задания на ТО 379 + "inspectionTasks": [ // задания на ТО 582 582 { 583 - "enabled": "" , ~/~/ Признак включения 584 - "name": "" , ~/~/ Имя задания 585 - "description": "" , ~/~/ Описание задания 586 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 587 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 588 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 589 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 590 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 591 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 592 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 593 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 594 - } 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 + ]}}} 595 595 596 -(% style="color:#000000" %) } 395 +(% style="color:#000000" %)… } 597 597 598 598 (% style="color:#000000" %)Ответ: 599 599 600 600 (% style="color:#000000" %){ 601 601 602 - "vehicleId": "", ~/~/ID ТС 603 - "parentId": "", ~/~/Guid владельца ТС 604 - "name": "", ~/~/Имя объекта 605 - "imei": "", ~/~/IMEI 606 - "deviceTypeId": "", ~/~/ID типа устройства 607 - "modelId": "", ~/~/ID модели 608 - "unitId": "", ~/~/ID подразделения 609 - "sim1": "", ~/~/SIM1 610 - "sim2": "", ~/~/SIM2 611 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 612 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 613 - "counters": { ~/~/Счётчики 614 - "mileageEnabled": true, 615 - "motohoursEnabled": true, 616 - "mileage": "", 617 - "motohours": 345.0 618 - }, 619 - "cmsv6Parameters": { ~/~/Параметры CmsV6 620 - "id": null, 621 - "enabled": true, ~/~/флаг включения 622 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 623 - "login": "", ~/~/ имя учетной записи 624 - "password": "" ~/~/ пароль учетной записи 625 - }, 626 - "inspectionTasks": { ~/~/ задания на ТО 627 - "id": "", ~/~/ ID задачи 628 - "enabled": false, ~/~/ Признак включения 629 - "name": "", ~/~/ Имя задания 630 - "description": "", ~/~/ Описание задания 631 - "mileageCondition": "", ~/~/ Условие по пробегу 632 - "lastMileage": "", ~/~/ Пробег (в метрах) 633 - "motohoursCondition": "", ~/~/ Условие по моточасам 634 - "lastMotohours": "", ~/~/ Моточасы 635 - "periodicCondition": "", ~/~/ Условие периодичности по времени 636 - "kind": "", ~/~/ Вид периодичности по времени 637 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 638 - } 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 + ]}}} 639 639 640 640 (% style="text-align:left" %) 641 641 (% style="color:#000000" %)} 642 642 643 -**Валидация:** 644 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 645 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 646 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 647 647 648 - 649 -(% class="box successmessage" %) 446 +(% class="box warningmessage" %) 650 650 ((( 651 -(% 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** 652 652 ))) 653 653 654 -(% style="color:#000000" %) Метод позволяет получить основныепараметрыобъектов:наименование, IMEI,типустройства, модель объекта,подразделение,номерателефонови идентификаторклиента,ккоторомуприкрепленобъект (клиент-родитель).451 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 655 655 656 -(% style="color:#000000" %) возвращает информацию об объектах с учетом настроек авторизованногопользователя, указанного в запросе (обязательныйпараметр в заголовках запроса - токен авторизации**«__X-Auth__»**):453 +(% style="color:#000000" %)Метод запроса: **PUT** 657 657 658 -(% style="color:#000000" %) − возвращается информацияоб объектахклиента-родителя авторизованного пользователя и объектах его дочерних клиентов;455 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 659 659 660 -(% style="color:#000000" %) −возвращает информациюоб объектахс учетомзаданныхнастроек видимостиобъектов;457 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 661 661 662 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 663 - 664 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 665 - 666 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 667 - 668 -(% style="color:#000000" %)Метод запроса: **POST** 669 - 670 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 671 - 672 -(% style="color:#000000" %)В заголовках запроса: 673 - 674 -(% style="color:#000000" %)− Content-Type: __**application/json**__ 675 - 676 -(% style="color:#000000" %)− X-Auth: Токен авторизации 677 - 678 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 679 - 680 680 (% style="color:#000000" %)Параметры в теле запроса (JSON): 681 681 682 -{ 683 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 684 - "name": null, ~/~/ Имя ТС (string, опционально) 685 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 686 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 687 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 688 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 689 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 690 - "customFields": null ~/~/ значение любого из произвольных полей ТС 691 -} 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»: «» //Сколько раз выполнить задание } ] } 692 692 693 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 694 - 695 695 (% style="color:#000000" %)Ответ: 696 696 697 -(% 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»: «» //Сколько раз выполнить задание } ] } 698 698 699 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 700 - "name": "" ~/~/ наименование объекта 701 - "imei": "" ~/~/ IMEI объекта 702 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 703 - "deviceTypeName": "" ~/~/ наименование типа устройства 704 - "sim1": "" ~/~/ первый номер телефона 705 - "sim2": "" ~/~/ второй номер телефона 706 - "parentId": "" ~/~/ идентификатор клиента-родителя 707 - "parentName": "" ~/~/ наименование клиента-родителя 708 - "modelId": "" ~/~/ идентификатор модели объекта 709 - "modelName": "" ~/~/ наименование модели объекта 710 - "unitId": "" ~/~/ идентификатор подразделения 711 - "unitName": "" ~/~/ наименование подразделения 712 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 713 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 714 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 715 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов (%%) 716 -(% style="color:#000000" %)} 717 717 718 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 719 - 720 - 721 721 (% class="box successmessage" %) 722 722 ((( 723 -(% 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** 724 724 ))) 725 725 726 -(% style="color:#000000" %) Метод позволяет и зменить статусобъекта. Метод позволяетизменитьстатус объекта,указанного в запросе(обязательныйпараметрвзаголовкахзапроса- токенавторизации **«__X-Auth__»**).474 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 727 727 728 -(% style="color:#000000" %)Метод запроса :**POST**476 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 729 729 730 -(% 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" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 731 731 732 -(% style="color:#000000" %) Параметрзапроса:{__**vehicleId**__}-IDТС480 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 733 733 734 -(% style="color:#000000" %) Взаголовкахзапроса:X-Auth:Токен авторизации482 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 735 735 736 -(% style="color:#000000" %) Параметрывтелезапроса(JSON):484 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 737 737 738 -(% style="color:#000000" %) {486 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 739 739 740 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 741 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 742 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 743 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 744 - "description": "", ~/~/ Описание 745 - "data": "", ~/~/ Данные 746 - "overwrite": false, ~/~/ Флаг перезаписи 747 - "stage": "", ~/~/ Состояние, может быть null 488 +(% style="color:#000000" %)Метод запроса: **POST** 748 748 749 -(% 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]] 750 750 751 -(% style="color:#000000" %) Ответ:492 +(% style="color:#000000" %)В заголовках запроса: 752 752 753 -(% style="color:#000000" %) {494 +(% style="color:#000000" %)− Content-Type: application/json 754 754 755 - "status": "", ~/~/ значение статуса 756 - "date": "", ~/~/ Дата смены статуса 757 - "description": "", ~/~/ Описание 758 - "data": "", ~/~/ Данные 759 - "overwrite": false, ~/~/ Флаг перезаписи 760 - "stage": "", ~/~/ Состояние 496 +(% style="color:#000000" %)− X-Auth: Токен авторизации 761 761 762 -(% style="text-align:left" %) 763 -(% style="color:#000000" %) } 498 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 764 764 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" %)} 765 765 766 -(% class="box warningmessage" %) 767 -((( 768 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 769 -))) 502 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 770 770 771 -(% 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//»: «» дата создания объектов //}, … ] 772 772 773 -(% style="color:#000000" %) Метод запроса:**PUT**506 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 774 774 775 -(% style="color:#000000" %) URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]508 +(% style="color:#000000" %)0 - «Блокировка» 776 776 777 -(% style="color:#000000" %) Взаголовках запроса: X-Auth:Токен авторизации510 +(% style="color:#000000" %)1 - «Активен», 778 778 779 -(% style="color:#000000" %) Параметрывтелезапроса (JSON):512 +(% style="color:#000000" %)2 - «Отменен» 780 780 781 -(% style="color:#000000" %) {514 +(% style="color:#000000" %)3 - «Оборудован» 782 782 783 -((( 784 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 785 - "parentId": "", ~/~/ ID клиента 786 - "name": "", ~/~/ имя ТС 787 - "imei": "", ~/~/ IMEI 788 - "deviceTypeId": "", ~/~/ ID типа устройства 789 - "modelId": "", ~/~/ , ID модели 790 - "unitId": "", ~/~/ подразделения 791 - "sim1": "", ~/~/ SIM 1 792 - "sim2": "", ~/~/ SIM2 (%%) 793 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 794 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 795 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 796 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 797 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 798 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 799 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 800 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 801 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 802 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 803 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 804 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 805 -(% style="color:#000000" %) "counters": 806 - { 807 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 808 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 809 - "mileage": "", ~/~/ пробег, в метрах 810 - "motohours": "" ~/~/ моточасы, в секундах 811 - } 812 - "cmsv6Parameters": ~/~/ параметры CMSv6 813 - { 814 - "id": "", ~/~/ идентификатор 815 - "enabled": true, ~/~/ флаг включения 816 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 817 - "login": "", ~/~/ имя учетной записи 818 - "password": "", ~/~/ пароль учетной записи 819 - } 820 - "inspectionTasks": ~/~/ задания на ТО 821 - { 822 - "id": "", ~/~/ ID задания 823 - "enabled": false, ~/~/ Признак включения 824 - "name": "", ~/~/ Имя задания 825 - "description": "", ~/~/ Описание задания 826 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 827 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 828 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 829 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 830 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 831 - "kind": "", ~/~/ Вид периодичности по времени 832 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 833 - } 834 -))) 516 +(% style="color:#000000" %)4 - «Диагностика» 835 835 836 -(% style="color:#000000" %) }518 +(% style="color:#000000" %)5 - «Сервис» 837 837 838 -(% style="color:#000000" %) Ответ:520 +(% style="color:#000000" %)6 - «Демонтаж» 839 839 840 -(% lang="en-US" style="text-align:left" %) 841 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 522 +(% style="color:#000000" %)7 - «Монтаж» 842 842 843 -(% lang="en-US" style="text-align:left" %) 844 - "vehicleId": "", ~/~/ ID ТС 845 - "parentId": "", ~/~/ ID клиента 846 - "name": "", ~/~/ имя ТС 847 - "imei": "", ~/~/ IMEI 848 - "deviceTypeId": "", ~/~/ типа устройства 849 - "modelId": "", ~/~/ ID модели 850 - "unitId": "", ~/~/ ID подразделения 851 - "sim1": "", ~/~/ SIM 1 852 - "sim2": "", ~/~/ SIM2 853 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 854 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 855 - "counters": 856 - { 857 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 858 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 859 - "mileage": "", ~/~/ пробег 860 - "motohours": "", ~/~/ моточасы 861 - } 862 - "cmsv6Parameters": ~/~/ параметры CMSv6 863 - { 864 - "id": ~/~/ идентификатор 865 - "enabled": true, ~/~/ флаг включения 866 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 867 - "login": "", ~/~/ имя учетной записи 868 - "password": "", ~/~/ пароль учетной записи 869 - } 870 - "inspectionTasks": ~/~/ задания на ТО 871 - { 872 - "id": "", ~/~/ ID задания 873 - "enabled": false, ~/~/ Признак включения 874 - "name": "", ~/~/ Имя задания 875 - "description": "", ~/~/ Описание задания 876 - "mileageCondition": "", ~/~/ Условие по пробегу 877 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 878 - "motohoursCondition": "", ~/~/ Условие по моточасам 879 - "lastMotohours": "", ~/~/ Моточасы 880 - "periodicCondition": "", ~/~/ Условие периодичности по времени 881 - "kind": "", ~/~/ Вид периодичности по времени 882 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 883 - } 524 +(% style="color:#000000" %)8 - «Дозаказ» 884 884 885 -(% lang="en-US" style="text-align:left" %) 886 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 526 +(% style="color:#000000" %)9 - «Обслужен» 887 887 888 -**валидация:** 889 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 890 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 891 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 528 +(% style="color:#000000" %)10 - «Списан» 892 892 530 +(% style="color:#000000" %)11 - «Неисправен» 893 893 894 -(% class="box errormessage" %) 895 -((( 896 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 897 -))) 532 +(% style="color:#000000" %)12 - «Проверен» 898 898 899 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 900 - 901 -(% style="color:#000000" %)Метод запроса: **DELETE** 902 - 903 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 904 - 905 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 906 - 907 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 908 - 909 909 (% style="text-align:left" %) 910 -(% style="color:#000000" %) **Ответ:Вслучаеуспешного выполнения запроса вернетсяHTTP ответ «200».**535 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется» 911 911 912 912 913 -(% class="box "lang="en-US"style="text-align: center;" %)538 +(% class="box successmessage" %) 914 914 ((( 915 -(% style="color:#000000; font-size:14pt" %)**РазделУстройства**540 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 916 916 ))) 917 917 918 -(% class="box infomessage" %) 919 -((( 920 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 921 -))) 543 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 922 922 923 -(% style="color:#000000" %) позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроекавторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации**«__X-Auth__»**).545 +(% style="color:#000000" %)Метод запроса: **POST** 924 924 925 -(% 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} 926 926 927 -(% 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 ТС 928 928 929 929 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 930 930 931 -(% style="color:#000000" %) Ответ:553 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { 932 932 933 -(% 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}}} 934 934 935 - "deviceTypeId" : "", ~/~/ ID типа устройства 936 - "deviceTypeName" : "" ~/~/ Название типа устройства 937 - 938 -(% style="text-align:left" %) 939 939 (% style="color:#000000" %)} 940 940 565 +(% style="color:#000000" %)Ответ: { 941 941 942 -(% class="box" style="text-align: center;" %) 943 -((( 944 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 945 -))) 567 +(% class="western" %) 568 +{{{ "status": "", // значение статуса 569 + "date": "", // Дата смены статуса 570 + "description": "", // Описание 571 + "data": "", // Данные 572 + "overwrite": false, // Флаг перезаписи 573 + "stage": "", // Состояние}}} 946 946 947 -(% class="box infomessage" %) 948 -((( 949 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 950 -))) 951 - 952 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 953 - 954 -(% style="color:#000000" %)Метод запроса: **GET** 955 - 956 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 957 - 958 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 959 - 960 -(% style="color:#000000" %)Ответ: 961 - 962 -(% style="color:#000000" %){ 963 - 964 - "id": "", ~/~/ ID типа датчика 965 - "name": "", ~/~/ Название 966 - "description": "", ~/~/ Описание 967 - 968 968 (% style="text-align:left" %) 969 969 (% style="color:#000000" %)} 970 970 ... ... @@ -971,5 +971,5 @@ 971 971 972 972 (% class="box" lang="en-US" style="text-align: center;" %) 973 973 ((( 974 -(% 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** 975 975 )))