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