Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,25 +1,26 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -= Описание ГЛОНАССSoft Public API 3.0 = 2 +((( 3 +**Содержание страницы:** 4 +))) 3 3 4 - 5 5 {{toc/}} 6 6 7 7 8 8 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 9 9 10 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 11 12 12 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 13 13 14 14 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 15 15 16 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 17 17 18 18 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 19 19 20 20 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 21 21 22 -(% class="box infomessage" %)23 +(% class="box successmessage" %) 23 23 ((( 24 24 (% lang="en-US" %)**POST /api/v3/auth/login** 25 25 ))) ... ... @@ -30,7 +30,7 @@ 30 30 31 31 (% 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" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 34 35 35 (% style="color:#000000" %)Параметры в теле запроса (JSON): 36 36 ... ... @@ -37,9 +37,8 @@ 37 37 (% style="color:#000000" %){ 38 38 "login": "testuser", 39 39 "password": "testuser" 40 -} (%%)41 +} 41 41 42 - 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) ... ... @@ -54,6 +54,15 @@ 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 56 56 57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 + 63 +(% class="wikigeneratedid" %) 64 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 65 + 57 57 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 58 58 59 59 (% class="box infomessage" %) ... ... @@ -61,7 +61,7 @@ 61 61 (% lang="en-US" %)**GET /api/v3/auth/check** 62 62 ))) 63 63 64 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).73 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 65 65 66 66 (% style="color:#000000" %)Метод запроса: **GET** 67 67 ... ... @@ -74,49 +74,122 @@ 74 74 75 75 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 76 76 77 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметровклиента**(%%) ==86 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 78 78 79 79 (% class="box infomessage" %) 80 80 ((( 81 - (% lang="en-US" %)**GET**(%%)**/(% lang="en-US" %)api/v3/agents(%%)**90 +**GET api/v3/agents/{id}** 82 82 ))) 83 83 84 - (% style="color:#000000" %)Метод позволяет получитьосновныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя.Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):93 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 85 85 95 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 96 + 97 +(% style="color:#000000" %)Метод запроса: **GET** 98 + 99 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 100 + 101 +Запрос должен содержать данные параметра "**agentId**" 102 + 103 +(% style="color:#000000" %)Ответ: 104 +{ 105 + "agentId": "", (%%) 106 + "parentId": "", 107 + "parentName": "string", 108 + "name": "string", 109 + "fullName": "string", 110 + "agentInfoType": 0, 111 + "isForeign": true/false, 112 + "district": "string", 113 + "region": "string", 114 + "city": "string", 115 + "inn": "string", 116 + "kpp": "string", 117 + "address": "string", 118 + "addressFact": "string", 119 + "email": "string", 120 + "director": "string", 121 + "bankName": "string", 122 + "bankBIK": "string", 123 + "bankRS": "string", 124 + "bankKS": "string" 125 + } 126 + 127 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 128 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 129 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 130 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 131 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 132 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 133 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 134 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 135 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 136 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 137 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 138 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 139 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 140 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 141 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 142 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 143 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 144 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 145 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 146 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 147 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 148 + 149 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 150 + 151 +(% class="box infomessage" %) 152 +((( 153 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 154 +))) 155 + 156 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 157 + 86 86 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 87 87 88 88 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 89 89 90 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».162 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 91 91 92 -(% style="color:#000000" %)Метод запроса: ** GET**164 +(% style="color:#000000" %)Метод запроса: **POST** 93 93 94 -(% 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>166 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 95 95 96 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)168 +(% style="color:#000000" %)Параметр запроса: 97 97 98 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 170 +(% style="color:#000000" %){ 171 + "parentId": "string" 172 +} 99 99 100 100 (% style="color:#000000" %)Ответ: 101 101 102 - (% style="color:#000000" %){103 - "agentId": ~/~/идентификатор клиента104 - "parentId": ~/~/ идентификатор клиента-родителя105 - "name": ~/~/ наименование клиента106 - "fullName": ~/~/ полное наименование клиента107 - "agentInfoType": "",~/~/ тип клиента (0- Клиент,1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)108 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)176 +{ 177 + "agentId": "",(% style="color:#000000" %) (%%) 178 + "parentId": "", 179 + "name": "string", 180 + "fullName": "string", 181 + "agentInfoType": 0, 182 +(% style="color:#000000" %) "status": "", 109 109 } 110 110 111 111 112 -== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) == 186 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 187 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 188 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 189 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 190 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 191 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 192 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 113 113 194 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 195 + 114 114 (% class="box successmessage" %) 115 115 ((( 116 116 **POST /api/v3/agents ** 117 117 ))) 118 118 119 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).201 +Метод позволяет добавить клиента, указанного в запросе. 120 120 121 121 Метод запроса: **POST** 122 122 ... ... @@ -127,9 +127,10 @@ 127 127 Параметры в теле запроса (JSON): 128 128 129 129 { 130 - 212 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 131 131 "name": "string", ~/~/ имя 132 132 "fullName": "string", ~/~/ полное наименование 215 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 133 133 "isForeign": true, ~/~/ иностранный контрагент 134 134 "district": "string", ~/~/ округ 135 135 "region": "string", ~/~/ регион ... ... @@ -154,6 +154,7 @@ 154 154 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 155 155 "name": "string", ~/~/ имя 156 156 "fullName": "string", ~/~/ полное наименование 240 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 157 157 "isForeign": true, ~/~/ иностранный контрагент 158 158 "district": "string", ~/~/ округ 159 159 "region": "string", ~/~/ регион ... ... @@ -170,8 +170,29 @@ 170 170 "bankKS": "string" ~/~/ корр. счёт 171 171 } 172 172 257 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 258 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 259 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 260 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 261 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 262 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 263 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 264 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 265 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 266 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 267 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 268 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 269 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 270 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 271 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 272 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 273 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 274 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 275 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 276 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 277 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 173 173 174 -== (% style="color:#000000 ,font-size:14px" %)**Редактирование клиента**(%%) ==279 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 175 175 176 176 (% class="box warningmessage" %) 177 177 ((( ... ... @@ -178,7 +178,7 @@ 178 178 **PUT /api/v3/agents** 179 179 ))) 180 180 181 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).286 +Метод позволяет отредактировать клиента, указанного в запросе. 182 182 183 183 Метод запроса: **PUT** 184 184 ... ... @@ -186,7 +186,6 @@ 186 186 187 187 В заголовках запроса: X-Auth: Токен авторизации 188 188 189 - 190 190 Параметры в теле запроса (JSON): 191 191 192 192 { ... ... @@ -194,6 +194,7 @@ 194 194 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 195 195 "name": "string", ~/~/ имя 196 196 "fullName": "string", ~/~/ полное наименование 301 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 197 197 "isForeign": true, ~/~/ иностранный контрагент 198 198 "district": "string", ~/~/ округ 199 199 "region": "string", ~/~/ регион ... ... @@ -210,7 +210,6 @@ 210 210 "bankKS": "string" ~/~/ корр. счёт 211 211 } 212 212 213 - 214 214 Ответ: 215 215 216 216 { ... ... @@ -234,15 +234,14 @@ 234 234 "bankKS": "string" ~/~/ корр. счёт 235 235 } 236 236 341 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 237 237 238 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) == 239 - 240 240 (% class="box errormessage" %) 241 241 ((( 242 242 **DELETE /api/v3/agents/{clientId}** 243 243 ))) 244 244 245 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).348 +Метод позволяет удалить клиента, указанного в строке запроса. 246 246 247 247 Метод запроса: **DELETE** 248 248 ... ... @@ -254,18 +254,31 @@ 254 254 255 255 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 256 256 360 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 257 257 258 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 362 +(% class="box warningmessage" %) 363 +((( 364 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 365 +))) 259 259 367 +Метод позволяет изменить статус клиента, указанного в запросе. 260 260 261 - ==(%style="color:#000000; line-height:14px" %)**Добавлениепользователя**(%%)==369 +В пути указывается GUID клиента и статус клиента. 262 262 371 +**status **- значение 0 - заблокирован, 1 - активен. 372 + 373 +Ответ: Code 204 374 + 375 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 376 + 377 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 378 + 263 263 (% class="box successmessage" %) 264 264 ((( 265 265 (% lang="en-US" %)**POST /api/v3/users** 266 266 ))) 267 267 268 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).384 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 269 269 270 270 (% style="color:#000000" %)Метод запроса: **POST** 271 271 ... ... @@ -275,7 +275,8 @@ 275 275 276 276 (% style="color:#000000" %)Параметры в теле запроса (JSON): 277 277 278 -(% style="color:#000000" %){ 394 +(% style="color:#000000" %) 395 +{ 279 279 "lastName": "", ~/~/ фамилия 280 280 "firstName": "", ~/~/ имя 281 281 "position": "", ~/~/ должность ... ... @@ -284,17 +284,40 @@ 284 284 "login": "", ~/~/ логин (обязателен) 285 285 "password": "", ~/~/ пароль (обязателен) 286 286 "email": "", ~/~/ email (обязателен) 287 - "description": "", ~/~/ описание 288 - "isEnabled": "", ~/~/ признак включения 404 + "description": "string", ~/~/ Описание 405 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 406 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 407 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 289 289 "parentId": "", ~/~/ Guid родительского агента 290 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 291 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 293 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 294 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 295 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 409 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 410 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 411 + "doubleAuth": 412 + { 413 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 414 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 415 + }, 416 + "groups": 417 + [ 418 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 419 + ], 420 + "customGroups": 421 + [ 422 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 423 + ], 424 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 296 296 } 297 297 427 +{ 428 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 429 + "lastName": "string", 430 + "firstName": "string", 431 + "position": "string", 432 + "phone": "string", 433 + "organization": "string", 434 + "login": "string", 435 + "password": "string", 436 + "email": "string", 437 + 298 298 (% style="text-align:left" %) 299 299 (% style="color:#000000; font-weight:normal" %)Ответ: 300 300 ... ... @@ -324,9 +324,9 @@ 324 324 (% style="color:#000000; font-weight:normal" %)} 325 325 326 326 327 -== (% style="color:#000000; font-size:1 4px" %)**Получение списка пользователей**(%%) ==467 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 328 328 329 -(% class="box successmessage" %)469 +(% class="box infomessage" %) 330 330 ((( 331 331 (% lang="en-US" %)**POST /api/v3/users/find** 332 332 ))) ... ... @@ -368,14 +368,13 @@ 368 368 "email": "" , ~/~/ E-mail 369 369 "sessionDuration":"", ~/~/ длительность сессии в минутах 370 370 "status": "1", ~/~/ статус пользователя 371 - "astLogged": "", ~/~/ дата/время последней авторизации 511 + "lastLogged": "", ~/~/ дата/время последней авторизации 372 372 373 373 (% style="color:#000000" %)} 374 374 515 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 375 375 376 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) == 377 - 378 -(% class="box successmessage" %) 517 +(% class="box infomessage" %) 379 379 ((( 380 380 (% lang="en-US" %)**GET /api/v3/users/{GUID}** 381 381 ))) ... ... @@ -407,8 +407,11 @@ 407 407 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 408 408 "description": "", ~/~/ Описание 409 409 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 410 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 411 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 549 + "doubleAuth": 550 + { 551 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 552 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 553 + }, 412 412 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 413 413 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 414 414 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован ... ... @@ -422,15 +422,14 @@ 422 422 ))) 423 423 ))) 424 424 567 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 425 425 426 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) == 427 - 428 428 (% class="box warningmessage" %) 429 429 ((( 430 430 (% lang="en-US" %)**PUT /api/v3/users** 431 431 ))) 432 432 433 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).574 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 434 434 435 435 (% style="color:#000000" %)Метод запроса: **PUT** 436 436 ... ... @@ -452,7 +452,9 @@ 452 452 "phone": "" , ~/~/ телефон 453 453 "organization": "" , ~/~/ организация 454 454 "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 455 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 596 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 597 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 598 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 456 456 "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 457 457 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 458 458 "isEnabled": "" , ~/~/ признак включения ... ... @@ -459,9 +459,12 @@ 459 459 "parentId": "" , ~/~/ Guid родительского агента 460 460 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 461 461 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 462 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 463 - "kind": "" , ~/~/ тип аутентификации 464 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 605 + "doubleAuth": 606 + { 607 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 608 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 609 + }, 610 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 465 465 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 466 466 467 467 (% lang="en-US" style="text-align:left" %) ... ... @@ -487,8 +487,12 @@ 487 487 "isEnabled": "" , ~/~/ признак включения 488 488 "parentId": "" , ~/~/ Guid родительского агента 489 489 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 490 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 491 - "kind": "" , ~/~/ тип аутентификации 636 + "doubleAuth": 637 + { 638 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 639 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 640 + }, 641 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 492 492 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 493 493 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 494 494 ... ... @@ -495,15 +495,14 @@ 495 495 (% lang="en-US" style="text-align:left" %) 496 496 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 497 497 648 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 498 498 499 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) == 500 - 501 501 (% class="box warningmessage" %) 502 502 ((( 503 503 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 504 504 ))) 505 505 506 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).655 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 507 507 508 508 (% style="color:#000000" %)Метод запроса: **PUT** 509 509 ... ... @@ -526,15 +526,14 @@ 526 526 (% style="text-align:left" %) 527 527 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 528 528 678 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 529 529 530 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) == 531 - 532 532 (% class="box warningmessage" %) 533 533 ((( 534 534 **POST /api/v3/users/disable** 535 535 ))) 536 536 537 -Метода позволяет выполнить массовую блокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).685 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 538 538 539 539 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 540 540 ... ... @@ -549,15 +549,14 @@ 549 549 550 550 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 551 551 700 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 552 552 553 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) == 554 - 555 555 (% class="box warningmessage" %) 556 556 ((( 557 557 **POST /api/v3/users/enable** 558 558 ))) 559 559 560 -Метода позволяет выполнить массовую разблокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).707 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 561 561 562 562 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 563 563 ... ... @@ -585,17 +585,16 @@ 585 585 } 586 586 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 587 587 "users" - массив id пользователей, которых не удалось включить или отключить. 588 - 589 - 590 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) == 591 591 ))) 592 592 737 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 738 + 593 593 (% class="box errormessage" %) 594 594 ((( 595 595 (% lang="en-US" %)**DELETE /api/v3/users/{id}** 596 596 ))) 597 597 598 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).744 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 599 599 600 600 (% style="color:#000000" %)Метод запроса: **DELETE** 601 601 ... ... @@ -608,12 +608,253 @@ 608 608 (% style="text-align:left" %) 609 609 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 610 610 757 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 611 611 612 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел:**Транспортныесредства**(%%) =759 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 613 613 761 +(% class="box infomessage" %) 762 +((( 763 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 764 +))) 614 614 615 - ==(%style="color:#000000; font-size:14px" %)**Получениеинформацииобобъекте**(%%) ==766 +Метод возвращает полную информацию о модели объекта. 616 616 768 +(% style="color:#000000" %)Метод запроса: **GET** 769 + 770 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 771 + 772 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 773 + 774 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 775 + 776 +(% style="color:#000000" %)Ответ: 777 + 778 +(% style="color:#000000" %){ 779 + "parentName": "string", 780 + "name": "string", 781 + "picture": "string", 782 + "minspeed": 0, 783 + "maxspeed": 0, 784 + "width": 0, 785 + "imbeddedtrailer": true, 786 + "hoppercapacity": 0, 787 + "hopperdischargespeed": 0, 788 + "modelType": 0, 789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 790 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 791 + "deleted": true 792 +} 793 + 794 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 795 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 796 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 797 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 798 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 799 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 800 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 801 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 802 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 803 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 804 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 805 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 806 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 807 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 808 + 809 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 810 + 811 +(% class="box successmessage" %) 812 +((( 813 +(% lang="en-US" %)**POST /api/v3/models/find** 814 +))) 815 + 816 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 817 + 818 +(% style="color:#000000" %)Метод запроса: **POST** 819 + 820 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 821 + 822 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 823 + 824 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 825 + 826 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 827 +} 828 + 829 +(% style="color:#000000" %)Ответ: 830 + 831 +(% style="color:#000000" %)[ 832 + { 833 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 834 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 835 + "parentName": "string", 836 + "name": "string", 837 + "modelType": 0 838 + } 839 +] 840 + 841 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 842 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 843 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 844 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 845 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 846 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 847 + 848 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 849 + 850 +(% class="box successmessage" %) 851 +((( 852 +(% lang="en-US" %)**POST /api/v3/models** 853 +))) 854 + 855 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 856 + 857 +(% style="color:#000000" %)Метод запроса: **POST** 858 + 859 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 860 + 861 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 862 + 863 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 864 + 865 +{ 866 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 867 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 868 + "deleted": true, 869 + "extId": "string", 870 + "name": "string", 871 + "picture": "string", 872 + "minspeed": 0, 873 + "maxspeed": 0, 874 + "width": 0, 875 + "imbeddedtrailer": true, 876 + "fueloutlay": 0, 877 + "hoppercapacity": 0, 878 + "hopperdischargespeed": 0, 879 + "modelType": 0 880 +} 881 + 882 +Ответ: 883 + 884 +{ 885 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 886 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 887 + "deleted": true, 888 + "extId": "string", 889 + "name": "string", 890 + "picture": "string", 891 + "minspeed": 0, 892 + "maxspeed": 0, 893 + "width": 0, 894 + "imbeddedtrailer": true, 895 + "hoppercapacity": 0, 896 + "hopperdischargespeed": 0, 897 + "modelType": 0 898 +} 899 + 900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 901 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 902 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 903 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 904 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 905 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 906 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 907 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 908 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 909 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 910 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 911 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 912 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 913 + 914 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 915 + 916 +(% class="box warningmessage" %) 917 +((( 918 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 919 +))) 920 + 921 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 922 + 923 +(% style="color:#000000" %)Метод запроса: **PUT** 924 + 925 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 926 + 927 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 928 + 929 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 930 + 931 +{ 932 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 933 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 934 + "deleted": true, 935 + "extId": "string", 936 + "name": "string", 937 + "picture": "string", 938 + "minspeed": 0, 939 + "maxspeed": 0, 940 + "width": 0, 941 + "imbeddedtrailer": true, 942 + "fueloutlay": 0, 943 + "hoppercapacity": 0, 944 + "hopperdischargespeed": 0, 945 + "modelType": 0 946 +} 947 + 948 +Ответ: 949 + 950 +{ 951 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 952 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 953 + "deleted": true, 954 + "extId": "string", 955 + "name": "string", 956 + "picture": "string", 957 + "minspeed": 0, 958 + "maxspeed": 0, 959 + "width": 0, 960 + "imbeddedtrailer": true, 961 + "fueloutlay": 0, 962 + "hoppercapacity": 0, 963 + "hopperdischargespeed": 0, 964 + "modelType": 0 965 +} 966 + 967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 968 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 969 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 970 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 971 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 972 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 973 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 974 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 975 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 976 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 977 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 978 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 979 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 980 + 981 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 982 + 983 +(% class="box errormessage" %) 984 +((( 985 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 986 +))) 987 + 988 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 989 + 990 +(% style="color:#000000" %)Метод запроса: **DELETE** 991 + 992 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 993 + 994 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 995 + 996 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 997 + 998 +Ответ: В случае успеха **Success 200** 999 + 1000 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 1001 + 1002 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 1003 + 617 617 (% class="box infomessage" %) 618 618 ((( 619 619 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -621,7 +621,7 @@ 621 621 622 622 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 623 623 624 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):1011 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 625 625 626 626 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 627 627 ... ... @@ -629,9 +629,9 @@ 629 629 630 630 (% style="color:#000000" %)Метод запроса: **GET** 631 631 632 -(% 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>1019 +(% 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} 633 633 634 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__>- идентификатор объекта (опционально)1021 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 635 635 636 636 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 637 637 ... ... @@ -645,18 +645,148 @@ 645 645 "deviceTypeId": , ~/~/ ID типа устройства 646 646 "deviceTypeName": "", ~/~/ Название типа устройства 647 647 "sim1": "", ~/~/ Номер SIM1 648 - "parentId": "", Номер SIM2 649 - "parentName": "", Наименование клиента-родителя 650 - "modelId": "", ID модели объекта 651 - "modelName": "", Имя модели объекта 652 - "createdAt": "", Дата создания объекта 653 - "mileageCalcMethod": "", Выбранный метод расчета пробега 654 - "counters": { ~/~/ Нормы 655 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 656 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 657 - "mileage": "", ~/~/ Пробег по нормам в метрах 658 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 1035 + "sim2": "", ~/~/ Номер SIM2 1036 + 1037 + "parentId": "", ~/~/ ID клиента-родителя 1038 + "parentName": "", ~/~/ Наименование клиента-родителя 1039 + "modelId": "", ~/~/ ID модели объекта 1040 + "modelName": "", ~/~/ Имя модели объекта 1041 + 1042 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1043 + "unitName": "string", ~/~/ Наименование подразделения 1044 + "status": 0, ~/~/ Статус объекта 1045 + 1046 + "createdAt": "", ~/~/ Дата создания объекта 659 659 }, 1048 + 1049 +"customFields": [ ~/~/ Произвольные поля 1050 + { 1051 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1052 + "name": "string", ~/~/ Имя поля 1053 + "value": "string", ~/~/ Значение поля 1054 + "forClient": true, ~/~/ Не используемая функция 1055 + "forTooltip": true, ~/~/ Отображать в подсказке 1056 + "forReport": true ~/~/ Отображать в отчете 1057 + } 1058 + 1059 +], ~/~/ Данные с вкладки нормы 1060 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1061 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1062 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1063 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1064 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1065 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1066 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1067 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1068 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1069 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1070 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1071 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1072 + 1073 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1074 + "mileageCoeff": 0, ~/~/ коэффициент пробега 1075 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1076 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1077 + "counters": { ~/~/ Счетчики 1078 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1079 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1080 + "mileage": 0, ~/~/ Текущий пробег 1081 + "motohours": 0, ~/~/ Текущие моточасы 1082 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1083 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 1084 + }, 1085 + 1086 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1087 + "id": "string", ~/~/ ID объекта 1088 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 1089 + "host": "string", ~/~/ CMSV6 Web Host 1090 + "login": "string", ~/~/ CMSV6 Account 1091 + "password": "string" ~/~/ CMSV6 Password 1092 + }, 1093 + 1094 +"commandTemplates": [ ~/~/ Шаблоны команд 1095 + { 1096 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1097 + "name": "string", ~/~/ Наименование команды 1098 + "command": "string", ~/~/ Текст команды 1099 + "retries": 0 ~/~/ Количество попыток 1100 + } 1101 + ], 1102 + 1103 + "sensors": [ ~/~/ Датчики 1104 + { 1105 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1106 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1107 + "type": 0, ~/~/ Тип датчика 1108 + "name": "string", ~/~/ Имя датчика 1109 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1110 + "inputNumber": 0, ~/~/ Номер входа 1111 + "pseudonym": "string", ~/~/ Псевдоним 1112 + "medianDegree": 0, ~/~/ Медианная фильтрация 1113 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1114 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1115 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1116 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1117 + { 1118 + "grades": [ ~/~/ Таблица тарировки 1 1119 + { 1120 + "input": 0, ~/~/ Входящее значение 1121 + "output": 0 ~/~/ Выходящее значение 1122 + } 1123 + ], 1124 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1125 + } 1126 + ], 1127 + "showInTooltip": true, ~/~/ Отображать в подсказке 1128 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1129 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1130 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1131 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1132 + "expr": "string", ~/~/ Формула 1133 + "children": [ ~/~/ массив дочерних датчиков 1134 + "string" 1135 + ], 1136 + "customParams": { ~/~/ прочие произвольные параметры 1137 + "additionalProp1": "string", 1138 + "additionalProp2": "string", 1139 + "additionalProp3": "string" 1140 + }, 1141 + 1142 +~/~/ Характерные для произвольного: 1143 + 1144 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1145 + 1146 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1147 + 1148 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1149 + 1150 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1151 + 1152 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1153 + 1154 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1155 + 1156 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1157 + 1158 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1159 + 1160 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1161 + 1162 +~/~/ "ValueOn": "Вкл.", 1163 + 1164 +~/~/ "ValueOff": "Выкл." 1165 + "summaryMaxValue": 0 ~/~/ Макс. значение 1166 + } 1167 + 1168 + "drivers": [ ~/~/ Водители 1169 + { 1170 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1171 + "name": "string", ~/~/ Наименование 1172 + "description": "string", 1173 + "isDefault": true ~/~/ По умолчанию 1174 + } 1175 + ], 1176 + 660 660 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 661 661 { 662 662 "id": "", ~/~/ ID задания ... ... @@ -672,7 +672,17 @@ 672 672 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 673 673 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 674 674 } 675 - ] 1192 + ], 1193 + 1194 + "statusHistory": [ ~/~/ История статусов 1195 + { 1196 + "status": 0, 1197 + "date": "2023-05-22T09:57:39.562Z", 1198 + "description": "string", 1199 + "additionalInfo": "string" 1200 + } 1201 + ] 1202 + 676 676 } 677 677 ))) 678 678 ... ... @@ -682,15 +682,92 @@ 682 682 (% style="text-align:left" %) 683 683 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 684 684 1212 +===== ===== 685 685 686 -== (%style="color:#000000;font-size:14px"%)**Добавлениеобъекта**(%%)==1214 +== **Получить ответ на отправленную на ТС команду** == 687 687 1216 +(% class="box infomessage" %) 1217 +((( 1218 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1219 +))) 1220 + 1221 +Идентификатор команды: cmdid 1222 + 1223 + 1224 +Запрос от терминала на ответ команды 1225 + 1226 + 1227 +Пример ответ от терминала: 1228 + 1229 + 1230 +ID= "" ~/~/ идентификатор произвольного поля 1231 + 1232 +Soft="" ~/~/ версия софта 1233 + 1234 +GPS=4 ~/~/ тип трекера 1235 + 1236 +Time=11:05:43 28.06.24 ~/~/ время запроса 1237 + 1238 +Lat=45.056221 ~/~/ широта 1239 + 1240 +Lon=39.035938 ~/~/ долгота 1241 + 1242 +Speed=0.0 ~/~/ скорость 1243 + 1244 +Course=181.4 ~/~/направление 1245 + 1246 + 1247 + 1248 +((( 1249 +== **Список отправленных объекту команд с ответами** == 1250 + 1251 +(% class="box infomessage" %) 1252 +((( 1253 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1254 +))) 1255 + 1256 +Идентификатор ТС: vehicleId 1257 + 1258 + 1259 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1260 + 1261 + 1262 +Пример ответа терминала 1263 + 1264 + 1265 +[ 1266 + 1267 +{ 1268 + 1269 +"id": "", ~/~/ идентификатор пользователя 1270 + 1271 +"commandText": "", ~/~/Текст команды. 1272 + 1273 +"templateId": "", ~/~/Идентификатор шаблона 1274 + 1275 +"updated": "", ~/~/ Время отправки 1276 + 1277 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1278 + 1279 +"answer": "", ~/~/ Ответ терминала. 1280 + 1281 +"status": "" ~/~/ Статус отправки 1282 + 1283 +} 1284 + 1285 +] 1286 + 1287 + 1288 +))) 1289 + 1290 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1291 + 688 688 (% class="box successmessage" %) 689 689 ((( 690 690 (% lang="en-US" %)**POST /api/v3/vehicles** 691 691 ))) 692 692 693 -(% style="color:#000000" %)Метод позволяет добавить объект . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).1297 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 694 694 695 695 (% style="color:#000000" %)Метод запроса: **POST** 696 696 ... ... @@ -722,6 +722,11 @@ 722 722 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 723 723 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 724 724 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1329 + 1330 + "mileageCalcMethod": 0, 1331 + "mileageCoeff": 0, 1332 + "locationByCellId": true, 1333 + "dottedLineTrackWhenNoCoords": true, 725 725 "counters": ~/~/ счетчики 726 726 { 727 727 "mileage": "" , ~/~/ пробег ... ... @@ -751,8 +751,98 @@ 751 751 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 752 752 } 753 753 754 -(% style="color:#000000" %) } 1363 +"drivers": [ ~/~/ Водители 1364 + { 1365 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1366 + "isDefault": true 1367 + } 1368 + ], 1369 + "commandTemplates": [ ~/~/ Шаблон команды 1370 + { 1371 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1372 + "name": "string", 1373 + "command": "string", 1374 + "retries": 0 1375 + } 1376 + ], 755 755 1378 + "sensors": [ ~/~/ Датчики 1379 + { 1380 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1381 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1382 + "type": 0, ~/~/ Тип датчика 1383 + "name": "string", ~/~/ Имя датчика 1384 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1385 + "inputNumber": 0, ~/~/ Номер входа 1386 + "pseudonym": "string", ~/~/ Псевдоним 1387 + "medianDegree": 0, ~/~/ Медианная фильтрация 1388 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1389 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1390 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1391 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1392 + { 1393 + "grades": [ ~/~/ Таблица тарировки 1 1394 + { 1395 + "input": 0, ~/~/ Входящее значение 1396 + "output": 0 ~/~/ Выходящее значение 1397 + } 1398 + ], 1399 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1400 + } 1401 + ], 1402 + "showInTooltip": true, ~/~/ Отображать в подсказке 1403 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1404 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1405 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1406 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1407 + "expr": "string", ~/~/ Формула 1408 + "children": [ ~/~/ массив дочерних датчиков 1409 + "string" 1410 + ], 1411 + "customParams": { ~/~/ прочие произвольные параметры 1412 + "additionalProp1": "string", 1413 + "additionalProp2": "string", 1414 + "additionalProp3": "string" 1415 + }, 1416 + 1417 +~/~/ Характерные для произвольного: 1418 + 1419 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1420 + 1421 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1422 + 1423 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1424 + 1425 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1426 + 1427 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1428 + 1429 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1430 + 1431 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1432 + 1433 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1434 + 1435 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1436 + 1437 +~/~/ "ValueOn": "Вкл.", 1438 + 1439 +~/~/ "ValueOff": "Выкл." 1440 + "summaryMaxValue": 0 ~/~/ Макс. значение 1441 + } 1442 + ], 1443 + "customFields": [ ~/~/ Произвольные поля 1444 + { 1445 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1446 + "name": "string", 1447 + "value": "string", 1448 + "forClient": true, 1449 + "forTooltip": true, 1450 + "forReport": true 1451 + } 1452 + ] 1453 +} 1454 + 756 756 (% style="color:#000000" %)Ответ: 757 757 758 758 (% style="color:#000000" %){ ... ... @@ -803,17 +803,16 @@ 803 803 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 804 804 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 805 805 1505 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 806 806 807 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) == 808 - 809 -(% class="box successmessage" %) 1507 +(% class="box infomessage" %) 810 810 ((( 811 811 (% lang="en-US" %)**POST /api/v3/vehicles/find** 812 812 ))) 813 813 814 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1512 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 815 815 816 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):1514 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 817 817 818 818 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 819 819 ... ... @@ -886,15 +886,14 @@ 886 886 887 887 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 888 888 1587 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 889 889 890 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) == 891 - 892 892 (% class="box successmessage" %) 893 893 ((( 894 894 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 895 895 ))) 896 896 897 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1594 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 898 898 899 899 (% style="color:#000000" %)Метод запроса: **POST** 900 900 ... ... @@ -933,15 +933,38 @@ 933 933 (% style="text-align:left" %) 934 934 (% style="color:#000000" %) } 935 935 1633 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1634 +**Отправить команду на терминал** 936 936 937 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) == 1636 +(% class="box successmessage" %) 1637 +((( 1638 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1639 +))) 938 938 1641 +Команда для отправки на тс. 1642 + 1643 + 1644 +{ 1645 + 1646 +"id": "", ~/~/идентификатор произвольного поля 1647 + 1648 +"command": "", ~/~/ Текст команды 1649 + 1650 +"retries": "", ~/~/ Количество попыток 1651 + 1652 +"idTemplate": "" ~/~/ ID шаблона команды 1653 + 1654 +} 1655 + 1656 + 1657 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1658 + 939 939 (% class="box warningmessage" %) 940 940 ((( 941 941 (% lang="en-US" %)**PUT /api/v3/vehicles** 942 942 ))) 943 943 944 -(% style="color:#000000" %)Метод позволяет отредактировать объект . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1664 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 945 945 946 946 (% style="color:#000000" %)Метод запроса: **PUT** 947 947 ... ... @@ -951,18 +951,16 @@ 951 951 952 952 (% style="color:#000000" %)Параметры в теле запроса (JSON): 953 953 954 -(% style="color:#000000" %){ 955 - 956 -((( 957 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 958 - "parentId": "", ~/~/ ID клиента 959 - "name": "", ~/~/ имя ТС 960 - "imei": "", ~/~/ IMEI 961 - "deviceTypeId": "", ~/~/ ID типа устройства 962 - "modelId": "", ~/~/ , ID модели 963 - "unitId": "", ~/~/ подразделения 964 - "sim1": "", ~/~/ SIM 1 965 - "sim2": "", ~/~/ SIM2 (%%) 1674 +(% style="color:#000000" %){ 1675 + "vehicleId": , ~/~/ ID объекта 1676 + "parentId": "" , ~/~/ ID клиента 1677 + "name": "" , ~/~/ имя ТС 1678 + "imei": "" , ~/~/ IMEI 1679 + "deviceTypeId": "" , ~/~/ ID типа устройства 1680 + "modelId": "" , ~/~/ ID модели 1681 + "unitId": "" , ~/~/ ID подразделения 1682 + "sim1": "" , ~/~/ Номер SIM 1 1683 + "sim2": "" , ~/~/ Номер SIM2 966 966 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 967 967 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 968 968 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -975,39 +975,132 @@ 975 975 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 976 976 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 977 977 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 978 -(% style="color:#000000" %) "counters": 979 - { 980 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 981 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 982 - "mileage": "", ~/~/ пробег, в метрах 983 - "motohours": "" ~/~/ моточасы, в секундах 984 - } 985 - "cmsv6Parameters": ~/~/ параметры CMSv6 986 - { 987 - "id": "", ~/~/ идентификатор 988 - "enabled": true, ~/~/ флаг включения 989 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 990 - "login": "", ~/~/ имя учетной записи 991 - "password": "", ~/~/ пароль учетной записи 992 - } 993 - "inspectionTasks": ~/~/ задания на ТО 994 - { 995 - "id": "", ~/~/ ID задания 996 - "enabled": false, ~/~/ Признак включения 997 - "name": "", ~/~/ Имя задания 998 - "description": "", ~/~/ Описание задания 999 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1000 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1001 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1002 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1003 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1004 - "kind": "", ~/~/ Вид периодичности по времени 1005 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1006 - } 1007 -))) 1008 1008 1009 -(% style="color:#000000" %)} 1697 + "mileageCalcMethod": 0, 1698 + "mileageCoeff": 0, 1699 + "locationByCellId": true, 1700 + "dottedLineTrackWhenNoCoords": true, 1701 + "counters": ~/~/ счетчики 1702 + { 1703 + "mileage": "" , ~/~/ пробег 1704 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1705 + "motohours": "" , ~/~/ моточасы 1706 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1707 + }, 1708 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1709 + "enabled": true, ~/~/ флаг включения 1710 + "id": "" , ~/~/ идентификатор 1711 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1712 + "login": "" , ~/~/ имя учетной записи 1713 + "password": "" ~/~/ пароль учетной записи 1714 + }, 1715 + "inspectionTasks": ~/~/ задания на ТО 1716 + { 1717 + "enabled": "" , ~/~/ Признак включения 1718 + "name": "" , ~/~/ Имя задания 1719 + "description": "" , ~/~/ Описание задания 1720 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1721 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1722 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1723 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1724 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1725 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1726 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1727 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1728 + } 1010 1010 1730 +"drivers": [ ~/~/ Водители 1731 + { 1732 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1733 + "isDefault": true 1734 + } 1735 + ], 1736 + "commandTemplates": [ ~/~/ Шаблон команды 1737 + { 1738 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1739 + "name": "string", 1740 + "command": "string", 1741 + "retries": 0 1742 + } 1743 + ], 1744 + 1745 + "sensors": [ ~/~/ Датчики 1746 + { 1747 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1748 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1749 + "type": 0, ~/~/ Тип датчика 1750 + "name": "string", ~/~/ Имя датчика 1751 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1752 + "inputNumber": 0, ~/~/ Номер входа 1753 + "pseudonym": "string", ~/~/ Псевдоним 1754 + "medianDegree": 0, ~/~/ Медианная фильтрация 1755 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1756 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1757 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1758 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1759 + { 1760 + "grades": [ ~/~/ Таблица тарировки 1 1761 + { 1762 + "input": 0, ~/~/ Входящее значение 1763 + "output": 0 ~/~/ Выходящее значение 1764 + } 1765 + ], 1766 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1767 + } 1768 + ], 1769 + "showInTooltip": true, ~/~/ Отображать в подсказке 1770 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1771 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1772 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1773 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1774 + "expr": "string", ~/~/ Формула 1775 + "children": [ ~/~/ массив дочерних датчиков 1776 + "string" 1777 + ], 1778 + "customParams": { ~/~/ прочие произвольные параметры 1779 + "additionalProp1": "string", 1780 + "additionalProp2": "string", 1781 + "additionalProp3": "string" 1782 + }, 1783 + 1784 +~/~/ Характерные для произвольного: 1785 + 1786 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1787 + 1788 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1789 + 1790 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1791 + 1792 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1793 + 1794 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1795 + 1796 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1797 + 1798 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1799 + 1800 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1801 + 1802 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1803 + 1804 +~/~/ "ValueOn": "Вкл.", 1805 + 1806 +~/~/ "ValueOff": "Выкл." 1807 + "summaryMaxValue": 0 ~/~/ Макс. значение 1808 + } 1809 + ], 1810 + "customFields": [ ~/~/ Произвольные поля 1811 + { 1812 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1813 + "name": "string", 1814 + "value": "string", 1815 + "forClient": true, 1816 + "forTooltip": true, 1817 + "forReport": true 1818 + } 1819 + ] 1820 +} 1821 + 1011 1011 (% style="color:#000000" %)Ответ: 1012 1012 1013 1013 (% lang="en-US" style="text-align:left" %) ... ... @@ -1058,20 +1058,19 @@ 1058 1058 (% lang="en-US" style="text-align:left" %) 1059 1059 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1060 1060 1061 -** валидация:**1872 +**Валидация:** 1062 1062 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1063 1063 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1064 1064 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1065 1065 1877 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1066 1066 1067 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) == 1068 - 1069 1069 (% class="box errormessage" %) 1070 1070 ((( 1071 1071 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1072 1072 ))) 1073 1073 1074 -(% style="color:#000000" %)Метод позволяет удалить объект . Метод позволяет удалить объект, указанный в строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1884 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1075 1075 1076 1076 (% style="color:#000000" %)Метод запроса: **DELETE** 1077 1077 ... ... @@ -1084,22 +1084,20 @@ 1084 1084 (% style="text-align:left" %) 1085 1085 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1086 1086 1897 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1087 1087 1088 -(% style="color:#000000; font-size:1 4pt" %)Раздел:**Устройства**1899 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1089 1089 1090 - 1091 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) == 1092 - 1093 1093 (% class="box infomessage" %) 1094 1094 ((( 1095 1095 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1096 1096 ))) 1097 1097 1098 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1906 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1099 1099 1100 1100 (% style="color:#000000" %)Метод запроса: **GET** 1101 1101 1102 -(% 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]]1910 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1103 1103 1104 1104 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1105 1105 ... ... @@ -1113,24 +1113,22 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 (% style="color:#000000" %)} 1115 1115 1924 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1116 1116 1117 -= (% style="color:#000000; font-size:1 8.6667pt" %)Раздел:**Датчики**(%%) =1926 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1118 1118 1119 - 1120 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) == 1121 - 1122 1122 (% class="box infomessage" %) 1123 1123 ((( 1124 1124 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1125 1125 ))) 1126 1126 1127 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1933 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1128 1128 1129 1129 (% style="color:#000000" %)Метод запроса: **GET** 1130 1130 1131 1131 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1132 1132 1133 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1939 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1134 1134 1135 1135 (% style="color:#000000" %)Ответ: 1136 1136 ... ... @@ -1143,7 +1143,2892 @@ 1143 1143 (% style="text-align:left" %) 1144 1144 (% style="color:#000000" %)} 1145 1145 1952 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1146 1146 1954 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1955 + 1956 +(% class="box infomessage" style="text-align: left;" %) 1957 +((( 1958 +**POST /api/v3/terminalMessages/count** 1959 +))) 1960 + 1961 +(% style="text-align: left;" %) 1962 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1963 + 1964 +(% style="text-align: left;" %) 1965 +Метод запроса **POST** 1966 + 1967 +(% style="text-align: left;" %) 1968 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1969 + 1970 +(% style="text-align: left;" %) 1971 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1972 + 1973 +(% style="text-align: left;" %) 1974 +{ 1975 + "vehicleIds": [ 1976 + id ~/~/ здесь передается список идентификаторов объектов 1977 + ], 1978 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1979 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1980 +} 1981 + 1982 +(% style="text-align: left;" %) 1983 +Ответ: 1984 + 1985 +(% style="text-align: left;" %) 1986 +[ 1987 + { 1988 + "vehicleId": 0, ~/~/ идентификатор объекта 1989 + "count": 0 ~/~/ количество сообщений за период 1990 + } 1991 +] 1992 + 1993 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1994 + 1995 +(% class="box infomessage" style="text-align: left;" %) 1996 +((( 1997 +**POST /api/v3/terminalMessages/mapping** 1998 +))) 1999 + 2000 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2001 + 2002 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2003 + 2004 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2005 + 2006 +{ 2007 + "protocolType": 0, 2008 + "params": ["string"] 2009 +} 2010 + 2011 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2012 +|protocolType|ID типа протокола 2013 +|params|((( 2014 +Массив наименований параметров в сообщении 2015 +))) 2016 + 2017 +Ответ: 2018 + 2019 +{ 2020 + "protocolType": 0, 2021 + "mapping": { 2022 + "additionalProp1": { 2023 + "inputType": 0, 2024 + "inputNumber": 0 2025 + }, 2026 + "additionalProp2": { 2027 + "inputType": 0, 2028 + "inputNumber": 0 2029 + } 2030 + } 2031 +} 2032 + 2033 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2034 +|protocolType|Тип протокола 2035 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2036 +|inputNumber|((( 2037 +Номер входа 2038 +))) 2039 + 2040 +(% class="wikigeneratedid" %) 2041 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]] 2042 + 2043 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 2044 + 2045 +(% class="box infomessage" %) 2046 +((( 2047 +**POST /api/v3/terminalMessages** 2048 +))) 2049 + 2050 +Метод возвращает список сообщений терминала объекта за выбранный период. 2051 + 2052 +(% style="text-align: left;" %) 2053 +Метод запроса **POST** 2054 + 2055 +(% style="text-align: left;" %) 2056 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2057 + 2058 +(% style="text-align: left;" %) 2059 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2060 + 2061 +{ 2062 + "vehicleId": 0, ~/~/ id объекта 2063 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 2064 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 2065 +} 2066 + 2067 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2068 +|vehicleId|ID объекта 2069 +|from|Дата и время начала периода запроса 2070 +|to|Дата и время окончания периода запроса 2071 + 2072 +Ответ: 2073 + 2074 +[ 2075 + { 2076 + "messages": [ 2077 + { 2078 + "deviceTime": "2023-11-29T07:40:44.052Z", 2079 + "serverTime": "2023-11-29T07:40:44.052Z", 2080 + "speed": 0, 2081 + "altitude": 0, 2082 + "latitude": 0, 2083 + "longitude": 0, 2084 + "satellites": 0, 2085 + "course": 0, 2086 + "voltage": 0, 2087 + "parameters": { 2088 + "additionalProp1": "string", 2089 + "additionalProp2": "string", 2090 + "additionalProp3": "string" 2091 + }, 2092 + "photoCount": 0, 2093 + "lbsCorrectedCoords": true, 2094 + "protocolType": 0 2095 + } 2096 + ] 2097 + } 2098 +] 2099 + 2100 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2101 +|deviceTime|Время сообщения терминала 2102 +|serverTime|Время когда сообщение поступило на сервер 2103 +|speed|Скорость 2104 +|altitude|Высота над уровнем моря 2105 +|latitude|Широта 2106 +|longitude|Долгота 2107 +|satellites|Кол-во спутников 2108 +|course|Курс 2109 +|voltage|Бортовое напряжение 2110 +|parameters|Список параметров и их значений 2111 +|photoCount|Количество фото 2112 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2113 +|protocolType|ID типа протокола 2114 + 2115 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2116 + 2117 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2118 + 2119 +(% class="box infomessage" %) 2120 +((( 2121 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2122 +))) 2123 + 2124 +(% style="color:#000000" %)Метод запроса: **POST** 2125 + 2126 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2127 + 2128 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2129 + 2130 +(% style="text-align:left" %) 2131 +Тело запроса: 2132 + 2133 +{ 2134 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2135 + "vehicleIds": [0], ~/~/ Список ID объектов 2136 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2137 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2138 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2139 +} 2140 + 2141 +Ответ: 2142 + 2143 +[ 2144 + { 2145 + "vehicleId": 0, ~/~/ ID объекта 2146 + "name": "string", ~/~/ Имя ТС 2147 + "periods": [ ~/~/ Периоды 2148 + { 2149 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2150 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2151 + "mileageBegin": 0, ~/~/ Пробег на начало периода 2152 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 2153 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2154 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2155 + } 2156 + ] 2157 + } 2158 +] 2159 + 2160 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2161 + 2162 +(% class="box infomessage" %) 2163 +((( 2164 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2165 +))) 2166 + 2167 +(% style="color:#000000" %)Метод запроса: **POST** 2168 + 2169 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2170 + 2171 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2172 + 2173 +(% style="text-align:left" %) 2174 +Тело запроса: 2175 + 2176 +{ 2177 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2178 + "vehicleIds": [0], ~/~/ Список ID объектов 2179 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2180 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2181 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2182 +} 2183 + 2184 +Ответ: 2185 + 2186 +[ 2187 + { 2188 + "vehicleId": 0, ~/~/ ID объекта 2189 + "name": "string", ~/~/ Имя ТС 2190 + "periods": [ ~/~/ Периоды 2191 + { 2192 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2193 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2194 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2195 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2196 + "fuelConsumption": 0, ~/~/ Расход топлива 2197 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2198 + } 2199 + ] 2200 + } 2201 +] 2202 + 2203 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2204 + 2205 +(% class="box infomessage" %) 2206 +((( 2207 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2208 +))) 2209 + 2210 +(% style="color:#000000" %)Метод запроса: **POST** 2211 + 2212 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2213 + 2214 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2215 + 2216 +(% style="text-align:left" %) 2217 +Тело запроса: 2218 + 2219 +{ 2220 + "vehicleIds": [0], ~/~/ Список ID объектов 2221 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2222 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2223 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2224 +} 2225 + 2226 +Ответ: 2227 + 2228 +[ 2229 + { 2230 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2231 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2232 + "vehicleId": 0, ~/~/ ID объекта 2233 + "name": "string", ~/~/ Имя объекта 2234 + "model": "string", ~/~/ Модель объекта 2235 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2236 + { 2237 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2238 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2239 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2240 + "valueFuel": 0, ~/~/ Количество 2241 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2242 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2243 + } 2244 + ] 2245 + } 2246 +] 2247 + 2248 + 2249 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2250 + 2251 +(% class="box infomessage" %) 2252 +((( 2253 +**POST /api/v3/vehicles/moveStop** 2254 +))) 2255 + 2256 +Метод запроса: **POST** 2257 + 2258 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2259 + 2260 +В заголовках запроса: X-Auth: Токен авторизации 2261 + 2262 + 2263 +Тело запроса: 2264 + 2265 +{ 2266 + 2267 + "vehicleIds": [ ], ~/~/ Список ID объектов 2268 + 2269 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2270 + 2271 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2272 + 2273 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2274 + 2275 +} 2276 + 2277 +Ответ: 2278 + 2279 +[ 2280 + 2281 + { 2282 + 2283 + "vehicleId": 0, ~/~/ ID объекта 2284 + 2285 + "vehicleName": "string", ~/~/ Имя объекта 2286 + 2287 + "moves": [ ~/~/ Событие движения 2288 + 2289 + { 2290 + 2291 + "mileage": 0, ~/~/ Пробег, км 2292 + 2293 + "eventId": 0, ~/~/ Идентификатор события 2294 + 2295 + "eventName": "string", ~/~/ Название события 2296 + 2297 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2298 + 2299 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2300 + 2301 + "duration": 0 ~/~/ Продолжительность события, секунд 2302 + 2303 + } 2304 + 2305 + ], 2306 + 2307 + "stops": [ ~/~/ События стоянок 2308 + 2309 + { 2310 + 2311 + "address": "string", ~/~/ Адрес события 2312 + 2313 + "eventId": 0, ~/~/ Идентификатор события 2314 + 2315 + "eventName": "string", ~/~/ Название события 2316 + 2317 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2318 + 2319 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2320 + 2321 + "duration": 0 ~/~/ Продолжительность события, секунд 2322 + 2323 + 2324 + } 2325 + 2326 + ] 2327 + 2328 + } 2329 + 2330 +] 2331 + 2332 + 2333 + 2334 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2335 + 2336 +(% class="box infomessage" %) 2337 +((( 2338 +**POST /api/v3/vehicles/getlastdata** 2339 +))) 2340 + 2341 +Метод запроса: **POST** 2342 + 2343 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2344 + 2345 +В заголовках запроса: X-Auth: Токен авторизации 2346 + 2347 + 2348 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2349 + 2350 +Ответ: 2351 + { 2352 + "vehicleId": 0, ~/~/Идентификатор объекта. 2353 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2354 + "vehicleNumber": "string",~/~/Номер объекта. 2355 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2356 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2357 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2358 + "speed": 0,~/~/Скорость объекта. 2359 + "course": 0,~/~/Курс движения [0;360] 2360 + "latitude": 0,~/~/Широта [-90°;90°]. 2361 + "longitude": 0,~/~/Долгота [-180°;180°]. 2362 + "address": "string",~/~/Адрес. 2363 + "geozones": [ ~/~/Сведения по геозонам. 2364 + { 2365 + "id": 0, 2366 + "name": "string" 2367 + } 2368 + 2369 + 2370 + 2371 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2372 + 2373 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2374 + 2375 +(% class="box infomessage" %) 2376 +((( 2377 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2378 +))) 2379 + 2380 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2381 + 2382 +(% style="color:#000000" %)Метод запроса: **POST** 2383 + 2384 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2385 + 2386 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2387 + 2388 +(% style="text-align:left" %) 2389 +Тело запроса: 2390 + 2391 +(% style="text-align:left" %) 2392 +{ 2393 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2394 +} 2395 + 2396 +(% style="text-align:left" %) 2397 +Ответ: 2398 + 2399 +[ 2400 + { 2401 + "id": 0, ~/~/ Идентификатор объекта геозоны 2402 + "name": "string", ~/~/ Название объекта геозоны 2403 + "type": 0, ~/~/ Тип объекта геозоны 2404 + "fname": "string", ~/~/ Имя файла 2405 + "parentId": "string", ~/~/ Идентификатор клиента 2406 + "radius": 0, ~/~/ Радиус геообъекта 2407 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2408 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2409 + "description": "string", ~/~/ Описание 2410 + "area": 0, ~/~/ Площадь, м^^2^^ 2411 + "perimetr": 0, ~/~/ Периметр, м 2412 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2413 + } 2414 +] 2415 + 2416 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2417 + 2418 +(% class="box infomessage" %) 2419 +((( 2420 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2421 +))) 2422 + 2423 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2424 + 2425 +(% style="color:#000000" %)Метод запроса: **POST** 2426 + 2427 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2428 + 2429 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2430 + 2431 +(% style="text-align:left" %) 2432 +Тело запроса: 2433 + 2434 +{ 2435 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2436 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2437 + "ids": [ ], ~/~/ Массив id объектов 2438 + "byTime": 0, ~/~/ Объединение событий по времени 2439 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2440 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2441 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2442 +} 2443 + 2444 +Ответ: 2445 +[ 2446 + { 2447 + "geozoneId": 0, ~/~/ ID геообъекта 2448 + "geozoneName": "string", ~/~/ Название геообъекта 2449 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2450 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2451 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2452 + "vehicleId": 0, ~/~/ ID объекта 2453 + "vehicleName": "string" ~/~/ Имя объекта 2454 + } 2455 +] 2456 + 2457 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2458 + 2459 +(% class="box infomessage" %) 2460 +((( 2461 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2462 +))) 2463 + 2464 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2465 + 2466 +(% style="color:#000000" %)Метод запроса: **POST** 2467 + 2468 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2469 + 2470 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2471 + 2472 +(% style="text-align:left" %) 2473 +Тело запроса: 2474 + 2475 +{ 2476 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2477 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2478 + "ids": [ ], ~/~/ Массив id геообъектов 2479 + "byTime": 0, ~/~/ Объединение событий по времени 2480 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2481 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2482 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2483 +} 2484 + 2485 +Ответ: 2486 + 2487 +[ 2488 + { 2489 + "geozoneId": 0, ~/~/ ID геообъекта 2490 + "geozoneName": "string", ~/~/ Название геообъекта 2491 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2492 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2493 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2494 + "vehicleId": 0, ~/~/ ID объекта 2495 + "vehicleName": "string" ~/~/ Имя объекта 2496 + } 2497 +] 2498 + 2499 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2500 + 2501 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2502 + 2503 +(% class="box infomessage" %) 2504 +((( 2505 +**POST /api/v3/notifications/find** 2506 +))) 2507 + 2508 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2509 + 2510 +(% style="text-align: left;" %) 2511 +Метод запроса **POST** 2512 + 2513 +(% style="text-align: left;" %) 2514 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2515 + 2516 +(% style="text-align: left;" %) 2517 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2518 + 2519 +{ 2520 + "parentId": "" ~/~/ id клиента 2521 +} 2522 + 2523 +Ответ: 2524 + 2525 +[ 2526 + { 2527 + "id": 0, ~/~/ ID уведомления 2528 + "name": "string", ~/~/ Название уведомления 2529 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2530 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2531 + "userId": "", ~/~/ Пользователь, создавший уведомление 2532 + "parentId": "", ~/~/ Идентификатор клиента 2533 + "parentName": "string" ~/~/ Имя клиента 2534 + } 2535 +] 2536 + 2537 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2538 + 2539 +(% class="box infomessage" %) 2540 +((( 2541 +**GET /api/v3/notifications/{id}** 2542 +))) 2543 + 2544 +Метод возвращает данные правил формирования выбранного уведомления. 2545 + 2546 +(% style="text-align: left;" %) 2547 +Метод запроса **GET** 2548 + 2549 +(% style="text-align: left;" %) 2550 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2551 + 2552 +(% style="text-align: left;" %) 2553 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2554 + 2555 +(% style="text-align: left;" %) 2556 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2557 + 2558 +(% style="text-align: left;" %) 2559 +(% style="color:#000000" %)Ответ: 2560 + 2561 +(% style="text-align: left;" %) 2562 +(% style="color:#000000" %){ 2563 + "id": 0, ~/~/ (%%)id уведомления 2564 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2565 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2566 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2567 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2568 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2569 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2570 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2571 +(% style="color:#000000" %) 0 2572 + ], 2573 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2574 +(% style="color:#000000" %) 0 2575 + ], 2576 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2577 +(% style="color:#000000" %) 0 2578 + ], 2579 + "settings": { ~/~/ Список параметров уведомления 2580 + "additionalProp1": "string", 2581 + "additionalProp2": "string", 2582 + "additionalProp3": "string" 2583 + }, 2584 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2585 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2586 +(% style="color:#000000" %) "" 2587 + ], 2588 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2589 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2590 +(% style="color:#000000" %) "string" 2591 + ], 2592 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2593 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2594 +(% style="color:#000000" %) { 2595 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2596 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2597 +(% style="color:#000000" %) } 2598 + ], 2599 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2600 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2601 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2602 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2603 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2604 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2605 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2606 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2607 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2608 +(% style="color:#000000" %)} 2609 + 2610 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2611 + 2612 +(% class="box warningmessage" %) 2613 +((( 2614 +**PUT /api/v3/notifications/** 2615 +))) 2616 + 2617 +Метод позволяет отредактировать уведомление. 2618 + 2619 +Метод запроса **PUT** 2620 + 2621 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2622 + 2623 +В заголовках запроса: X-Auth: Токен авторизации 2624 + 2625 +Тело запроса: 2626 +{ 2627 + "id": 0, ~/~/ id уведомления 2628 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2629 + "userId": "", ~/~/ Пользователь, создавший уведомление 2630 + "parentId": "", ~/~/ Идентификатор клиента 2631 + "parentName": "string", ~/~/ Имя клиента 2632 + "name": "string", ~/~/ Название уведомления 2633 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2634 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2635 + 0 2636 + ], 2637 + "geoids": [ ~/~/ Список id геообъектов для анализа 2638 + 0 2639 + ], 2640 + "fieldids": [ ~/~/ Список id полей для анализа 2641 + 0 2642 + ], 2643 + "settings": { ~/~/ Список параметров уведомления 2644 + "additionalProp1": "string", 2645 + "additionalProp2": "string", 2646 + "additionalProp3": "string" 2647 + }, 2648 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2649 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2650 + "" 2651 + ], 2652 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2653 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2654 + "string" 2655 + ], 2656 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2657 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2658 + { 2659 + "id": 0, ~/~/ Идентификатор участника чата 2660 + "info": "string" ~/~/ Дополнительные сведения 2661 + } 2662 + ], 2663 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2664 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2665 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2666 + "kind": 0, ~/~/ Определяет вид уведомления 2667 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2668 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2669 + "timezone": 0, ~/~/ Сдвиг часового пояса 2670 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2671 + "autoProlongation": true ~/~/ Автопродление срока действия 2672 +} 2673 + 2674 +Ответ: 2675 + 2676 +Success 2677 + 2678 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2679 + 2680 +(% class="box errormessage" %) 2681 +((( 2682 +**DELETE /api/v3/notifications/{id}** 2683 +))) 2684 + 2685 +Метод позволяет удалить выбранное уведомление. 2686 + 2687 +Метод запроса **DELETE** 2688 + 2689 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2690 + 2691 +Передаваемый параметр: {id} - id уведомления 2692 + 2693 +В заголовках запроса: X-Auth: Токен авторизации 2694 + 2695 +Ответ: 2696 + 2697 +Success 2698 + 2699 + 2700 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2701 + 2702 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2703 + 2704 +(% class="box infomessage" %) 2705 +((( 2706 +**POST /api/v3/Drivers/find** 2707 +))) 2708 + 2709 +Передается параметр: parentId - ID клиента-родителя 2710 + 2711 +Ответ: 2712 + 2713 +[ 2714 + { 2715 + "name": "string", ~/~/ Определяет наименование 2716 + "description": "string", ~/~/ Определяет описание 2717 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2718 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2719 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2720 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2721 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2722 + "deleted": true ~/~/ Признак удаления 2723 + } 2724 +] 2725 + 2726 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2727 + 2728 +(% class="box infomessage" %) 2729 +((( 2730 +**GET /api/v3/Drivers/{driverGuid}** 2731 +))) 2732 + 2733 +Передается параметр: ID водителя 2734 + 2735 +Ответ: 2736 + 2737 +{ 2738 + "name": "string", ~/~/ Определяет наименование 2739 + "description": "string", ~/~/ Определяет описание 2740 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2741 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2742 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2743 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2744 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2745 + "deleted": true ~/~/ Признак удаления 2746 +} 2747 + 2748 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2749 + 2750 +(% class="box successmessage" %) 2751 +((( 2752 +**POST /api/v3/Drivers** 2753 +))) 2754 + 2755 +Запрос: 2756 + 2757 +{ 2758 + "name": "string", 2759 + "description": "string", 2760 + "hiredate": "2023-06-30T12:50:54.020Z", 2761 + "chopdate": "2023-06-30T12:50:54.020Z", 2762 + "exclusive": true, 2763 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2764 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2765 + "deleted": true 2766 +} 2767 + 2768 +Ответ: 2769 + 2770 +{ 2771 + "name": "string", 2772 + "description": "string", 2773 + "hiredate": "2023-06-30T12:50:54.051Z", 2774 + "chopdate": "2023-06-30T12:50:54.051Z", 2775 + "exclusive": true, 2776 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2777 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2778 + "deleted": true 2779 +} 2780 + 2781 + 2782 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2783 + 2784 +(% class="box warningmessage" %) 2785 +((( 2786 +**PUT /api/v3/Drivers** 2787 +))) 2788 + 2789 +Запрос: 2790 + 2791 +{ 2792 + "name": "string", 2793 + "description": "string", 2794 + "hiredate": "2023-06-30T12:50:27.910Z", 2795 + "chopdate": "2023-06-30T12:50:27.910Z", 2796 + "exclusive": true, 2797 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2798 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2799 + "deleted": true 2800 +} 2801 + 2802 +Ответ: 2803 + 2804 +{ 2805 + "name": "string", 2806 + "description": "string", 2807 + "hiredate": "2023-06-30T12:50:27.929Z", 2808 + "chopdate": "2023-06-30T12:50:27.929Z", 2809 + "exclusive": true, 2810 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2811 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2812 + "deleted": true 2813 +} 2814 + 2815 + 2816 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2817 + 2818 +(% class="box errormessage" %) 2819 +((( 2820 +**DELETE /api/v3/Drivers/{driverGuid}** 2821 +))) 2822 + 2823 +Передается параметр: ID водителя 2824 + 2825 +Ответ: 2826 + 2827 +Success 2828 + 2829 + 2830 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 2831 + 2832 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 2833 + 2834 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2835 + 2836 +(% class="box infomessage" %) 2837 +((( 2838 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2839 +))) 2840 + 2841 +Запрос: 2842 + 2843 +{ 2844 + "Ids": [ 2845 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2846 + ], 2847 + "BeginTime": "2023-06-30T12:49:04.365Z", 2848 + "EndTime": "2023-06-30T12:49:04.365Z" 2849 +} 2850 + 2851 +Ответ: 2852 + 2853 +[ 2854 + { 2855 + "VehicleId": 0, 2856 + "CreateTime": "2023-06-30T09:52:31.240Z", 2857 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2858 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2859 + "BeginTime": "2023-06-30T09:52:31.240Z", 2860 + "EndTime": "2023-06-30T09:52:31.240Z" 2861 + } 2862 +] 2863 + 2864 + 2865 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2866 + 2867 +(% class="box infomessage" %) 2868 +((( 2869 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2870 +))) 2871 + 2872 +Запрос: 2873 + 2874 +{ 2875 + "Ids": [ 2876 + 0 2877 + ], 2878 + "BeginTime": "2023-06-30T12:48:39.419Z", 2879 + "EndTime": "2023-06-30T12:48:39.419Z" 2880 +} 2881 + 2882 +Ответ: 2883 + 2884 +[ 2885 + { 2886 + "VehicleId": 0, 2887 + "CreateTime": "2023-06-30T09:54:01.631Z", 2888 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2889 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2890 + "BeginTime": "2023-06-30T09:54:01.631Z", 2891 + "EndTime": "2023-06-30T09:54:01.631Z" 2892 + } 2893 +] 2894 + 2895 + 2896 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2897 + 2898 +(% class="box successmessage" %) 2899 +((( 2900 +**POST /api/v3/DriversVehiclesAssignments** 2901 +))) 2902 + 2903 +Передается массив назначений 2904 + 2905 +Запрос: 2906 + 2907 +[ 2908 + { 2909 + "VehicleId": 0, ~/~/ Идентификатор объекта 2910 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2911 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2912 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2913 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2914 + } 2915 +] 2916 + 2917 +Ответ: 2918 + 2919 +[ 2920 + { 2921 + "VehicleId": 0, 2922 + "CreateTime": "2023-06-30T11:04:46.903Z", 2923 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2924 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2925 + "BeginTime": "2023-06-30T11:04:46.903Z", 2926 + "EndTime": "2023-06-30T11:04:46.903Z" 2927 + } 2928 +] 2929 + 2930 + 2931 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2932 + 2933 +(% class="box warningmessage" %) 2934 +((( 2935 +**PUT /api/v3/DriversVehiclesAssignments** 2936 +))) 2937 + 2938 +Запрос: 2939 + 2940 +[ 2941 + { 2942 + "VehicleId": 0, 2943 + "CreateTime": "2023-06-30T11:14:08.117Z", 2944 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2945 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2946 + "BeginTime": "2023-06-30T11:14:08.117Z", 2947 + "EndTime": "2023-06-30T11:14:08.117Z" 2948 + } 2949 +] 2950 + 2951 +Ответ: 2952 + 2953 +[ 2954 + { 2955 + "VehicleId": 0, 2956 + "CreateTime": "2023-06-30T11:14:53.349Z", 2957 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2958 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2959 + "BeginTime": "2023-06-30T11:14:53.349Z", 2960 + "EndTime": "2023-06-30T11:14:53.349Z" 2961 + } 2962 +] 2963 + 2964 + 2965 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2966 + 2967 +(% class="box errormessage" %) 2968 +((( 2969 +**DELETE /api/v3/DriversVehiclesAssignments** 2970 +))) 2971 + 2972 +Запрос: 2973 + 2974 +[ 2975 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 +] 2977 + 2978 +Ответ: 2979 + 2980 +Success 2981 + 2982 + 2983 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2984 + 2985 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2986 + 2987 +(% class="box infomessage" %) 2988 +((( 2989 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2990 +))) 2991 + 2992 +Запрос: 2993 + 2994 +{ 2995 + "Ids": [ 2996 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2997 + ], 2998 + "BeginTime": "2023-06-30T12:47:12.162Z", 2999 + "EndTime": "2023-06-30T12:47:12.162Z" 3000 +} 3001 + 3002 +Ответ: 3003 + 3004 +[ 3005 + { 3006 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3007 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3008 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3009 + "BeginTime": "2023-06-30T11:19:40.703Z", 3010 + "EndTime": "2023-06-30T11:19:40.703Z" 3011 + } 3012 +] 3013 + 3014 + 3015 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3016 + 3017 +(% class="box infomessage" %) 3018 +((( 3019 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3020 +))) 3021 + 3022 +Запрос: 3023 + 3024 +{ 3025 + "Ids": [ 3026 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3027 + ], 3028 + "BeginTime": "2023-06-30T12:47:12.162Z", 3029 + "EndTime": "2023-06-30T12:47:12.162Z" 3030 +} 3031 + 3032 +Ответ: 3033 + 3034 +[ 3035 + { 3036 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3037 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3038 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3039 + "BeginTime": "2023-06-30T11:19:40.703Z", 3040 + "EndTime": "2023-06-30T11:19:40.703Z" 3041 + } 3042 +] 3043 + 3044 + 3045 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3046 + 3047 +(% class="box successmessage" %) 3048 +((( 3049 +**POST /api/v3/DriversRfidsAssignments** 3050 +))) 3051 + 3052 +Запрос: 3053 + 3054 +[ 3055 + { 3056 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3057 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3058 + "BeginTime": "2023-06-30T11:27:08.635Z", 3059 + "EndTime": "2023-06-30T11:27:08.635Z" 3060 + } 3061 +] 3062 + 3063 +Ответ: 3064 + 3065 +[ 3066 + { 3067 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3068 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3069 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3070 + "BeginTime": "2023-06-30T11:27:08.677Z", 3071 + "EndTime": "2023-06-30T11:27:08.677Z" 3072 + } 3073 +] 3074 + 3075 + 3076 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3077 + 3078 +(% class="box warningmessage" %) 3079 +((( 3080 +**PUT /api/v3/DriversRfidsAssignments** 3081 +))) 3082 + 3083 +Запрос: 3084 + 3085 +[ 3086 + { 3087 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3088 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3089 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3090 + "BeginTime": "2023-06-30T11:28:43.330Z", 3091 + "EndTime": "2023-06-30T11:28:43.330Z" 3092 + } 3093 +] 3094 + 3095 +Ответ: 3096 + 3097 +[ 3098 + { 3099 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3100 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3101 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3102 + "BeginTime": "2023-06-30T11:28:43.331Z", 3103 + "EndTime": "2023-06-30T11:28:43.331Z" 3104 + } 3105 +] 3106 + 3107 + 3108 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3109 + 3110 +(% class="box errormessage" %) 3111 +((( 3112 +**DELETE /api/v3/DriversRfidsAssignments** 3113 +))) 3114 + 3115 +Запрос: 3116 + 3117 +[ 3118 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3119 +] 3120 + 3121 +Ответ: 3122 + 3123 +Success 3124 + 3125 + 3126 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3127 + 3128 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3129 + 3130 +(% class="box infomessage" %) 3131 +((( 3132 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3133 +))) 3134 + 3135 +Запрос: 3136 + 3137 +{ 3138 + "Ids": [ 3139 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3140 + ], 3141 + "BeginTime": "2023-06-30T12:45:10.852Z", 3142 + "EndTime": "2023-06-30T12:45:10.852Z" 3143 +} 3144 + 3145 +Ответ: 3146 + 3147 +[ 3148 + { 3149 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3150 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3151 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3152 + "BeginTime": "2023-06-30T11:58:04.695Z", 3153 + "EndTime": "2023-06-30T11:58:04.695Z" 3154 + } 3155 +] 3156 + 3157 + 3158 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3159 + 3160 +(% class="box infomessage" %) 3161 +((( 3162 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3163 +))) 3164 + 3165 +Запрос: 3166 + 3167 +{ 3168 + "Ids": [ 3169 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3170 + ], 3171 + "BeginTime": "2023-06-30T12:45:10.852Z", 3172 + "EndTime": "2023-06-30T12:45:10.852Z" 3173 +} 3174 + 3175 +Ответ: 3176 + 3177 +[ 3178 + { 3179 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3180 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3181 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3182 + "BeginTime": "2023-06-30T11:58:04.695Z", 3183 + "EndTime": "2023-06-30T11:58:04.695Z" 3184 + } 3185 +] 3186 + 3187 + 3188 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3189 + 3190 +(% class="box successmessage" %) 3191 +((( 3192 +**POST /api/v3/DriversFuelCardsAssignments** 3193 +))) 3194 + 3195 +Запрос: 3196 + 3197 +[ 3198 + { 3199 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3200 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3201 + "BeginTime": "2023-06-30T12:09:53.175Z", 3202 + "EndTime": "2023-06-30T12:09:53.175Z" 3203 + } 3204 +] 3205 + 3206 +Ответ: 3207 + 3208 +[ 3209 + { 3210 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3211 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3212 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3213 + "BeginTime": "2023-06-30T12:09:53.201Z", 3214 + "EndTime": "2023-06-30T12:09:53.201Z" 3215 + } 3216 +] 3217 + 3218 + 3219 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3220 + 3221 +(% class="box warningmessage" %) 3222 +((( 3223 +**PUT /api/v3/DriversFuelCardsAssignments** 3224 +))) 3225 + 3226 +Запрос: 3227 + 3228 +[ 3229 + { 3230 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3231 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3232 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3233 + "BeginTime": "2023-06-30T12:09:53.201Z", 3234 + "EndTime": "2023-06-30T12:09:53.201Z" 3235 + } 3236 +] 3237 + 3238 +Ответ: 3239 + 3240 +[ 3241 + { 3242 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3243 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3244 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3245 + "BeginTime": "2023-06-30T12:09:53.201Z", 3246 + "EndTime": "2023-06-30T12:09:53.201Z" 3247 + } 3248 +] 3249 + 3250 + 3251 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3252 + 3253 +(% class="box errormessage" %) 3254 +((( 3255 +**DELETE /api/v3/DriversFuelCardsAssignments** 3256 +))) 3257 + 3258 +Запрос: 3259 + 3260 +[ 3261 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3262 +] 3263 + 3264 +Ответ: 3265 + 3266 +Success 3267 + 3268 + 3269 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3270 + 3271 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3272 + 3273 +(% class="box infomessage" %) 3274 +((( 3275 +**POST /api/v3/Trailers** 3276 +))) 3277 + 3278 +Пример запроса: 3279 + 3280 +{ 3281 + "startDate": "2023-11-14T10:48:03.671Z", 3282 + "endDate": "2023-11-14T10:48:03.671Z", 3283 + "ids": [ 0 ], 3284 + "timezone": 0 3285 +} 3286 + 3287 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3288 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3289 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3290 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3291 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3292 + 3293 +Пример ответа: 3294 + 3295 +[ 3296 + { 3297 + "SD": "2023-11-14T10:48:03.717Z", 3298 + "ED": "2023-11-14T10:48:03.717Z", 3299 + "id": 0, 3300 + "SLat": 0, 3301 + "SLon": 0, 3302 + "ELat": 0, 3303 + "ELon": 0, 3304 + "mileage": 0 3305 + "Duration": 0 3306 + "Address": "string", 3307 + "Address2": "string", 3308 + "name": "string", 3309 + "rid": "string", 3310 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3311 + "trailer": { 3312 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3313 + "Number": "string", 3314 + "Description": "string", 3315 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3316 + "ExternalID": "string", 3317 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3318 + "CreateTime": "2023-11-14T10:48:03.717Z", 3319 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3320 + "IsDeleted": true 3321 + }, 3322 + "filesCount": 0, 3323 + } 3324 +] 3325 + 3326 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3327 +|SD|Дата и время начала события 3328 +|ED|Дата и время окончания события 3329 +|id|ID объекта 3330 +|SLat|Широта начальной координаты 3331 +|SLon|Долгота начальной координаты 3332 +|ELat|Широта конечной координаты 3333 +|ELon|Долгота конечной координаты 3334 +|mileage|Пробег 3335 +|Duration|Продолжительность 3336 +|Address|Адрес начального местоположения 3337 +|Address2|Адрес конечного местоположения 3338 +|name|Имя радиометки 3339 +|rid|Номер радиометки 3340 +|rguid|ID радиометки 3341 +|trailer|Информация об агрегате 3342 +|ModelGuid|ID агрегата 3343 +|Number|Название/номер агрегата 3344 +|Description|Текст примечания агрегата 3345 + 3346 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3347 + 3348 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3349 + 3350 +(% class="box infomessage" %) 3351 +((( 3352 +**POST /api/v3/Rfids/find** 3353 +))) 3354 + 3355 +Запрос: 3356 + 3357 +{ 3358 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3359 +} 3360 + 3361 +Ответ: 3362 + 3363 +[ 3364 + { 3365 + "name": "string", 3366 + "number": 0, 3367 + "period": 0, 3368 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3369 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3370 + } 3371 +] 3372 + 3373 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3374 +|parentId|ID клиента 3375 +|name|Название карты-метки 3376 +|number|Номер 3377 +|period|Период запросов в секундах (работает только для агрегатов) 3378 +|id|ID карты-метки 3379 + 3380 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3381 + 3382 +(% class="box infomessage" %) 3383 +((( 3384 +**GET /api/v3/Rfids/{rfidGuid}** 3385 +))) 3386 + 3387 +Передаем параметр rfidGuid - идентификатор карты-метки 3388 + 3389 +Ответ: 3390 + 3391 +[ 3392 + { 3393 + "name": "string", 3394 + "number": 0, 3395 + "period": 0, 3396 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3397 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3398 + } 3399 +] 3400 + 3401 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3402 +|name|Название карты-метки 3403 +|number|Номер 3404 +|period|Период запросов в секундах (работает только для агрегатов) 3405 +|id|ID карты-метки 3406 +|parentId|ID клиента 3407 + 3408 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3409 + 3410 +(% class="box successmessage" %) 3411 +((( 3412 +**POST /api/v3/Rfids** 3413 +))) 3414 + 3415 +Запрос: 3416 + 3417 +{ 3418 + "name": "string", 3419 + "number": 0, 3420 + "period": 0, 3421 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3422 +} 3423 + 3424 +Ответ: 3425 + 3426 +{ 3427 + "name": "string", 3428 + "number": 0, 3429 + "period": 0, 3430 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3431 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3432 +} 3433 + 3434 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3435 +|name|Название карты-метки 3436 +|number|Номер 3437 +|period|Период запросов в секундах (работает только для агрегатов) 3438 +|id|ID карты-метки 3439 +|parentId|ID клиента 3440 + 3441 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3442 + 3443 +(% class="box warningmessage" %) 3444 +((( 3445 +**PUT /api/v3/Rfids** 3446 +))) 3447 + 3448 +Запрос: 3449 + 3450 +{ 3451 + "name": "string", 3452 + "number": 0, 3453 + "period": 0, 3454 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3455 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3456 +} 3457 + 3458 +Ответ: 3459 + 3460 +{ 3461 + "name": "string", 3462 + "number": 0, 3463 + "period": 0, 3464 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3465 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3466 +} 3467 + 3468 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3469 +|name|Название карты-метки 3470 +|number|Номер 3471 +|period|Период запросов в секундах (работает только для агрегатов) 3472 +|id|ID карты-метки 3473 +|parentId|ID клиента 3474 + 3475 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3476 + 3477 +(% class="box errormessage" %) 3478 +((( 3479 +**DELETE /api/v3/Rfids/{rfidGuid}** 3480 +))) 3481 + 3482 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3483 + 3484 +Ответ: 3485 + 3486 +Success 3487 + 3488 + 3489 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3490 + 3491 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3492 + 3493 +(% class="box infomessage" %) 3494 +((( 3495 +**GET /api/v3/Billing/client/balance/{clientId}** 3496 +))) 3497 + 3498 +Параметр запроса: **clientId **- идентификатор клиента. 3499 + 3500 +Ответ: 3501 + 3502 +{ 3503 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3504 + "Balance": 0 3505 +} 3506 + 3507 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3508 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3509 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3510 + 3511 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3512 + 3513 +(% class="box infomessage" %) 3514 +((( 3515 +**GET /api/v3/Billing/client/constraint/{clientId}** 3516 +))) 3517 + 3518 +Параметр запроса: **clientId **- идентификатор клиента. 3519 + 3520 +Ответ: 3521 + 3522 +{ 3523 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3524 + "CalculationType": 0, 3525 + "PermissibleBalance": 0, 3526 + "DefermentDays": 0, 3527 + "SendUiNotifications": true, 3528 + "SendEmailNotifications": true, 3529 + "IsPrivate": true, 3530 +} 3531 + 3532 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3533 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3534 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3535 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3536 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3537 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3538 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3539 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3540 + 3541 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3542 + 3543 +(% class="box infomessage" %) 3544 +((( 3545 +**GET /api/v3/Billing/client/plan/{clientId}** 3546 +))) 3547 + 3548 +Параметры запроса: 3549 + 3550 +**clientId **- идентификатор клиента. 3551 + 3552 +**planId **- идентификатор тарифного плана. 3553 + 3554 +Ответ: 3555 + 3556 +{ 3557 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3558 + "Plan": { **~/~/ Описание тарифного плана** 3559 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3560 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3561 + "Name": "string", 3562 + "IsArchived": true, 3563 + "Constraint": { 3564 + "CalculationType": 0, 3565 + "PermissibleBalance": 0, 3566 + "DefermentDays": 0 3567 + }, 3568 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3569 + { 3570 + "Feature": "string", 3571 + "IsFactual": true, 3572 + "Limit": 0, 3573 + "Price": 0, 3574 + "PeriodValue": 0, 3575 + "PeriodType": 0 3576 + } 3577 + ] 3578 + }, 3579 + "DebitDate": "2023-10-18T12:46:24.213Z", 3580 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3581 + { 3582 + "Feature": "string", 3583 + "IsEnabled": true, 3584 + "IsPrivate": true, 3585 + "IsFactual": true, 3586 + "Limit": 0, 3587 + "Price": 0, 3588 + "DebitDate": "2023-10-18T12:46:24.213Z", 3589 + "PeriodValue": 0, 3590 + "PeriodType": 0 3591 + } 3592 + ] 3593 +} 3594 + 3595 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3596 +|ClientId|Идентификатор клиента 3597 +|Id|Идентификатор тарифного плана 3598 +|OwnerId|Идентификатор клиента-владельца 3599 +|Name|Наименование тарифного плана 3600 +|IsArchived|Признак, определяющий архивный тарифный план 3601 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3602 +|PermissibleBalance|Допустимый баланс 3603 +|DefermentDays|Отсрочка, количество дней 3604 +|Feature|Код услуги 3605 +|IsEnabled|Признак, определяющий активирована ли услуга 3606 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3607 +|IsFactual|Признак, определяющий расчёт по факту 3608 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3609 +|Price|Цена за единицу. 3610 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3611 +|PeriodValue|Значение периода. 3612 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3613 + 3614 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3615 + 3616 +(% class="box infomessage" %) 3617 +((( 3618 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3619 +))) 3620 + 3621 +Параметр запроса: **clientId **- идентификатор клиента. 3622 + 3623 +Ответ: 3624 + 3625 +[ 3626 + { 3627 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3628 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3629 + "Name": "string", 3630 + "IsArchived": true, 3631 + "Constraint": { 3632 + "CalculationType": 0, 3633 + "PermissibleBalance": 0, 3634 + "DefermentDays": 0 3635 + }, 3636 + "Features": [ 3637 + { 3638 + "Feature": "string", 3639 + "IsFactual": true, 3640 + "Limit": 0, 3641 + "Price": 0, 3642 + "PeriodValue": 0, 3643 + "PeriodType": 0 3644 + } 3645 + ] 3646 + } 3647 +] 3648 + 3649 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3650 +|ClientId|Идентификатор клиента 3651 +|Id|Идентификатор тарифного плана 3652 +|OwnerId|Идентификатор клиента-владельца 3653 +|Name|Наименование тарифного плана 3654 +|IsArchived|Признак, определяющий архивный тарифный план 3655 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3656 +|PermissibleBalance|Допустимый баланс 3657 +|DefermentDays|Отсрочка, количество дней 3658 +|Feature|Код услуги 3659 +|IsFactual|Признак, определяющий расчёт по факту 3660 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3661 +|Price|Цена за единицу. 3662 +|PeriodValue|Значение периода. 3663 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3664 + 3665 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3666 + 3667 +(% class="box infomessage" %) 3668 +((( 3669 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3670 +))) 3671 + 3672 +Параметр запроса: **clientId **- идентификатор клиента. 3673 + 3674 +Ответ: 3675 + 3676 +[ 3677 + { 3678 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3679 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3680 + "Name": "string", 3681 + "IsArchived": true, 3682 + "Constraint": { 3683 + "CalculationType": 0, 3684 + "PermissibleBalance": 0, 3685 + "DefermentDays": 0 3686 + }, 3687 + "Features": [ 3688 + { 3689 + "Feature": "string", 3690 + "IsFactual": true, 3691 + "Limit": 0, 3692 + "Price": 0, 3693 + "PeriodValue": 0, 3694 + "PeriodType": 0 3695 + } 3696 + ] 3697 + } 3698 +] 3699 + 3700 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3701 +|ClientId|Идентификатор клиента 3702 +|Id|Идентификатор тарифного плана 3703 +|OwnerId|Идентификатор клиента-владельца 3704 +|Name|Наименование тарифного плана 3705 +|IsArchived|Признак, определяющий архивный тарифный план 3706 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3707 +|PermissibleBalance|Допустимый баланс 3708 +|DefermentDays|Отсрочка, количество дней 3709 +|Feature|Код услуги 3710 +|IsFactual|Признак, определяющий расчёт по факту 3711 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3712 +|Price|Цена за единицу. 3713 +|PeriodValue|Значение периода. 3714 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3715 + 3716 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3717 + 3718 +(% class="box warningmessage" %) 3719 +((( 3720 +**PUT /api/v3/Billing/client/balance** 3721 +))) 3722 + 3723 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3724 + 3725 +Тело запроса: 3726 + 3727 +{ 3728 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3729 + "Balance": 0 3730 +} 3731 + 3732 +Ответ: Success 3733 + 3734 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3735 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3736 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3737 + 3738 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3739 + 3740 +(% class="box warningmessage" %) 3741 +((( 3742 +**PUT /api/v3/billing/client/balance/deposit** 3743 +))) 3744 + 3745 +Создает операцию **Пополнение **с указанной суммой 3746 + 3747 +Тело запроса: 3748 + 3749 +{ 3750 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3751 + "Balance": 0 3752 +} 3753 + 3754 +Ответ: Success 3755 + 3756 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3757 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3758 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3759 + 3760 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3761 + 3762 +Создает операцию **Списание **с указанной суммой 3763 + 3764 +(% class="box warningmessage" %) 3765 +((( 3766 +**PUT /api/v3/billing/client/balance/withdraw** 3767 +))) 3768 + 3769 +Тело запроса: 3770 + 3771 +{ 3772 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3773 + "Balance": 0 3774 +} 3775 + 3776 +Ответ: Success 3777 + 3778 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3779 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3780 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3781 + 3782 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3783 + 3784 +(% class="box warningmessage" %) 3785 +((( 3786 +**PUT /api/v3/Billing/client/constraint** 3787 +))) 3788 + 3789 +Тело запроса: 3790 + 3791 +{ 3792 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3793 + "CalculationType": 0, 3794 + "PermissibleBalance": 0, 3795 + "DefermentDays": 0, 3796 + "SendUiNotifications": true, 3797 + "SendEmailNotifications": true, 3798 + "IsPrivate": true, 3799 +} 3800 + 3801 +Ответ: Success 3802 + 3803 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3804 +|ClientId|Идентификатор клиента 3805 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3806 +|PermissibleBalance|Допустимый баланс 3807 +|DefermentDays|((( 3808 +Отсрочка, количество дней 3809 +))) 3810 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3811 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3812 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3813 + 3814 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3815 + 3816 +(% class="box warningmessage" %) 3817 +((( 3818 +**PUT /api/v3/Billing/client/plan** 3819 +))) 3820 + 3821 +Тело запроса: 3822 + 3823 +{ 3824 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3825 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3826 + "Features": [ 3827 + { 3828 + "Feature": "string", 3829 + "IsEnabled": true, 3830 + "IsFactual": true, 3831 + "Limit": 0, 3832 + "Price": 0, 3833 + "DebitDate": "2023-10-18T13:26:58.987Z", 3834 + "PeriodValue": 0, 3835 + "PeriodType": 0 3836 + } 3837 + ] 3838 +} 3839 + 3840 +Ответ: Success 3841 + 3842 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3843 +|ClientId|Идентификатор клиента 3844 +|PlanId|Идентификатор тарифного плана 3845 +|Feature|Код услуги 3846 +|IsEnabled|Признак, определяющий активирована ли услуга 3847 +|IsFactual|Признак, определяющий расчёт по факту 3848 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3849 +|Price|Цена за единицу. 3850 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3851 +|PeriodValue|Значение периода. 3852 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3853 + 3854 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3855 + 3856 +(% class="box warningmessage" %) 3857 +((( 3858 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3859 +))) 3860 + 3861 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3862 + 3863 +(% class="box infomessage" %) 3864 +((( 3865 +**POST /api/v3/vehicles/import/{agentId}** 3866 +))) 3867 + 3868 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3869 + 3870 +В пути указывается **agentId** - id клиента. 3871 + 3872 +**Заголовок** 3873 + 3874 +**X-Auth: [токен авторизации]** 3875 + 3876 +**Параметры** 3877 + 3878 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3879 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3880 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3881 + 3882 +В теле использовать тип **form-data,** тип значения** file** 3883 + 3884 +**Ключи** 3885 + 3886 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3887 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3888 +|csv|В значении передаем файл датчиков, формат **csv** 3889 + 3890 +Ответ: 3891 + 3892 +{ 3893 + "vehicleId": 0, 3894 + "name": "string", 3895 + "errors": ["string"] 3896 +} 3897 + 3898 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3899 +|vehicleId|ID созданного объекта 3900 +|name|Имя созданного объекта 3901 +|errors|Ошибки и их описание 3902 + 3903 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3904 + 3905 +(% class="box infomessage" %) 3906 +((( 3907 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3908 +))) 3909 + 3910 +(% class="wikigeneratedid" %) 3911 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3912 + 3913 +(% class="wikigeneratedid" %) 3914 +В пути указывается **vehicleId **- id объекта. 3915 + 3916 +**Заголовок** 3917 + 3918 +**X-Auth: [токен авторизации]** 3919 + 3920 +В теле использовать тип **form-data.** 3921 + 3922 +Ключи: 3923 + 3924 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3925 +|**history**|В значении передавать файл с историей 3926 + 3927 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3928 + 3929 +Ответ: 3930 + 3931 +{ 3932 + "results": [ 3933 + { 3934 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3935 + "vehicleId": 0, 3936 + "errors": [ 3937 + "string" 3938 + ], 3939 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 3940 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 3941 + "producedCount": 0, 3942 + "msgCount": 0 3943 + } 3944 + ] 3945 +} 3946 + 3947 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3948 +|results|Результаты импорта в разрезе ТС 3949 +|vehicleGuid|Guid ТС 3950 +|vehicleId|ID ТС 3951 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3952 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 3953 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3954 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 3955 +|msgCount|Кол-во обработанных сообщений всего 3956 + 3957 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3958 + 3959 +(% class="box infomessage" %) 3960 +((( 3961 +**GET /api/v3/vehicles/import/history/status** 3962 +))) 3963 + 3964 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3965 + 3966 +Ответ: 3967 + 3968 +{ 3969 + "activity": true, 3970 + "progress": 0, 3971 + "message": "string" 3972 +} 3973 + 3974 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3975 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3976 +|progress|Guid ТС 3977 + 3978 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3979 + 3980 +(% class="box infomessage" %) 3981 +((( 3982 +**POST /api/v3/vehicles/export** 3983 +))) 3984 + 3985 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3986 + 3987 +Тело запроса: 3988 + 3989 +[ 3990 + id 3991 +] 3992 + 3993 +Ответ: Success 200, получаете файлы с настройками. 3994 + 3995 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3996 + 3997 +(% class="box infomessage" %) 3998 +((( 3999 +**POST /api/v3/vehicles/export/history** 4000 +))) 4001 + 4002 +Метод возвращает список сообщений терминала объекта за выбранный период. 4003 + 4004 +Тело запроса: 4005 + 4006 +{ 4007 + "vehicleId": 0, 4008 + "asArchive": true, 4009 + "from": "2023-09-27T12:17:45.973Z", 4010 + "to": "2023-09-27T12:17:45.973Z" 4011 +} 4012 + 4013 +Ответ: 4014 + 4015 +Получаете файл. Сообщение: Code 200/Success 4016 + 4017 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4018 +|vehicleId|ID объекта 4019 +|asArchive|true - Архивировать файл, False - не архивировать 4020 +|from|Дата и время начала запроса 4021 +|to|Дата и время окончания запроса 4022 + 4023 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4024 + 4025 +(% class="box infomessage" %) 4026 +((( 4027 +**GET /api/v3/vehicles/export/history/status** 4028 +))) 4029 + 4030 +Метод возвращает список сообщений терминала объекта за выбранный период. 4031 + 4032 +Ответ: 4033 + 4034 +{ 4035 + "activity": true, 4036 + "progress": 0, 4037 + "message": "string" 4038 +} 4039 + 4040 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4041 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4042 +|progress|Прогресс экспорта, от 0 до 100% 4043 +|message|Текст описывающий статус 4044 + 4045 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4046 + 4047 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4048 + 4049 +(% class="box infomessage" %) 4050 +((( 4051 +**POST /api/v3/EcoDriving/rating** 4052 +))) 4053 + 4054 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4055 + 4056 +Тело запроса: 4057 + 4058 +{ 4059 + "vehicleIds": [vehicleId], 4060 + "from": "2023-11-22T09:29:48.051Z", 4061 + "to": "2023-11-22T09:29:48.051Z" 4062 +} 4063 + 4064 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4065 +|vehicleIds|Массив ID объектов 4066 +|from|Дата начала запроса 4067 +|to|Дата окончания запроса 4068 + 4069 +Ответ: 4070 + 4071 +{ 4072 + "items": [ 4073 + { 4074 + "from": "2023-11-22T09:29:48.052Z", 4075 + "to": "2023-11-22T09:29:48.052Z", 4076 + "vehicleId": 0, 4077 + "vehicleName": "string", 4078 + "vehicleModel": "string", 4079 + "penalty": 0, 4080 + "score": 0, 4081 + "totalViolations": 0, 4082 + "violationsByType": { 4083 + "overspeedingViolations": 0, 4084 + "accelerationViolations": 0, 4085 + "brakingViolations": 0, 4086 + "turningViolations": 0, 4087 + "dangerousDrivingViolations": 0, 4088 + "sensorViolations": 0 4089 + }, 4090 + "moveTime": 0, 4091 + "mileage": 0, 4092 + "tripsCount": 0, 4093 + "trips": [ 4094 + { 4095 + "penalty": 0, 4096 + "score": 0, 4097 + "violationsCount": 0, 4098 + "violationsByType": { 4099 + "overspeedingViolations": 0, 4100 + "accelerationViolations": 0, 4101 + "brakingViolations": 0, 4102 + "turningViolations": 0, 4103 + "dangerousDrivingViolations": 0, 4104 + "sensorViolations": 0 4105 + }, 4106 + "moveTime": 0, 4107 + "mileage": 0, 4108 + "motohours": 0, 4109 + "maxSpeed": 0, 4110 + "startAddress": "string", 4111 + "endAddress": "string", 4112 + "drivers": [ 4113 + { 4114 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4115 + "driverName": "string", 4116 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4117 + } 4118 + ] 4119 + } 4120 + ] 4121 + } 4122 + ] 4123 +} 4124 + 4125 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4126 +|from|Дата начала запроса 4127 +|to|Дата окончания 4128 +|vehicleId|ID объекта 4129 +|vehicleName|Имя объекта 4130 +|vehicleModel|Модель объекта 4131 +|penalty|Сумма штрафных баллов 4132 +|score|Оценка 4133 +|totalViolations|Суммарное количество нарушений 4134 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4135 +|overspeedingViolations|Превышение скорости 4136 +|accelerationViolations|Ускорение 4137 +|brakingViolations|Торможение 4138 +|turningViolations|Резкий поворот 4139 +|dangerousDrivingViolations|Резкое вождение 4140 +|sensorViolations|Нарушение по датчику 4141 +|moveTime|Время в движении 4142 +|mileage|Пробег 4143 +|tripsCount|Количество рейсов 4144 +|motohours|Моточасы 4145 +|maxSpeed|Максимальная скорость 4146 +|startAddress|Адрес начала рейса 4147 +|endAddress|Адрес окончания рейса 4148 +|drivers|Список водителей, которые были на объекте в течениии рейса 4149 +|driverGuid|Guid водителя 4150 +|driverName|Имя водителя 4151 +|driverRfid|Номер Карты-метки 4152 + 4153 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4154 + 4155 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4156 + 4157 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4158 + 4159 +(% class="box infomessage" %) 4160 +((( 4161 +POST /api/v3/fuelcards/transactions 4162 +))) 4163 + 4164 +Метод запроса: POST 4165 + 4166 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4167 +\\В заголовках запроса: X-Auth: Токен авторизации 4168 + 4169 +Параметры в теле запроса (JSON): 4170 + 4171 +{ 4172 + 4173 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4174 + 4175 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4176 + 4177 + "ids": [ 4178 + 4179 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4180 + 4181 + ], 4182 + 4183 + "timezone": 0 ~/~/Таймзона 4184 + 4185 +} 4186 + 4187 +Ответ: 4188 + 4189 + { 4190 + 4191 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4192 + 4193 + "driver": "string", ~/~/Водители, привязанные к ТК 4194 + 4195 + "object": "string", ~/~/Наименование ТС 4196 + 4197 + "amount": 0, ~/~/Количество топлива 4198 + 4199 + "amountDut": 0, ~/~/Количество по ДУТ 4200 + 4201 + "amountDiff": 0, ~/~/Разница, л 4202 + 4203 + "amountDiffPerc": 0, ~/~/Разница, % 4204 + 4205 + "summa": 0, ~/~/Стоимость, руб 4206 + 4207 + "serviceName": "string", ~/~/Тип топлива 4208 + 4209 + "price": 0, ~/~/Цена за литр, руб 4210 + 4211 + "cardName": "string", ~/~/Наименование ТК 4212 + 4213 + "cardNum": "string", ~/~/Номер ТК 4214 + 4215 + "operator": "string", ~/~/Оператор ТК 4216 + 4217 + "address": "string" ~/~/Адрес АЗС 4218 + 4219 + } 4220 + 4221 + 4222 +==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ==== 4223 + 4224 + 4225 +==== **Получение полных данных о ретрансляторе** ==== 4226 + 4227 +(% class="box infomessage" %) 4228 +((( 4229 +**GET ** **/api/v3/retranslations/{id}** 4230 +))) 4231 + 4232 +Идентификатор запроса: ID 4233 + 4234 + 4235 +Пример ответа: 4236 + 4237 +{ 4238 + 4239 +"description": "", ~/~/ Определяет описание 4240 + 4241 +"subscriberId": "", ~/~/ Подписчик 4242 + 4243 +"protocolType": 0, ~/~/ Тип протокола 4244 + 4245 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4246 + 4247 +"address": "string", ~/~/ Адрес события 4248 + 4249 +"objects": [ ~/~/Объекты для ретрансляции 4250 + 4251 +{ 4252 + 4253 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4254 + 4255 +"name": "", ~/~/ Наименование объекта ретрансляции 4256 + 4257 +"imei": "", ~/~/ IMEI объекта 4258 + 4259 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4260 + 4261 +} 4262 + 4263 + ], 4264 + 4265 +"id": "", ~/~/ идентификатор пользователя 4266 + 4267 +"parentId": "", ~/~/Guid родителя 4268 + 4269 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4270 + 4271 +} 4272 + 4273 + 4274 +==== **Удаление данных ретранслятора** ==== 4275 + 4276 +(% class="box infomessage" %) 4277 +((( 4278 +**DELETE** **/api/v3/retranslations/{id}** 4279 +))) 4280 + 4281 +Параметр запроса: ID 4282 + 4283 + 4284 +==== **Создание ретранслятора** ==== 4285 + 4286 +(% class="box infomessage" %) 4287 +((( 4288 +**POST ** **/api/v3/retranslations/{id}** 4289 +))) 4290 + 4291 +Запрос: 4292 + 4293 + 4294 +{ 4295 + 4296 +"description": "", ~/~/ Описание 4297 + 4298 +"subscriberId": "", ~/~/ Подписчик 4299 + 4300 +"protocolType": 0, ~/~/ Тип протокола 4301 + 4302 +"address": "", ~/~/ Адрес ретрансляции 4303 + 4304 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4305 + 4306 +"objects": [ ~/~/Объекты для ретрансляции 4307 + 4308 +{ 4309 + 4310 +"id": "", ~/~/ идентификатор пользователя 4311 + 4312 +"imei": "", ~/~/IMEI объекта 4313 + 4314 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4315 + 4316 +} 4317 + 4318 + ] 4319 + 4320 +} 4321 + 4322 + 4323 + 4324 +Ответ 4325 + 4326 +{ 4327 + 4328 +"description": "string", ~/~/ Определяет описание 4329 + 4330 +"subscriberId": "", ~/~/ идентификатор запроса 4331 + 4332 +"protocolType": 0, ~/~/ Тип протокола 4333 + 4334 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4335 + 4336 +"address": "", ~/~/ Адрес события 4337 + 4338 +"objects": [ ~/~/Объекты для ретрансляции 4339 + 4340 +{ 4341 + 4342 +"id": "", ~/~/ идентификатор пользователя 4343 + 4344 +"name": "string", ~/~/ Название уведомления 4345 + 4346 +"imei": "string", ~/~/IMEI объекта 4347 + 4348 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4349 + 4350 +} 4351 + 4352 + ], 4353 + 4354 +"id": "", ~/~/ идентификатор пользователя 4355 + 4356 +"parentId": "", ~/~/ Guid идентификатор родителя 4357 + 4358 +"deleted": true ~/~/ Признак удаления 4359 + 4360 +} 4361 + 4362 + 4363 +==== **Редактирование ретранслятора** ==== 4364 + 4365 +(% class="box infomessage" %) 4366 +((( 4367 +**PUT** **/api/v3/retranslations** 4368 +))) 4369 + 4370 +Пример запроса: 4371 + 4372 +{ 4373 + 4374 +"id": "", ~/~/ идентификатор пользователя 4375 + 4376 +"description": "string", ~/~/ Определяет описание 4377 + 4378 +"subscriberId": "", ~/~/ идентификатор запроса 4379 + 4380 +"protocolType": 0, ~/~/ Тип протокола 4381 + 4382 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4383 + 4384 +"address": "string", ~/~/ Адрес события 4385 + 4386 +"objects": ~/~/Объекты для ретрансляции 4387 + 4388 +[ 4389 + 4390 +{ 4391 + 4392 +"id": "", ~/~/ идентификатор пользователя 4393 + 4394 +"imei": "", ~/~/IMEI объекта 4395 + 4396 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4397 + 4398 +} 4399 + 4400 + ] 4401 + 4402 +} 4403 + 4404 + 4405 +Пример ответа: 4406 + 4407 +{ 4408 + 4409 +"description": "", ~/~/ Определяет описание 4410 + 4411 +"subscriberId": "", ~/~/ идентификатор запроса 4412 + 4413 +"protocolType": 0, ~/~/ Тип протокола 4414 + 4415 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4416 + 4417 +"address": "string", ~/~/ Адрес события 4418 + 4419 +"objects": [ ~/~/Объекты для ретрансляции 4420 + 4421 +{ 4422 + 4423 +"id": "", ~/~/ идентификатор пользователя 4424 + 4425 +"name": "string", ~/~/ Название уведомления 4426 + 4427 +"imei": "", ~/~/IMEI объекта 4428 + 4429 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4430 + 4431 +} 4432 + 4433 + ], 4434 + 4435 +"id": "", ~/~/ идентификатор пользователя 4436 + 4437 +"parentId": "", ~/~/ Guid идентификатор родителя 4438 + 4439 +"deleted": true ~/~/ Признак удаления 4440 + 4441 +} 4442 + 4443 + 4444 + 4445 +==== **Получение списка ретранслятора клиента** ==== 4446 + 4447 +(% class="box infomessage" %) 4448 +((( 4449 +**POST /api/v3/retranslations/find** 4450 +))) 4451 + 4452 +Пример запроса: 4453 + 4454 + 4455 +{ 4456 + 4457 +"id": "", ~/~/ идентификатор пользователя 4458 + 4459 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4460 + 4461 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4462 + 4463 +} 4464 + 4465 + 4466 + 4467 +Ответ 4468 + 4469 + 4470 +[ 4471 + 4472 +{ 4473 + 4474 +"description": "", ~/~/ Определяет описание 4475 + 4476 +"subscriberId": "", ~/~/ идентификатор запроса 4477 + 4478 +"protocolType": 0, ~/~/ Тип протокола 4479 + 4480 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4481 + 4482 +"address": "string", ~/~/ Адрес события 4483 + 4484 +"id": "", ~/~/ идентификатор пользователя 4485 + 4486 +"parentId": "", ~/~/ Guid идентификатор родителя 4487 + 4488 +"deleted": true ~/~/ Признак удаления 4489 + 4490 +} 4491 + 4492 +] 4493 + 4494 + 4495 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) = 4496 + 4497 + 4498 +==== **API для отчета по выгрузке комбайнов** ==== 4499 + 4500 + 4501 +(% class="box infomessage" %) 4502 +((( 4503 +POST **/api/v3/Reports/harvesterUnloading** 4504 +))) 4505 + 4506 +Пример запроса: 4507 + 4508 + 4509 +{ 4510 + 4511 + "byTime": 0, ~/~/ Объединение событий по времени 4512 + 4513 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4514 + 4515 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4516 + 4517 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4518 + 4519 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4520 + 4521 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4522 + 4523 + 0 4524 + 4525 + ], 4526 + 4527 + "from": "", ~/~/ Дата и время начало запроса 4528 + 4529 + "to": "", ~/~/ Дата и время окончания запроса 4530 + 4531 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4532 + 4533 +} 4534 + 4535 + 4536 + 4537 +Пример ответа: 4538 + 4539 + 4540 +[ 4541 + 4542 + { 4543 + 4544 + "harvesterName": "", ~/~/Комбайн, номер 4545 + 4546 + "harvesterId": 0, ~/~/Комбайн, id 4547 + 4548 +"harvesterModel": "", ~/~/ Модель комбайна 4549 + 4550 + "hopperCapacity": 0, ~/~/ Объем бункера м3 4551 + 4552 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4553 + 4554 + "events": [ ~/~/Список событий в разрезе комбайна 4555 + 4556 + { 4557 + 4558 + "driverId": "", ~/~/Идентификатор водителя 4559 + 4560 + "driverName": "", ~/~/Водитель комбайна, ФИО 4561 + 4562 + "RFID": "", ~/~/ идентификатор карты-метки 4563 + 4564 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4565 + 4566 + "vehicleId": 0, ~/~/идентификатор объекта 4567 + 4568 + "vehicleName": "string", ~/~/ Имя объекта 4569 + 4570 + "modelName": "string", ~/~/ Имя модели объекта 4571 + 4572 + "nearestVehicles": [ ~/~/Объекты рядом 4573 + 4574 + { 4575 + 4576 + "vehicleId": 0, ~/~/идентификатор объекта 4577 + 4578 + "vehicleName": "string" ~/~/ Имя объекта 4579 + 4580 + } 4581 + 4582 + ], 4583 + 4584 + "fields": [ ~/~/Поля, где происходила выгрузка 4585 + 4586 + { 4587 + 4588 + "id": 0, ~/~/ идентификатор пользователя 4589 + 4590 + "name": "string" ~/~/ имя пользователя 4591 + 4592 + } 4593 + 4594 + ], 4595 + 4596 + "event": "string", ~/~/Событие 4597 + 4598 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4599 + 4600 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4601 + 4602 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4603 + 4604 + "cultureName": "string", ~/~/ название культуры 4605 + 4606 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4607 + 4608 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4609 + 4610 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4611 + 4612 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4613 + 4614 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4615 + 4616 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4617 + 4618 + "issued": 0, ~/~/Выдано, бункеров 4619 + 4620 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4621 + 4622 + "latitude": 0, ~/~/Широта 4623 + 4624 + "longitude": 0, ~/~/ Долгота 4625 + 4626 + "litresAway": 0, ~/~/Отдано, л 4627 + 4628 + "m3Away": 0 ~/~/Отдано, м3 4629 + 4630 + } 4631 + 4632 + ] 4633 + 4634 + } 4635 + 4636 +] 4637 + 4638 + 4639 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4640 + 4641 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4642 + 4643 + 4644 +(% class="box infomessage" %) 4645 +((( 4646 +GET api/v3/Vehicles/recyclebin/all 4647 +))) 4648 + 4649 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4650 + 4651 +Параметр запроса: {parentId} - идентификатор агента 4652 + 4653 +В заголовках запроса: X-Auth: Токен авторизации 4654 + 4655 +Ответ: 4656 + 4657 +[ 4658 + 4659 + { 4660 + 4661 + "recordTime": "", ~/~/Время записи 4662 + 4663 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4664 + 4665 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4666 + 4667 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4668 + 4669 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4670 + 4671 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4672 + 4673 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4674 + 4675 + "items": [ ~/~/ [ 4676 + 4677 +nullable: true ~/~/Детали 4678 + 4679 + { 4680 + 4681 + "name": "string", ~/~/наименование столбца 4682 + 4683 + "value": "string" ~/~/содержание столбца 4684 + 4685 + } 4686 + 4687 + ] 4688 + 4689 + }, 4690 + 4691 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4692 + 4693 + "string" 4694 + 4695 + ] 4696 + 4697 + } 4698 + 4699 +] 4700 + 4701 + 4702 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4703 + 4704 +(% class="box infomessage" %) 4705 +((( 4706 +POST/api/v3/Vehicles/recyclebin/erase 4707 +))) 4708 + 4709 +В заголовках запроса: X-Auth: Токен авторизации 4710 + 4711 +Пример запроса: 4712 + 4713 + 4714 +[ 4715 + 4716 + 0 4717 + 4718 +] 4719 + 4720 + 4721 +Пример ответа: 4722 + 4723 +[ 4724 + 4725 + { 4726 + 4727 + "recordTime": "", ~/~/Время записи 4728 + 4729 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4730 + 4731 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4732 + 4733 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4734 + 4735 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4736 + 4737 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4738 + 4739 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4740 + 4741 + "items": [ ~/~/Детали 4742 + 4743 + { 4744 + 4745 + "name": "", ~/~/Имя свойства 4746 + 4747 + "value": "" ~/~/Значение свойства 4748 + 4749 + } 4750 + 4751 + ] 4752 + 4753 + }, 4754 + 4755 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4756 + 4757 + "" 4758 + 4759 + ] 4760 + 4761 + } 4762 + 4763 +] 4764 + 4765 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4766 + 4767 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4768 + 4769 +(% class="box infomessage" %) 4770 +((( 4771 +POST/api/v3/Vehicles/recyclebin/restore 4772 +))) 4773 + 4774 +В заголовках запроса: X-Auth: Токен авторизации 4775 + 4776 +Параметры в теле запроса (JSON): 4777 + 4778 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4779 + 4780 +В заголовках запроса: X-Auth: Токен авторизации 4781 + 4782 + 4783 +Пример запроса: 4784 + 4785 +[ 4786 + 4787 + 0 4788 + 4789 +] 4790 + 4791 + 4792 +Пример ответа: 4793 + 4794 +[ 4795 + 4796 + { 4797 + 4798 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4799 + 4800 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4801 + 4802 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4803 + 4804 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4805 + 4806 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4807 + 4808 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4809 + 4810 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4811 + 4812 + "items": [ ~/~/Детали 4813 + 4814 + { 4815 + 4816 + "name": "string", ~/~/Имя свойства 4817 + 4818 + "value": "string" ~/~/Значение свойства 4819 + 4820 + } 4821 + 4822 + ] 4823 + 4824 + }, 4825 + 4826 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4827 + 4828 + "string" 4829 + 4830 + ] 4831 + 4832 + } 4833 + 4834 +] 4835 + 4836 + 4837 + 1147 1147 (% class="box" lang="en-US" style="text-align: center;" %) 1148 1148 ((( 1149 1149 (% 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]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content