Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/19 14:01
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Artem1 +XWiki.Gadmin - Content
-
... ... @@ -1,570 +1,424 @@ 1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 1 +== Описание ГЛОНАССSoft Public API == 3 3 4 4 == == 5 5 6 -(% class="box" style="text-align: center;" %) 7 -((( 8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 9 -))) 5 + **Действующие ограничения** 6 + 10 10 11 - (%style="color:#000000" %)−(%%)Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).8 +- Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов) 12 12 13 - (%style="color:#000000" %)−(%%)Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).10 +- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 - 13 +\\ 17 17 18 -(% class="box" style="text-align: center;" %) 19 -((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 -))) 15 + **Авторизация** 22 22 23 -(% class="box infomessage" %) 24 -((( 25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login** 26 -))) 17 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 27 27 28 - (% style="color:#000000" %)Методпозволяет получить токенавторизации, который необходимо добавлять в заголовок для работы со всеми методами API. Впараметрах метода передается имя пользователяи пароль.19 +Метод запроса: GET 29 29 30 - (%style="color:#000000" %)Метод запроса:**GET**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]] 31 31 32 - (%style="color:#000000" %)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]23 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 25 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ] 26 + 35 35 36 -(% lang="en-US" %) 37 -(% style="color:#000000" %)**Ответ:** 28 + **Получение списка объектов** 38 38 39 -(% lang="en-US" %) 40 -(% style="color:#000000" %){ 30 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 41 41 42 -(% lang="en-US" %) 43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 - "User": "" , ~/~/ имя пользователя 32 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 45 45 46 -(% lang="en-US" %) 47 - } 34 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов; 48 48 49 - **Примечание:**Времяжизнитокенаавторизации задается в настройкахпользователя,таместьпараметрдлительностьсессии.При каждомзапросетокенпролонгируется.36 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 50 50 38 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 51 51 52 -(% class="box infomessage" %) 53 -((( 54 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 55 -))) 40 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 56 56 57 - (% style="color:#000000" %)Методпозволяет проверить статус авторизации. Методпозволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса- токен авторизации **«X-Auth»**).42 +Метод запроса: POST 58 58 59 - (%style="color:#000000" %)Метод запроса:**GET**44 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 60 60 61 - (%style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]46 +В заголовках запроса: 62 62 63 - (% style="color:#000000"%)В заголовках запроса: X-Auth: Токен авторизации48 +−Content-Type: application/json 64 64 65 -(% lang="en-US" %) 66 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 50 +−X-Auth: Токен авторизации 67 67 52 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 68 68 69 -(% class="box" style="text-align: center;" %) 70 -((( 71 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 72 -))) 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, опционально)}}}} 73 73 74 -(% class="box infomessage" %) 75 -((( 76 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 77 -))) 56 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 78 78 79 - (% style="color:#000000"%)Методпозволяетполучитьосновныепараметрыклиентов: наименование,полное наименование,тип, статусиидентификатор клиента-родителя.Методвозвращаетинформациюоклиентахсучетомнастроеквторизованногопользователя,указанноговзапросе(обязательныйпараметрвзаголовкахзапроса- токен авторизации**«X-Auth»**):58 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 80 80 81 - (%style="color:#000000"%)−информация оклиентахпредоставляется при наличии права «Просмотр клиентов»;60 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 82 82 83 - (% style="color:#000000"%)−возвращается информация оклиенте, которому принадлежит авторизованный пользователь, и его дочернихклиентах;62 +0 - «Блокировка» 84 84 85 - (%style="color:#000000"%)− информация о клиенте типа«Партнер» и его подклиентов возвращается приналичии права «Доступ к партнёрским клиентам».64 +1 - «Активен», 86 86 87 - (%style="color:#000000"%)Метод запроса: **GET**66 +2 - «Отменен» 88 88 89 - (%style="color:#000000"%)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>68 +3 - «Оборудован» 90 90 91 - (%style="color:#000000" %)Параметр запроса: <parentId>- идентификатор клиента-родителя (опционально)70 +4 - «Диагностика» 92 92 93 - (%style="color:#000000" %)В заголовках запроса: X-Auth:Токен авторизации72 +5 - «Сервис» 94 94 95 - (%style="color:#000000"%)Ответ:74 +6 - «Демонтаж» 96 96 97 -(% style="color:#000000" %){ 98 - "agentId": "", ~/~/ идентификатор клиента 99 - "parentId": "", ~/~/ идентификатор клиента-родителя 100 - "name": "", ~/~/ наименование клиента 101 - "fullName": "", ~/~/ полное наименование клиента 102 - "agentInfoType": "", ~/~/ тип клиента1 103 - "status": "", ~/~/ статус клиента 104 - } 76 +7 - «Монтаж» 105 105 78 +8 - «Дозаказ» 106 106 107 - (%style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US"%)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]80 +9 - «Обслужен» 108 108 82 +10 - «Списан» 109 109 110 -(% class="box" style="text-align: center;" %) 111 -((( 112 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 113 -))) 84 +11 - «Неисправен» 114 114 115 -(% class="box successmessage" %) 116 -((( 117 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 118 -))) 86 +12 - «Проверен» 119 119 120 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 88 +13 - «Не эксплуатируется» 89 + 121 121 122 - (%style="color:#000000"%)Методзапроса:**POST**91 + **Получение списка клиентов.** 123 123 124 - (%style="color:#000000"%)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]93 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 125 125 126 - (% style="color:#000000" %)В заголовкахзапроса:X-Auth:Токен авторизации95 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»; 127 127 128 - (% style="color:#000000" %)Параметрывтеле запроса(JSON):97 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 129 129 130 -(% style="color:#000000" %){ 131 - "lastName": "", ~/~/ фамилия 132 - "firstName": "", ~/~/ имя 133 - "position": "", ~/~/ должность 134 - "phone": "", ~/~/ телефон 135 - "organization": "", ~/~/ организация 136 - "login": "", ~/~/ логин 137 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 138 - "email": "", ~/~/ email 139 - "description": "", ~/~/ описание 140 - "isEnabled": "", ~/~/ признак включения 141 - "parentId": "", ~/~/ Guid родительского агента 142 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 143 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 144 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 145 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 - "groups": "" , ~/~/ группы пользователя, названия групп 148 - } 99 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 149 149 150 -(% style="text-align:left" %) 151 -(% style="color:#000000; font-weight:normal" %)Ответ: 101 +Метод запроса: GET 152 152 153 -(% style="text-align:left" %) 154 -(% 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> 155 155 156 -(% style="text-align:left" %) 157 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 158 - "lastName": "" , ~/~/ Фамилия , 159 - "firstName": "" , ~/~/ Имя 160 - "position": "" , ~/~/ Должность 161 - "phone": "" , ~/~/ Телефон 162 - "organization": "" , ~/~/ Организация 163 - "login": "" , ~/~/ Логин 164 - "password": "" , ~/~/ Пароль 165 - "email": "" , ~/~/ Email 166 - "description": "" , ~/~/ Описание 167 - "isEnabled": "" , ~/~/ Признак включения 168 - "parentId": "" , ~/~/ Guid родительского агента 169 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 170 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 171 - "kind": "" , ~/~/ тип аутентификации 172 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 173 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 105 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 174 174 175 -(% style="text-align:left" %) 176 -(% style="color:#000000; font-weight:normal" %) } 107 +В заголовках запроса: X-Auth: Токен авторизации 177 177 109 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 178 178 179 -(% class="box successmessage" %) 180 -((( 181 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 182 -))) 111 +Примечание. Возможные значение параметра agentInfoType: 112 + 183 183 184 - (%style="color:#000000"%)Метод позволяет получить основные параметрыпользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.114 + **Получение списка пользователей.** 185 185 186 - (% style="color:#000000" %)Методвозвращаетинформацию опользователяхклиента-родителяавторизованногопользователяи пользователях егодочернихклиентов. Информацияопользователях предоставляетсяприаличии права **«Просмотрпользователей»**.116 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр. 187 187 188 - (%style="color:#000000"%)Метод запроса:**POST**118 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей». 189 189 190 - (%style="color:#000000" %)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]120 +Метод запроса: POST 191 191 192 - (% style="color:#000000" %)Условия фильтрации объектовзадаются в теле запроса.Параметры в теле запроса (JSON):122 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 193 193 194 - (%style="color:#000000"%){124 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 195 195 196 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента197 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно198 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно199 - "email": "eee" ,~/~/ Email пользователя, по которому фильтруется, null - неважно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 - неважно}}} 200 200 201 - (% style="color:#000000" %)}131 +} 202 202 203 - (%style="color:#000000"%)Ответ:133 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 204 204 205 - (%style="color:#000000"%){(%%)135 +{{{ "sessionDuration": "", // длительность сессии в минутах}}} 206 206 207 - "id": "" , ~/~/ идентификатор пользователя 208 - "lastName": "" , ~/~/ фамилия 209 - "firstName": "" , ~/~/ имя 210 - "position": "" , ~/~/ должность 211 - "phone": "" , ~/~/ телефон 212 - "parentId": "" , ~/~/ идентификатор клиента-родителя 213 - "parentName": "" , ~/~/ наименование клиента-родителя 214 - "organization": "" , ~/~/ организация 215 - "login": "" , ~/~/ логин 216 - "email": "" , ~/~/ E-mail 217 - "sessionDuration":"", ~/~/ длительность сессии в минутах 218 - "status": "1", ~/~/ статус пользователя 219 - "astLogged": "", ~/~/ дата/время последней авторизации 137 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ] 138 + 220 220 221 - (%style="color:#000000"%)}140 + **Получение списка типов устройств** 222 222 142 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 223 223 224 -(% class="box warningmessage" %) 225 -((( 226 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 227 -))) 144 +Метод запроса: GET 228 228 229 - (% style="color:#000000" %) Метод позволяет отредактироватьпользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).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]] 230 230 231 - (%style="color:#000000" %)Методзапроса:**PUT**148 +В заголовках запроса:X-Auth: Токен авторизации 232 232 233 - (% style="color:#000000"%)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]150 +Ответ: [ 234 234 235 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 152 +{{{ { 153 + "deviceTypeId" : "", // ID типа устройства 154 + "deviceTypeName" : "" // Название типа устройства 155 + },}}} 236 236 237 - (%lang="en-US" style="text-align:left" %)238 - (%lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):157 +… ] 158 + 239 239 240 -(% lang="en-US" style="text-align:left" %) 241 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 160 + **Получение списка типов датчиков** 242 242 243 -(% lang="en-US" style="text-align:left" %) 244 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 245 - "lastName": "" , ~/~/ фамилия 246 - "firstName": "" , ~/~/ имя 247 - "position": "" , ~/~/ должность 248 - "phone": "" , ~/~/ телефон 249 - "organization": "" , ~/~/ организация 250 - "login": "" , ~/~/ логин 251 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 252 - "email": "" , ~/~/ email 253 - "description": "" , ~/~/ описание 254 - "isEnabled": "" , ~/~/ признак включения 255 - "parentId": "" , ~/~/ Guid родительского агента 256 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 257 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 258 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 259 - "kind": "" , ~/~/ тип аутентификации 260 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 261 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 162 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 262 262 263 -(% lang="en-US" style="text-align:left" %) 264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 164 +Метод запроса: GET 265 265 266 -(% lang="en-US" style="text-align:left" %) 267 -(% 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]] 268 268 269 -(% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 168 +В заголовках запроса:X-Auth: Токен авторизации 271 271 272 -(% lang="en-US" style="text-align:left" %) 273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя 274 - "lastName": "" , ~/~/ фамилия 275 - "firstName": "" , ~/~/ имя 276 - "position": "" , ~/~/ должность 277 - "phone": "" , ~/~/ телефон 278 - "organization": "" , ~/~/ организация 279 - "login": "" , ~/~/ логин 280 - "password": "" , ~/~/ пароль 281 - "email": "" , ~/~/ email 282 - "description": "" , ~/~/ описание 283 - "isEnabled": "" , ~/~/ признак включения 284 - "parentId": "" , ~/~/ Guid родительского агента 285 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 286 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 287 - "kind": "" , ~/~/ тип аутентификации 288 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя// 170 +Ответ: [ 290 290 291 -(% lang="en-US" style="text-align:left" %) 292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 172 +{{{ {}}} 293 293 174 +«id»: «», //ID типа датчика «name»: «», //Название 294 294 295 -(% class="box warningmessage" %) 296 -((( 297 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 298 -))) 176 +{{{ "description": "" // Описание 177 + },}}} 299 299 300 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 179 +… ] 180 + 301 301 302 - (%style="color:#000000"%)Методзапроса:**PUT**182 + **Получение информации об объекте** 303 303 304 - (%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}184 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 305 305 306 - (%style="color:#000000" %)Параметр запроса:{id}-Guidпользователя186 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 307 307 308 - (%style="color:#000000"%)Взаголовкахзапроса:X-Auth:Токенавторизации188 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание». 309 309 310 - (% style="color:#000000" %)Параметрыв телезапроса(JSON):190 +Метод запроса: GET 311 311 312 - (%style="color:#000000" %){192 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID> 313 313 314 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 315 - "description": "" , ~/~/ описание 316 - "data": "" , ~/~/ данные, связанные со сменой статуса 194 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 317 317 318 - (% style="color:#000000"%)}196 +В заголовках запроса: X-Auth: Токен авторизации 319 319 320 -(% style="text-align:left" %) 321 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 198 +Ответ: 322 322 200 +{ 323 323 324 -(% class="box errormessage" %) 325 -((( 326 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 327 -))) 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 + ...}}} 328 328 329 - (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).218 +} 330 330 331 -(% style="color:#000000" %)Метод запроса: **DELETE** 220 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется» 221 + 332 332 333 - (%style="color:#000000"%)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}223 + **Добавление пользователя** 334 334 335 - (%style="color:#000000"%)Параметрзапроса:{id}-Guidпользователя225 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 336 336 337 - (% style="color:#000000" %)В заголовкахзапроса:X-Auth: Токен авторизации227 +Метод запроса: POST 338 338 339 -(% style="text-align:left" %) 340 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 229 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 341 341 231 +В заголовках запроса: X-Auth: Токен авторизации 342 342 343 -(% class="box" style="text-align: center;" %) 344 -((( 345 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 346 -))) 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»: [ // группы пользователя «», //названия групп «», «» ] } 347 347 348 -(% class="box infomessage" %) 349 -((( 350 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 351 -))) 235 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 236 + 352 352 353 - (%style="color:#000000"%)Методпозволяет получить всю информацию изкарточкиобъекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, названиеклиента, ID модели, наименование модели объекта, IDподразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусовсо всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».238 + **Редактирование пользователя** 354 354 355 - (% style="color:#000000" %)Методвозвращаетинформациюобобъектес учетомнастроек авторизованногопользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации**«X-Auth»**):240 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 356 356 357 - (% style="color:#000000" %)− возвращается информация об объекте клиента-родителяавторизованногопользователяи объекте его дочерних клиентов;242 +Метод запроса: PUT 358 358 359 - (%style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.244 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 360 360 361 - (%style="color:#000000" %)Методзапроса:**GET**246 +В заголовках запроса: X-Auth: Токен авторизации 362 362 363 -( %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>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 - блокирован) 364 364 365 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 250 +{{{ "description": "", // описание 251 + "data": "" // данные, связанные со сменой статуса}}} 366 366 367 - (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации253 +} 368 368 369 -(% style="color:#000000" %)Ответ: 255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 256 + 370 370 371 - (%style="color:#000000"%){258 + **Удаление пользователя** 372 372 373 - "vehicleId": "" , ~/~/ идентификатор объекта 374 - "name": "" , ~/~/ имя объекта 375 - "imei": "" , ~/~/ IMEI объекта 376 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 377 - "deviceTypeName": "" , ~/~/ наименование устройства объекта 378 - "parentId": "" , ~/~/ идентификатор клиента-родителя 379 - "parentName": "" , ~/~/ наименование клиента-родителя, 380 - "modelId": "" , ~/~/ идентификатор модели объекта 381 - "modelName": "" , ~/~/ наименование модели объекта, 382 - "unitId": "" , ~/~/ идентификатор подразделения 383 - "unitName": "" , ~/~/ наименование подразделения 384 - "status": "" , ~/~/ статус объекта 260 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 385 385 386 - }262 +Метод запроса: DELETE 387 387 388 -(% style="text-align:left" %) 389 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 264 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id} 390 390 391 -(% style="text-align:left" %) 392 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 266 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 393 393 268 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 269 + 394 394 395 -(% class="box successmessage" %) 396 -((( 397 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 398 -))) 271 + **Добавление объекта** 399 399 400 - (% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации**«X-Auth»**,//Content-Type//:**application/json**;//charset//=**utf-8**).273 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8) 401 401 402 - (% style="color:#000000" %)Метод запроса:**POST**275 +Метод запроса: POST 403 403 404 - (% style="color:#000000" %)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]277 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 405 405 406 - (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации279 +В заголовках запроса: X-Auth: Токен авторизации 407 407 408 - (% style="color:#000000" %)Параметры в теле запроса (JSON):281 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 409 409 410 -(% style="color:#000000" %){ 411 - 412 - "parentId": "" , ~/~/ ID клиента 413 - "name": "" , ~/~/ имя ТС 414 - "imei": "" , ~/~/ IMEI 415 - "deviceTypeId": "" , ~/~/ ID типа устройства 416 - "modelId": "" , ~/~/ ID модели 417 - "unitId": "" , ~/~/ ID подразделения 418 - "sim1": "" , ~/~/ Номер SIM 1 419 - "sim2": "" , ~/~/ Номер SIM2 420 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 421 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 422 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 423 - "counters": { 424 - "mileage": "" , ~/~/ пробег 425 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 426 - "motohours": "" , ~/~/ моточасы 427 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 428 - }, 429 - "cmsv6Parameters": { ~/~/ параметры CMSv6 430 - "enabled": true, ~/~/ флаг включения 431 - "id": "" , ~/~/ идентификатор 432 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 433 - "login": "" , ~/~/ имя учетной записи 434 - "password": "" ~/~/ пароль учетной записи 435 - }, 436 - "inspectionTasks": ~/~/ задания на ТО 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": "" // пароль учетной записи 306 + }, 307 + "inspectionTasks": [ // задания на ТО 437 437 { 438 - "enabled": "" , ~/~/ Признак включения 439 - "name": "" , ~/~/ Имя задания 440 - "description": "" , ~/~/ Описание задания 441 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 442 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 443 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 444 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 445 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 446 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 447 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 448 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 449 - } 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 + ]}}} 450 450 451 - (%style="color:#000000" %)}323 +… } 452 452 453 - (% style="color:#000000" %)Ответ:325 +Ответ: 454 454 455 - (% style="color:#000000" %){327 +{ 456 456 457 - ~/~/ID ТС458 - ~/~/Guid владельца ТС459 - ~/~/Имя объекта460 - ~/~/IMEI461 - ~/~/ID типа устройства462 - ~/~/ID модели463 - ~/~/ID подразделения464 - ~/~/SIM1465 - ~/~/SIM2466 - ~/~/Расход топлива на 100 км467 - ~/~/Расход топлива на холостом ходу468 - "counters": { ~/~/Счётчики469 - "mileageEnabled": true, 470 - "motohoursEnabled": true, 471 - "mileage": "", 472 - "motohours": 345.0 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 473 473 }, 474 - "cmsv6Parameters": { ~/~/Параметры CmsV6475 - "id": null, 476 - "enabled": true, ~/~/флаг включения477 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6478 - "login": "", ~/~/ имя учетной записи479 - "password": "" ~/~/ пароль учетной записи346 + "cmsv6Parameters": { //Параметры CmsV6 347 + "id": null, 348 + "enabled": true, //флаг включения 349 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 350 + "login": "", // имя учетной записи 351 + "password": "" // пароль учетной записи 480 480 }, 481 - "inspectionTasks": { ~/~/ задания на ТО 482 - "id": "", ~/~/ ID задачи 483 - "enabled": false, ~/~/ Признак включения 484 - "name": "", ~/~/ Имя задания 485 - "description": "", ~/~/ Описание задания 486 - "mileageCondition": "", ~/~/ Условие по пробегу 487 - "lastMileage": "", ~/~/ Пробег (в метрах) 488 - "motohoursCondition": "", ~/~/ Условие по моточасам 489 - "lastMotohours": "", ~/~/ Моточасы 490 - "periodicCondition": "", ~/~/ Условие периодичности по времени 491 - "kind": "", ~/~/ Вид периодичности по времени 492 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 493 - } 353 + "inspectionTasks": [ // задания на ТО 354 + { 355 + "id": "", // ID задачи 356 + "enabled": false, // Признак включения 357 + "name": "", // Имя задания 358 + "description": "", // Описание задания 359 + "mileageCondition": "", // Условие по пробегу 360 + "lastMileage": "", // Пробег (в метрах) 361 + "motohoursCondition": "", // Условие по моточасам 362 + "lastMotohours": "", // Моточасы 363 + "periodicCondition": "", // Условие периодичности по времени}}} 494 494 495 -(% style="text-align:left" %) 496 -(% style="color:#000000" %)} 365 +{{{ "kind": "", // Вид периодичности по времени 366 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 367 + } 368 + ]}}} 497 497 370 +} 371 + 498 498 499 -(% class="box successmessage" %) 500 -((( 501 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** 502 -))) 373 + **Удаление объекта** 503 503 504 - (% style="color:#000000" %)Метод позволяетполучить основные параметры объектов:наименование,IMEI, типустройства, модель объекта,подразделение,номера телефонови идентификаторклиента,ккоторомуприкрепленобъект (клиент-родитель).375 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 505 505 506 - (% style="color:#000000" %)Методвозвращает информацию об объектах с учетом настроек авторизованногопользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):377 +Метод запроса: DELETE 507 507 508 - (%style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;379 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId} 509 509 510 - (% style="color:#000000" %)− возвращаетинформациюоб объектахсучетомзаданныхнастроек видимости объектов;381 +Параметр запроса: {id} - Guid объекта 511 511 512 - (%style="color:#000000" %)− информация предоставляется с учетом наличия правна просмотр объектов заблокированныхдоговоров (объекты, принадлежащиезаблокированному договору возвращаются при наличиилюбогоиз прав «Видимость объектов заблокированныхдоговоров в панели управления» или «Видимостьобъектовзаблокированных договоров в мониторинге»;383 +В заголовках запроса: X-Auth: Токен авторизации 513 513 514 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 385 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 386 + 515 515 516 - (%style="color:#000000"%)−информацияостатусеобъекта предоставляется при наличииправа «Просмотр статуса объекта».388 + **Редактирование объекта** 517 517 518 - (%style="color:#000000"%)Метод запроса:**POST**390 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 519 519 520 - (%style="color:#000000" %)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]392 +Метод запроса: PUT 521 521 522 - (%style="color:#000000" %)В заголовках запроса:394 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 523 523 524 - (%style="color:#000000"%)− Content-Type:application/json396 +В заголовках запроса: X-Auth: Токен авторизации 525 525 526 - (%style="color:#000000"%)− X-Auth: Токенавторизации398 +Параметры в теле запроса (JSON): 527 527 528 - (%style="color:#000000"%)Условияфильтрации объектовзадаются в теле запроса.Параметры втелезапроса(JSON):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»: «» //Сколько раз выполнить задание } ] } 529 529 530 - (% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##402 +Ответ: 531 531 532 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 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 + 533 533 534 - (%class="western"style="color:#000000"%)##~/~/IDтипаустройства(short,опционально) "parentId": null, ~/~/ ID клиента(Guid, опционально) "unitId": null##407 + **Изменение статуса объекта** 535 535 536 - (%class="western"style="color:#000000"%)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed"~/~/IDподразделения(Guid, опционально)##(%style="color:#000000"%)}409 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 537 537 538 - (% style="color:#000000" %) Фильтрация осуществляется поточному совпадениюзначенийпараметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрацияпо значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».411 +Метод запроса: POST 539 539 540 - (% style="color:#000000" %)Ответ:[{ «vehicleId»:«»,//идентификатор объекта «name»: «»,// наименование объекта «imei»: «»,// IMEI объекта «deviceTypeId»: «»,// идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «»,// первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «»,//наименование клиента-родителя «modelId»:«»,//идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «»,//идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «»,// статус объекта //«//createdAt//»: «» дата создания объектов //}, … ]413 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId} 541 541 542 - (% style="color:#000000" %)Параметры«sim1» и «sim2» содержатся в ответе при наличии у авторизованногопользователя права **«Просмотр номеров телефонов объектов»**. Параметр«status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержитidстатусаобъектав системе, соответствие id и текстовое названия статуса приведены ниже:415 +Параметр запроса: {vehicleId} - ID ТС 543 543 544 - 0- «Блокировка»1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика»,5-«Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен»,10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».417 +В заголовках запроса: X-Auth: Токен авторизации 545 545 419 +Параметры в теле запроса (JSON): { 546 546 547 -(% class="box successmessage" %) 548 -((( 549 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 550 -))) 551 - 552 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 553 - 554 -(% style="color:#000000" %)Метод запроса: **POST** 555 - 556 -(% 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} 557 - 558 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 559 - 560 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 561 - 562 -(% style="color:#000000" %)Параметры в теле запроса (JSON): { 563 - 564 -(% class="western" %) 565 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 566 - // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 567 - // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 421 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 568 568 "date": "", // Дата смены статуса (null если сменить немедленно) 569 569 "description": "", // Описание 570 570 "data": "", // Данные ... ... @@ -571,11 +571,10 @@ 571 571 "overwrite": false, // Флаг перезаписи 572 572 "stage": "", // Состояние, может быть null}}} 573 573 574 - (% style="color:#000000" %)}428 +} 575 575 576 - (% style="color:#000000" %)Ответ: {430 +Ответ: { 577 577 578 -(% class="western" %) 579 579 {{{ "status": "", // значение статуса 580 580 "date": "", // Дата смены статуса 581 581 "description": "", // Описание ... ... @@ -583,116 +583,19 @@ 583 583 "overwrite": false, // Флаг перезаписи 584 584 "stage": "", // Состояние}}} 585 585 586 - (% style="text-align:left" %)587 - (%style="color:#000000" %)}439 +} 440 + 588 588 442 + **Проверка авторизации** 589 589 590 -(% class="box warningmessage" %) 591 -((( 592 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 593 -))) 444 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth» 594 594 595 - (% style="color:#000000" %)Методпозволяет отредактировать объект. Методпозволяет отредактировать объект, указанный в запросе (обязательныйпараметр в заголовках запроса - токен авторизации **«X-Auth»**).446 +Метод запроса: GET 596 596 597 - (%style="color:#000000" %)Метод запроса: **PUT**448 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]] 598 598 599 - (%style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]450 +В заголовках запроса: X-Auth: Токен авторизации 600 600 601 - (% style="color:#000000"%)Взаголовкахзапроса:X-Auth:Токенавторизации452 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401» 602 602 603 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 604 - 605 -(% 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»: «» //Сколько раз выполнить задание } ] } 606 - 607 -(% style="color:#000000" %)Ответ: 608 - 609 -(% lang="en-US" style="text-align:left" %) 610 -(% 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»: «» //Сколько раз выполнить задание } ] } 611 - 612 - 613 -(% class="box errormessage" %) 614 -((( 615 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 616 -))) 617 - 618 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 619 - 620 -(% style="color:#000000" %)Метод запроса: **DELETE** 621 - 622 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 623 - 624 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 625 - 626 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 627 - 628 -(% style="text-align:left" %) 629 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 630 - 631 - 632 -(% class="box" lang="en-US" style="text-align: center;" %) 633 -((( 634 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 635 -))) 636 - 637 -(% class="box infomessage" %) 638 -((( 639 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 640 -))) 641 - 642 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 643 - 644 -(% style="color:#000000" %)Метод запроса: **GET** 645 - 646 -(% 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]] 647 - 648 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 649 - 650 -(% style="color:#000000" %)Ответ: [ 651 - 652 -(% class="western" %) 653 -{{{ { 654 - "deviceTypeId" : "", // ID типа устройства 655 - "deviceTypeName" : "" // Название типа устройства 656 - },}}} 657 - 658 -(% style="text-align:left" %) 659 -(% style="color:#000000" %)…** **] 660 - 661 - 662 -(% class="box" style="text-align: center;" %) 663 -((( 664 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 665 -))) 666 - 667 -(% class="box infomessage" %) 668 -((( 669 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 670 -))) 671 - 672 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 673 - 674 -(% style="color:#000000" %)Метод запроса: **GET** 675 - 676 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 677 - 678 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 679 - 680 -(% style="color:#000000" %)Ответ: [ 681 - 682 -(% class="western" style="margin-bottom:19px" %) 683 -{{{ {}}} 684 - 685 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 686 - 687 -(% class="western" %) 688 -{{{ "description": "" // Описание 689 - },}}} 690 - 691 -(% style="text-align:left" %) 692 -(% style="color:#000000" %)… ] 693 - 694 - 695 -(% class="box" lang="en-US" style="text-align: center;" %) 696 -((( 697 -(% 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]] ** 698 -))) 454 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**