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