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