Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/04/21 14:13
<
>
отредактировано Андрей Калиновский
на 2024/07/19 15:59
на 2024/07/19 15:59
отредактировано Артем Шемяков
на 2022/09/01 17:47
на 2022/09/01 17:47
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Автор документа
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.Artem - Теги
-
... ... @@ -1,1 +1,0 @@ 1 -Public API|API - Содержимое
-
... ... @@ -1,45 +1,39 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 +== Описание ГЛОНАССSoft Public API 3.0 == 3 + 4 +== == 5 + 6 +(% class="box" style="text-align: center;" %) 2 2 ((( 3 -** Содержаниестраницы:**8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 4 4 ))) 5 5 6 - {{toc/}}11 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 7 7 13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 8 8 9 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 10 - 11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 - 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 - 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 + 16 16 17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 +(% class="box" style="text-align: center;" %) 19 +((( 20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 +))) 18 18 19 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 - 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 - 23 -(% class="box successmessage" %) 23 +(% class="box infomessage" %) 24 24 ((( 25 -(% lang="en-US" %)** POST25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %)Метод запроса: ** POST**30 +(% style="color:#000000" %)Метод запроса: **GET** 31 31 32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]] 33 33 34 34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 37 - 38 -(% style="color:#000000" %){ 39 - "login": "testuser", 40 - "password": "testuser" 41 -} 42 - 36 +(% lang="en-US" %) 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) ... ... @@ -46,31 +46,21 @@ 46 46 (% style="color:#000000" %){ 47 47 48 48 (% lang="en-US" %) 49 -(% style="color:#000000" %) "AuthId": " (%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000"%)", ~/~/ токен авторизации50 - "User": " testuser" , ~/~/ имя пользователя43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 + "User": "" , ~/~/ имя пользователя 51 51 52 52 (% lang="en-US" %) 53 -} 47 + } 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 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 - 66 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 67 - 68 68 (% class="box infomessage" %) 69 69 ((( 70 -(% lang="en-US" %)**GET /api/v3/auth/check** 54 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 71 71 ))) 72 72 73 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 74 74 75 75 (% style="color:#000000" %)Метод запроса: **GET** 76 76 ... ... @@ -81,307 +81,59 @@ 81 81 (% lang="en-US" %) 82 82 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 83 83 84 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 85 85 86 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 87 - 88 -(% class="box infomessage" %) 69 +(% class="box" style="text-align: center;" %) 89 89 ((( 90 - **GETapi/v3/agents/{id}**71 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 91 91 ))) 92 92 93 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 94 - 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 151 (% class="box infomessage" %) 152 152 ((( 153 -(% lang="en-US" %)** POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**76 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 154 154 ))) 155 155 156 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочернихклиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителяи т.д.Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 157 157 158 158 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 159 159 160 160 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 161 161 162 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права « __**Доступ к партнёрским клиентам**__».85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 163 163 164 -(% style="color:#000000" %)Метод запроса: ** POST**87 +(% style="color:#000000" %)Метод запроса: **GET** 165 165 166 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 89 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId> 167 167 168 -(% style="color:#000000" %)Параметр запроса: 91 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 169 169 170 -(% style="color:#000000" %){ 171 - "parentId": "string" 172 -} 93 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 173 173 174 174 (% style="color:#000000" %)Ответ: 175 175 176 -{ 177 - "agentId": (%style="color:#000000"%)(%%)178 - "parentId": 179 - "name": string",180 - "fullName": string",181 - "agentInfoType": 0,182 - (%style="color:#000000"%)183 -} 97 +(% style="color:#000000" %){ 98 + "agentId": "", ~/~/ идентификатор клиента 99 + "parentId": "", ~/~/ идентификатор клиента-родителя 100 + "name": "", ~/~/ наименование клиента 101 + "fullName": "", ~/~/ полное наименование клиента 102 + "agentInfoType": "", ~/~/ тип клиента1 103 + "status": "", ~/~/ статус клиента 104 + } 184 184 185 185 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 - Активен 107 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] 193 193 194 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 195 195 196 -(% class="box s uccessmessage" %)110 +(% class="box" style="text-align: center;" %) 197 197 ((( 198 - **POST/api/v3/agents **112 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 199 199 ))) 200 200 201 -Метод позволяет добавить клиента, указанного в запросе. 202 - 203 -Метод запроса: **POST** 204 - 205 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 206 - 207 -В заголовках запроса: X-Auth: Токен авторизации 208 - 209 -Параметры в теле запроса (JSON): 210 - 211 -{ 212 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 213 - "name": "string", ~/~/ имя 214 - "fullName": "string", ~/~/ полное наименование 215 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 216 - "isForeign": true, ~/~/ иностранный контрагент 217 - "district": "string", ~/~/ округ 218 - "region": "string", ~/~/ регион 219 - "city": "string", ~/~/ город 220 - "inn": "string", ~/~/ ИНН 221 - "kpp": "string", ~/~/ КПП 222 - "address": "string", ~/~/ юридический адрес 223 - "addressFact": "string", ~/~/ фактический адрес 224 - "email": "string", ~/~/ email 225 - "director": "string", ~/~/ ФИО руководителя 226 - "bankName": "string", ~/~/ банк 227 - "bankBIK": "string", ~/~/ БИК 228 - "bankRS": "string", ~/~/ номер счёта 229 - "bankKS": "string" ~/~/ корр. счёт 230 -} 231 - 232 - 233 -Ответ: 234 - 235 -{ 236 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 237 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 238 - "name": "string", ~/~/ имя 239 - "fullName": "string", ~/~/ полное наименование 240 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 241 - "isForeign": true, ~/~/ иностранный контрагент 242 - "district": "string", ~/~/ округ 243 - "region": "string", ~/~/ регион 244 - "city": "string", ~/~/ город 245 - "inn": "string", ~/~/ ИНН 246 - "kpp": "string", ~/~/ КПП 247 - "address": "string", ~/~/ юридический адрес 248 - "addressFact": "string", ~/~/ фактический адрес 249 - "email": "string", ~/~/ email 250 - "director": "string", ~/~/ ФИО руководителя 251 - "bankName": "string", ~/~/ банк 252 - "bankBIK": "string", ~/~/ БИК 253 - "bankRS": "string", ~/~/ номер счёта 254 - "bankKS": "string" ~/~/ корр. счёт 255 -} 256 - 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" %)Корр. счет 278 - 279 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 280 - 281 -(% class="box warningmessage" %) 282 -((( 283 -**PUT /api/v3/agents** 284 -))) 285 - 286 -Метод позволяет отредактировать клиента, указанного в запросе. 287 - 288 -Метод запроса: **PUT** 289 - 290 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 291 - 292 -В заголовках запроса: X-Auth: Токен авторизации 293 - 294 -Параметры в теле запроса (JSON): 295 - 296 -{ 297 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 298 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 299 - "name": "string", ~/~/ имя 300 - "fullName": "string", ~/~/ полное наименование 301 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 302 - "isForeign": true, ~/~/ иностранный контрагент 303 - "district": "string", ~/~/ округ 304 - "region": "string", ~/~/ регион 305 - "city": "string", ~/~/ город 306 - "inn": "string", ~/~/ ИНН 307 - "kpp": "string", ~/~/ КПП 308 - "address": "string", ~/~/ юридический адрес 309 - "addressFact": "string", ~/~/ фактический адрес 310 - "email": "string", ~/~/ email 311 - "director": "string", ~/~/ ФИО руководителя 312 - "bankName": "string", ~/~/ банк 313 - "bankBIK": "string", ~/~/ БИК 314 - "bankRS": "string", ~/~/ номер счёта 315 - "bankKS": "string" ~/~/ корр. счёт 316 -} 317 - 318 -Ответ: 319 - 320 -{ 321 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 322 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 323 - "name": "string", ~/~/ имя 324 - "fullName": "string", ~/~/ полное наименование 325 - "isForeign": true, ~/~/ иностранный контрагент 326 - "district": "string", ~/~/ округ 327 - "region": "string", ~/~/ регион 328 - "city": "string", ~/~/ город 329 - "inn": "string", ~/~/ ИНН 330 - "kpp": "string", ~/~/ КПП 331 - "address": "string", ~/~/ юридический адрес 332 - "addressFact": "string", ~/~/ фактический адрес 333 - "email": "string", ~/~/ email 334 - "director": "string", ~/~/ ФИО руководителя 335 - "bankName": "string", ~/~/ банк 336 - "bankBIK": "string", ~/~/ БИК 337 - "bankRS": "string", ~/~/ номер счёта 338 - "bankKS": "string" ~/~/ корр. счёт 339 -} 340 - 341 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 342 - 343 -(% class="box errormessage" %) 344 -((( 345 -**DELETE /api/v3/agents/{clientId}** 346 -))) 347 - 348 -Метод позволяет удалить клиента, указанного в строке запроса. 349 - 350 -Метод запроса: **DELETE** 351 - 352 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 353 - 354 -Параметр запроса: **{clientId}** - Guid пользователя 355 - 356 -В заголовках запроса: X-Auth: Токен авторизации 357 - 358 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 359 - 360 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 361 - 362 -(% class="box warningmessage" %) 363 -((( 364 -**PUT /api/v3/agents/{id}/changeStatus/{status}** 365 -))) 366 - 367 -Метод позволяет изменить статус клиента, указанного в запросе. 368 - 369 -В пути указывается GUID клиента и статус клиента. 370 - 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 - 379 379 (% class="box successmessage" %) 380 380 ((( 381 -(% lang="en-US" %)**POST /api/v3/users** 117 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 382 382 ))) 383 383 384 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 120 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 385 385 386 386 (% style="color:#000000" %)Метод запроса: **POST** 387 387 ... ... @@ -391,55 +391,31 @@ 391 391 392 392 (% style="color:#000000" %)Параметры в теле запроса (JSON): 393 393 394 -(% style="color:#000000" %) 395 -{ 130 +(% style="color:#000000" %){ 396 396 "lastName": "", ~/~/ фамилия 397 397 "firstName": "", ~/~/ имя 398 398 "position": "", ~/~/ должность 399 399 "phone": "", ~/~/ телефон 400 400 "organization": "", ~/~/ организация 401 - "login": "", ~/~/ логин (обязателен) 402 - "password": "", ~/~/ пароль (обязателен) 403 - "email": "", ~/~/ email (обязателен) 404 - "description": "string", ~/~/ Описание 405 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 406 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 407 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 136 + "login": "", ~/~/ логин 137 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 138 + "email": "", ~/~/ email 139 + "description": "", ~/~/ описание 140 + "isEnabled": "", ~/~/ признак включения 408 408 "parentId": "", ~/~/ Guid родительского агента 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 - Азербайджанский 425 -} 142 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 143 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 144 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 145 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 + "groups": "" , ~/~/ группы пользователя, названия групп 148 + } 426 426 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 - 438 438 (% style="text-align:left" %) 439 439 (% style="color:#000000; font-weight:normal" %)Ответ: 440 440 441 441 (% style="text-align:left" %) 442 -(% style="color:#000000; font-weight:normal" %){ 154 +(% style="color:#000000; font-weight:normal" %){ 443 443 444 444 (% style="text-align:left" %) 445 445 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -458,31 +458,27 @@ 458 458 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 459 459 "kind": "" , ~/~/ тип аутентификации 460 460 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 461 - "groups": (% style="color:#000000"%)["",""](% style="color:#000000; font-weight:normal" %),~/~/ ролипользователя,перечислены названия групп173 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 462 462 463 463 (% style="text-align:left" %) 464 -(% style="color:#000000; font-weight:normal" %)} 176 +(% style="color:#000000; font-weight:normal" %) } 465 465 466 466 467 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 468 - 469 -(% class="box infomessage" %) 179 +(% class="box successmessage" %) 470 470 ((( 471 -(% lang="en-US" %)**POST /api/v3/users/find** 181 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 472 472 ))) 473 473 474 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 184 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 475 475 476 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **« __Просмотр пользователей__»**.186 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 477 477 478 478 (% style="color:#000000" %)Метод запроса: **POST** 479 479 480 480 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 481 481 482 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 483 483 484 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 485 - 486 486 (% style="color:#000000" %){ 487 487 488 488 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента ... ... @@ -490,11 +490,11 @@ 490 490 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 491 491 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 492 492 493 -(% style="color:#000000" %)} 201 +(% style="color:#000000" %) } 494 494 495 495 (% style="color:#000000" %)Ответ: 496 496 497 -(% style="color:#000000" %){ 205 +(% style="color:#000000" %){ (%%) 498 498 499 499 "id": "" , ~/~/ идентификатор пользователя 500 500 "lastName": "" , ~/~/ фамилия ... ... @@ -508,70 +508,17 @@ 508 508 "email": "" , ~/~/ E-mail 509 509 "sessionDuration":"", ~/~/ длительность сессии в минутах 510 510 "status": "1", ~/~/ статус пользователя 511 - " lastLogged": "", ~/~/ дата/время последней авторизации219 + "astLogged": "", ~/~/ дата/время последней авторизации 512 512 513 -(% style="color:#000000" %)} 221 +(% style="color:#000000" %) } 514 514 515 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 516 516 517 -(% class="box infomessage" %) 518 -((( 519 -(% lang="en-US" %)**GET /api/v3/users/{GUID}** 520 -))) 521 - 522 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 523 - 524 -(% style="color:#000000" %)Метод запроса: **GET** 525 - 526 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 527 - 528 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 529 - 530 -(% style="color:#000000" %)Ответ: 531 - 532 -((( 533 -((( 534 -{ 535 - "id": "", ~/~/ GUID пользователя 536 - "lastName": "", ~/~/ Фамилия 537 - "firstName": "", ~/~/ Имя 538 - "position": "", ~/~/ Должность 539 - "phone": "", ~/~/ Номер телефона 540 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 541 - "parentName": "", Наименование клиента, которому принадлежит пользователь 542 - "organization": "", ~/~/ Организация 543 - "login": "", ~/~/ Логин пользователя 544 - "email": "", ~/~/ Адрес электронной почты 545 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 546 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 547 - "description": "", ~/~/ Описание 548 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 549 - "doubleAuth": 550 - { 551 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 552 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 553 - }, 554 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 555 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 556 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 557 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 558 - "groups": [], ~/~/ Список ролей пользователя 559 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 560 - "authDevices": [ ], ~/~/ Список авторизованных устройств 561 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 562 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 563 -} 564 -))) 565 -))) 566 - 567 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 568 - 569 569 (% class="box warningmessage" %) 570 570 ((( 571 -(% lang="en-US" %)**PUT /api/v3/users** 226 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 572 572 ))) 573 573 574 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 229 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 575 575 576 576 (% style="color:#000000" %)Метод запроса: **PUT** 577 577 ... ... @@ -583,7 +583,7 @@ 583 583 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 584 584 585 585 (% lang="en-US" style="text-align:left" %) 586 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 587 587 588 588 (% lang="en-US" style="text-align:left" %) 589 589 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -592,35 +592,30 @@ 592 592 "position": "" , ~/~/ должность 593 593 "phone": "" , ~/~/ телефон 594 594 "organization": "" , ~/~/ организация 595 - "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 596 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 597 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 598 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 599 - "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 600 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 250 + "login": "" , ~/~/ логин 251 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 252 + "email": "" , ~/~/ email 253 + "description": "" , ~/~/ описание 601 601 "isEnabled": "" , ~/~/ признак включения 602 602 "parentId": "" , ~/~/ Guid родительского агента 603 603 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 604 604 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 605 - "doubleAuth": 606 - { 607 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 608 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 609 - }, 610 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 258 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 259 + "kind": "" , ~/~/ тип аутентификации 260 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 611 611 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 612 612 613 613 (% lang="en-US" style="text-align:left" %) 614 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 615 615 616 616 (% lang="en-US" style="text-align:left" %) 617 617 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 618 618 619 619 (% lang="en-US" style="text-align:left" %) 620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 621 621 622 622 (% lang="en-US" style="text-align:left" %) 623 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя 624 624 "lastName": "" , ~/~/ фамилия 625 625 "firstName": "" , ~/~/ имя 626 626 "position": "" , ~/~/ должность ... ... @@ -633,32 +633,27 @@ 633 633 "isEnabled": "" , ~/~/ признак включения 634 634 "parentId": "" , ~/~/ Guid родительского агента 635 635 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 636 - "doubleAuth": 637 - { 638 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 639 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 640 - }, 641 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 286 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 287 + "kind": "" , ~/~/ тип аутентификации 642 642 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 643 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя// 644 644 645 645 (% lang="en-US" style="text-align:left" %) 646 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 647 647 648 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 649 649 650 650 (% class="box warningmessage" %) 651 651 ((( 652 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 297 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 653 653 ))) 654 654 655 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 300 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 656 656 657 657 (% style="color:#000000" %)Метод запроса: **PUT** 658 658 659 659 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 660 660 661 -(% style="color:#000000" %)Параметр запроса: { __**id**__} - Guid пользователя306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 662 662 663 663 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 664 664 ... ... @@ -670,84 +670,24 @@ 670 670 "description": "" , ~/~/ описание 671 671 "data": "" , ~/~/ данные, связанные со сменой статуса 672 672 673 -(% style="color:#000000" %)} 318 + (% style="color:#000000" %)} 674 674 675 675 (% style="text-align:left" %) 676 676 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 677 677 678 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 679 679 680 -(% class="box warningmessage" %) 681 -((( 682 -**POST /api/v3/users/disable** 683 -))) 684 - 685 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 686 - 687 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 688 - 689 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 690 - 691 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 692 - 693 - [ 694 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 695 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 696 - ] 697 - 698 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 699 - 700 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 701 - 702 -(% class="box warningmessage" %) 703 -((( 704 -**POST /api/v3/users/enable** 705 -))) 706 - 707 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 708 - 709 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 710 - 711 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 712 - 713 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 714 - 715 - [ 716 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 717 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 718 - ] 719 - 720 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 721 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 722 - 723 -((( 724 -В теле ответа: 725 -{ 726 - "errorMessages": [ 727 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 728 - ], 729 - "users": [ 730 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 731 - ] 732 -} 733 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 734 -"users" - массив id пользователей, которых не удалось включить или отключить. 735 -))) 736 - 737 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 738 - 739 739 (% class="box errormessage" %) 740 740 ((( 741 -(% lang="en-US" %)**DELETE /api/v3/users/{id}** 326 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 742 742 ))) 743 743 744 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 329 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 745 745 746 746 (% style="color:#000000" %)Метод запроса: **DELETE** 747 747 748 748 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 749 749 750 -(% style="color:#000000" %)Параметр запроса: { **__id__**} - Guid пользователя335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 751 751 752 752 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 753 753 ... ... @@ -754,443 +754,52 @@ 754 754 (% style="text-align:left" %) 755 755 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 756 756 757 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 758 758 759 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 760 - 761 -(% class="box infomessage" %) 343 +(% class="box" style="text-align: center;" %) 762 762 ((( 763 -(% l ang="en-US" %)**GET/api/v3/models/{Id}**345 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 764 764 ))) 765 765 766 -Метод возвращает полную информацию о модели объекта. 767 - 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 - 1004 1004 (% class="box infomessage" %) 1005 1005 ((( 1006 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 350 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 1007 1007 ))) 1008 1008 1009 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 353 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 1010 1010 1011 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 355 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 1012 1012 1013 1013 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 1014 1014 1015 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **« __Просмотр заданий на техобслуживание__»**.359 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 1016 1016 1017 1017 (% style="color:#000000" %)Метод запроса: **GET** 1018 1018 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}363 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID> 1020 1020 1021 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__- идентификатор объекта (integer($int32))365 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 1022 1022 1023 1023 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1024 1024 1025 1025 (% style="color:#000000" %)Ответ: 1026 1026 1027 -((( 1028 -{ 1029 - "vehicleId": "", ~/~/ ID объекта 1030 - "name": "", ~/~/ Имя объекта 1031 - "imei": "", ~/~/ IMEI объекта 1032 - "deviceTypeId": , ~/~/ ID типа устройства 1033 - "deviceTypeName": "", ~/~/ Название типа устройства 1034 - "sim1": "", ~/~/ Номер SIM1 1035 - "sim2": "", ~/~/ Номер SIM2 371 +(% style="color:#000000" %){ 1036 1036 1037 - "parentId": "", ~/~/ ID клиента-родителя 1038 - "parentName": "", ~/~/ Наименование клиента-родителя 1039 - "modelId": "", ~/~/ ID модели объекта 1040 - "modelName": "", ~/~/ Имя модели объекта 373 + "vehicleId": "" , ~/~/ идентификатор объекта 374 + "name": "" , ~/~/ имя объекта 375 + "imei": "" , ~/~/ IMEI объекта 376 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 377 + "deviceTypeName": "" , ~/~/ наименование устройства объекта 378 + "parentId": "" , ~/~/ идентификатор клиента-родителя 379 + "parentName": "" , ~/~/ наименование клиента-родителя, 380 + "modelId": "" , ~/~/ идентификатор модели объекта 381 + "modelName": "" , ~/~/ наименование модели объекта, 382 + "unitId": "" , ~/~/ идентификатор подразделения 383 + "unitName": "" , ~/~/ наименование подразделения 384 + "status": "" , ~/~/ статус объекта 1041 1041 1042 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1043 - "unitName": "string", ~/~/ Наименование подразделения 1044 - "status": 0, ~/~/ Статус объекта 1045 - 1046 - "createdAt": "", ~/~/ Дата создания объекта 1047 - }, 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 1057 } 1058 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 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1144 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1145 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1146 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1147 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1148 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1149 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1150 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1151 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1152 -~/~/ "ValueOn": "Вкл.", 1153 -~/~/ "ValueOff": "Выкл." 1154 - "summaryMaxValue": 0 ~/~/ Макс. значение 1155 - } 1156 - "drivers": [ ~/~/ Водители 1157 - { 1158 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1159 - "name": "string", ~/~/ Наименование 1160 - "description": "string", 1161 - "isDefault": true ~/~/ По умолчанию 1162 - } 1163 - ], 1164 - 1165 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1166 - { 1167 - "id": "", ~/~/ ID задания 1168 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 1169 - "name": "", ~/~/ Наименование задания 1170 - "description": "", ~/~/ Описание задания 1171 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1172 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1173 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1174 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1175 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1176 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1177 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 1178 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1179 - } 1180 - ], 1181 - 1182 - "statusHistory": [ ~/~/ История статусов 1183 - { 1184 - "status": 0, 1185 - "date": "2023-05-22T09:57:39.562Z", 1186 - "description": "string", 1187 - "additionalInfo": "string" 1188 - } 1189 - ] 1190 - 1191 -} 1192 -))) 1193 - 1194 1194 (% style="text-align:left" %) 1195 1195 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1196 1196 ... ... @@ -1198,65 +1198,12 @@ 1198 1198 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1199 1199 1200 1200 1201 -== **Получить ответ на отправленную на ТС команду** == 1202 - 1203 -(% class="box infomessage" %) 1204 -((( 1205 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1206 -))) 1207 - 1208 -Идентификатор команды: cmdid 1209 - 1210 -Запрос от терминала на ответ команды 1211 - 1212 -Пример ответ от терминала: 1213 - 1214 -ID= "" ~/~/ идентификатор произвольного поля 1215 -Soft="" ~/~/ версия софта 1216 -GPS=4 ~/~/ тип трекера 1217 -Time=11:05:43 28.06.24 ~/~/ время запроса 1218 -Lat=45.056221 ~/~/ широта 1219 -Lon=39.035938 ~/~/ долгота 1220 -Speed=0.0 ~/~/ скорость 1221 -Course=181.4 ~/~/направление 1222 - 1223 -((( 1224 -== **Список отправленных объекту команд с ответами** == 1225 - 1226 -(% class="box infomessage" %) 1227 -((( 1228 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1229 -))) 1230 - 1231 -Идентификатор ТС: vehicleId 1232 - 1233 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1234 - 1235 -Пример ответа терминала 1236 - 1237 -[ 1238 -{ 1239 -"id": "", ~/~/ идентификатор пользователя 1240 -"commandText": "", ~/~/Текст команды. 1241 -"templateId": "", ~/~/Идентификатор шаблона 1242 -"updated": "", ~/~/ Время отправки 1243 -"tryCount": 0, ~/~/ Количество попыток отправки команды 1244 -"answer": "", ~/~/ Ответ терминала. 1245 -"status": "" ~/~/ Статус отправки 1246 -} 1247 -] 1248 - 1249 - 1250 -))) 1251 - 1252 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1253 - 1254 1254 (% class="box successmessage" %) 1255 1255 ((( 1256 -(% lang="en-US" %)**POST /api/v3/vehicles** 397 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 1257 1257 ))) 1258 1258 1259 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 400 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**). 1260 1260 1261 1261 (% style="color:#000000" %)Метод запроса: **POST** 1262 1262 ... ... @@ -1264,226 +1264,118 @@ 1264 1264 1265 1265 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1266 1266 1267 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 408 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 1268 1268 1269 -(% style="color:#000000" %){ 1270 - 1271 - "parentId": "" , ~/~/ ID клиента 1272 - "name": "" , ~/~/ имя ТС 1273 - "imei": "" , ~/~/ IMEI 1274 - "deviceTypeId": "" , ~/~/ ID типа устройства 1275 - "modelId": "" , ~/~/ ID модели 1276 - "unitId": "" , ~/~/ ID подразделения 1277 - "sim1": "" , ~/~/ Номер SIM 1 1278 - "sim2": "" , ~/~/ Номер SIM2 1279 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1280 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1281 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1282 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1283 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1284 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1285 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1286 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1287 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1288 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1289 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1290 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1291 - 1292 - "mileageCalcMethod": 0, 1293 - "mileageCoeff": 0, 1294 - "locationByCellId": true, 1295 - "dottedLineTrackWhenNoCoords": true, 1296 - "counters": ~/~/ счетчики 1297 - { 1298 - "mileage": "" , ~/~/ пробег 1299 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1300 - "motohours": "" , ~/~/ моточасы 1301 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 410 +(% class="western" %) 411 +{{{ "parentId": "", // ID клиента 412 + "name": "", // имя ТС 413 + "imei": "", // IMEI 414 + "deviceTypeId": "",// ID типа устройства 415 + "modelId": "", 416 + "unitId": "", // ID подразделения 417 + "sim1": "", // Номер SIM 1 418 + "sim2": "", // Номер SIM2 419 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 420 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 421 + "consumptionIdle": "",// Расход топлива на холостом ходу 422 + "counters": { 423 + "mileage": "", // пробег 424 + "mileageEnabled": true, // флаг активности счётчика "пробег" 425 + "motohours":"", // моточасы 426 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 427 + }, 428 + "cmsv6Parameters": { // параметры CMSv6 429 + "enabled": true, // флаг включения 430 + //"id": "", // идентификатор 431 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 432 + "login": "", // имя учетной записи 433 + "password": "" // пароль учетной записи 1302 1302 }, 1303 - "cmsv6Parameters": { ~/~/ параметры CMSv6 1304 - "enabled": true, ~/~/ флаг включения 1305 - "id": "" , ~/~/ идентификатор 1306 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1307 - "login": "" , ~/~/ имя учетной записи 1308 - "password": "" ~/~/ пароль учетной записи 1309 - }, 1310 - "inspectionTasks": ~/~/ задания на ТО 435 + "inspectionTasks": [ // задания на ТО 1311 1311 { 1312 - "enabled": "" , ~/~/ Признак включения 1313 - "name": "" , ~/~/ Имя задания 1314 - "description": "" , ~/~/ Описание задания 1315 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1316 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1317 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1318 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1319 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1320 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1321 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1322 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1323 - } 1324 - 1325 -"drivers": [ ~/~/ Водители 1326 - { 1327 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1328 - "isDefault": true 1329 - } 1330 - ], 1331 - "commandTemplates": [ ~/~/ Шаблон команды 1332 - { 1333 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1334 - "name": "string", 1335 - "command": "string", 1336 - "retries": 0 1337 - } 1338 - ], 1339 - 1340 - "sensors": [ ~/~/ Датчики 1341 - { 1342 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1343 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1344 - "type": 0, ~/~/ Тип датчика 1345 - "name": "string", ~/~/ Имя датчика 1346 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1347 - "inputNumber": 0, ~/~/ Номер входа 1348 - "pseudonym": "string", ~/~/ Псевдоним 1349 - "medianDegree": 0, ~/~/ Медианная фильтрация 1350 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1351 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1352 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1353 - "gradesTables": [ ~/~/ Массив таблиц тарировки 1354 - { 1355 - "grades": [ ~/~/ Таблица тарировки 1 1356 - { 1357 - "input": 0, ~/~/ Входящее значение 1358 - "output": 0 ~/~/ Выходящее значение 1359 - } 1360 - ], 1361 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1362 - } 1363 - ], 1364 - "showInTooltip": true, ~/~/ Отображать в подсказке 1365 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 1366 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1367 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1368 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1369 - "expr": "string", ~/~/ Формула 1370 - "children": [ ~/~/ массив дочерних датчиков 1371 - "string" 1372 - ], 1373 - "customParams": { ~/~/ прочие произвольные параметры 1374 - "additionalProp1": "string", 1375 - "additionalProp2": "string", 1376 - "additionalProp3": "string" 437 + "enabled": "", // Признак включения 438 + "name": "", // Имя задания 439 + "description": "", // Описание задания 440 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 441 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 442 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 443 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 444 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 445 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 446 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 447 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 1377 1377 }, 449 + ]}}} 1378 1378 1379 - ~/~/Характерныедляпроизвольного:451 +(% style="color:#000000" %)… } 1380 1380 1381 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1382 - 1383 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1384 - 1385 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1386 - 1387 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1388 - 1389 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1390 - 1391 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1392 - 1393 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1394 - 1395 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1396 - 1397 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1398 - 1399 -~/~/ "ValueOn": "Вкл.", 1400 - 1401 -~/~/ "ValueOff": "Выкл." 1402 - "summaryMaxValue": 0 ~/~/ Макс. значение 1403 - } 1404 - ], 1405 - "customFields": [ ~/~/ Произвольные поля 1406 - { 1407 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1408 - "name": "string", 1409 - "value": "string", 1410 - "forClient": true, 1411 - "forTooltip": true, 1412 - "forReport": true 1413 - } 1414 - ] 1415 -} 1416 - 1417 1417 (% style="color:#000000" %)Ответ: 1418 1418 1419 1419 (% style="color:#000000" %){ 1420 1420 1421 - "vehicleId": "", ~/~/ID ТС 1422 - "parentId": "", ~/~/Guid владельца ТС 1423 - "name": "", ~/~/Имя объекта 1424 - "imei": "", ~/~/IMEI 1425 - "deviceTypeId": "", ~/~/ID типа устройства 1426 - "modelId": "", ~/~/ID модели 1427 - "unitId": "", ~/~/ID подразделения 1428 - "sim1": "", ~/~/SIM1 1429 - "sim2": "", ~/~/SIM2 1430 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1431 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1432 - "counters": { ~/~/Счётчики 1433 - "mileageEnabled": true, 1434 - "motohoursEnabled": true, 1435 - "mileage": "", 1436 - "motohours": 345.0 1437 - }, 1438 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1439 - "id": null, 1440 - "enabled": true, ~/~/флаг включения 1441 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1442 - "login": "", ~/~/ имя учетной записи 1443 - "password": "" ~/~/ пароль учетной записи 1444 - }, 1445 - "inspectionTasks": { ~/~/ задания на ТО 1446 - "id": "", ~/~/ ID задачи 1447 - "enabled": false, ~/~/ Признак включения 1448 - "name": "", ~/~/ Имя задания 1449 - "description": "", ~/~/ Описание задания 1450 - "mileageCondition": "", ~/~/ Условие по пробегу 1451 - "lastMileage": "", ~/~/ Пробег (в метрах) 1452 - "motohoursCondition": "", ~/~/ Условие по моточасам 1453 - "lastMotohours": "", ~/~/ Моточасы 1454 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1455 - "kind": "", ~/~/ Вид периодичности по времени 1456 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1457 - } 457 +(% class="western" %) 458 +{{{ "vehicleId": "", //ID ТС 459 + "parentId": "", //Guid владельца ТС 460 + "name": "", //Имя объекта 461 + "imei": "", //IMEI 462 + "deviceTypeId": "", //ID типа устройства 463 + "modelId": "", //ID модели 464 + "unitId": "", //ID подразделения 465 + "sim1": "", //SIM1 466 + "sim2": "", //SIM2 467 + "consumptionPer100Km": "", //Расход топлива на 100 км 468 + "consumptionIdle": "", //Расход топлива на холостом ходу 469 + "counters": { //Счётчики 470 + "mileageEnabled": true, 471 + "motohoursEnabled": true, 472 + "mileage": "", 473 + "motohours": 345.0 474 + }, 475 + "cmsv6Parameters": { //Параметры CmsV6 476 + "id": null, 477 + "enabled": true, //флаг включения 478 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 479 + "login": "", // имя учетной записи 480 + "password": "" // пароль учетной записи 481 + }, 482 + "inspectionTasks": [ // задания на ТО 483 + { 484 + "id": "", // ID задачи 485 + "enabled": false, // Признак включения 486 + "name": "", // Имя задания 487 + "description": "", // Описание задания 488 + "mileageCondition": "", // Условие по пробегу 489 + "lastMileage": "", // Пробег (в метрах) 490 + "motohoursCondition": "", // Условие по моточасам 491 + "lastMotohours": "", // Моточасы 492 + "periodicCondition": "", // Условие периодичности по времени 493 + "kind": "", // Вид периодичности по времени 494 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 495 + } 496 + ]}}} 1458 1458 1459 1459 (% style="text-align:left" %) 1460 1460 (% style="color:#000000" %)} 1461 1461 1462 -**Валидация:** 1463 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1464 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1465 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1466 1466 1467 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1468 - 1469 -(% class="box infomessage" %) 502 +(% class="box successmessage" %) 1470 1470 ((( 1471 -(% lang="en-US" %)**POST /api/v3/vehicles/find** 504 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** 1472 1472 ))) 1473 1473 1474 -(% style="color:#000000" %)Метод позволяет получить список доступныхобъектовмониторинга (транспортных средств)с их основнымипараметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).507 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1475 1475 1476 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 509 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 1477 1477 1478 1478 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 1479 1479 1480 1480 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 1481 1481 1482 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»**или**«__Видимость объектов заблокированных договоров в мониторинге__»**;515 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 1483 1483 1484 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;517 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 1485 1485 1486 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.519 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 1487 1487 1488 1488 (% style="color:#000000" %)Метод запроса: **POST** 1489 1489 ... ... @@ -1491,133 +1491,78 @@ 1491 1491 1492 1492 (% style="color:#000000" %)В заголовках запроса: 1493 1493 1494 -(% style="color:#000000" %)− Content-Type: __**application/json**__527 +(% style="color:#000000" %)− Content-Type: application/json 1495 1495 1496 1496 (% style="color:#000000" %)− X-Auth: Токен авторизации 1497 1497 1498 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 531 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 1499 1499 1500 -(% style="color:#000000" %) Параметрывтелезапроса (JSON):533 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",## 1501 1501 1502 -{ 1503 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1504 - "name": null, ~/~/ Имя ТС (string, опционально) 1505 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1506 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1507 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1508 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1509 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1510 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1511 -} 535 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 1512 1512 1513 -(% style="color:#000000" %) Фильтрацияосуществляетсяпоточному совпадению значений параметров«__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__»,«__**unitId**__»,ипочастичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра«__**sim**__»осуществляетсяприналичии у авторизованного пользователя права **«__Просмотрномеровтелефоновобъектов__»**.537 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 1514 1514 1515 -(% style="color:#000000" %) Ответ:539 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 1516 1516 1517 -(% style="color:#000000" %) {541 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 1518 1518 1519 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1520 - "name": "" ~/~/ наименование объекта 1521 - "imei": "" ~/~/ IMEI объекта 1522 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 1523 - "deviceTypeName": "" ~/~/ наименование типа устройства 1524 - "sim1": "" ~/~/ первый номер телефона 1525 - "sim2": "" ~/~/ второй номер телефона 1526 - "parentId": "" ~/~/ идентификатор клиента-родителя 1527 - "parentName": "" ~/~/ наименование клиента-родителя 1528 - "modelId": "" ~/~/ идентификатор модели объекта 1529 - "modelName": "" ~/~/ наименование модели объекта 1530 - "unitId": "" ~/~/ идентификатор подразделения 1531 - "unitName": "" ~/~/ наименование подразделения 1532 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1533 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1534 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1535 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1536 - "customFields": [ 1537 - { 1538 - "id": "", ~/~/ идентификатор произвольного поля 1539 - "name": "", ~/~/ имя произвольного поля 1540 - "value": "", ~/~/ значение произвольного поля 1541 - "forClient": true, ~/~/ право на отображение у клиента 1542 - "forTooltip": false, ~/~/ право на отображение в подсказке 1543 - "forReport": false ~/~/ право на отображение в отчетах 1544 - }(%%) 1545 -(% style="color:#000000" %)} 543 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 1546 1546 1547 -(% style="color:#000000" %) Параметры « __**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.545 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1548 1548 1549 - == (% style="color:#000000;font-size:16px"%)**Изменениестатуса объекта**(%%) ==547 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1550 1550 549 + 1551 1551 (% class="box successmessage" %) 1552 1552 ((( 1553 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 552 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 1554 1554 ))) 1555 1555 1556 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 555 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1557 1557 1558 1558 (% style="color:#000000" %)Метод запроса: **POST** 1559 1559 1560 1560 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId} 1561 1561 1562 -(% style="color:#000000" %)Параметр запроса: { __**vehicleId**__} - ID ТС561 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 1563 1563 1564 1564 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1565 1565 1566 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 565 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { 1567 1567 1568 -(% style="color:#000000" %){ 567 +(% class="western" %) 568 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 569 + // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 570 + // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 571 + "date": "", // Дата смены статуса (null если сменить немедленно) 572 + "description": "", // Описание 573 + "data": "", // Данные 574 + "overwrite": false, // Флаг перезаписи 575 + "stage": "", // Состояние, может быть null}}} 1569 1569 1570 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1571 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1572 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1573 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1574 - "description": "", ~/~/ Описание 1575 - "data": "", ~/~/ Данные 1576 - "overwrite": false, ~/~/ Флаг перезаписи 1577 - "stage": "", ~/~/ Состояние, может быть null 1578 - 1579 1579 (% style="color:#000000" %)} 1580 1580 1581 -(% style="color:#000000" %)Ответ: 579 +(% style="color:#000000" %)Ответ: { 1582 1582 1583 -(% style="color:#000000" %){ 581 +(% class="western" %) 582 +{{{ "status": "", // значение статуса 583 + "date": "", // Дата смены статуса 584 + "description": "", // Описание 585 + "data": "", // Данные 586 + "overwrite": false, // Флаг перезаписи 587 + "stage": "", // Состояние}}} 1584 1584 1585 - "status": "", ~/~/ значение статуса 1586 - "date": "", ~/~/ Дата смены статуса 1587 - "description": "", ~/~/ Описание 1588 - "data": "", ~/~/ Данные 1589 - "overwrite": false, ~/~/ Флаг перезаписи 1590 - "stage": "", ~/~/ Состояние 1591 - 1592 1592 (% style="text-align:left" %) 1593 -(% style="color:#000000" %) 590 +(% style="color:#000000" %)} 1594 1594 1595 -(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1596 -**Отправить команду на терминал** 1597 1597 1598 -(% class="box successmessage" %) 1599 -((( 1600 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1601 -))) 1602 - 1603 -Команда для отправки на тс. 1604 - 1605 -{ 1606 -"id": "", ~/~/идентификатор произвольного поля 1607 -"command": "", ~/~/ Текст команды 1608 -"retries": "", ~/~/ Количество попыток 1609 -"idTemplate": "" ~/~/ ID шаблона команды 1610 -} 1611 - 1612 - 1613 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1614 - 1615 1615 (% class="box warningmessage" %) 1616 1616 ((( 1617 -(% lang="en-US" %)**PUT /api/v3/vehicles** 595 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 1618 1618 ))) 1619 1619 1620 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 598 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1621 1621 1622 1622 (% style="color:#000000" %)Метод запроса: **PUT** 1623 1623 ... ... @@ -1627,223 +1627,26 @@ 1627 1627 1628 1628 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1629 1629 1630 -(% style="color:#000000" %){ 1631 - "vehicleId": , ~/~/ ID объекта 1632 - "parentId": "" , ~/~/ ID клиента 1633 - "name": "" , ~/~/ имя ТС 1634 - "imei": "" , ~/~/ IMEI 1635 - "deviceTypeId": "" , ~/~/ ID типа устройства 1636 - "modelId": "" , ~/~/ ID модели 1637 - "unitId": "" , ~/~/ ID подразделения 1638 - "sim1": "" , ~/~/ Номер SIM 1 1639 - "sim2": "" , ~/~/ Номер SIM2 1640 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1641 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1642 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1643 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1644 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1645 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1646 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1647 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1648 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1649 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1650 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1651 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 608 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 1652 1652 1653 - "mileageCalcMethod": 0, 1654 - "mileageCoeff": 0, 1655 - "locationByCellId": true, 1656 - "dottedLineTrackWhenNoCoords": true, 1657 - "counters": ~/~/ счетчики 1658 - { 1659 - "mileage": "" , ~/~/ пробег 1660 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1661 - "motohours": "" , ~/~/ моточасы 1662 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1663 - }, 1664 - "cmsv6Parameters": { ~/~/ параметры CMSv6 1665 - "enabled": true, ~/~/ флаг включения 1666 - "id": "" , ~/~/ идентификатор 1667 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1668 - "login": "" , ~/~/ имя учетной записи 1669 - "password": "" ~/~/ пароль учетной записи 1670 - }, 1671 - "inspectionTasks": ~/~/ задания на ТО 1672 - { 1673 - "enabled": "" , ~/~/ Признак включения 1674 - "name": "" , ~/~/ Имя задания 1675 - "description": "" , ~/~/ Описание задания 1676 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1677 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1678 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1679 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1680 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1681 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1682 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1683 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1684 - } 1685 - 1686 -"drivers": [ ~/~/ Водители 1687 - { 1688 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1689 - "isDefault": true 1690 - } 1691 - ], 1692 - "commandTemplates": [ ~/~/ Шаблон команды 1693 - { 1694 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1695 - "name": "string", 1696 - "command": "string", 1697 - "retries": 0 1698 - } 1699 - ], 1700 - 1701 - "sensors": [ ~/~/ Датчики 1702 - { 1703 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1704 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1705 - "type": 0, ~/~/ Тип датчика 1706 - "name": "string", ~/~/ Имя датчика 1707 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1708 - "inputNumber": 0, ~/~/ Номер входа 1709 - "pseudonym": "string", ~/~/ Псевдоним 1710 - "medianDegree": 0, ~/~/ Медианная фильтрация 1711 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1712 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1713 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1714 - "gradesTables": [ ~/~/ Массив таблиц тарировки 1715 - { 1716 - "grades": [ ~/~/ Таблица тарировки 1 1717 - { 1718 - "input": 0, ~/~/ Входящее значение 1719 - "output": 0 ~/~/ Выходящее значение 1720 - } 1721 - ], 1722 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1723 - } 1724 - ], 1725 - "showInTooltip": true, ~/~/ Отображать в подсказке 1726 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 1727 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1728 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1729 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1730 - "expr": "string", ~/~/ Формула 1731 - "children": [ ~/~/ массив дочерних датчиков 1732 - "string" 1733 - ], 1734 - "customParams": { ~/~/ прочие произвольные параметры 1735 - "additionalProp1": "string", 1736 - "additionalProp2": "string", 1737 - "additionalProp3": "string" 1738 - }, 1739 - 1740 -~/~/ Характерные для произвольного: 1741 - 1742 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1743 - 1744 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1745 - 1746 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1747 - 1748 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1749 - 1750 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1751 - 1752 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1753 - 1754 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1755 - 1756 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1757 - 1758 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1759 - 1760 -~/~/ "ValueOn": "Вкл.", 1761 - 1762 -~/~/ "ValueOff": "Выкл." 1763 - "summaryMaxValue": 0 ~/~/ Макс. значение 1764 - } 1765 - ], 1766 - "customFields": [ ~/~/ Произвольные поля 1767 - { 1768 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1769 - "name": "string", 1770 - "value": "string", 1771 - "forClient": true, 1772 - "forTooltip": true, 1773 - "forReport": true 1774 - } 1775 - ] 1776 -} 1777 - 1778 1778 (% style="color:#000000" %)Ответ: 1779 1779 1780 1780 (% lang="en-US" style="text-align:left" %) 1781 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 613 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 1782 1782 1783 -(% lang="en-US" style="text-align:left" %) 1784 - "vehicleId": "", ~/~/ ID ТС 1785 - "parentId": "", ~/~/ ID клиента 1786 - "name": "", ~/~/ имя ТС 1787 - "imei": "", ~/~/ IMEI 1788 - "deviceTypeId": "", ~/~/ типа устройства 1789 - "modelId": "", ~/~/ ID модели 1790 - "unitId": "", ~/~/ ID подразделения 1791 - "sim1": "", ~/~/ SIM 1 1792 - "sim2": "", ~/~/ SIM2 1793 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1794 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1795 - "counters": 1796 - { 1797 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1798 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1799 - "mileage": "", ~/~/ пробег 1800 - "motohours": "", ~/~/ моточасы 1801 - } 1802 - "cmsv6Parameters": ~/~/ параметры CMSv6 1803 - { 1804 - "id": ~/~/ идентификатор 1805 - "enabled": true, ~/~/ флаг включения 1806 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1807 - "login": "", ~/~/ имя учетной записи 1808 - "password": "", ~/~/ пароль учетной записи 1809 - } 1810 - "inspectionTasks": ~/~/ задания на ТО 1811 - { 1812 - "id": "", ~/~/ ID задания 1813 - "enabled": false, ~/~/ Признак включения 1814 - "name": "", ~/~/ Имя задания 1815 - "description": "", ~/~/ Описание задания 1816 - "mileageCondition": "", ~/~/ Условие по пробегу 1817 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1818 - "motohoursCondition": "", ~/~/ Условие по моточасам 1819 - "lastMotohours": "", ~/~/ Моточасы 1820 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1821 - "kind": "", ~/~/ Вид периодичности по времени 1822 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1823 - } 1824 1824 1825 -(% lang="en-US" style="text-align:left" %) 1826 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1827 - 1828 -**Валидация:** 1829 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1830 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1831 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1832 - 1833 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1834 - 1835 1835 (% class="box errormessage" %) 1836 1836 ((( 1837 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 618 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1838 1838 ))) 1839 1839 1840 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 621 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1841 1841 1842 1842 (% style="color:#000000" %)Метод запроса: **DELETE** 1843 1843 1844 1844 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 1845 1845 1846 -(% style="color:#000000" %)Параметр запроса: { __**id**__} - Guid объекта627 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 1847 1847 1848 1848 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1849 1849 ... ... @@ -1850,2665 +1850,70 @@ 1850 1850 (% style="text-align:left" %) 1851 1851 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1852 1852 1853 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1854 1854 1855 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1856 - 1857 -(% class="box infomessage" %) 635 +(% class="box" lang="en-US" style="text-align: center;" %) 1858 1858 ((( 1859 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**637 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 1860 1860 ))) 1861 1861 1862 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1863 - 1864 -(% style="color:#000000" %)Метод запроса: **GET** 1865 - 1866 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1867 - 1868 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1869 - 1870 -(% style="color:#000000" %)Ответ: 1871 - 1872 -(% style="color:#000000" %){ 1873 - 1874 - "deviceTypeId" : "", ~/~/ ID типа устройства 1875 - "deviceTypeName" : "" ~/~/ Название типа устройства 1876 - 1877 -(% style="text-align:left" %) 1878 -(% style="color:#000000" %)} 1879 - 1880 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1881 - 1882 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1883 - 1884 1884 (% class="box infomessage" %) 1885 1885 ((( 1886 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/ sensors/types**642 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 1887 1887 ))) 1888 1888 1889 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типахдатчиков с учетом настроек авторизованного пользователя, указанного в запросе.645 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1890 1890 1891 1891 (% style="color:#000000" %)Метод запроса: **GET** 1892 1892 1893 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/se nsors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]649 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1894 1894 1895 1895 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1896 1896 1897 -(% style="color:#000000" %)Ответ: 653 +(% style="color:#000000" %)Ответ: [ 1898 1898 1899 -(% style="color:#000000" %){(%%)1900 - "id": "", ~/~/ ID типа датчика1901 - " name": "",~/~/Название1902 - "de scription": "",~/~/Описание1903 - (%style="color:#000000"%)}655 +(% class="western" %) 656 +{{{ { 657 + "deviceTypeId" : "", // ID типа устройства 658 + "deviceTypeName" : "" // Название типа устройства 659 + },}}} 1904 1904 1905 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1906 - 1907 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1908 - 1909 -(% class="box infomessage" style="text-align: left;" %) 1910 -((( 1911 -**POST /api/v3/terminalMessages/count** 1912 -))) 1913 - 1914 -(% style="text-align: left;" %) 1915 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1916 - 1917 -(% style="text-align: left;" %) 1918 -Метод запроса **POST** 1919 - 1920 -(% style="text-align: left;" %) 1921 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1922 - 1923 -(% style="text-align: left;" %) 1924 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1925 - 1926 -(% style="text-align: left;" %) 1927 -{ 1928 - "vehicleIds": [ 1929 - id ~/~/ здесь передается список идентификаторов объектов 1930 - ], 1931 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1932 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1933 -} 1934 - 1935 -(% style="text-align: left;" %) 1936 -Ответ: 1937 - 1938 -(% style="text-align: left;" %) 1939 -[ 1940 - { 1941 - "vehicleId": 0, ~/~/ идентификатор объекта 1942 - "count": 0 ~/~/ количество сообщений за период 1943 - } 1944 -] 1945 - 1946 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1947 - 1948 -(% class="box infomessage" style="text-align: left;" %) 1949 -((( 1950 -**POST /api/v3/terminalMessages/mapping** 1951 -))) 1952 - 1953 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1954 - 1955 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1956 - 1957 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1958 - 1959 -{ 1960 - "protocolType": 0, 1961 - "params": ["string"] 1962 -} 1963 - 1964 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1965 -|protocolType|ID типа протокола 1966 -|params|((( 1967 -Массив наименований параметров в сообщении 1968 -))) 1969 - 1970 -Ответ: 1971 - 1972 -{ 1973 - "protocolType": 0, 1974 - "mapping": { 1975 - "additionalProp1": { 1976 - "inputType": 0, 1977 - "inputNumber": 0 1978 - }, 1979 - "additionalProp2": { 1980 - "inputType": 0, 1981 - "inputNumber": 0 1982 - } 1983 - } 1984 -} 1985 - 1986 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1987 -|protocolType|Тип протокола 1988 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1989 -|inputNumber|((( 1990 -Номер входа 1991 -))) 1992 - 1993 -(% class="wikigeneratedid" %) 1994 -Перечень 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/]] 1995 - 1996 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1997 - 1998 -(% class="box infomessage" %) 1999 -((( 2000 -**POST /api/v3/terminalMessages** 2001 -))) 2002 - 2003 -Метод возвращает список сообщений терминала объекта за выбранный период. 2004 - 2005 -(% style="text-align: left;" %) 2006 -Метод запроса **POST** 2007 - 2008 -(% style="text-align: left;" %) 2009 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2010 - 2011 -(% style="text-align: left;" %) 2012 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2013 - 2014 -{ 2015 - "vehicleId": 0, ~/~/ id объекта 2016 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 2017 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 2018 -} 2019 - 2020 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2021 -|vehicleId|ID объекта 2022 -|from|Дата и время начала периода запроса 2023 -|to|Дата и время окончания периода запроса 2024 - 2025 -Ответ: 2026 - 2027 -[ 2028 - { 2029 - "messages": [ 2030 - { 2031 - "deviceTime": "2023-11-29T07:40:44.052Z", 2032 - "serverTime": "2023-11-29T07:40:44.052Z", 2033 - "speed": 0, 2034 - "altitude": 0, 2035 - "latitude": 0, 2036 - "longitude": 0, 2037 - "satellites": 0, 2038 - "course": 0, 2039 - "voltage": 0, 2040 - "parameters": { 2041 - "additionalProp1": "string", 2042 - "additionalProp2": "string", 2043 - "additionalProp3": "string" 2044 - }, 2045 - "photoCount": 0, 2046 - "lbsCorrectedCoords": true, 2047 - "protocolType": 0 2048 - } 2049 - ] 2050 - } 2051 -] 2052 - 2053 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2054 -|deviceTime|Время сообщения терминала 2055 -|serverTime|Время когда сообщение поступило на сервер 2056 -|speed|Скорость 2057 -|altitude|Высота над уровнем моря 2058 -|latitude|Широта 2059 -|longitude|Долгота 2060 -|satellites|Кол-во спутников 2061 -|course|Курс 2062 -|voltage|Бортовое напряжение 2063 -|parameters|Список параметров и их значений 2064 -|photoCount|Количество фото 2065 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2066 -|protocolType|ID типа протокола 2067 - 2068 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2069 - 2070 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2071 - 2072 -(% class="box infomessage" %) 2073 -((( 2074 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2075 -))) 2076 - 2077 -(% style="color:#000000" %)Метод запроса: **POST** 2078 - 2079 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2080 - 2081 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2082 - 2083 2083 (% style="text-align:left" %) 2084 - Телозапроса:662 +(% style="color:#000000" %)…** **] 2085 2085 2086 -{ 2087 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2088 - "vehicleIds": [0], ~/~/ Список ID объектов 2089 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2090 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2091 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2092 -} 2093 2093 2094 -Ответ: 2095 - 2096 -[ 2097 - { 2098 - "vehicleId": 0, ~/~/ ID объекта 2099 - "name": "string", ~/~/ Имя ТС 2100 - "periods": [ ~/~/ Периоды 2101 - { 2102 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2103 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2104 - "mileageBegin": 0, ~/~/ Пробег на начало периода 2105 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 2106 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2107 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2108 - } 2109 - ] 2110 - } 2111 -] 2112 - 2113 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2114 - 2115 -(% class="box infomessage" %) 665 +(% class="box" style="text-align: center;" %) 2116 2116 ((( 2117 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**667 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 2118 2118 ))) 2119 2119 2120 -(% style="color:#000000" %)Метод запроса: **POST** 2121 - 2122 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2123 - 2124 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2125 - 2126 -(% style="text-align:left" %) 2127 -Тело запроса: 2128 - 2129 -{ 2130 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2131 - "vehicleIds": [0], ~/~/ Список ID объектов 2132 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2133 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2134 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2135 -} 2136 - 2137 -Ответ: 2138 - 2139 -[ 2140 - { 2141 - "vehicleId": 0, ~/~/ ID объекта 2142 - "name": "string", ~/~/ Имя ТС 2143 - "periods": [ ~/~/ Периоды 2144 - { 2145 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2146 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2147 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2148 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2149 - "fuelConsumption": 0, ~/~/ Расход топлива 2150 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2151 - } 2152 - ] 2153 - } 2154 -] 2155 - 2156 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2157 - 2158 2158 (% class="box infomessage" %) 2159 2159 ((( 2160 -(% style="color:#000000; line-height:100%" %)** **(% l ang="en-US" %)**POST**(%%)**/api/v3/vehicles/fuelInOut**672 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 2161 2161 ))) 2162 2162 2163 -(% style="color:#000000" %)Метод запроса :**POST**675 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 2164 2164 2165 -(% style="color:#000000" %) URLзапроса:(%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut677 +(% style="color:#000000" %)Метод запроса: **GET** 2166 2166 2167 -(% style="color:#000000" %) Взаголовках запроса:X-Auth:Токен авторизации679 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 2168 2168 2169 -(% style="text-align:left" %) 2170 -Тело запроса: 681 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 2171 2171 2172 -{ 2173 - "vehicleIds": [0], ~/~/ Список ID объектов 2174 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2175 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2176 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2177 -} 683 +(% style="color:#000000" %)Ответ: [ 2178 2178 2179 -Ответ: 685 +(% class="western" style="margin-bottom:19px" %) 686 +{{{ {}}} 2180 2180 2181 -[ 2182 - { 2183 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2184 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2185 - "vehicleId": 0, ~/~/ ID объекта 2186 - "name": "string", ~/~/ Имя объекта 2187 - "model": "string", ~/~/ Модель объекта 2188 - "fuels": [ ~/~/ Массив данным по заправкам и сливам 2189 - { 2190 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2191 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2192 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2193 - "valueFuel": 0, ~/~/ Количество 2194 - "fuelStart": 0, ~/~/ Уровень топлива на начало события 2195 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2196 - } 2197 - ] 2198 - } 2199 -] 688 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 2200 2200 690 +(% class="western" %) 691 +{{{ "description": "" // Описание 692 + },}}} 2201 2201 2202 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2203 - 2204 -(% class="box infomessage" %) 2205 -((( 2206 -**POST /api/v3/vehicles/moveStop** 2207 -))) 2208 - 2209 -Метод запроса: **POST** 2210 - 2211 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2212 - 2213 -В заголовках запроса: X-Auth: Токен авторизации 2214 - 2215 - 2216 -Тело запроса: 2217 - 2218 -{ 2219 - "vehicleIds": [ ], ~/~/ Список ID объектов 2220 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2221 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2222 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2223 -} 2224 - 2225 -Ответ: 2226 - 2227 -[ 2228 - { 2229 - "vehicleId": 0, ~/~/ ID объекта 2230 - "vehicleName": "string", ~/~/ Имя объекта 2231 - "moves": [ ~/~/ Событие движения 2232 - { 2233 - "mileage": 0, ~/~/ Пробег, км 2234 - "eventId": 0, ~/~/ Идентификатор события 2235 - "eventName": "string", ~/~/ Название события 2236 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2237 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2238 - "duration": 0 ~/~/ Продолжительность события, секунд 2239 - } 2240 - ], 2241 - "stops": [ ~/~/ События стоянок 2242 - { 2243 - "address": "string", ~/~/ Адрес события 2244 - "eventId": 0, ~/~/ Идентификатор события 2245 - "eventName": "string", ~/~/ Название события 2246 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2247 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2248 - "duration": 0 ~/~/ Продолжительность события, секунд 2249 - } 2250 - ] 2251 - } 2252 -] 2253 - 2254 - 2255 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2256 - 2257 -(% class="box infomessage" %) 2258 -((( 2259 -**POST /api/v3/vehicles/getlastdata** 2260 -))) 2261 - 2262 -Метод запроса: **POST** 2263 - 2264 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2265 - 2266 -В заголовках запроса: X-Auth: Токен авторизации 2267 - 2268 - 2269 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2270 - 2271 -Ответ: 2272 - { 2273 - "vehicleId": 0, ~/~/Идентификатор объекта. 2274 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2275 - "vehicleNumber": "string",~/~/Номер объекта. 2276 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2277 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2278 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2279 - "speed": 0,~/~/Скорость объекта. 2280 - "course": 0,~/~/Курс движения [0;360] 2281 - "latitude": 0,~/~/Широта [-90°;90°]. 2282 - "longitude": 0,~/~/Долгота [-180°;180°]. 2283 - "address": "string",~/~/Адрес. 2284 - "geozones": [ ~/~/Сведения по геозонам. 2285 - { 2286 - "id": 0, 2287 - "name": "string" 2288 - } 2289 - 2290 - 2291 - 2292 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2293 - 2294 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2295 - 2296 -(% class="box infomessage" %) 2297 -((( 2298 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2299 -))) 2300 - 2301 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2302 - 2303 -(% style="color:#000000" %)Метод запроса: **POST** 2304 - 2305 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2306 - 2307 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2308 - 2309 2309 (% style="text-align:left" %) 2310 - Телозапроса:695 +(% style="color:#000000" %)… ] 2311 2311 2312 -(% style="text-align:left" %) 2313 -{ 2314 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2315 -} 2316 2316 2317 -(% style="text-align:left" %) 2318 -Ответ: 2319 - 2320 -[ 2321 - { 2322 - "id": 0, ~/~/ Идентификатор объекта геозоны 2323 - "name": "string", ~/~/ Название объекта геозоны 2324 - "type": 0, ~/~/ Тип объекта геозоны 2325 - "fname": "string", ~/~/ Имя файла 2326 - "parentId": "string", ~/~/ Идентификатор клиента 2327 - "radius": 0, ~/~/ Радиус геообъекта 2328 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2329 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2330 - "description": "string", ~/~/ Описание 2331 - "area": 0, ~/~/ Площадь, м^^2^^ 2332 - "perimetr": 0, ~/~/ Периметр, м 2333 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2334 - } 2335 -] 2336 - 2337 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2338 - 2339 -(% class="box infomessage" %) 2340 -((( 2341 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2342 -))) 2343 - 2344 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2345 - 2346 -(% style="color:#000000" %)Метод запроса: **POST** 2347 - 2348 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2349 - 2350 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2351 - 2352 -(% style="text-align:left" %) 2353 -Тело запроса: 2354 - 2355 -{ 2356 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2357 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2358 - "ids": [ ], ~/~/ Массив id объектов 2359 - "byTime": 0, ~/~/ Объединение событий по времени 2360 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2361 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2362 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2363 -} 2364 - 2365 -Ответ: 2366 -[ 2367 - { 2368 - "geozoneId": 0, ~/~/ ID геообъекта 2369 - "geozoneName": "string", ~/~/ Название геообъекта 2370 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2371 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2372 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2373 - "vehicleId": 0, ~/~/ ID объекта 2374 - "vehicleName": "string" ~/~/ Имя объекта 2375 - } 2376 -] 2377 - 2378 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2379 - 2380 -(% class="box infomessage" %) 2381 -((( 2382 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2383 -))) 2384 - 2385 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2386 - 2387 -(% style="color:#000000" %)Метод запроса: **POST** 2388 - 2389 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2390 - 2391 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2392 - 2393 -(% style="text-align:left" %) 2394 -Тело запроса: 2395 - 2396 -{ 2397 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2398 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2399 - "ids": [ ], ~/~/ Массив id геообъектов 2400 - "byTime": 0, ~/~/ Объединение событий по времени 2401 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2402 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2403 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2404 -} 2405 - 2406 -Ответ: 2407 - 2408 -[ 2409 - { 2410 - "geozoneId": 0, ~/~/ ID геообъекта 2411 - "geozoneName": "string", ~/~/ Название геообъекта 2412 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2413 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2414 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2415 - "vehicleId": 0, ~/~/ ID объекта 2416 - "vehicleName": "string" ~/~/ Имя объекта 2417 - } 2418 -] 2419 - 2420 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2421 - 2422 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2423 - 2424 -(% class="box infomessage" %) 2425 -((( 2426 -**POST /api/v3/notifications/find** 2427 -))) 2428 - 2429 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2430 - 2431 -(% style="text-align: left;" %) 2432 -Метод запроса **POST** 2433 - 2434 -(% style="text-align: left;" %) 2435 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2436 - 2437 -(% style="text-align: left;" %) 2438 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2439 - 2440 -{ 2441 - "parentId": "" ~/~/ id клиента 2442 -} 2443 - 2444 -Ответ: 2445 - 2446 -[ 2447 - { 2448 - "id": 0, ~/~/ ID уведомления 2449 - "name": "string", ~/~/ Название уведомления 2450 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2451 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2452 - "userId": "", ~/~/ Пользователь, создавший уведомление 2453 - "parentId": "", ~/~/ Идентификатор клиента 2454 - "parentName": "string" ~/~/ Имя клиента 2455 - } 2456 -] 2457 - 2458 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2459 - 2460 -(% class="box infomessage" %) 2461 -((( 2462 -**GET /api/v3/notifications/{id}** 2463 -))) 2464 - 2465 -Метод возвращает данные правил формирования выбранного уведомления. 2466 - 2467 -(% style="text-align: left;" %) 2468 -Метод запроса **GET** 2469 - 2470 -(% style="text-align: left;" %) 2471 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2472 - 2473 -(% style="text-align: left;" %) 2474 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2475 - 2476 -(% style="text-align: left;" %) 2477 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2478 - 2479 -(% style="text-align: left;" %) 2480 -(% style="color:#000000" %)Ответ: 2481 - 2482 -(% style="text-align: left;" %) 2483 -(% style="color:#000000" %){ 2484 - "id": 0, ~/~/ (%%)id уведомления 2485 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2486 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2487 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2488 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2489 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2490 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2491 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2492 -(% style="color:#000000" %) 0 2493 - ], 2494 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2495 -(% style="color:#000000" %) 0 2496 - ], 2497 - "fieldids": [ ~/~/ (%%)Список id полей для анализа 2498 -(% style="color:#000000" %) 0 2499 - ], 2500 - "settings": { ~/~/ Список параметров уведомления 2501 - "additionalProp1": "string", 2502 - "additionalProp2": "string", 2503 - "additionalProp3": "string" 2504 - }, 2505 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2506 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2507 -(% style="color:#000000" %) "" 2508 - ], 2509 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2510 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2511 -(% style="color:#000000" %) "string" 2512 - ], 2513 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2514 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2515 -(% style="color:#000000" %) { 2516 - "id": 0, ~/~/ (%%)Идентификатор участника чата 2517 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2518 -(% style="color:#000000" %) } 2519 - ], 2520 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2521 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2522 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2523 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2524 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2525 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2526 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2527 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2528 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2529 -(% style="color:#000000" %)} 2530 - 2531 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2532 - 2533 -(% class="box warningmessage" %) 2534 -((( 2535 -**PUT /api/v3/notifications/** 2536 -))) 2537 - 2538 -Метод позволяет отредактировать уведомление. 2539 - 2540 -Метод запроса **PUT** 2541 - 2542 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2543 - 2544 -В заголовках запроса: X-Auth: Токен авторизации 2545 - 2546 -Тело запроса: 2547 -{ 2548 - "id": 0, ~/~/ id уведомления 2549 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2550 - "userId": "", ~/~/ Пользователь, создавший уведомление 2551 - "parentId": "", ~/~/ Идентификатор клиента 2552 - "parentName": "string", ~/~/ Имя клиента 2553 - "name": "string", ~/~/ Название уведомления 2554 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2555 - "vehicleIds": [ ~/~/ Список id объектов для анализа 2556 - 0 2557 - ], 2558 - "geoids": [ ~/~/ Список id геообъектов для анализа 2559 - 0 2560 - ], 2561 - "fieldids": [ ~/~/ Список id полей для анализа 2562 - 0 2563 - ], 2564 - "settings": { ~/~/ Список параметров уведомления 2565 - "additionalProp1": "string", 2566 - "additionalProp2": "string", 2567 - "additionalProp3": "string" 2568 - }, 2569 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2570 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2571 - "" 2572 - ], 2573 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2574 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2575 - "string" 2576 - ], 2577 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2578 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2579 - { 2580 - "id": 0, ~/~/ Идентификатор участника чата 2581 - "info": "string" ~/~/ Дополнительные сведения 2582 - } 2583 - ], 2584 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2585 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2586 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2587 - "kind": 0, ~/~/ Определяет вид уведомления 2588 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2589 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2590 - "timezone": 0, ~/~/ Сдвиг часового пояса 2591 - "validity": 0, ~/~/ Срок действия в днях (1-90) 2592 - "autoProlongation": true ~/~/ Автопродление срока действия 2593 -} 2594 - 2595 -Ответ: 2596 - 2597 -Success 2598 - 2599 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2600 - 2601 -(% class="box errormessage" %) 2602 -((( 2603 -**DELETE /api/v3/notifications/{id}** 2604 -))) 2605 - 2606 -Метод позволяет удалить выбранное уведомление. 2607 - 2608 -Метод запроса **DELETE** 2609 - 2610 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2611 - 2612 -Передаваемый параметр: {id} - id уведомления 2613 - 2614 -В заголовках запроса: X-Auth: Токен авторизации 2615 - 2616 -Ответ: 2617 - 2618 -Success 2619 - 2620 - 2621 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2622 - 2623 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2624 - 2625 -(% class="box infomessage" %) 2626 -((( 2627 -**POST /api/v3/Drivers/find** 2628 -))) 2629 - 2630 -Передается параметр: parentId - ID клиента-родителя 2631 - 2632 -Ответ: 2633 - 2634 -[ 2635 - { 2636 - "name": "string", ~/~/ Определяет наименование 2637 - "description": "string", ~/~/ Определяет описание 2638 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2639 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2640 - "exclusive": true, ~/~/ Определяет признак "Исключительный" 2641 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2642 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2643 - "deleted": true ~/~/ Признак удаления 2644 - } 2645 -] 2646 - 2647 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2648 - 2649 -(% class="box infomessage" %) 2650 -((( 2651 -**GET /api/v3/Drivers/{driverGuid}** 2652 -))) 2653 - 2654 -Передается параметр: ID водителя 2655 - 2656 -Ответ: 2657 - 2658 -{ 2659 - "name": "string", ~/~/ Определяет наименование 2660 - "description": "string", ~/~/ Определяет описание 2661 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2662 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2663 - "exclusive": true, ~/~/ Определяет признак "Исключительный" 2664 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2665 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2666 - "deleted": true ~/~/ Признак удаления 2667 -} 2668 - 2669 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2670 - 2671 -(% class="box successmessage" %) 2672 -((( 2673 -**POST /api/v3/Drivers** 2674 -))) 2675 - 2676 -Запрос: 2677 - 2678 -{ 2679 - "name": "string", 2680 - "description": "string", 2681 - "hiredate": "2023-06-30T12:50:54.020Z", 2682 - "chopdate": "2023-06-30T12:50:54.020Z", 2683 - "exclusive": true, 2684 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2685 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2686 - "deleted": true 2687 -} 2688 - 2689 -Ответ: 2690 - 2691 -{ 2692 - "name": "string", 2693 - "description": "string", 2694 - "hiredate": "2023-06-30T12:50:54.051Z", 2695 - "chopdate": "2023-06-30T12:50:54.051Z", 2696 - "exclusive": true, 2697 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2698 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2699 - "deleted": true 2700 -} 2701 - 2702 - 2703 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2704 - 2705 -(% class="box warningmessage" %) 2706 -((( 2707 -**PUT /api/v3/Drivers** 2708 -))) 2709 - 2710 -Запрос: 2711 - 2712 -{ 2713 - "name": "string", 2714 - "description": "string", 2715 - "hiredate": "2023-06-30T12:50:27.910Z", 2716 - "chopdate": "2023-06-30T12:50:27.910Z", 2717 - "exclusive": true, 2718 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2719 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2720 - "deleted": true 2721 -} 2722 - 2723 -Ответ: 2724 - 2725 -{ 2726 - "name": "string", 2727 - "description": "string", 2728 - "hiredate": "2023-06-30T12:50:27.929Z", 2729 - "chopdate": "2023-06-30T12:50:27.929Z", 2730 - "exclusive": true, 2731 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2732 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2733 - "deleted": true 2734 -} 2735 - 2736 - 2737 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2738 - 2739 -(% class="box errormessage" %) 2740 -((( 2741 -**DELETE /api/v3/Drivers/{driverGuid}** 2742 -))) 2743 - 2744 -Передается параметр: ID водителя 2745 - 2746 -Ответ: 2747 - 2748 -Success 2749 - 2750 - 2751 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 2752 - 2753 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 2754 - 2755 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2756 - 2757 -(% class="box infomessage" %) 2758 -((( 2759 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2760 -))) 2761 - 2762 -Запрос: 2763 - 2764 -{ 2765 - "Ids": [ 2766 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2767 - ], 2768 - "BeginTime": "2023-06-30T12:49:04.365Z", 2769 - "EndTime": "2023-06-30T12:49:04.365Z" 2770 -} 2771 - 2772 -Ответ: 2773 - 2774 -[ 2775 - { 2776 - "VehicleId": 0, 2777 - "CreateTime": "2023-06-30T09:52:31.240Z", 2778 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2779 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2780 - "BeginTime": "2023-06-30T09:52:31.240Z", 2781 - "EndTime": "2023-06-30T09:52:31.240Z" 2782 - } 2783 -] 2784 - 2785 - 2786 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2787 - 2788 -(% class="box infomessage" %) 2789 -((( 2790 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2791 -))) 2792 - 2793 -Запрос: 2794 - 2795 -{ 2796 - "Ids": [ 2797 - 0 2798 - ], 2799 - "BeginTime": "2023-06-30T12:48:39.419Z", 2800 - "EndTime": "2023-06-30T12:48:39.419Z" 2801 -} 2802 - 2803 -Ответ: 2804 - 2805 -[ 2806 - { 2807 - "VehicleId": 0, 2808 - "CreateTime": "2023-06-30T09:54:01.631Z", 2809 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2810 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2811 - "BeginTime": "2023-06-30T09:54:01.631Z", 2812 - "EndTime": "2023-06-30T09:54:01.631Z" 2813 - } 2814 -] 2815 - 2816 - 2817 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2818 - 2819 -(% class="box successmessage" %) 2820 -((( 2821 -**POST /api/v3/DriversVehiclesAssignments** 2822 -))) 2823 - 2824 -Передается массив назначений 2825 - 2826 -Запрос: 2827 - 2828 -[ 2829 - { 2830 - "VehicleId": 0, ~/~/ Идентификатор объекта 2831 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2832 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2833 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2834 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2835 - } 2836 -] 2837 - 2838 -Ответ: 2839 - 2840 -[ 2841 - { 2842 - "VehicleId": 0, 2843 - "CreateTime": "2023-06-30T11:04:46.903Z", 2844 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2845 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2846 - "BeginTime": "2023-06-30T11:04:46.903Z", 2847 - "EndTime": "2023-06-30T11:04:46.903Z" 2848 - } 2849 -] 2850 - 2851 - 2852 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2853 - 2854 -(% class="box warningmessage" %) 2855 -((( 2856 -**PUT /api/v3/DriversVehiclesAssignments** 2857 -))) 2858 - 2859 -Запрос: 2860 - 2861 -[ 2862 - { 2863 - "VehicleId": 0, 2864 - "CreateTime": "2023-06-30T11:14:08.117Z", 2865 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2866 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2867 - "BeginTime": "2023-06-30T11:14:08.117Z", 2868 - "EndTime": "2023-06-30T11:14:08.117Z" 2869 - } 2870 -] 2871 - 2872 -Ответ: 2873 - 2874 -[ 2875 - { 2876 - "VehicleId": 0, 2877 - "CreateTime": "2023-06-30T11:14:53.349Z", 2878 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2879 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2880 - "BeginTime": "2023-06-30T11:14:53.349Z", 2881 - "EndTime": "2023-06-30T11:14:53.349Z" 2882 - } 2883 -] 2884 - 2885 - 2886 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2887 - 2888 -(% class="box errormessage" %) 2889 -((( 2890 -**DELETE /api/v3/DriversVehiclesAssignments** 2891 -))) 2892 - 2893 -Запрос: 2894 - 2895 -[ 2896 - "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2897 -] 2898 - 2899 -Ответ: 2900 - 2901 -Success 2902 - 2903 - 2904 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2905 - 2906 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2907 - 2908 -(% class="box infomessage" %) 2909 -((( 2910 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2911 -))) 2912 - 2913 -Запрос: 2914 - 2915 -{ 2916 - "Ids": [ 2917 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2918 - ], 2919 - "BeginTime": "2023-06-30T12:47:12.162Z", 2920 - "EndTime": "2023-06-30T12:47:12.162Z" 2921 -} 2922 - 2923 -Ответ: 2924 - 2925 -[ 2926 - { 2927 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2928 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2929 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2930 - "BeginTime": "2023-06-30T11:19:40.703Z", 2931 - "EndTime": "2023-06-30T11:19:40.703Z" 2932 - } 2933 -] 2934 - 2935 - 2936 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2937 - 2938 -(% class="box infomessage" %) 2939 -((( 2940 -**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2941 -))) 2942 - 2943 -Запрос: 2944 - 2945 -{ 2946 - "Ids": [ 2947 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2948 - ], 2949 - "BeginTime": "2023-06-30T12:47:12.162Z", 2950 - "EndTime": "2023-06-30T12:47:12.162Z" 2951 -} 2952 - 2953 -Ответ: 2954 - 2955 -[ 2956 - { 2957 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2958 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2959 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2960 - "BeginTime": "2023-06-30T11:19:40.703Z", 2961 - "EndTime": "2023-06-30T11:19:40.703Z" 2962 - } 2963 -] 2964 - 2965 - 2966 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2967 - 2968 -(% class="box successmessage" %) 2969 -((( 2970 -**POST /api/v3/DriversRfidsAssignments** 2971 -))) 2972 - 2973 -Запрос: 2974 - 2975 -[ 2976 - { 2977 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2978 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2979 - "BeginTime": "2023-06-30T11:27:08.635Z", 2980 - "EndTime": "2023-06-30T11:27:08.635Z" 2981 - } 2982 -] 2983 - 2984 -Ответ: 2985 - 2986 -[ 2987 - { 2988 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2989 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2990 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2991 - "BeginTime": "2023-06-30T11:27:08.677Z", 2992 - "EndTime": "2023-06-30T11:27:08.677Z" 2993 - } 2994 -] 2995 - 2996 - 2997 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2998 - 2999 -(% class="box warningmessage" %) 3000 -((( 3001 -**PUT /api/v3/DriversRfidsAssignments** 3002 -))) 3003 - 3004 -Запрос: 3005 - 3006 -[ 3007 - { 3008 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3009 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3010 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3011 - "BeginTime": "2023-06-30T11:28:43.330Z", 3012 - "EndTime": "2023-06-30T11:28:43.330Z" 3013 - } 3014 -] 3015 - 3016 -Ответ: 3017 - 3018 -[ 3019 - { 3020 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3021 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3022 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 - "BeginTime": "2023-06-30T11:28:43.331Z", 3024 - "EndTime": "2023-06-30T11:28:43.331Z" 3025 - } 3026 -] 3027 - 3028 - 3029 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3030 - 3031 -(% class="box errormessage" %) 3032 -((( 3033 -**DELETE /api/v3/DriversRfidsAssignments** 3034 -))) 3035 - 3036 -Запрос: 3037 - 3038 -[ 3039 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3040 -] 3041 - 3042 -Ответ: 3043 - 3044 -Success 3045 - 3046 - 3047 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3048 - 3049 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3050 - 3051 -(% class="box infomessage" %) 3052 -((( 3053 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3054 -))) 3055 - 3056 -Запрос: 3057 - 3058 -{ 3059 - "Ids": [ 3060 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3061 - ], 3062 - "BeginTime": "2023-06-30T12:45:10.852Z", 3063 - "EndTime": "2023-06-30T12:45:10.852Z" 3064 -} 3065 - 3066 -Ответ: 3067 - 3068 -[ 3069 - { 3070 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3071 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3072 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3073 - "BeginTime": "2023-06-30T11:58:04.695Z", 3074 - "EndTime": "2023-06-30T11:58:04.695Z" 3075 - } 3076 -] 3077 - 3078 - 3079 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3080 - 3081 -(% class="box infomessage" %) 3082 -((( 3083 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3084 -))) 3085 - 3086 -Запрос: 3087 - 3088 -{ 3089 - "Ids": [ 3090 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3091 - ], 3092 - "BeginTime": "2023-06-30T12:45:10.852Z", 3093 - "EndTime": "2023-06-30T12:45:10.852Z" 3094 -} 3095 - 3096 -Ответ: 3097 - 3098 -[ 3099 - { 3100 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3101 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3102 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3103 - "BeginTime": "2023-06-30T11:58:04.695Z", 3104 - "EndTime": "2023-06-30T11:58:04.695Z" 3105 - } 3106 -] 3107 - 3108 - 3109 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3110 - 3111 -(% class="box successmessage" %) 3112 -((( 3113 -**POST /api/v3/DriversFuelCardsAssignments** 3114 -))) 3115 - 3116 -Запрос: 3117 - 3118 -[ 3119 - { 3120 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3121 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3122 - "BeginTime": "2023-06-30T12:09:53.175Z", 3123 - "EndTime": "2023-06-30T12:09:53.175Z" 3124 - } 3125 -] 3126 - 3127 -Ответ: 3128 - 3129 -[ 3130 - { 3131 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3132 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3133 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3134 - "BeginTime": "2023-06-30T12:09:53.201Z", 3135 - "EndTime": "2023-06-30T12:09:53.201Z" 3136 - } 3137 -] 3138 - 3139 - 3140 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3141 - 3142 -(% class="box warningmessage" %) 3143 -((( 3144 -**PUT /api/v3/DriversFuelCardsAssignments** 3145 -))) 3146 - 3147 -Запрос: 3148 - 3149 -[ 3150 - { 3151 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3152 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3153 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3154 - "BeginTime": "2023-06-30T12:09:53.201Z", 3155 - "EndTime": "2023-06-30T12:09:53.201Z" 3156 - } 3157 -] 3158 - 3159 -Ответ: 3160 - 3161 -[ 3162 - { 3163 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3164 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3165 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3166 - "BeginTime": "2023-06-30T12:09:53.201Z", 3167 - "EndTime": "2023-06-30T12:09:53.201Z" 3168 - } 3169 -] 3170 - 3171 - 3172 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3173 - 3174 -(% class="box errormessage" %) 3175 -((( 3176 -**DELETE /api/v3/DriversFuelCardsAssignments** 3177 -))) 3178 - 3179 -Запрос: 3180 - 3181 -[ 3182 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3183 -] 3184 - 3185 -Ответ: 3186 - 3187 -Success 3188 - 3189 - 3190 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3191 - 3192 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3193 - 3194 -(% class="box infomessage" %) 3195 -((( 3196 -**POST /api/v3/Trailers** 3197 -))) 3198 - 3199 -Пример запроса: 3200 - 3201 -{ 3202 - "startDate": "2023-11-14T10:48:03.671Z", 3203 - "endDate": "2023-11-14T10:48:03.671Z", 3204 - "ids": [ 0 ], 3205 - "timezone": 0 3206 -} 3207 - 3208 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3209 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3210 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3211 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3212 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3213 - 3214 -Пример ответа: 3215 - 3216 -[ 3217 - { 3218 - "SD": "2023-11-14T10:48:03.717Z", 3219 - "ED": "2023-11-14T10:48:03.717Z", 3220 - "id": 0, 3221 - "SLat": 0, 3222 - "SLon": 0, 3223 - "ELat": 0, 3224 - "ELon": 0, 3225 - "mileage": 0 3226 - "Duration": 0 3227 - "Address": "string", 3228 - "Address2": "string", 3229 - "name": "string", 3230 - "rid": "string", 3231 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3232 - "trailer": { 3233 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3234 - "Number": "string", 3235 - "Description": "string", 3236 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3237 - "ExternalID": "string", 3238 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3239 - "CreateTime": "2023-11-14T10:48:03.717Z", 3240 - "UpdateTime": "2023-11-14T10:48:03.717Z", 3241 - "IsDeleted": true 3242 - }, 3243 - "filesCount": 0, 3244 - } 3245 -] 3246 - 3247 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3248 -|SD|Дата и время начала события 3249 -|ED|Дата и время окончания события 3250 -|id|ID объекта 3251 -|SLat|Широта начальной координаты 3252 -|SLon|Долгота начальной координаты 3253 -|ELat|Широта конечной координаты 3254 -|ELon|Долгота конечной координаты 3255 -|mileage|Пробег 3256 -|Duration|Продолжительность 3257 -|Address|Адрес начального местоположения 3258 -|Address2|Адрес конечного местоположения 3259 -|name|Имя радиометки 3260 -|rid|Номер радиометки 3261 -|rguid|ID радиометки 3262 -|trailer|Информация об агрегате 3263 -|ModelGuid|ID агрегата 3264 -|Number|Название/номер агрегата 3265 -|Description|Текст примечания агрегата 3266 - 3267 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3268 - 3269 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3270 - 3271 -(% class="box infomessage" %) 3272 -((( 3273 -**POST /api/v3/Rfids/find** 3274 -))) 3275 - 3276 -Запрос: 3277 - 3278 -{ 3279 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3280 -} 3281 - 3282 -Ответ: 3283 - 3284 -[ 3285 - { 3286 - "name": "string", 3287 - "number": 0, 3288 - "period": 0, 3289 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3290 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3291 - } 3292 -] 3293 - 3294 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3295 -|parentId|ID клиента 3296 -|name|Название карты-метки 3297 -|number|Номер 3298 -|period|Период запросов в секундах (работает только для агрегатов) 3299 -|id|ID карты-метки 3300 - 3301 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3302 - 3303 -(% class="box infomessage" %) 3304 -((( 3305 -**GET /api/v3/Rfids/{rfidGuid}** 3306 -))) 3307 - 3308 -Передаем параметр rfidGuid - идентификатор карты-метки 3309 - 3310 -Ответ: 3311 - 3312 -[ 3313 - { 3314 - "name": "string", 3315 - "number": 0, 3316 - "period": 0, 3317 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3318 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3319 - } 3320 -] 3321 - 3322 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3323 -|name|Название карты-метки 3324 -|number|Номер 3325 -|period|Период запросов в секундах (работает только для агрегатов) 3326 -|id|ID карты-метки 3327 -|parentId|ID клиента 3328 - 3329 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3330 - 3331 -(% class="box successmessage" %) 3332 -((( 3333 -**POST /api/v3/Rfids** 3334 -))) 3335 - 3336 -Запрос: 3337 - 3338 -{ 3339 - "name": "string", 3340 - "number": 0, 3341 - "period": 0, 3342 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3343 -} 3344 - 3345 -Ответ: 3346 - 3347 -{ 3348 - "name": "string", 3349 - "number": 0, 3350 - "period": 0, 3351 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3352 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3353 -} 3354 - 3355 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3356 -|name|Название карты-метки 3357 -|number|Номер 3358 -|period|Период запросов в секундах (работает только для агрегатов) 3359 -|id|ID карты-метки 3360 -|parentId|ID клиента 3361 - 3362 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3363 - 3364 -(% class="box warningmessage" %) 3365 -((( 3366 -**PUT /api/v3/Rfids** 3367 -))) 3368 - 3369 -Запрос: 3370 - 3371 -{ 3372 - "name": "string", 3373 - "number": 0, 3374 - "period": 0, 3375 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3376 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3377 -} 3378 - 3379 -Ответ: 3380 - 3381 -{ 3382 - "name": "string", 3383 - "number": 0, 3384 - "period": 0, 3385 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3386 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3387 -} 3388 - 3389 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3390 -|name|Название карты-метки 3391 -|number|Номер 3392 -|period|Период запросов в секундах (работает только для агрегатов) 3393 -|id|ID карты-метки 3394 -|parentId|ID клиента 3395 - 3396 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3397 - 3398 -(% class="box errormessage" %) 3399 -((( 3400 -**DELETE /api/v3/Rfids/{rfidGuid}** 3401 -))) 3402 - 3403 -Передаем параметр **rfidGuid** - идентификатор карты-метки 3404 - 3405 -Ответ: 3406 - 3407 -Success 3408 - 3409 - 3410 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3411 - 3412 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3413 - 3414 -(% class="box infomessage" %) 3415 -((( 3416 -**GET /api/v3/Billing/client/balance/{clientId}** 3417 -))) 3418 - 3419 -Параметр запроса: **clientId **- идентификатор клиента. 3420 - 3421 -Ответ: 3422 - 3423 -{ 3424 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3425 - "Balance": 0 3426 -} 3427 - 3428 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3429 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3430 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3431 - 3432 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3433 - 3434 -(% class="box infomessage" %) 3435 -((( 3436 -**GET /api/v3/Billing/client/constraint/{clientId}** 3437 -))) 3438 - 3439 -Параметр запроса: **clientId **- идентификатор клиента. 3440 - 3441 -Ответ: 3442 - 3443 -{ 3444 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3445 - "CalculationType": 0, 3446 - "PermissibleBalance": 0, 3447 - "DefermentDays": 0, 3448 - "SendUiNotifications": true, 3449 - "SendEmailNotifications": true, 3450 - "IsPrivate": true, 3451 -} 3452 - 3453 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3454 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3455 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3456 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3457 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3458 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3459 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3460 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3461 - 3462 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3463 - 3464 -(% class="box infomessage" %) 3465 -((( 3466 -**GET /api/v3/Billing/client/plan/{clientId}** 3467 -))) 3468 - 3469 -Параметры запроса: 3470 - 3471 -**clientId **- идентификатор клиента. 3472 - 3473 -**planId **- идентификатор тарифного плана. 3474 - 3475 -Ответ: 3476 - 3477 -{ 3478 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3479 - "Plan": { **~/~/ Описание тарифного плана** 3480 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3481 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3482 - "Name": "string", 3483 - "IsArchived": true, 3484 - "Constraint": { 3485 - "CalculationType": 0, 3486 - "PermissibleBalance": 0, 3487 - "DefermentDays": 0 3488 - }, 3489 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3490 - { 3491 - "Feature": "string", 3492 - "IsFactual": true, 3493 - "Limit": 0, 3494 - "Price": 0, 3495 - "PeriodValue": 0, 3496 - "PeriodType": 0 3497 - } 3498 - ] 3499 - }, 3500 - "DebitDate": "2023-10-18T12:46:24.213Z", 3501 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3502 - { 3503 - "Feature": "string", 3504 - "IsEnabled": true, 3505 - "IsPrivate": true, 3506 - "IsFactual": true, 3507 - "Limit": 0, 3508 - "Price": 0, 3509 - "DebitDate": "2023-10-18T12:46:24.213Z", 3510 - "PeriodValue": 0, 3511 - "PeriodType": 0 3512 - } 3513 - ] 3514 -} 3515 - 3516 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3517 -|ClientId|Идентификатор клиента 3518 -|Id|Идентификатор тарифного плана 3519 -|OwnerId|Идентификатор клиента-владельца 3520 -|Name|Наименование тарифного плана 3521 -|IsArchived|Признак, определяющий архивный тарифный план 3522 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3523 -|PermissibleBalance|Допустимый баланс 3524 -|DefermentDays|Отсрочка, количество дней 3525 -|Feature|Код услуги 3526 -|IsEnabled|Признак, определяющий активирована ли услуга 3527 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3528 -|IsFactual|Признак, определяющий расчёт по факту 3529 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3530 -|Price|Цена за единицу. 3531 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3532 -|PeriodValue|Значение периода. 3533 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3534 - 3535 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3536 - 3537 -(% class="box infomessage" %) 3538 -((( 3539 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3540 -))) 3541 - 3542 -Параметр запроса: **clientId **- идентификатор клиента. 3543 - 3544 -Ответ: 3545 - 3546 -[ 3547 - { 3548 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3549 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3550 - "Name": "string", 3551 - "IsArchived": true, 3552 - "Constraint": { 3553 - "CalculationType": 0, 3554 - "PermissibleBalance": 0, 3555 - "DefermentDays": 0 3556 - }, 3557 - "Features": [ 3558 - { 3559 - "Feature": "string", 3560 - "IsFactual": true, 3561 - "Limit": 0, 3562 - "Price": 0, 3563 - "PeriodValue": 0, 3564 - "PeriodType": 0 3565 - } 3566 - ] 3567 - } 3568 -] 3569 - 3570 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3571 -|ClientId|Идентификатор клиента 3572 -|Id|Идентификатор тарифного плана 3573 -|OwnerId|Идентификатор клиента-владельца 3574 -|Name|Наименование тарифного плана 3575 -|IsArchived|Признак, определяющий архивный тарифный план 3576 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3577 -|PermissibleBalance|Допустимый баланс 3578 -|DefermentDays|Отсрочка, количество дней 3579 -|Feature|Код услуги 3580 -|IsFactual|Признак, определяющий расчёт по факту 3581 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3582 -|Price|Цена за единицу. 3583 -|PeriodValue|Значение периода. 3584 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3585 - 3586 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3587 - 3588 -(% class="box infomessage" %) 3589 -((( 3590 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3591 -))) 3592 - 3593 -Параметр запроса: **clientId **- идентификатор клиента. 3594 - 3595 -Ответ: 3596 - 3597 -[ 3598 - { 3599 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3600 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3601 - "Name": "string", 3602 - "IsArchived": true, 3603 - "Constraint": { 3604 - "CalculationType": 0, 3605 - "PermissibleBalance": 0, 3606 - "DefermentDays": 0 3607 - }, 3608 - "Features": [ 3609 - { 3610 - "Feature": "string", 3611 - "IsFactual": true, 3612 - "Limit": 0, 3613 - "Price": 0, 3614 - "PeriodValue": 0, 3615 - "PeriodType": 0 3616 - } 3617 - ] 3618 - } 3619 -] 3620 - 3621 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3622 -|ClientId|Идентификатор клиента 3623 -|Id|Идентификатор тарифного плана 3624 -|OwnerId|Идентификатор клиента-владельца 3625 -|Name|Наименование тарифного плана 3626 -|IsArchived|Признак, определяющий архивный тарифный план 3627 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3628 -|PermissibleBalance|Допустимый баланс 3629 -|DefermentDays|Отсрочка, количество дней 3630 -|Feature|Код услуги 3631 -|IsFactual|Признак, определяющий расчёт по факту 3632 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3633 -|Price|Цена за единицу. 3634 -|PeriodValue|Значение периода. 3635 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3636 - 3637 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3638 - 3639 -(% class="box warningmessage" %) 3640 -((( 3641 -**PUT /api/v3/Billing/client/balance** 3642 -))) 3643 - 3644 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3645 - 3646 -Тело запроса: 3647 - 3648 -{ 3649 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3650 - "Balance": 0 3651 -} 3652 - 3653 -Ответ: Success 3654 - 3655 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3656 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3657 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3658 - 3659 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3660 - 3661 -(% class="box warningmessage" %) 3662 -((( 3663 -**PUT /api/v3/billing/client/balance/deposit** 3664 -))) 3665 - 3666 -Создает операцию **Пополнение **с указанной суммой 3667 - 3668 -Тело запроса: 3669 - 3670 -{ 3671 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3672 - "Balance": 0 3673 -} 3674 - 3675 -Ответ: Success 3676 - 3677 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3678 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3679 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3680 - 3681 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3682 - 3683 -Создает операцию **Списание **с указанной суммой 3684 - 3685 -(% class="box warningmessage" %) 3686 -((( 3687 -**PUT /api/v3/billing/client/balance/withdraw** 3688 -))) 3689 - 3690 -Тело запроса: 3691 - 3692 -{ 3693 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3694 - "Balance": 0 3695 -} 3696 - 3697 -Ответ: Success 3698 - 3699 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3700 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3701 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3702 - 3703 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3704 - 3705 -(% class="box warningmessage" %) 3706 -((( 3707 -**PUT /api/v3/Billing/client/constraint** 3708 -))) 3709 - 3710 -Тело запроса: 3711 - 3712 -{ 3713 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3714 - "CalculationType": 0, 3715 - "PermissibleBalance": 0, 3716 - "DefermentDays": 0, 3717 - "SendUiNotifications": true, 3718 - "SendEmailNotifications": true, 3719 - "IsPrivate": true, 3720 -} 3721 - 3722 -Ответ: Success 3723 - 3724 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3725 -|ClientId|Идентификатор клиента 3726 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3727 -|PermissibleBalance|Допустимый баланс 3728 -|DefermentDays|((( 3729 -Отсрочка, количество дней 3730 -))) 3731 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3732 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3733 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3734 - 3735 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3736 - 3737 -(% class="box warningmessage" %) 3738 -((( 3739 -**PUT /api/v3/Billing/client/plan** 3740 -))) 3741 - 3742 -Тело запроса: 3743 - 3744 -{ 3745 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3746 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3747 - "Features": [ 3748 - { 3749 - "Feature": "string", 3750 - "IsEnabled": true, 3751 - "IsFactual": true, 3752 - "Limit": 0, 3753 - "Price": 0, 3754 - "DebitDate": "2023-10-18T13:26:58.987Z", 3755 - "PeriodValue": 0, 3756 - "PeriodType": 0 3757 - } 3758 - ] 3759 -} 3760 - 3761 -Ответ: Success 3762 - 3763 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3764 -|ClientId|Идентификатор клиента 3765 -|PlanId|Идентификатор тарифного плана 3766 -|Feature|Код услуги 3767 -|IsEnabled|Признак, определяющий активирована ли услуга 3768 -|IsFactual|Признак, определяющий расчёт по факту 3769 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3770 -|Price|Цена за единицу. 3771 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3772 -|PeriodValue|Значение периода. 3773 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3774 - 3775 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3776 - 3777 -(% class="box warningmessage" %) 3778 -((( 3779 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3780 -))) 3781 - 3782 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3783 - 3784 -(% class="box infomessage" %) 3785 -((( 3786 -**POST /api/v3/vehicles/import/{agentId}** 3787 -))) 3788 - 3789 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3790 - 3791 -В пути указывается **agentId** - id клиента. 3792 - 3793 -**Заголовок** 3794 - 3795 -**X-Auth: [токен авторизации]** 3796 - 3797 -**Параметры** 3798 - 3799 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3800 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3801 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3802 - 3803 -В теле использовать тип **form-data,** тип значения** file** 3804 - 3805 -**Ключи** 3806 - 3807 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3808 -|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3809 -|csv|В значении передаем файл датчиков, формат **csv** 3810 - 3811 -Ответ: 3812 - 3813 -{ 3814 - "vehicleId": 0, 3815 - "name": "string", 3816 - "errors": ["string"] 3817 -} 3818 - 3819 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3820 -|vehicleId|ID созданного объекта 3821 -|name|Имя созданного объекта 3822 -|errors|Ошибки и их описание 3823 - 3824 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3825 - 3826 -(% class="box infomessage" %) 3827 -((( 3828 -**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3829 -))) 3830 - 3831 -(% class="wikigeneratedid" %) 3832 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3833 - 3834 -(% class="wikigeneratedid" %) 3835 -В пути указывается **vehicleId **- id объекта. 3836 - 3837 -**Заголовок** 3838 - 3839 -**X-Auth: [токен авторизации]** 3840 - 3841 -В теле использовать тип **form-data.** 3842 - 3843 -Ключи: 3844 - 3845 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3846 -|**history**|В значении передавать файл с историей 3847 - 3848 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3849 - 3850 -Ответ: 3851 - 3852 -{ 3853 - "results": [ 3854 - { 3855 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3856 - "vehicleId": 0, 3857 - "errors": [ 3858 - "string" 3859 - ], 3860 - "firstMessageDate": "2023-11-28T09:27:58.949Z", 3861 - "lastMessageDate": "2023-11-28T09:27:58.949Z", 3862 - "producedCount": 0, 3863 - "msgCount": 0 3864 - } 3865 - ] 3866 -} 3867 - 3868 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3869 -|results|Результаты импорта в разрезе ТС 3870 -|vehicleGuid|Guid ТС 3871 -|vehicleId|ID ТС 3872 -|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3873 -|firstMessageDate|Дата первого импортированного сообщения (UTC) 3874 -|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3875 -|producedCount|Кол-во успешно отправленных в шину данных сообщений 3876 -|msgCount|Кол-во обработанных сообщений всего 3877 - 3878 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3879 - 3880 -(% class="box infomessage" %) 3881 -((( 3882 -**GET /api/v3/vehicles/import/history/status** 3883 -))) 3884 - 3885 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3886 - 3887 -Ответ: 3888 - 3889 -{ 3890 - "activity": true, 3891 - "progress": 0, 3892 - "message": "string" 3893 -} 3894 - 3895 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3896 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3897 -|progress|Guid ТС 3898 - 3899 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3900 - 3901 -(% class="box infomessage" %) 3902 -((( 3903 -**POST /api/v3/vehicles/export** 3904 -))) 3905 - 3906 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3907 - 3908 -Тело запроса: 3909 - 3910 -[ 3911 - id 3912 -] 3913 - 3914 -Ответ: Success 200, получаете файлы с настройками. 3915 - 3916 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3917 - 3918 -(% class="box infomessage" %) 3919 -((( 3920 -**POST /api/v3/vehicles/export/history** 3921 -))) 3922 - 3923 -Метод возвращает список сообщений терминала объекта за выбранный период. 3924 - 3925 -Тело запроса: 3926 - 3927 -{ 3928 - "vehicleId": 0, 3929 - "asArchive": true, 3930 - "from": "2023-09-27T12:17:45.973Z", 3931 - "to": "2023-09-27T12:17:45.973Z" 3932 -} 3933 - 3934 -Ответ: 3935 - 3936 -Получаете файл. Сообщение: Code 200/Success 3937 - 3938 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3939 -|vehicleId|ID объекта 3940 -|asArchive|true - Архивировать файл, False - не архивировать 3941 -|from|Дата и время начала запроса 3942 -|to|Дата и время окончания запроса 3943 - 3944 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3945 - 3946 -(% class="box infomessage" %) 3947 -((( 3948 -**GET /api/v3/vehicles/export/history/status** 3949 -))) 3950 - 3951 -Метод возвращает список сообщений терминала объекта за выбранный период. 3952 - 3953 -Ответ: 3954 - 3955 -{ 3956 - "activity": true, 3957 - "progress": 0, 3958 - "message": "string" 3959 -} 3960 - 3961 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3962 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3963 -|progress|Прогресс экспорта, от 0 до 100% 3964 -|message|Текст описывающий статус 3965 - 3966 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3967 - 3968 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3969 - 3970 -(% class="box infomessage" %) 3971 -((( 3972 -**POST /api/v3/EcoDriving/rating** 3973 -))) 3974 - 3975 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3976 - 3977 -Тело запроса: 3978 - 3979 -{ 3980 - "vehicleIds": [vehicleId], 3981 - "from": "2023-11-22T09:29:48.051Z", 3982 - "to": "2023-11-22T09:29:48.051Z" 3983 -} 3984 - 3985 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3986 -|vehicleIds|Массив ID объектов 3987 -|from|Дата начала запроса 3988 -|to|Дата окончания запроса 3989 - 3990 -Ответ: 3991 - 3992 -{ 3993 - "items": [ 3994 - { 3995 - "from": "2023-11-22T09:29:48.052Z", 3996 - "to": "2023-11-22T09:29:48.052Z", 3997 - "vehicleId": 0, 3998 - "vehicleName": "string", 3999 - "vehicleModel": "string", 4000 - "penalty": 0, 4001 - "score": 0, 4002 - "totalViolations": 0, 4003 - "violationsByType": { 4004 - "overspeedingViolations": 0, 4005 - "accelerationViolations": 0, 4006 - "brakingViolations": 0, 4007 - "turningViolations": 0, 4008 - "dangerousDrivingViolations": 0, 4009 - "sensorViolations": 0 4010 - }, 4011 - "moveTime": 0, 4012 - "mileage": 0, 4013 - "tripsCount": 0, 4014 - "trips": [ 4015 - { 4016 - "penalty": 0, 4017 - "score": 0, 4018 - "violationsCount": 0, 4019 - "violationsByType": { 4020 - "overspeedingViolations": 0, 4021 - "accelerationViolations": 0, 4022 - "brakingViolations": 0, 4023 - "turningViolations": 0, 4024 - "dangerousDrivingViolations": 0, 4025 - "sensorViolations": 0 4026 - }, 4027 - "moveTime": 0, 4028 - "mileage": 0, 4029 - "motohours": 0, 4030 - "maxSpeed": 0, 4031 - "startAddress": "string", 4032 - "endAddress": "string", 4033 - "drivers": [ 4034 - { 4035 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4036 - "driverName": "string", 4037 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4038 - } 4039 - ] 4040 - } 4041 - ] 4042 - } 4043 - ] 4044 -} 4045 - 4046 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4047 -|from|Дата начала запроса 4048 -|to|Дата окончания 4049 -|vehicleId|ID объекта 4050 -|vehicleName|Имя объекта 4051 -|vehicleModel|Модель объекта 4052 -|penalty|Сумма штрафных баллов 4053 -|score|Оценка 4054 -|totalViolations|Суммарное количество нарушений 4055 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4056 -|overspeedingViolations|Превышение скорости 4057 -|accelerationViolations|Ускорение 4058 -|brakingViolations|Торможение 4059 -|turningViolations|Резкий поворот 4060 -|dangerousDrivingViolations|Резкое вождение 4061 -|sensorViolations|Нарушение по датчику 4062 -|moveTime|Время в движении 4063 -|mileage|Пробег 4064 -|tripsCount|Количество рейсов 4065 -|motohours|Моточасы 4066 -|maxSpeed|Максимальная скорость 4067 -|startAddress|Адрес начала рейса 4068 -|endAddress|Адрес окончания рейса 4069 -|drivers|Список водителей, которые были на объекте в течениии рейса 4070 -|driverGuid|Guid водителя 4071 -|driverName|Имя водителя 4072 -|driverRfid|Номер Карты-метки 4073 - 4074 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4075 - 4076 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4077 - 4078 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4079 - 4080 -(% class="box infomessage" %) 4081 -((( 4082 -POST /api/v3/fuelcards/transactions 4083 -))) 4084 - 4085 -Метод запроса: POST 4086 - 4087 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4088 -\\В заголовках запроса: X-Auth: Токен авторизации 4089 - 4090 -Параметры в теле запроса (JSON): 4091 - 4092 -{ 4093 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4094 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4095 - "ids": [ 4096 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4097 - ], 4098 - "timezone": 0 ~/~/Таймзона 4099 -} 4100 - 4101 - 4102 -Ответ: 4103 - { 4104 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4105 - "driver": "string", ~/~/Водители, привязанные к ТК 4106 - "object": "string", ~/~/Наименование ТС 4107 - "amount": 0, ~/~/Количество топлива 4108 - "amountDut": 0, ~/~/Количество по ДУТ 4109 - "amountDiff": 0, ~/~/Разница, л 4110 - "amountDiffPerc": 0, ~/~/Разница, % 4111 - "summa": 0, ~/~/Стоимость, руб 4112 - "serviceName": "string", ~/~/Тип топлива 4113 - "price": 0, ~/~/Цена за литр, руб 4114 - "cardName": "string", ~/~/Наименование ТК 4115 - "cardNum": "string", ~/~/Номер ТК 4116 - "operator": "string", ~/~/Оператор ТК 4117 - "address": "string" ~/~/Адрес АЗС 4118 - } 4119 - 4120 - 4121 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4122 - 4123 - 4124 -== **Получение полных данных о ретрансляторе** == 4125 - 4126 -(% class="box infomessage" %) 4127 -((( 4128 -**GET ** **/api/v3/retranslations/{id}** 4129 -))) 4130 - 4131 -Идентификатор запроса: ID 4132 - 4133 - 4134 -Пример ответа: 4135 - 4136 -{ 4137 -"description": "", ~/~/ Определяет описание 4138 -"subscriberId": "", ~/~/ Подписчик 4139 -"protocolType": 0, ~/~/ Тип протокола 4140 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4141 -"address": "string", ~/~/ Адрес события 4142 -"objects": [ ~/~/Объекты для ретрансляции 4143 -{ 4144 -"id": "", ~/~/ Идентификатор объекта ретрансляции 4145 -"name": "", ~/~/ Наименование объекта ретрансляции 4146 -"imei": "", ~/~/ IMEI объекта 4147 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4148 -} 4149 - ], 4150 -"id": "", ~/~/ идентификатор пользователя 4151 -"parentId": "", ~/~/Guid родителя 4152 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4153 -} 4154 - 4155 - 4156 -== **Удаление данных ретранслятора** == 4157 - 4158 -(% class="box infomessage" %) 4159 -((( 4160 -**DELETE** **/api/v3/retranslations/{id}** 4161 -))) 4162 - 4163 -Параметр запроса: ID 4164 - 4165 - 4166 -== **Создание ретранслятора** == 4167 - 4168 -(% class="box infomessage" %) 4169 -((( 4170 -**POST ** **/api/v3/retranslations/{id}** 4171 -))) 4172 - 4173 -Запрос: 4174 - 4175 -{ 4176 -"description": "", ~/~/ Описание 4177 -"subscriberId": "", ~/~/ Подписчик 4178 -"protocolType": 0, ~/~/ Тип протокола 4179 -"address": "", ~/~/ Адрес ретрансляции 4180 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4181 -"objects": [ ~/~/Объекты для ретрансляции 4182 -{ 4183 -"id": "", ~/~/ идентификатор пользователя 4184 -"imei": "", ~/~/IMEI объекта 4185 -"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4186 -} 4187 - ] 4188 -} 4189 - 4190 - 4191 -Ответ: 4192 - 4193 -{ 4194 -"description": "string", ~/~/ Определяет описание 4195 -"subscriberId": "", ~/~/ идентификатор запроса 4196 -"protocolType": 0, ~/~/ Тип протокола 4197 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4198 -"address": "", ~/~/ Адрес события 4199 -"objects": [ ~/~/Объекты для ретрансляции 4200 -{ 4201 -"id": "", ~/~/ идентификатор пользователя 4202 -"name": "string", ~/~/ Название уведомления 4203 -"imei": "string", ~/~/IMEI объекта 4204 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4205 -} 4206 - ], 4207 -"id": "", ~/~/ идентификатор пользователя 4208 -"parentId": "", ~/~/ Guid идентификатор родителя 4209 -"deleted": true ~/~/ Признак удаления 4210 -} 4211 - 4212 - 4213 -== **Редактирование ретранслятора** == 4214 - 4215 -(% class="box infomessage" %) 4216 -((( 4217 -**PUT** **/api/v3/retranslations** 4218 -))) 4219 - 4220 -Пример запроса: 4221 - 4222 -{ 4223 -"id": "", ~/~/ идентификатор пользователя 4224 -"description": "string", ~/~/ Определяет описание 4225 -"subscriberId": "", ~/~/ идентификатор запроса 4226 -"protocolType": 0, ~/~/ Тип протокола 4227 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4228 -"address": "string", ~/~/ Адрес события 4229 -"objects": ~/~/Объекты для ретрансляции 4230 -[ 4231 -{ 4232 -"id": "", ~/~/ идентификатор пользователя 4233 -"imei": "", ~/~/IMEI объекта 4234 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4235 -} 4236 - ] 4237 -} 4238 - 4239 - 4240 -Пример ответа: 4241 - 4242 -{ 4243 -"description": "", ~/~/ Определяет описание 4244 -"subscriberId": "", ~/~/ идентификатор запроса 4245 -"protocolType": 0, ~/~/ Тип протокола 4246 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4247 -"address": "string", ~/~/ Адрес события 4248 -"objects": [ ~/~/Объекты для ретрансляции 4249 -{ 4250 -"id": "", ~/~/ идентификатор пользователя 4251 -"name": "string", ~/~/ Название уведомления 4252 -"imei": "", ~/~/IMEI объекта 4253 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4254 -} 4255 - ], 4256 -"id": "", ~/~/ идентификатор пользователя 4257 -"parentId": "", ~/~/ Guid идентификатор родителя 4258 -"deleted": true ~/~/ Признак удаления 4259 -} 4260 - 4261 - 4262 -== **Получение списка ретранслятора клиента** == 4263 - 4264 -(% class="box infomessage" %) 4265 -((( 4266 -**POST /api/v3/retranslations/find** 4267 -))) 4268 - 4269 -Пример запроса: 4270 - 4271 -{ 4272 -"id": "", ~/~/ идентификатор пользователя 4273 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4274 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4275 -} 4276 - 4277 -Ответ 4278 - 4279 -[ 4280 -{ 4281 -"description": "", ~/~/ Определяет описание 4282 -"subscriberId": "", ~/~/ идентификатор запроса 4283 -"protocolType": 0, ~/~/ Тип протокола 4284 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4285 -"address": "string", ~/~/ Адрес события 4286 -"id": "", ~/~/ идентификатор пользователя 4287 -"parentId": "", ~/~/ Guid идентификатор родителя 4288 -"deleted": true ~/~/ Признак удаления 4289 -} 4290 -] 4291 - 4292 - 4293 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) = 4294 - 4295 -== **API для отчета по выгрузке комбайнов** == 4296 - 4297 -(% class="box infomessage" %) 4298 -((( 4299 -POST **/api/v3/Reports/harvesterUnloading** 4300 -))) 4301 - 4302 -Пример запроса: 4303 - 4304 -{ 4305 - "byTime": 0, ~/~/ Объединение событий по времени 4306 - "byDist": 0, ~/~/ Объединение событий по расстоянию 4307 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4308 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4309 - "showNearestObjects": true, ~/~/Показывать объекты рядом? 4310 - "vehicleIds": [ ~/~/ Список id объектов для анализа 4311 - 0 4312 - ], 4313 - "from": "", ~/~/ Дата и время начало запроса 4314 - "to": "", ~/~/ Дата и время окончания запроса 4315 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4316 -} 4317 - 4318 -Пример ответа: 4319 - 4320 -[ 4321 - { 4322 - "harvesterName": "", ~/~/Комбайн, номер 4323 - "harvesterId": 0, ~/~/Комбайн, id 4324 -"harvesterModel": "", ~/~/ Модель комбайна 4325 -"hopperCapacity": 0, ~/~/ Объем бункера м3 4326 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4327 - "events": [ ~/~/Список событий в разрезе комбайна 4328 - { 4329 - "driverId": "", ~/~/Идентификатор водителя 4330 - "driverName": "", ~/~/Водитель комбайна, ФИО 4331 - "RFID": "", ~/~/ идентификатор карты-метки 4332 - "rfidName": "", ~/~/Водитель комбайна, имя метки 4333 - "vehicleId": 0, ~/~/идентификатор объекта 4334 - "vehicleName": "string", ~/~/ Имя объекта 4335 - "modelName": "string", ~/~/ Имя модели объекта 4336 - "nearestVehicles": [ ~/~/Объекты рядом 4337 - { 4338 - "vehicleId": 0, ~/~/идентификатор объекта 4339 - "vehicleName": "string" ~/~/ Имя объекта 4340 - } 4341 - ], 4342 - "fields": [ ~/~/Поля, где происходила выгрузка 4343 - { 4344 - "id": 0, ~/~/ идентификатор пользователя 4345 - "name": "string" ~/~/ имя пользователя 4346 - } 4347 - ], 4348 - "event": "string", ~/~/Событие 4349 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4350 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4351 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4352 - "cultureName": "string", ~/~/ название культуры 4353 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4354 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4355 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4356 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4357 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4358 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4359 - "issued": 0, ~/~/Выдано, бункеров 4360 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4361 - "latitude": 0, ~/~/Широта 4362 - "longitude": 0, ~/~/ Долгота 4363 - "litresAway": 0, ~/~/Отдано, л 4364 - "m3Away": 0 ~/~/Отдано, м3 4365 - } 4366 - ] 4367 - } 4368 -] 4369 - 4370 - 4371 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4372 - 4373 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4374 - 4375 - 4376 -(% class="box infomessage" %) 4377 -((( 4378 -GET api/v3/Vehicles/recyclebin/all 4379 -))) 4380 - 4381 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4382 - 4383 -Параметр запроса: {parentId} - идентификатор агента 4384 - 4385 -В заголовках запроса: X-Auth: Токен авторизации 4386 - 4387 -Ответ: 4388 - 4389 -[ 4390 - { 4391 - "recordTime": "", ~/~/Время записи 4392 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4393 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4394 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4395 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4396 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4397 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4398 - "items": [ ~/~/ 4399 -nullable: true ~/~/Детали 4400 - { 4401 - "name": "string", ~/~/наименование столбца 4402 - "value": "string" ~/~/содержание столбца 4403 - } 4404 - ] 4405 - }, 4406 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4407 - "string" 4408 - ] 4409 - } 4410 -] 4411 - 4412 - 4413 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4414 - 4415 -(% class="box infomessage" %) 4416 -((( 4417 -POST/api/v3/Vehicles/recyclebin/erase 4418 -))) 4419 - 4420 -В заголовках запроса: X-Auth: Токен авторизации 4421 - 4422 -Пример запроса: 4423 - 4424 -[ 4425 -0 4426 -] 4427 - 4428 - 4429 -Пример ответа: 4430 - 4431 -[ 4432 -{ 4433 - "recordTime": "", ~/~/Время записи 4434 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4435 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4436 - "objectId": 0, ~/~/ID объекта, помещённого в корзин 4437 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4438 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4439 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4440 - "items": [ ~/~/Детали 4441 - { 4442 - "name": "", ~/~/Имя свойства 4443 - "value": "" ~/~/Значение свойства 4444 - } 4445 - ] 4446 - }, 4447 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4448 - "" 4449 - ] 4450 - } 4451 -] 4452 - 4453 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4454 - 4455 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4456 - 4457 -(% class="box infomessage" %) 4458 -((( 4459 -POST/api/v3/Vehicles/recyclebin/restore 4460 -))) 4461 - 4462 -В заголовках запроса: X-Auth: Токен авторизации 4463 - 4464 -Параметры в теле запроса (JSON): 4465 - 4466 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4467 - 4468 -В заголовках запроса: X-Auth: Токен авторизации 4469 - 4470 - 4471 -Пример запроса: 4472 - 4473 -((( 4474 -[ 4475 -))) 4476 - 4477 -((( 4478 - 0 4479 -))) 4480 - 4481 -((( 4482 -] 4483 -))) 4484 - 4485 - 4486 -Пример ответа: 4487 - 4488 -[ 4489 -{ 4490 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4491 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4492 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4493 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4494 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4495 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4496 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4497 - "items": [ ~/~/Детали 4498 - { 4499 - "name": "string", ~/~/Имя свойства 4500 - "value": "string" ~/~/Значение свойства 4501 - } 4502 - ] 4503 - }, 4504 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4505 - "string" 4506 - ] 4507 - } 4508 -] 4509 - 4510 - 4511 - 4512 4512 (% class="box" lang="en-US" style="text-align: center;" %) 4513 4513 ((( 4514 4514 (% 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,1 +1,0 @@ 1 -XWiki.krainovim - Размер
-
... ... @@ -1,1 +1,0 @@ 1 -268.0 KB - Содержимое