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