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