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