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