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