Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/17 16:44
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,11 +1,10 @@ 1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 1 +(% class="western" %) 2 +== Описание ГЛОНАССSoft Public API 3 + == 3 3 4 -== == 5 - 6 -(% class="box" style="text-align: center;" %) 5 +(% class="box" %) 7 7 ((( 8 - (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**7 +**Действующие ограничения** 9 9 ))) 10 10 11 11 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). ... ... @@ -17,44 +17,46 @@ 17 17 18 18 (% class="box" style="text-align: center;" %) 19 19 ((( 20 -(% style="color: #000000; font-size:14pt" %)**РазделАвторизация**19 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Клиенты** 21 21 ))) 22 22 23 23 (% class="box infomessage" %) 24 24 ((( 25 - ; line-height:100%" %)**Авторизация**(%style="color:#000000" %)**—**(% lang="en-US" %)**GET /api/v3/auth/login**24 +(% style="color:#000000" %)**Получение основных параметров клиента — (% lang="en-US" %)GET (%%)/(% lang="en-US" %)api/v3/agents(%%)** 26 26 ))) 27 27 28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации,которыйнеобходимодобавлятьвзаголовокдляработы со всеми методамиAPI.Впараметрахметодапередаетсяимяпользователяипароль.27 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 29 29 30 -(% style="color:#000000" %) Методзапроса:**GET**29 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 31 31 32 -(% 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]]31 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 33 33 34 -(% style="color:#000000" %) Вслучае успешноговыполненияметода,поле«AuthId» содержиттокен авторизации«X-Auth».33 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 35 35 36 -(% lang="en-US" %) 37 -(% style="color:#000000" %)**Ответ:** 35 +(% style="color:#000000" %)Метод запроса: **GET** 38 38 39 -(% lang="en-US" %) 40 -(% style="color:#000000" %){ 37 +(% 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> 41 41 42 -(% lang="en-US" %) 43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 - "User": "" , ~/~/ имя пользователя 39 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 45 45 46 -(% lang="en-US" %) 47 -} 41 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 48 48 49 - **Примечание:**Времяжизнивторизации задаетсявнастройкахпользователя,тамсть параметрдлительностьсессии.При каждомзапросетокен пролонгируется.43 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 50 50 45 +(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% lang="en-US" style="font-variant: normal; color: rgb(0, 0, 0); font-family: Liberation Serif, serif; font-size: 12pt; font-style: normal; font-weight: normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" lang="en-US" %)] 51 51 47 + 48 +(% class="box" style="text-align: center;" %) 49 +((( 50 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Авторизация** 51 +))) 52 + 52 52 (% class="box infomessage" %) 53 53 ((( 54 -(% style=" color:#000000; line-height:100%" %)**Проверка авторизации**(% style="color:#000000" %)**—**(% lang="en-US" %)**GET /api/v3/auth/check**55 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Проверка авторизации — G(% lang="en-US" %)ET /api/v3/auth/check(%%)** 55 55 ))) 56 56 57 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»** ).58 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**. 58 58 59 59 (% style="color:#000000" %)Метод запроса: **GET** 60 60 ... ... @@ -63,170 +63,116 @@ 63 63 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 64 64 65 65 (% lang="en-US" %) 66 -(% style="color:#000000" %) **Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**67 +(% style="color:#000000" %)Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401». 67 67 68 68 69 -(% class="box" style="text-align: center;" %) 70 -((( 71 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 72 -))) 73 - 74 74 (% class="box infomessage" %) 75 75 ((( 76 -(% style="color: #000000" %)**Получение основных параметров клиента —**(% lang="en-US" %)**GET**(%%)**/(% lang="en-US" %)api/v3/agents(%%)**72 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Авторизация — GE(% lang="en-US" %)T /api/v3/auth/login(%%)** 77 77 ))) 78 78 79 -(% style="color:#000000" %) Метод позволяет получить о сновныепараметры клиентов: наименование,полноенаименование,тип, статусиидентификатор клиента-родителя.Методвозвращаетинформациюоклиентахс учетом настроекавторизованногопользователя,указанногов запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):75 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 80 80 81 -(% style="color:#000000" %) − информация о клиентах предоставляетсяпри наличииправа «Просмотрклиентов»;77 +(% style="color:#000000" %)Метод запроса: **GET** 82 82 83 -(% style="color:#000000" %) − возвращается информация о клиенте, которомупринадлежит авторизованныйпользователь, и его дочерних клиентах;79 +(% 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]] 84 84 85 -(% style="color:#000000" %) −информацияо клиентетипа «Партнер»и его подклиентоввозвращается при наличииправа «Доступ к партнёрским клиентам».81 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 86 86 87 -(% style="color:#000000" %)Метод запроса: **GET** 83 +(% lang="en-US" %) 84 +(% style="color:#000000" %)Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ] 88 88 89 -(% 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> 90 90 91 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 87 +(% class="box" lang="en-US" style="text-align: center;" %) 88 +((( 89 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел (% lang="ru-RU" %)Устройства(%%)** 90 +))) 92 92 93 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 92 +(% class="box infomessage" %) 93 +((( 94 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка типов устройств - GE(% lang="en-US" %)T /api/v3/devices/types(%%)** 95 +))) 94 94 95 -(% style="color:#000000" %) Ответ:97 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 96 96 97 -(% style="color:#000000" %){ 98 - "agentId": "", ~/~/ идентификатор клиента 99 - "parentId": "", ~/~/ идентификатор клиента-родителя 100 - "name": "", ~/~/ наименование клиента 101 - "fullName": "", ~/~/ полное наименование клиента 102 - "agentInfoType": "", ~/~/ тип клиента1 103 - "status": "", ~/~/ статус клиента 104 - } 99 +(% style="color:#000000" %)Метод запроса: **GET** 105 105 101 +(% 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]] 106 106 107 -(% 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" %)]103 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 108 108 105 +(% style="color:#000000" %)Ответ: [ 109 109 107 +(% class="western" %) 108 +{{{ { 109 + "deviceTypeId" : "", // ID типа устройства 110 + "deviceTypeName" : "" // Название типа устройства 111 + },}}} 112 + 113 +(% style="text-align:left" %) 114 +(% style="color:#000000" %)…** **] 115 + 116 + 110 110 (% class="box" style="text-align: center;" %) 111 111 ((( 112 -(% style="color: #000000; font-size:14pt" %)**РазделПользователи**119 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Датчики** 113 113 ))) 114 114 115 -(% class="box successmessage" %)122 +(% class="box infomessage" %) 116 116 ((( 117 -(% style=" color:#000000; line-height:100%" %)**Добавление пользователя—**(% lang="en-US" %)**POST /api/v3/users**124 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка типов датчиков - GE(% lang="en-US" %)T /api/v3/sensors/types(%%)** 118 118 ))) 119 119 120 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Методпозволяет добавитьпользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).127 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 121 121 122 -(% style="color:#000000" %)Метод запроса: ** POST**129 +(% style="color:#000000" %)Метод запроса: **GET** 123 123 124 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users>>url:https://hosting.glonasssoft.ru/api/v3/users]]131 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 125 125 126 -(% style="color:#000000" %)В заголовках запроса: 133 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 127 127 128 -(% style="color:#000000" %) Параметрывтеле запроса (JSON):135 +(% style="color:#000000" %)Ответ: [ 129 129 130 -(% style="color:#000000" %){ 131 - "lastName": "", ~/~/ фамилия 132 - "firstName": "", ~/~/ имя 133 - "position": "", ~/~/ должность 134 - "phone": "", ~/~/ телефон 135 - "organization": "", ~/~/ организация 136 - "login": "", ~/~/ логин 137 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 138 - "email": "", ~/~/ email 139 - "description": "", ~/~/ описание 140 - "isEnabled": "", ~/~/ признак включения 141 - "parentId": "", ~/~/ Guid родительского агента 142 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 143 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 144 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 145 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 - "groups": "" , ~/~/ группы пользователя, названия групп 148 - } 137 +(% class="western" style="margin-bottom:19px" %) 138 +{{{ {}}} 149 149 150 -(% style="text-align:left" %) 151 -(% style="color:#000000; font-weight:normal" %)Ответ: 140 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 152 152 153 -(% style="text-align:left" %) 154 -(% style="color:#000000; font-weight:normal" %){ 142 +(% class="western" %) 143 +{{{ "description": "" // Описание 144 + },}}} 155 155 156 156 (% style="text-align:left" %) 157 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 158 - "lastName": "" , ~/~/ Фамилия , 159 - "firstName": "" , ~/~/ Имя 160 - "position": "" , ~/~/ Должность 161 - "phone": "" , ~/~/ Телефон 162 - "organization": "" , ~/~/ Организация 163 - "login": "" , ~/~/ Логин 164 - "password": "" , ~/~/ Пароль 165 - "email": "" , ~/~/ Email 166 - "description": "" , ~/~/ Описание 167 - "isEnabled": "" , ~/~/ Признак включения 168 - "parentId": "" , ~/~/ Guid родительского агента 169 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 170 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 171 - "kind": "" , ~/~/ тип аутентификации 172 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 173 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 147 +(% style="color:#000000" %)… ] 174 174 175 -(% style="text-align:left" %) 176 -(% style="color:#000000; font-weight:normal" %)} 177 177 150 +(% class="box" style="text-align: center;" %) 151 +((( 152 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Пользователи** 153 +))) 178 178 179 179 (% class="box successmessage" %) 180 180 ((( 181 -(% style=" color:#000000; line-height:100%" %)**Получениесписка пользователей—**(% lang="en-US" %)**POST /api/v3/users/find**157 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Добавление пользователя — (% lang="en-US" %)POST /api/v3/users(%%)** 182 182 ))) 183 183 184 -(% style="color:#000000" %) Метод позволяет получить основные параметрыпользователей:логин,имя,адресэлектроннойпочты,номертелефона,статус,идентификаторклиента-родителяипрочее.160 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 185 185 186 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 187 - 188 188 (% style="color:#000000" %)Метод запроса: **POST** 189 189 190 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users /find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]164 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 191 191 192 -(% style="color:#000000" %) Условияфильтрацииобъектовзадаютсяв телезапроса.Параметрывелезапроса (JSON):166 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 193 193 194 -(% style="color:#000000" %){ 168 +(% 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»: [ // группы пользователя «», //названия групп «», «» ] } 195 195 196 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 197 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 198 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 199 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 170 +(% style="text-align:left" %) 171 +(% style="color: rgb(0, 0, 0); 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» //названия групп ] } 200 200 201 -(% style="color:#000000" %)} 202 202 203 -(% style="color:#000000" %)Ответ: 204 - 205 -(% style="color:#000000" %){ 206 - 207 -(% style="color:#000000" %) "id": "" , ~/~/ идентификатор пользователя 208 - "lastName": "" , ~/~/ фамилия 209 - "firstName": "" , ~/~/ имя 210 - "position": "" , ~/~/ должность 211 - "phone": "" , ~/~/ телефон 212 - "parentId": "" , ~/~/ идентификатор клиента-родителя 213 - "parentName": "" , ~/~/ наименование клиента-родителя 214 - "organization": "" , ~/~/ организация 215 - "login": "" , ~/~/ логин 216 - "email": "" , ~/~/ E-mail 217 - 218 -(% style="color:#000000" %)} 219 - 220 -(% class="western" style="margin-bottom:19px" %) 221 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 222 - 223 -(% lang="en-US" style="text-align:left" %) 224 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 225 - 226 - 227 227 (% class="box warningmessage" %) 228 228 ((( 229 -(% style=" color:#000000; line-height:100%" %)**Редактирование пользователя —**(% lang="en-US" %)**PUT /api/v3/users**176 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Редактирование пользователя — (% lang="en-US" %)PUT /api/v3/users(%%)** 230 230 ))) 231 231 232 232 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). ... ... @@ -238,12 +238,12 @@ 238 238 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 239 239 240 240 (% lang="en-US" style="text-align:left" %) 241 -(% 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» //названия групп ] }188 +(% lang="ru-RU" style="color: rgb(0, 0, 0); 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» //названия групп ] } // 242 242 243 243 244 244 (% class="box warningmessage" %) 245 245 ((( 246 -(% style="color:#000000" %)**Измен ениестатусапользователя**// //**—**(% lang="en-US" %)**PUT /api/v3/users/status/{id}**193 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— (% lang="en-US" %)PUT /api/v3/users/status/{id}(%%)** 247 247 ))) 248 248 249 249 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). ... ... @@ -252,7 +252,7 @@ 252 252 253 253 (% 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} Параметр запроса: 254 254 255 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// 202 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 256 256 257 257 (% class="western" %) 258 258 {{{ "description": "", // описание ... ... @@ -264,9 +264,41 @@ 264 264 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 265 265 266 266 214 +(% class="box successmessage" %) 215 +((( 216 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка пользователей — (% lang="en-US" %)POST /api/v3/users/find(%%)** 217 +))) 218 + 219 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 220 + 221 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 222 + 223 +(% style="color:#000000" %)Метод запроса: **POST** 224 + 225 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 226 + 227 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 228 + 229 +(% class="western" %) 230 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 231 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 232 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 233 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 234 + 235 +(% style="color:#000000" %)} 236 + 237 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 238 + 239 +(% class="western" style="margin-bottom:19px" %) 240 +{{{ "sessionDuration":"", // длительность сессии в минутах}}} 241 + 242 +(% lang="en-US" style="text-align:left" %) 243 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 244 + 245 + 267 267 (% class="box errormessage" %) 268 268 ((( 269 -(% style=" color:#000000; line-height:100%" %)**Удаление пользователя —**(% lang="en-US" %)**DELETE /api/v3/users/{id}**248 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Удаление пользователя — (% lang="en-US" %)DELETE /api/v3/users/{id}(%%)** 270 270 ))) 271 271 272 272 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). ... ... @@ -283,12 +283,31 @@ 283 283 284 284 (% class="box" style="text-align: center;" %) 285 285 ((( 286 -(% style="color: #000000; font-size:14pt" %)**Раздел Транспортные средства**265 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Транспортные средства** 287 287 ))) 288 288 268 +(% class="box errormessage" %) 269 +((( 270 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Удаление объекта — D(% lang="en-US" %)ELETE /api/v3/vehicles/{vehicleId}(%%)** 271 +))) 272 + 273 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 274 + 275 +(% style="color:#000000" %)Метод запроса: **DELETE** 276 + 277 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 278 + 279 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 280 + 281 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 282 + 283 +(% style="text-align:left" %) 284 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 285 + 286 + 289 289 (% class="box infomessage" %) 290 290 ((( 291 -(% style=" color:#000000; line-height:100%" %)**Получение информации об объекте —**(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**289 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение информации об объекте — (% lang="en-US" %)GET /api/v3/vehicles/{vehicleId}(%%)** 292 292 ))) 293 293 294 294 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». ... ... @@ -339,7 +339,7 @@ 339 339 340 340 (% class="box successmessage" %) 341 341 ((( 342 -(% style=" color:#000000; line-height:100%" %)**Добавление объекта —**(% lang="en-US" %)**POST /api/v3/vehicles**340 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Добавление объекта — (% lang="en-US" %)POST /api/v3/vehicles(%%)** 343 343 ))) 344 344 345 345 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**). ... ... @@ -444,9 +444,32 @@ 444 444 (% style="color:#000000" %)} 445 445 446 446 445 +(% class="box warningmessage" %) 446 +((( 447 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Редактирование объекта — (% lang="en-US" %)PUT /api/v3/vehicles(%%)** 448 +))) 449 + 450 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 451 + 452 +(% style="color:#000000" %)Метод запроса: **PUT** 453 + 454 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 455 + 456 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 457 + 458 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 459 + 460 +(% 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»: «» //Сколько раз выполнить задание } ] } 461 + 462 +(% style="color:#000000" %)Ответ: 463 + 464 +(% lang="en-US" style="text-align:left" %) 465 +(% lang="ru-RU" style="color: rgb(0, 0, 0); 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»: «» //Сколько раз выполнить задание } ] } 466 + 467 + 447 447 (% class="box successmessage" %) 448 448 ((( 449 -(% style=" color:#000000; line-height:100%" %)**Получение параметровобъектов —**(% lang="en-US" %)**POST /api/v3/vehicles/find**470 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка объектов — P(% lang="en-US" %)OST /api/v3/vehicles(%%)** 450 450 ))) 451 451 452 452 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). ... ... @@ -475,14 +475,8 @@ 475 475 476 476 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 477 477 478 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",## 499 +(% 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" %)} 479 479 480 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 481 - 482 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 483 - 484 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 485 - 486 486 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 487 487 488 488 (% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] ... ... @@ -489,12 +489,39 @@ 489 489 490 490 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 491 491 492 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».507 +(% style="color:#000000" %)0 - «Блокировка» 493 493 509 +(% style="color:#000000" %)1 - «Активен», 494 494 511 +(% style="color:#000000" %)2 - «Отменен» 512 + 513 +(% style="color:#000000" %)3 - «Оборудован» 514 + 515 +(% style="color:#000000" %)4 - «Диагностика» 516 + 517 +(% style="color:#000000" %)5 - «Сервис» 518 + 519 +(% style="color:#000000" %)6 - «Демонтаж» 520 + 521 +(% style="color:#000000" %)7 - «Монтаж» 522 + 523 +(% style="color:#000000" %)8 - «Дозаказ» 524 + 525 +(% style="color:#000000" %)9 - «Обслужен» 526 + 527 +(% style="color:#000000" %)10 - «Списан» 528 + 529 +(% style="color:#000000" %)11 - «Неисправен» 530 + 531 +(% style="color:#000000" %)12 - «Проверен» 532 + 533 +(% style="text-align:left" %) 534 +(% style="font-weight: normal; color: rgb(0, 0, 0)" %)13 - «Не эксплуатируется» 535 + 536 + 495 495 (% class="box successmessage" %) 496 496 ((( 497 -(% style=" color:#000000; line-height:100%" %)**Изменение статуса объекта —**(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**539 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Изменение статуса объекта — (% lang="en-US" %)POST /api/v3/vehicles/changeStatus/{vehicleId}(%%)** 498 498 ))) 499 499 500 500 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). ... ... @@ -510,9 +510,7 @@ 510 510 (% style="color:#000000" %)Параметры в теле запроса (JSON): { 511 511 512 512 (% class="western" %) 513 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 514 - // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 515 - // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 555 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 516 516 "date": "", // Дата смены статуса (null если сменить немедленно) 517 517 "description": "", // Описание 518 518 "data": "", // Данные ... ... @@ -535,112 +535,7 @@ 535 535 (% style="color:#000000" %)} 536 536 537 537 538 -(% class="box warningmessage" %) 539 -((( 540 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 541 -))) 542 - 543 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 544 - 545 -(% style="color:#000000" %)Метод запроса: **PUT** 546 - 547 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 548 - 549 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 550 - 551 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 552 - 553 -(% 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 - 555 -(% style="color:#000000" %)Ответ: 556 - 557 -(% lang="en-US" style="text-align:left" %) 558 -(% 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»: «» //Сколько раз выполнить задание } ] } 559 - 560 - 561 -(% class="box errormessage" %) 562 -((( 563 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 564 -))) 565 - 566 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 567 - 568 -(% style="color:#000000" %)Метод запроса: **DELETE** 569 - 570 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 571 - 572 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 573 - 574 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 575 - 576 -(% style="text-align:left" %) 577 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 578 - 579 - 580 580 (% class="box" lang="en-US" style="text-align: center;" %) 581 581 ((( 582 -(% style="color: #000000; font-size:14pt" %)**РазделУстройства**580 +(% style="color: rgb(0, 0, 0); font-size: 14pt" lang="ru-RU" %)**Расширенное описание PUBLIC API 3.0 доступно по запросу на support@glonasssoft.ru** 583 583 ))) 584 - 585 -(% class="box infomessage" %) 586 -((( 587 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 588 -))) 589 - 590 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 591 - 592 -(% style="color:#000000" %)Метод запроса: **GET** 593 - 594 -(% 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]] 595 - 596 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 597 - 598 -(% style="color:#000000" %)Ответ: [ 599 - 600 -(% class="western" %) 601 -{{{ { 602 - "deviceTypeId" : "", // ID типа устройства 603 - "deviceTypeName" : "" // Название типа устройства 604 - },}}} 605 - 606 -(% style="text-align:left" %) 607 -(% style="color:#000000" %)…** **] 608 - 609 - 610 -(% class="box" style="text-align: center;" %) 611 -((( 612 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 613 -))) 614 - 615 -(% class="box infomessage" %) 616 -((( 617 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 618 -))) 619 - 620 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 621 - 622 -(% style="color:#000000" %)Метод запроса: **GET** 623 - 624 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 625 - 626 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 627 - 628 -(% style="color:#000000" %)Ответ: [ 629 - 630 -(% class="western" style="margin-bottom:19px" %) 631 -{{{ {}}} 632 - 633 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 634 - 635 -(% class="western" %) 636 -{{{ "description": "" // Описание 637 - },}}} 638 - 639 -(% style="text-align:left" %) 640 -(% style="color:#000000" %)… ] 641 - 642 - 643 -(% class="box" lang="en-US" style="text-align: center;" %) 644 -((( 645 -(% 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]] ** 646 -)))