Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,25 +1,33 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -= Описание ГЛОНАССSoft Public API 3.0 = 2 +((( 3 +**Содержание страницы:**\ 4 +))) 3 3 4 4 5 -{{toc/}} 6 - 7 - 8 8 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 9 9 10 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 9 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 11 12 12 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 13 13 14 14 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 15 15 16 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!15 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 17 17 17 + 18 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 19 + 20 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 21 + 18 18 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 19 19 20 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 24 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 25 +((( 26 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 27 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 28 +))) 21 21 22 -(% class="box infomessage" %)30 +(% class="box successmessage" %) 23 23 ((( 24 24 (% lang="en-US" %)**POST /api/v3/auth/login** 25 25 ))) ... ... @@ -30,7 +30,7 @@ 30 30 31 31 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 32 32 33 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».41 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 34 35 35 (% style="color:#000000" %)Параметры в теле запроса (JSON): 36 36 ... ... @@ -37,23 +37,27 @@ 37 37 (% style="color:#000000" %){ 38 38 "login": "testuser", 39 39 "password": "testuser" 40 -} (%%)48 +} 41 41 42 - 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) 46 46 (% style="color:#000000" %){ 47 - 48 -(% lang="en-US" %) 49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 50 - "User": "testuser" , ~/~/ имя пользователя 51 - 52 -(% lang="en-US" %) 54 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 55 + "User": "testuser" , ~/~/ имя пользователя(%%) 53 53 } 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 56 56 60 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 61 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 62 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 63 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 64 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 65 + 66 +(% class="wikigeneratedid" %) 67 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 68 + 57 57 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 58 58 59 59 (% class="box infomessage" %) ... ... @@ -61,7 +61,7 @@ 61 61 (% lang="en-US" %)**GET /api/v3/auth/check** 62 62 ))) 63 63 64 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).76 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 65 65 66 66 (% style="color:#000000" %)Метод запроса: **GET** 67 67 ... ... @@ -74,40 +74,114 @@ 74 74 75 75 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 76 76 77 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметровклиента**(%%) ==89 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 78 78 79 79 (% class="box infomessage" %) 80 80 ((( 81 - (% lang="en-US" %)**GET**(%%)**/(% lang="en-US" %)api/v3/agents(%%)**93 +**GET api/v3/agents/{id}** 82 82 ))) 83 83 84 - (% style="color:#000000" %)Метод позволяет получитьосновныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя.Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):96 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 85 85 98 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 99 + 100 +(% style="color:#000000" %)Метод запроса: **GET** 101 + 102 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 103 + 104 +Запрос должен содержать данные параметра "**agentId**" 105 + 106 +(% style="color:#000000" %)Ответ: 107 +{ 108 + "agentId": "", (%%) 109 + "parentId": "", 110 + "parentName": "string", 111 + "name": "string", 112 + "fullName": "string", 113 + "agentInfoType": 0, 114 + "isForeign": true/false, 115 + "district": "string", 116 + "region": "string", 117 + "city": "string", 118 + "inn": "string", 119 + "kpp": "string", 120 + "address": "string", 121 + "addressFact": "string", 122 + "email": "string", 123 + "director": "string", 124 + "bankName": "string", 125 + "bankBIK": "string", 126 + "bankRS": "string", 127 + "bankKS": "string" 128 + } 129 + 130 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 131 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 132 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 133 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 134 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 135 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 136 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 137 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 138 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 139 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 140 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 141 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 142 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 143 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 144 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 145 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 146 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 147 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 148 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 149 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 150 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 151 + 152 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 153 + 154 +(% class="box infomessage" %) 155 +((( 156 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 157 +))) 158 + 159 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 160 + 86 86 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 87 87 88 88 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 89 89 90 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».165 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 91 91 92 -(% style="color:#000000" %)Метод запроса: ** GET**167 +(% style="color:#000000" %)Метод запроса: **POST** 93 93 94 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>169 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 95 95 96 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)171 +(% style="color:#000000" %)Параметр запроса: 97 97 98 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 173 +(% style="color:#000000" %){ 174 + "parentId": "string" 175 +} 99 99 100 100 (% style="color:#000000" %)Ответ: 101 101 102 - (% style="color:#000000" %){103 - "agentId": ~/~/идентификатор клиента104 - "parentId": ~/~/ идентификатор клиента-родителя105 - "name": ~/~/ наименование клиента106 - "fullName": ~/~/ полное наименование клиента107 - "agentInfoType": "",~/~/ тип клиента (0- Клиент,1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)108 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)179 +{ 180 + "agentId": "",(% style="color:#000000" %) (%%) 181 + "parentId": "", 182 + "name": "string", 183 + "fullName": "string", 184 + "agentInfoType": 0, 185 +(% style="color:#000000" %) "status": "", 109 109 } 110 110 188 + 189 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 190 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 191 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 192 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 193 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 194 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 195 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 196 + 111 111 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 112 112 113 113 (% class="box successmessage" %) ... ... @@ -115,7 +115,7 @@ 115 115 **POST /api/v3/agents ** 116 116 ))) 117 117 118 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).204 +Метод позволяет добавить клиента, указанного в запросе. 119 119 120 120 Метод запроса: **POST** 121 121 ... ... @@ -126,9 +126,10 @@ 126 126 Параметры в теле запроса (JSON): 127 127 128 128 { 129 - 215 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 130 130 "name": "string", ~/~/ имя 131 131 "fullName": "string", ~/~/ полное наименование 218 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 132 132 "isForeign": true, ~/~/ иностранный контрагент 133 133 "district": "string", ~/~/ округ 134 134 "region": "string", ~/~/ регион ... ... @@ -145,7 +145,6 @@ 145 145 "bankKS": "string" ~/~/ корр. счёт 146 146 } 147 147 148 - 149 149 Ответ: 150 150 151 151 { ... ... @@ -153,6 +153,7 @@ 153 153 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 154 154 "name": "string", ~/~/ имя 155 155 "fullName": "string", ~/~/ полное наименование 242 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 156 156 "isForeign": true, ~/~/ иностранный контрагент 157 157 "district": "string", ~/~/ округ 158 158 "region": "string", ~/~/ регион ... ... @@ -169,6 +169,27 @@ 169 169 "bankKS": "string" ~/~/ корр. счёт 170 170 } 171 171 259 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 260 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 261 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 262 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 263 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 264 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 265 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 266 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 267 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 268 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 269 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 270 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 271 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 272 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 273 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 274 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 275 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 276 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 277 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 278 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 279 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 172 172 173 173 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 174 174 ... ... @@ -177,7 +177,7 @@ 177 177 **PUT /api/v3/agents** 178 178 ))) 179 179 180 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).288 +Метод позволяет отредактировать клиента, указанного в запросе. 181 181 182 182 Метод запроса: **PUT** 183 183 ... ... @@ -185,7 +185,6 @@ 185 185 186 186 В заголовках запроса: X-Auth: Токен авторизации 187 187 188 - 189 189 Параметры в теле запроса (JSON): 190 190 191 191 { ... ... @@ -193,6 +193,7 @@ 193 193 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 194 194 "name": "string", ~/~/ имя 195 195 "fullName": "string", ~/~/ полное наименование 303 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 196 196 "isForeign": true, ~/~/ иностранный контрагент 197 197 "district": "string", ~/~/ округ 198 198 "region": "string", ~/~/ регион ... ... @@ -209,7 +209,6 @@ 209 209 "bankKS": "string" ~/~/ корр. счёт 210 210 } 211 211 212 - 213 213 Ответ: 214 214 215 215 { ... ... @@ -233,15 +233,14 @@ 233 233 "bankKS": "string" ~/~/ корр. счёт 234 234 } 235 235 343 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 236 236 237 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) == 238 - 239 239 (% class="box errormessage" %) 240 240 ((( 241 241 **DELETE /api/v3/agents/{clientId}** 242 242 ))) 243 243 244 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).350 +Метод позволяет удалить клиента, указанного в строке запроса. 245 245 246 246 Метод запроса: **DELETE** 247 247 ... ... @@ -253,18 +253,31 @@ 253 253 254 254 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 255 255 362 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 256 256 257 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 364 +(% class="box warningmessage" %) 365 +((( 366 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 367 +))) 258 258 369 +Метод позволяет изменить статус клиента, указанного в запросе. 259 259 260 - ==(%style="color:#000000; line-height:14px" %)**Добавлениепользователя**(%%)==371 +В пути указывается GUID клиента и статус клиента. 261 261 373 +**status **- значение 0 - заблокирован, 1 - активен. 374 + 375 +Ответ: Code 204 376 + 377 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 378 + 379 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 380 + 262 262 (% class="box successmessage" %) 263 263 ((( 264 264 (% lang="en-US" %)**POST /api/v3/users** 265 265 ))) 266 266 267 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).386 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 268 268 269 269 (% style="color:#000000" %)Метод запроса: **POST** 270 270 ... ... @@ -274,7 +274,8 @@ 274 274 275 275 (% style="color:#000000" %)Параметры в теле запроса (JSON): 276 276 277 -(% style="color:#000000" %){ 396 +(% style="color:#000000" %) 397 +{ 278 278 "lastName": "", ~/~/ фамилия 279 279 "firstName": "", ~/~/ имя 280 280 "position": "", ~/~/ должность ... ... @@ -283,25 +283,43 @@ 283 283 "login": "", ~/~/ логин (обязателен) 284 284 "password": "", ~/~/ пароль (обязателен) 285 285 "email": "", ~/~/ email (обязателен) 286 - "description": "", ~/~/ описание 287 - "isEnabled": "", ~/~/ признак включения 406 + "description": "string", ~/~/ Описание 407 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 408 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 409 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 288 288 "parentId": "", ~/~/ Guid родительского агента 289 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 290 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 291 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 292 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 293 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 294 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 411 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 412 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 413 + "doubleAuth": 414 + { 415 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 416 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 417 + }, 418 + "groups": 419 + [ 420 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 421 + ], 422 + "customGroups": 423 + [ 424 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 425 + ], 426 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 295 295 } 428 +{ 429 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 430 + "lastName": "string", 431 + "firstName": "string", 432 + "position": "string", 433 + "phone": "string", 434 + "organization": "string", 435 + "login": "string", 436 + "password": "string", 437 + "email": "string", 296 296 297 297 (% style="text-align:left" %) 298 298 (% style="color:#000000; font-weight:normal" %)Ответ: 299 - 300 -(% style="text-align:left" %) 301 -(% style="color:#000000; font-weight:normal" %){ 302 - 303 -(% style="text-align:left" %) 304 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 441 +{ 442 + "id": "" , ~/~/ ID пользователя 305 305 "lastName": "" , ~/~/ Фамилия , 306 306 "firstName": "" , ~/~/ Имя 307 307 "position": "" , ~/~/ Должность ... ... @@ -318,14 +318,12 @@ 318 318 "kind": "" , ~/~/ тип аутентификации 319 319 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 320 320 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 459 +} 321 321 322 -(% style="text-align:left" %) 323 -(% style="color:#000000; font-weight:normal" %)} 324 324 462 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 325 325 326 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) == 327 - 328 -(% class="box successmessage" %) 464 +(% class="box infomessage" %) 329 329 ((( 330 330 (% lang="en-US" %)**POST /api/v3/users/find** 331 331 ))) ... ... @@ -342,19 +342,16 @@ 342 342 343 343 (% style="color:#000000" %)Параметры в теле запроса (JSON): 344 344 345 -(% style="color:#000000" %){ 346 - 481 +(% style="color:#000000" %){(%%) 347 347 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 348 348 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 349 349 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 350 350 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 351 - 352 352 (% style="color:#000000" %)} 353 353 354 354 (% style="color:#000000" %)Ответ: 355 355 356 356 (% style="color:#000000" %){ (%%) 357 - 358 358 "id": "" , ~/~/ идентификатор пользователя 359 359 "lastName": "" , ~/~/ фамилия 360 360 "firstName": "" , ~/~/ имя ... ... @@ -367,14 +367,12 @@ 367 367 "email": "" , ~/~/ E-mail 368 368 "sessionDuration":"", ~/~/ длительность сессии в минутах 369 369 "status": "1", ~/~/ статус пользователя 370 - "astLogged": "", ~/~/ дата/время последней авторизации 371 - 503 + "lastLogged": "", ~/~/ дата/время последней авторизации 372 372 (% style="color:#000000" %)} 373 373 506 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 374 374 375 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) == 376 - 377 -(% class="box successmessage" %) 508 +(% class="box infomessage" %) 378 378 ((( 379 379 (% lang="en-US" %)**GET /api/v3/users/{GUID}** 380 380 ))) ... ... @@ -406,8 +406,11 @@ 406 406 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 407 407 "description": "", ~/~/ Описание 408 408 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 409 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 410 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 540 + "doubleAuth": 541 + { 542 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 543 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 544 + }, 411 411 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 412 412 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 413 413 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован ... ... @@ -421,15 +421,14 @@ 421 421 ))) 422 422 ))) 423 423 558 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 424 424 425 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) == 426 - 427 427 (% class="box warningmessage" %) 428 428 ((( 429 429 (% lang="en-US" %)**PUT /api/v3/users** 430 430 ))) 431 431 432 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).565 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 433 433 434 434 (% style="color:#000000" %)Метод запроса: **PUT** 435 435 ... ... @@ -441,10 +441,8 @@ 441 441 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 442 442 443 443 (% lang="en-US" style="text-align:left" %) 444 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 445 - 446 -(% lang="en-US" style="text-align:left" %) 447 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 577 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 578 + "id": "" , ~/~/ ID пользователя 448 448 "lastName": "" , ~/~/ фамилия 449 449 "firstName": "" , ~/~/ имя 450 450 "position": "" , ~/~/ должность ... ... @@ -451,7 +451,9 @@ 451 451 "phone": "" , ~/~/ телефон 452 452 "organization": "" , ~/~/ организация 453 453 "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 454 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 585 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 586 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 587 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 455 455 "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 456 456 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 457 457 "isEnabled": "" , ~/~/ признак включения ... ... @@ -458,12 +458,13 @@ 458 458 "parentId": "" , ~/~/ Guid родительского агента 459 459 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 460 460 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 461 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 462 - "kind": "" , ~/~/ тип аутентификации 463 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 464 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 465 - 466 -(% lang="en-US" style="text-align:left" %) 594 + "doubleAuth": 595 + { 596 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 597 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 598 + }, 599 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 600 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 467 467 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 468 468 469 469 (% lang="en-US" style="text-align:left" %) ... ... @@ -470,10 +470,8 @@ 470 470 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 471 471 472 472 (% lang="en-US" style="text-align:left" %) 473 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 474 - 475 -(% lang="en-US" style="text-align:left" %) 476 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 607 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 608 + "id": "" , ~/~/ идентификатор пользователя 477 477 "lastName": "" , ~/~/ фамилия 478 478 "firstName": "" , ~/~/ имя 479 479 "position": "" , ~/~/ должность ... ... @@ -486,23 +486,24 @@ 486 486 "isEnabled": "" , ~/~/ признак включения 487 487 "parentId": "" , ~/~/ Guid родительского агента 488 488 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 489 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 490 - "kind": "" , ~/~/ тип аутентификации 621 + "doubleAuth": 622 + { 623 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 624 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 625 + }, 626 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 491 491 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 492 492 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 629 +} 493 493 494 -(% lang="en-US" style="text-align:left" %) 495 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 631 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 496 496 497 - 498 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) == 499 - 500 500 (% class="box warningmessage" %) 501 501 ((( 502 502 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 503 503 ))) 504 504 505 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).638 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 506 506 507 507 (% style="color:#000000" %)Метод запроса: **PUT** 508 508 ... ... @@ -514,26 +514,23 @@ 514 514 515 515 (% style="color:#000000" %)Параметры в теле запроса (JSON): 516 516 517 -(% style="color:#000000" %){ 518 - 650 +(% style="color:#000000" %){(%%) 519 519 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 520 520 "description": "" , ~/~/ описание 521 521 "data": "" , ~/~/ данные, связанные со сменой статуса 522 - 523 523 (% style="color:#000000" %)} 524 524 525 525 (% style="text-align:left" %) 526 526 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 527 527 659 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 528 528 529 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) == 530 - 531 531 (% class="box warningmessage" %) 532 532 ((( 533 533 **POST /api/v3/users/disable** 534 534 ))) 535 535 536 -Метода позволяет выполнить массовую блокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).666 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 537 537 538 538 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 539 539 ... ... @@ -542,21 +542,20 @@ 542 542 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 543 543 544 544 [ 545 - 675 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 546 546 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 547 547 ] 548 548 549 549 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 550 550 681 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 551 551 552 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) == 553 - 554 554 (% class="box warningmessage" %) 555 555 ((( 556 556 **POST /api/v3/users/enable** 557 557 ))) 558 558 559 -Метода позволяет выполнить массовую разблокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).688 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 560 560 561 561 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 562 562 ... ... @@ -584,17 +584,16 @@ 584 584 } 585 585 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 586 586 "users" - массив id пользователей, которых не удалось включить или отключить. 587 - 588 - 589 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) == 590 590 ))) 591 591 718 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 719 + 592 592 (% class="box errormessage" %) 593 593 ((( 594 594 (% lang="en-US" %)**DELETE /api/v3/users/{id}** 595 595 ))) 596 596 597 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).725 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 598 598 599 599 (% style="color:#000000" %)Метод запроса: **DELETE** 600 600 ... ... @@ -607,12 +607,253 @@ 607 607 (% style="text-align:left" %) 608 608 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 609 609 738 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 610 610 611 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел:**Транспортныесредства**(%%) =740 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 612 612 742 +(% class="box infomessage" %) 743 +((( 744 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 745 +))) 613 613 614 - ==(%style="color:#000000; font-size:14px" %)**Получениеинформацииобобъекте**(%%) ==747 +Метод возвращает полную информацию о модели объекта. 615 615 749 +(% style="color:#000000" %)Метод запроса: **GET** 750 + 751 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 752 + 753 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 754 + 755 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 756 + 757 +(% style="color:#000000" %)Ответ: 758 + 759 +(% style="color:#000000" %){ 760 + "parentName": "string", 761 + "name": "string", 762 + "picture": "string", 763 + "minspeed": 0, 764 + "maxspeed": 0, 765 + "width": 0, 766 + "imbeddedtrailer": true, 767 + "hoppercapacity": 0, 768 + "hopperdischargespeed": 0, 769 + "modelType": 0, 770 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 771 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 772 + "deleted": true 773 +} 774 + 775 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 776 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 777 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 778 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 779 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 780 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 781 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 782 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 783 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 784 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 785 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 786 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 787 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 788 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 789 + 790 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 791 + 792 +(% class="box successmessage" %) 793 +((( 794 +(% lang="en-US" %)**POST /api/v3/models/find** 795 +))) 796 + 797 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 798 + 799 +(% style="color:#000000" %)Метод запроса: **POST** 800 + 801 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 802 + 803 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 804 + 805 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 806 + 807 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 808 +} 809 + 810 +(% style="color:#000000" %)Ответ: 811 + 812 +(% style="color:#000000" %)[ 813 + { 814 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 815 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 816 + "parentName": "string", 817 + "name": "string", 818 + "modelType": 0 819 + } 820 +] 821 + 822 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 823 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 824 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 825 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 826 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 827 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 828 + 829 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 830 + 831 +(% class="box successmessage" %) 832 +((( 833 +(% lang="en-US" %)**POST /api/v3/models** 834 +))) 835 + 836 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 837 + 838 +(% style="color:#000000" %)Метод запроса: **POST** 839 + 840 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 841 + 842 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 843 + 844 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 845 + 846 +{ 847 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 848 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 849 + "deleted": true, 850 + "extId": "string", 851 + "name": "string", 852 + "picture": "string", 853 + "minspeed": 0, 854 + "maxspeed": 0, 855 + "width": 0, 856 + "imbeddedtrailer": true, 857 + "fueloutlay": 0, 858 + "hoppercapacity": 0, 859 + "hopperdischargespeed": 0, 860 + "modelType": 0 861 +} 862 + 863 +Ответ: 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 + "hoppercapacity": 0, 877 + "hopperdischargespeed": 0, 878 + "modelType": 0 879 +} 880 + 881 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 882 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 883 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 884 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 885 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 886 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 887 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 888 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 889 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 890 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 891 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 892 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 893 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 894 + 895 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 896 + 897 +(% class="box warningmessage" %) 898 +((( 899 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 900 +))) 901 + 902 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 903 + 904 +(% style="color:#000000" %)Метод запроса: **PUT** 905 + 906 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 907 + 908 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 909 + 910 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 911 + 912 +{ 913 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 914 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 915 + "deleted": true, 916 + "extId": "string", 917 + "name": "string", 918 + "picture": "string", 919 + "minspeed": 0, 920 + "maxspeed": 0, 921 + "width": 0, 922 + "imbeddedtrailer": true, 923 + "fueloutlay": 0, 924 + "hoppercapacity": 0, 925 + "hopperdischargespeed": 0, 926 + "modelType": 0 927 +} 928 + 929 +Ответ: 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 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 949 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 950 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 951 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 952 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 953 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 954 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 955 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 956 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 957 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 958 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 959 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 960 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 961 + 962 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 963 + 964 +(% class="box errormessage" %) 965 +((( 966 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 967 +))) 968 + 969 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 970 + 971 +(% style="color:#000000" %)Метод запроса: **DELETE** 972 + 973 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 974 + 975 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 976 + 977 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 978 + 979 +Ответ: В случае успеха **Success 200** 980 + 981 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 982 + 983 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 984 + 616 616 (% class="box infomessage" %) 617 617 ((( 618 618 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -620,7 +620,7 @@ 620 620 621 621 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 622 622 623 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):992 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 624 624 625 625 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 626 626 ... ... @@ -628,9 +628,9 @@ 628 628 629 629 (% style="color:#000000" %)Метод запроса: **GET** 630 630 631 -(% 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>1000 +(% 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} 632 632 633 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__>- идентификатор объекта (опционально)1002 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 634 634 635 635 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 636 636 ... ... @@ -644,18 +644,129 @@ 644 644 "deviceTypeId": , ~/~/ ID типа устройства 645 645 "deviceTypeName": "", ~/~/ Название типа устройства 646 646 "sim1": "", ~/~/ Номер SIM1 647 - "parentId": "", Номер SIM2 648 - "parentName": "", Наименование клиента-родителя 649 - "modelId": "", ID модели объекта 650 - "modelName": "", Имя модели объекта 651 - "createdAt": "", Дата создания объекта 652 - "mileageCalcMethod": "", Выбранный метод расчета пробега 653 - "counters": { ~/~/ Нормы 654 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 655 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 656 - "mileage": "", ~/~/ Пробег по нормам в метрах 657 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 1016 + "sim2": "", ~/~/ Номер SIM2 1017 + "parentId": "", ~/~/ ID клиента-родителя 1018 + "parentName": "", ~/~/ Наименование клиента-родителя 1019 + "modelId": "", ~/~/ ID модели объекта 1020 + "modelName": "", ~/~/ Имя модели объекта 1021 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1022 + "unitName": "string", ~/~/ Наименование подразделения 1023 + "status": 0, ~/~/ Статус объекта 1024 + "createdAt": "", ~/~/ Дата создания объекта 658 658 }, 1026 +"customFields": [ ~/~/ Произвольные поля 1027 + { 1028 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1029 + "name": "string", ~/~/ Имя поля 1030 + "value": "string", ~/~/ Значение поля 1031 + "forClient": true, ~/~/ Не используемая функция 1032 + "forTooltip": true, ~/~/ Отображать в подсказке 1033 + "forReport": true ~/~/ Отображать в отчете 1034 + } 1035 + 1036 +], ~/~/ Данные с вкладки нормы 1037 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1038 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1039 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1040 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1041 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1042 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1043 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1044 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1045 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1046 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1047 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1048 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1049 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1050 + "mileageCoeff": 0, ~/~/ коэффициент пробега 1051 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1052 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1053 + "counters": { ~/~/ Счетчики 1054 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1055 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1056 + "mileage": 0, ~/~/ Текущий пробег 1057 + "motohours": 0, ~/~/ Текущие моточасы 1058 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1059 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 1060 + }, 1061 + 1062 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1063 + "id": "string", ~/~/ ID объекта 1064 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 1065 + "host": "string", ~/~/ CMSV6 Web Host 1066 + "login": "string", ~/~/ CMSV6 Account 1067 + "password": "string" ~/~/ CMSV6 Password 1068 + }, 1069 + 1070 +"commandTemplates": [ ~/~/ Шаблоны команд 1071 + { 1072 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1073 + "name": "string", ~/~/ Наименование команды 1074 + "command": "string", ~/~/ Текст команды 1075 + "retries": 0 ~/~/ Количество попыток 1076 + } 1077 + ], 1078 + "sensors": [ ~/~/ Датчики 1079 + { 1080 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1081 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1082 + "type": 0, ~/~/ Тип датчика 1083 + "name": "string", ~/~/ Имя датчика 1084 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1085 + "inputNumber": 0, ~/~/ Номер входа 1086 + "pseudonym": "string", ~/~/ Псевдоним 1087 + "medianDegree": 0, ~/~/ Медианная фильтрация 1088 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1089 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1090 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1091 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1092 + { 1093 + "grades": [ ~/~/ Таблица тарировки 1 1094 + { 1095 + "input": 0, ~/~/ Входящее значение 1096 + "output": 0 ~/~/ Выходящее значение 1097 + } 1098 + ], 1099 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1100 + } 1101 + ], 1102 + "showInTooltip": true, ~/~/ Отображать в подсказке 1103 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1104 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1105 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1106 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1107 + "expr": "string", ~/~/ Формула 1108 + "children": [ ~/~/ массив дочерних датчиков 1109 + "string" 1110 + ], 1111 + "customParams": { ~/~/ прочие произвольные параметры 1112 + "additionalProp1": "string", 1113 + "additionalProp2": "string", 1114 + "additionalProp3": "string" 1115 + }, 1116 + 1117 +~/~/ Характерные для произвольного: 1118 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1119 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1120 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1121 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1122 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1123 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1124 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1125 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1126 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1127 +~/~/ "ValueOn": "Вкл.", 1128 +~/~/ "ValueOff": "Выкл." 1129 + "summaryMaxValue": 0 ~/~/ Макс. значение 1130 + } 1131 + "drivers": [ ~/~/ Водители 1132 + { 1133 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1134 + "name": "string", ~/~/ Наименование 1135 + "description": "string", 1136 + "isDefault": true ~/~/ По умолчанию 1137 + } 1138 + ], 659 659 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 660 660 { 661 661 "id": "", ~/~/ ID задания ... ... @@ -671,7 +671,15 @@ 671 671 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 672 672 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 673 673 } 674 - ] 1154 + ], 1155 +"statusHistory": [ ~/~/ История статусов 1156 + { 1157 + "status": 0, 1158 + "date": "2023-05-22T09:57:39.562Z", 1159 + "description": "string", 1160 + "additionalInfo": "string" 1161 + } 1162 + ] 675 675 } 676 676 ))) 677 677 ... ... @@ -682,14 +682,115 @@ 682 682 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 683 683 684 684 685 -== (% style="color:#000000; font-size:14px" %)**Добавлениеобъекта**(%%)==1173 +== **Импортировать историю ТС (Асинхронный запрос)** == 686 686 687 687 (% class="box successmessage" %) 688 688 ((( 1177 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1178 +))) 1179 + 1180 +(% style="color:#000000" %)Метод запроса: **POST** 1181 + 1182 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} 1183 + 1184 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор транспортного средства 1185 + 1186 + 1187 +Ответ: 1188 + 1189 +{ 1190 + 1191 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1192 + 1193 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1194 + 1195 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1196 + 1197 + "Message": "string", ~/~/ Информация о выполнении запроса 1198 + 1199 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1200 + 1201 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1202 + 1203 + "Data": "string" ~/~/ Данные 1204 + 1205 +} 1206 + 1207 + 1208 +== **Отправить команду на терминал** == 1209 + 1210 +(% class="box successmessage" %) 1211 +((( 1212 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1213 +))) 1214 + 1215 +Команда для отправки на тс. 1216 + 1217 +{ 1218 +"id": "", ~/~/идентификатор произвольного поля 1219 +"command": "", ~/~/ Текст команды 1220 +"retries": "", ~/~/ Количество попыток 1221 +"idTemplate": "" ~/~/ ID шаблона команды 1222 +} 1223 + 1224 + 1225 +== **Получить ответ на отправленную на ТС команду** == 1226 + 1227 +(% class="box infomessage" %) 1228 +((( 1229 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1230 +))) 1231 + 1232 +Идентификатор команды: cmdid 1233 + 1234 +Запрос от терминала на ответ команды 1235 + 1236 +Пример ответ от терминала: 1237 + 1238 +ID= "" ~/~/ идентификатор произвольного поля 1239 +Soft="" ~/~/ версия софта 1240 +GPS=4 ~/~/ тип трекера 1241 +Time=11:05:43 28.06.24 ~/~/ время запроса 1242 +Lat=45.056221 ~/~/ широта 1243 +Lon=39.035938 ~/~/ долгота 1244 +Speed=0.0 ~/~/ скорость 1245 +Course=181.4 ~/~/направление 1246 + 1247 +((( 1248 +== **Список отправленных объекту команд с ответами** == 1249 + 1250 +(% class="box infomessage" %) 1251 +((( 1252 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1253 +))) 1254 + 1255 +Идентификатор ТС: vehicleId 1256 + 1257 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1258 + 1259 +Пример ответа терминала 1260 + 1261 +[ 1262 +{ 1263 +"id": "", ~/~/ идентификатор пользователя 1264 +"commandText": "", ~/~/Текст команды. 1265 +"templateId": "", ~/~/Идентификатор шаблона 1266 +"updated": "", ~/~/ Время отправки 1267 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1268 +"answer": "", ~/~/ Ответ терминала. 1269 +"status": "" ~/~/ Статус отправки 1270 +} 1271 +] 1272 +))) 1273 + 1274 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1275 + 1276 +(% class="box successmessage" %) 1277 +((( 689 689 (% lang="en-US" %)**POST /api/v3/vehicles** 690 690 ))) 691 691 692 -(% style="color:#000000" %)Метод позволяет добавить объект . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).1281 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 693 693 694 694 (% style="color:#000000" %)Метод запроса: **POST** 695 695 ... ... @@ -699,8 +699,7 @@ 699 699 700 700 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 701 701 702 -(% style="color:#000000" %){ 703 - 1291 +(% style="color:#000000" %){(%%) 704 704 "parentId": "" , ~/~/ ID клиента 705 705 "name": "" , ~/~/ имя ТС 706 706 "imei": "" , ~/~/ IMEI ... ... @@ -721,6 +721,10 @@ 721 721 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 722 722 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 723 723 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1312 + "mileageCalcMethod": 0, 1313 + "mileageCoeff": 0, 1314 + "locationByCellId": true, 1315 + "dottedLineTrackWhenNoCoords": true, 724 724 "counters": ~/~/ счетчики 725 725 { 726 726 "mileage": "" , ~/~/ пробег ... ... @@ -749,70 +749,265 @@ 749 749 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 750 750 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 751 751 } 1344 +"drivers": [ ~/~/ Водители 1345 + { 1346 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1347 + "isDefault": true 1348 + } 1349 + ], 1350 + "commandTemplates": [ ~/~/ Шаблон команды 1351 + { 1352 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1353 + "name": "string", 1354 + "command": "string", 1355 + "retries": 0 1356 + } 1357 + ], 1358 +"sensors": [ ~/~/ Датчики 1359 + { 1360 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1361 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1362 + "type": 0, ~/~/ Тип датчика 1363 + "name": "string", ~/~/ Имя датчика 1364 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1365 + "inputNumber": 0, ~/~/ Номер входа 1366 + "pseudonym": "string", ~/~/ Псевдоним 1367 + "medianDegree": 0, ~/~/ Медианная фильтрация 1368 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1369 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1370 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1371 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1372 + { 1373 + "grades": [ ~/~/ Таблица тарировки 1 1374 + { 1375 + "input": 0, ~/~/ Входящее значение 1376 + "output": 0 ~/~/ Выходящее значение 1377 + } 1378 + ], 1379 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1380 + } 1381 + ], 1382 + "showInTooltip": true, ~/~/ Отображать в подсказке 1383 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1384 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1385 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1386 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1387 + "expr": "string", ~/~/ Формула 1388 + "children": [ ~/~/ массив дочерних датчиков 1389 + "string" 1390 + ], 1391 + "customParams": { ~/~/ прочие произвольные параметры 1392 + "additionalProp1": "string", 1393 + "additionalProp2": "string", 1394 + "additionalProp3": "string" 1395 + }, 1396 +~/~/ Характерные для произвольного: 1397 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1398 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1399 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1400 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1401 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1402 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1403 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1404 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1405 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1406 +~/~/ "ValueOn": "Вкл.", 1407 +~/~/ "ValueOff": "Выкл." 1408 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 752 752 753 -(% style="color:#000000" %) } 1410 +((( 1411 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1412 + { 1413 + "from": 0, ~/~/ С какого значения 1414 + "color": "string", ~/~/ Каким цветом 1415 + "text": "string" ~/~/ Текст подписи к этому интервалу 1416 + } 1417 + ] 1418 + } 1419 + ], 1420 +))) 754 754 1422 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1423 + 1424 + 1425 + "customFields": [ ~/~/ Произвольные поля 1426 + { 1427 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1428 + "name": "string", ~/~/ Наименование произвольного поля 1429 + "value": "string", ~/~/ Значение произвольного поля 1430 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1431 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1432 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1433 + } 1434 + ] 1435 +} 1436 + 755 755 (% style="color:#000000" %)Ответ: 756 756 757 -(% style="color:#000000" %){ 758 758 759 - "vehicleId": "", ~/~/ID ТС 760 - "parentId": "", ~/~/Guid владельца ТС 761 - "name": "", ~/~/Имя объекта 762 - "imei": "", ~/~/IMEI 763 - "deviceTypeId": "", ~/~/ID типа устройства 764 - "modelId": "", ~/~/ID модели 765 - "unitId": "", ~/~/ID подразделения 766 - "sim1": "", ~/~/SIM1 767 - "sim2": "", ~/~/SIM2 768 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 769 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 770 - "counters": { ~/~/Счётчики 771 - "mileageEnabled": true, 772 - "motohoursEnabled": true, 773 - "mileage": "", 774 - "motohours": 345.0 775 - }, 776 - "cmsv6Parameters": { ~/~/Параметры CmsV6 777 - "id": null, 778 - "enabled": true, ~/~/флаг включения 779 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 780 - "login": "", ~/~/ имя учетной записи 781 - "password": "" ~/~/ пароль учетной записи 782 - }, 783 - "inspectionTasks": { ~/~/ задания на ТО 784 - "id": "", ~/~/ ID задачи 785 - "enabled": false, ~/~/ Признак включения 786 - "name": "", ~/~/ Имя задания 787 - "description": "", ~/~/ Описание задания 788 - "mileageCondition": "", ~/~/ Условие по пробегу 789 - "lastMileage": "", ~/~/ Пробег (в метрах) 790 - "motohoursCondition": "", ~/~/ Условие по моточасам 791 - "lastMotohours": "", ~/~/ Моточасы 792 - "periodicCondition": "", ~/~/ Условие периодичности по времени 793 - "kind": "", ~/~/ Вид периодичности по времени 794 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1440 +((( 1441 +((( 1442 +((( 1443 +{ 1444 + "vehicleId": 0, ~/~/ ID ТС 1445 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1446 + "name": "string", ~/~/ Имя объекта 1447 + "imei": "string", ~/~/ IMEI 1448 + "deviceTypeId": 0, ~/~/ ID типа устройства 1449 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1450 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1451 + "sim1": "string", ~/~/ SIM1 1452 + "sim2": "string", ~/~/ SIM2 1453 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1454 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1455 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1456 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1457 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1458 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1459 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1460 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1461 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1462 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1463 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1464 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1465 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1466 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1467 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1468 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1469 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1470 + "counters": { ~/~/ Dto для состояний счётчиков 1471 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1472 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1473 + "mileage": 0, ~/~/ Пробег 1474 + "motohours": 0 ~/~/ Моточасы 1475 + }, 1476 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1477 + "id": "string", ~/~/ CMSV6 Идентификатор 1478 + "enabled": true, ~/~/ Признак включения 1479 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1480 + "login": "string", ~/~/ CMSV6 имя учетной записи 1481 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1482 + }, 1483 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1484 + { 1485 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1486 + "enabled": true, ~/~/ Признак включения 1487 + "name": "string", ~/~/ Имя задания 1488 + "description": "string", ~/~/ Описание задания 1489 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1490 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1491 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1492 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1493 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1494 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1495 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1496 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 795 795 } 1498 + ], 1499 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1500 + { 1501 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1502 + "inputNumber": 0, ~/~/ № входа. 1503 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1504 + "comment": "string", ~/~/ Комментарий 1505 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1506 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1507 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1508 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1509 + } 1510 + ], 1511 + "commandTemplates": [ ~/~/ Список шаблонов команд 1512 + { 1513 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1514 + "name": "string", ~/~/ Название шаблона команд 1515 + "command": "string", ~/~/ Команда на выполнение 1516 + "retries": 0 ~/~/ Лимит попыток отправки 1517 + } 1518 + ], 1519 + "sensors": [ ~/~/ Список датчиков 1520 + { 1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1522 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1523 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1524 + "name": "string", ~/~/ Имя датчика 1525 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1526 + "inputNumber": 0, ~/~/ Номер входа 1527 + "pseudonym": "string", ~/~/ Псевдоним 1528 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1529 + "isInverted": true, ~/~/ Признак инверсии 1530 + "disabled": true, ~/~/ Датчик не участвует в обработке 1531 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1532 + "gradesTables": [ ~/~/ Тарировка 1533 + { 1534 + "grades": [ ~/~/ Таблицы тарировки 1535 + { 1536 + "input": 0, ~/~/ Вход 1537 + "output": 0 ~/~/ Выход 1538 + } 1539 + ], 1540 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1541 + } 1542 + ], 1543 + "showInTooltip": true, ~/~/ Отображение в подсказке 1544 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1545 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1546 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1547 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1548 + "expr": "string", ~/~/ Выражение 1549 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1550 + "string" 1551 + ], 1552 + "customParams": { 1553 + "additionalProp1": "string", 1554 + "additionalProp2": "string", 1555 + "additionalProp3": "string" 1556 + }, 1557 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1558 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1559 + { 1560 + "from": 0, ~/~/ С какого значения 1561 + "color": "string", ~/~/ Каким цветом 1562 +))) 796 796 797 -(% style="text-align:left" %) 798 -(% style="color:#000000" %)} 1564 +((( 1565 + "text": "string" ~/~/ Текст подписи к этому интервалу 1566 + } 1567 + ] 1568 + } 1569 + ], 1570 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1571 + "customFields": [ ~/~/ Список произвольных полей 1572 + { 1573 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1574 + "name": "string", ~/~/ Наименование произвольного поля 1575 + "value": "string", ~/~/ Значение произвольного поля 1576 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1577 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1578 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1579 + } 1580 + ], 1581 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1582 +} 1583 +))) 1584 +))) 1585 +))) 799 799 1587 + 800 800 **Валидация:** 801 801 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 802 802 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 803 803 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 804 804 1593 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 805 805 806 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) == 807 - 808 -(% class="box successmessage" %) 1595 +(% class="box infomessage" %) 809 809 ((( 810 810 (% lang="en-US" %)**POST /api/v3/vehicles/find** 811 811 ))) 812 812 813 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1600 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 814 814 815 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):1602 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 816 816 817 817 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 818 818 ... ... @@ -844,9 +844,12 @@ 844 844 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 845 845 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 846 846 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 847 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 848 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 849 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1634 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1635 + "unitName": "string", ~/~/ Название подразделения (опционально) 1636 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1637 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1638 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1639 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 850 850 } 851 851 852 852 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -853,8 +853,14 @@ 853 853 854 854 (% style="color:#000000" %)Ответ: 855 855 856 -(% style="color:#000000" %){ 1646 +(% style="color:#000000" %)[ 1647 +{ 857 857 1649 +((( 1650 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1651 +))) 1652 + 1653 +((( 858 858 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 859 859 "name": "" ~/~/ наименование объекта 860 860 "imei": "" ~/~/ IMEI объекта ... ... @@ -880,20 +880,31 @@ 880 880 "forClient": true, ~/~/ право на отображение у клиента 881 881 "forTooltip": false, ~/~/ право на отображение в подсказке 882 882 "forReport": false ~/~/ право на отображение в отчетах 883 - }(%%) 884 -(% style="color:#000000" %)} 1679 +))) 885 885 1681 +((( 1682 + } 1683 + ], 1684 + "vehicleGroups": [ ~/~/ Группы ТС 1685 + { 1686 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1687 + "name": "string" ~/~/ Наименование группы ТС 1688 + } 1689 + ] 1690 + } 1691 +] 1692 +))) 1693 + 886 886 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 887 887 1696 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 888 888 889 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) == 890 - 891 891 (% class="box successmessage" %) 892 892 ((( 893 893 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 894 894 ))) 895 895 896 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1703 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 897 897 898 898 (% style="color:#000000" %)Метод запроса: **POST** 899 899 ... ... @@ -915,13 +915,11 @@ 915 915 "data": "", ~/~/ Данные 916 916 "overwrite": false, ~/~/ Флаг перезаписи 917 917 "stage": "", ~/~/ Состояние, может быть null 918 - 919 919 (% style="color:#000000" %)} 920 920 921 921 (% style="color:#000000" %)Ответ: 922 922 923 -(% style="color:#000000" %){ 924 - 1729 +(% style="color:#000000" %){(%%) 925 925 "status": "", ~/~/ значение статуса 926 926 "date": "", ~/~/ Дата смены статуса 927 927 "description": "", ~/~/ Описание ... ... @@ -928,12 +928,11 @@ 928 928 "data": "", ~/~/ Данные 929 929 "overwrite": false, ~/~/ Флаг перезаписи 930 930 "stage": "", ~/~/ Состояние 931 - 932 -(% style="text-align:left" %) 933 933 (% style="color:#000000" %) } 934 934 1738 +== == 935 935 936 -== (% style="color:#000000; font-size:1 4px" %)**Редактирование объекта**(%%) ==1740 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 937 937 938 938 (% class="box warningmessage" %) 939 939 ((( ... ... @@ -940,7 +940,7 @@ 940 940 (% lang="en-US" %)**PUT /api/v3/vehicles** 941 941 ))) 942 942 943 -(% style="color:#000000" %)Метод позволяет отредактировать объект . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1747 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 944 944 945 945 (% style="color:#000000" %)Метод запроса: **PUT** 946 946 ... ... @@ -950,18 +950,16 @@ 950 950 951 951 (% style="color:#000000" %)Параметры в теле запроса (JSON): 952 952 953 -(% style="color:#000000" %){ 954 - 955 -((( 956 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 957 - "parentId": "", ~/~/ ID клиента 958 - "name": "", ~/~/ имя ТС 959 - "imei": "", ~/~/ IMEI 960 - "deviceTypeId": "", ~/~/ ID типа устройства 961 - "modelId": "", ~/~/ , ID модели 962 - "unitId": "", ~/~/ подразделения 963 - "sim1": "", ~/~/ SIM 1 964 - "sim2": "", ~/~/ SIM2 (%%) 1757 +(% style="color:#000000" %){ 1758 + "vehicleId": , ~/~/ ID объекта 1759 + "parentId": "" , ~/~/ ID клиента 1760 + "name": "" , ~/~/ имя ТС 1761 + "imei": "" , ~/~/ IMEI 1762 + "deviceTypeId": "" , ~/~/ ID типа устройства 1763 + "modelId": "" , ~/~/ ID модели 1764 + "unitId": "" , ~/~/ ID подразделения 1765 + "sim1": "" , ~/~/ Номер SIM 1 1766 + "sim2": "" , ~/~/ Номер SIM2 965 965 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 966 966 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 967 967 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -974,103 +974,314 @@ 974 974 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 975 975 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 976 976 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 977 -(% style="color:#000000" %) "counters": 978 - { 979 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 980 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 981 - "mileage": "", ~/~/ пробег, в метрах 982 - "motohours": "" ~/~/ моточасы, в секундах 983 - } 984 - "cmsv6Parameters": ~/~/ параметры CMSv6 985 - { 986 - "id": "", ~/~/ идентификатор 987 - "enabled": true, ~/~/ флаг включения 988 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 989 - "login": "", ~/~/ имя учетной записи 990 - "password": "", ~/~/ пароль учетной записи 991 - } 992 - "inspectionTasks": ~/~/ задания на ТО 993 - { 994 - "id": "", ~/~/ ID задания 995 - "enabled": false, ~/~/ Признак включения 996 - "name": "", ~/~/ Имя задания 997 - "description": "", ~/~/ Описание задания 998 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 999 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1000 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1001 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1002 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1003 - "kind": "", ~/~/ Вид периодичности по времени 1004 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1005 - } 1006 -))) 1007 1007 1008 -(% style="color:#000000" %)} 1780 + "mileageCalcMethod": 0, 1781 + "mileageCoeff": 0, 1782 + "locationByCellId": true, 1783 + "dottedLineTrackWhenNoCoords": true, 1784 + "counters": ~/~/ счетчики 1785 + { 1786 + "mileage": "" , ~/~/ пробег 1787 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1788 + "motohours": "" , ~/~/ моточасы 1789 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1790 + }, 1791 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1792 + "enabled": true, ~/~/ флаг включения 1793 + "id": "" , ~/~/ идентификатор 1794 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1795 + "login": "" , ~/~/ имя учетной записи 1796 + "password": "" ~/~/ пароль учетной записи 1797 + }, 1798 + "inspectionTasks": ~/~/ задания на ТО 1799 + { 1800 + "enabled": "" , ~/~/ Признак включения 1801 + "name": "" , ~/~/ Имя задания 1802 + "description": "" , ~/~/ Описание задания 1803 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1804 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1805 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1806 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1807 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1808 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1809 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1810 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1811 + } 1009 1009 1813 +"drivers": [ ~/~/ Водители 1814 + { 1815 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1816 + "isDefault": true 1817 + } 1818 + ], 1819 + "commandTemplates": [ ~/~/ Шаблон команды 1820 + { 1821 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1822 + "name": "string", 1823 + "command": "string", 1824 + "retries": 0 1825 + } 1826 + ], 1827 +"sensors": [ ~/~/ Датчики 1828 + { 1829 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1830 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1831 + "type": 0, ~/~/ Тип датчика 1832 + "name": "string", ~/~/ Имя датчика 1833 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1834 + "inputNumber": 0, ~/~/ Номер входа 1835 + "pseudonym": "string", ~/~/ Псевдоним 1836 + "medianDegree": 0, ~/~/ Медианная фильтрация 1837 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1838 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1839 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1840 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1841 + { 1842 + "grades": [ ~/~/ Таблица тарировки 1 1843 + { 1844 + "input": 0, ~/~/ Входящее значение 1845 + "output": 0 ~/~/ Выходящее значение 1846 + } 1847 + ], 1848 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1849 + } 1850 + ], 1851 + "showInTooltip": true, ~/~/ Отображать в подсказке 1852 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1853 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1854 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1855 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1856 + "expr": "string", ~/~/ Формула 1857 + "children": [ ~/~/ массив дочерних датчиков 1858 + "string" 1859 + ], 1860 + "customParams": { ~/~/ прочие произвольные параметры 1861 + "additionalProp1": "string", 1862 + "additionalProp2": "string", 1863 + "additionalProp3": "string" 1864 + }, 1865 +~/~/ Характерные для произвольного: 1866 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1867 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1868 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1869 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1870 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1871 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1872 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1873 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1874 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1875 +~/~/ "ValueOn": "Вкл.", 1876 +~/~/ "ValueOff": "Выкл." 1877 + "summaryMaxValue": 0 ~/~/ Макс. значение 1878 + 1879 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1880 + { 1881 + "from": 0, ~/~/ С какого значения 1882 + "color": "string", ~/~/ Каким цветом 1883 + "text": "string" ~/~/ Текст подписи к этому интервалу 1884 + } 1885 + ] 1886 + } 1887 + ], 1888 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1889 + 1890 + "customFields": [ ~/~/ Произвольные поля 1891 + { 1892 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1893 + "name": "string", ~/~/ Наименование произвольного поля 1894 + "value": "string", ~/~/ Значение произвольного поля 1895 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1896 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1897 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1898 + } 1899 + ] 1900 +} 1901 + 1902 + 1010 1010 (% style="color:#000000" %)Ответ: 1011 1011 1012 -(% lang="en-US" style="text-align:left" %) 1013 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1905 +((( 1906 +{ 1907 + "vehicleId": 0, ~/~/ ID ТС 1908 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1909 + "name": "string", ~/~/ Имя объекта 1910 + "imei": "string", ~/~/ IMEI 1911 + "deviceTypeId": 0, ~/~/ ID типа устройства 1912 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1913 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1914 + "sim1": "string", ~/~/ SIM1 1915 + "sim2": "string", ~/~/ SIM2 1916 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1917 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1918 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1919 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1920 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1921 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1922 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1923 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1924 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1925 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1926 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1927 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1928 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1929 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1930 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1931 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1932 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1933 + "counters": { ~/~/ состояний счётчиков 1934 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1935 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1936 + "mileage": 0, ~/~/ Пробег 1937 + "motohours": 0 ~/~/ Моточасы 1938 + }, 1939 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1940 + "id": "string", ~/~/ CMSV6 Идентификатор 1941 + "enabled": true, ~/~/ Признак включения 1942 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1943 +))) 1014 1014 1015 -(% lang="en-US" style="text-align:left" %) 1016 - "vehicleId": "", ~/~/ ID ТС 1017 - "parentId": "", ~/~/ ID клиента 1018 - "name": "", ~/~/ имя ТС 1019 - "imei": "", ~/~/ IMEI 1020 - "deviceTypeId": "", ~/~/ типа устройства 1021 - "modelId": "", ~/~/ ID модели 1022 - "unitId": "", ~/~/ ID подразделения 1023 - "sim1": "", ~/~/ SIM 1 1024 - "sim2": "", ~/~/ SIM2 1025 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1026 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1027 - "counters": 1028 - { 1029 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1030 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1031 - "mileage": "", ~/~/ пробег 1032 - "motohours": "", ~/~/ моточасы 1033 - } 1034 - "cmsv6Parameters": ~/~/ параметры CMSv6 1945 + 1946 +((( 1947 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1948 + "login": "string", ~/~/ CMSV6 имя учетной записи 1949 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1950 + }, 1951 + "inspectionTasks": [ ~/~/ Задания на ТО 1952 + { 1953 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1954 + "enabled": true, ~/~/ Признак включения 1955 + "name": "string", ~/~/ Имя задания 1956 + "description": "string", ~/~/ Описание задания 1957 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1958 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1959 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1960 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1961 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1962 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 1963 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 1964 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1965 + } 1966 + ], 1967 + "drivers": [ ~/~/ Список водителей 1968 + { 1969 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1970 + "inputNumber": 0, ~/~/ № входа. 1971 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 1972 + "comment": "string", ~/~/ Комментарий. 1973 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1974 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1975 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 1976 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 1977 + } 1978 + ], 1979 + "commandTemplates": [ ~/~/ Список шаблонов команд 1980 + { 1981 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1982 + "name": "string", ~/~/ Название шаблона команд 1983 + "command": "string", ~/~/ Команда на выполнение 1984 + "retries": 0 ~/~/ Лимит попыток отправки 1985 + } 1986 + ], 1987 + "sensors": [ ~/~/ Список датчиков 1988 + { 1989 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1990 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1991 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 1992 +))) 1993 + 1994 +((( 1995 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 1996 +))) 1997 + 1998 +((( 1999 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2000 +))) 2001 + 2002 +((( 2003 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2004 +))) 2005 + 2006 +((( 2007 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2008 +))) 2009 + 2010 +((( 2011 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2012 + "name": "string", ~/~/ Имя датчика 2013 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2014 +))) 2015 + 2016 +((( 2017 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2018 + "inputNumber": 0, ~/~/ Номер входа 2019 + "pseudonym": "string", ~/~/ Псевдоним 2020 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2021 + "isInverted": true, ~/~/ Признак инверсии 2022 + "disabled": true, ~/~/ Датчик не участвует в обработке 2023 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2024 + "gradesTables": [ ~/~/ Тарировка 1035 1035 { 1036 - "id": ~/~/ идентификатор 1037 - "enabled": true, ~/~/ флаг включения 1038 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1039 - "login": "", ~/~/ имя учетной записи 1040 - "password": "", ~/~/ пароль учетной записи 1041 - } 1042 - "inspectionTasks": ~/~/ задания на ТО 2026 + "grades": [ ~/~/ Таблицы тарировки 2027 + { 2028 + "input": 0, ~/~/ Вход 2029 + "output": 0 ~/~/ Выход 2030 + } 2031 + ], 2032 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 2033 + } 2034 + ], 2035 + "showInTooltip": true, ~/~/ Отображение в подсказке 2036 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 2037 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2038 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2039 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2040 + "expr": "string", ~/~/ Выражение 2041 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2042 + "string" 2043 + ], 2044 + "customParams": { ~/~/ Дополнительные настройки 2045 + "additionalProp1": "string", 2046 + "additionalProp2": "string", 2047 + "additionalProp3": "string" 2048 + }, 2049 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2050 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1043 1043 { 1044 - "id": "", ~/~/ ID задания 1045 - "enabled": false, ~/~/ Признак включения 1046 - "name": "", ~/~/ Имя задания 1047 - "description": "", ~/~/ Описание задания 1048 - "mileageCondition": "", ~/~/ Условие по пробегу 1049 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1050 - "motohoursCondition": "", ~/~/ Условие по моточасам 1051 - "lastMotohours": "", ~/~/ Моточасы 1052 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1053 - "kind": "", ~/~/ Вид периодичности по времени 1054 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2052 + "from": 0, ~/~/ С какого значения 2053 + "color": "string", ~/~/ Каким цветом 2054 + "text": "string" ~/~/ Текст подписи к этому интервалу 1055 1055 } 2056 + ] 2057 + } 2058 + ], 2059 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2060 + "customFields": [ ~/~/ Список произвольных полей 2061 + { 2062 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2063 + "name": "string", ~/~/ Наименование произвольного поля 2064 + "value": "string", ~/~/ Значение произвольного поля 2065 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2066 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2067 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2068 + } 2069 + ], 2070 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2071 +} 2072 +))) 1056 1056 1057 -(% lang="en-US" style="text-align:left" %) 1058 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1059 - 1060 -**валидация:** 2074 +**Валидация:** 1061 1061 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1062 1062 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1063 1063 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1064 1064 2079 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1065 1065 1066 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) == 1067 - 1068 1068 (% class="box errormessage" %) 1069 1069 ((( 1070 1070 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1071 1071 ))) 1072 1072 1073 -(% style="color:#000000" %)Метод позволяет удалить объект . Метод позволяет удалить объект, указанный в строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).2086 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1074 1074 1075 1075 (% style="color:#000000" %)Метод запроса: **DELETE** 1076 1076 ... ... @@ -1083,66 +1083,2670 @@ 1083 1083 (% style="text-align:left" %) 1084 1084 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1085 1085 2099 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1086 1086 1087 -(% style="color:#000000; font-size:1 4pt" %)Раздел:**Устройства**2101 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1088 1088 1089 - 1090 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) == 1091 - 1092 1092 (% class="box infomessage" %) 1093 1093 ((( 1094 1094 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1095 1095 ))) 1096 1096 1097 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).2108 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1098 1098 1099 1099 (% style="color:#000000" %)Метод запроса: **GET** 1100 1100 1101 -(% 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]]2112 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1102 1102 1103 1103 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1104 1104 1105 1105 (% style="color:#000000" %)Ответ: 1106 1106 1107 -(% style="color:#000000" %){ 1108 - 2118 +(% style="color:#000000" %){(%%) 1109 1109 "deviceTypeId" : "", ~/~/ ID типа устройства 1110 1110 "deviceTypeName" : "" ~/~/ Название типа устройства 1111 - 1112 -(% style="text-align:left" %) 1113 1113 (% style="color:#000000" %)} 1114 1114 2123 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1115 1115 1116 -= (% style="color:#000000; font-size:1 8.6667pt" %)Раздел:**Датчики**(%%) =2125 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1117 1117 1118 - 1119 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) == 1120 - 1121 1121 (% class="box infomessage" %) 1122 1122 ((( 1123 1123 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1124 1124 ))) 1125 1125 1126 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).2132 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1127 1127 1128 1128 (% style="color:#000000" %)Метод запроса: **GET** 1129 1129 1130 1130 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1131 1131 1132 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 2138 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1133 1133 1134 1134 (% style="color:#000000" %)Ответ: 1135 1135 1136 -(% style="color:#000000" %){ 1137 - 2142 +(% style="color:#000000" %){(%%) 1138 1138 "id": "", ~/~/ ID типа датчика 1139 1139 "name": "", ~/~/ Название 1140 1140 "description": "", ~/~/ Описание 2146 +(% style="color:#000000" %)} 1141 1141 2148 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 2149 + 2150 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 2151 + 2152 +(% class="box infomessage" style="text-align: left;" %) 2153 +((( 2154 +**POST /api/v3/terminalMessages/count** 2155 +))) 2156 + 2157 +(% style="text-align: left;" %) 2158 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 2159 + 2160 +(% style="text-align: left;" %) 2161 +Метод запроса **POST** 2162 + 2163 +(% style="text-align: left;" %) 2164 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 2165 + 2166 +(% style="text-align: left;" %) 2167 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2168 + 2169 +(% style="text-align: left;" %) 2170 +{ 2171 + "vehicleIds": [ 2172 + id ~/~/ здесь передается список идентификаторов объектов 2173 + ], 2174 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 2175 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 2176 +} 2177 + 2178 +(% style="text-align: left;" %) 2179 +Ответ: 2180 + 2181 +(% style="text-align: left;" %) 2182 +[ 2183 + { 2184 + "vehicleId": 0, ~/~/ идентификатор объекта 2185 + "count": 0 ~/~/ количество сообщений за период 2186 + } 2187 +] 2188 + 2189 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2190 + 2191 +(% class="box infomessage" style="text-align: left;" %) 2192 +((( 2193 +**POST /api/v3/terminalMessages/mapping** 2194 +))) 2195 + 2196 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2197 + 2198 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2199 + 2200 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2201 + 2202 +{ 2203 + "protocolType": 0, 2204 + "params": ["string"] 2205 +} 2206 + 2207 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2208 +|protocolType|ID типа протокола 2209 +|params|((( 2210 +Массив наименований параметров в сообщении 2211 +))) 2212 + 2213 +Ответ: 2214 + 2215 +{ 2216 + "protocolType": 0, 2217 + "mapping": { 2218 + "additionalProp1": { 2219 + "inputType": 0, 2220 + "inputNumber": 0 2221 + }, 2222 + "additionalProp2": { 2223 + "inputType": 0, 2224 + "inputNumber": 0 2225 + } 2226 + } 2227 +} 2228 + 2229 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2230 +|protocolType|Тип протокола 2231 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2232 +|inputNumber|((( 2233 +Номер входа 2234 +))) 2235 + 2236 +(% class="wikigeneratedid" %) 2237 +Перечень 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/]] 2238 + 2239 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 2240 + 2241 +(% class="box infomessage" %) 2242 +((( 2243 +**POST /api/v3/terminalMessages** 2244 +))) 2245 + 2246 +Метод возвращает список сообщений терминала объекта за выбранный период. 2247 + 2248 +(% style="text-align: left;" %) 2249 +Метод запроса **POST** 2250 + 2251 +(% style="text-align: left;" %) 2252 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2253 + 2254 +(% style="text-align: left;" %) 2255 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2256 + 2257 +{ 2258 + "vehicleId": 0, ~/~/ id объекта 2259 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 2260 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 2261 +} 2262 + 2263 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2264 +|vehicleId|ID объекта 2265 +|from|Дата и время начала периода запроса 2266 +|to|Дата и время окончания периода запроса 2267 + 2268 +Ответ: 2269 + 2270 +[ 2271 + { 2272 + "messages": [ 2273 + { 2274 + "deviceTime": "2023-11-29T07:40:44.052Z", 2275 + "serverTime": "2023-11-29T07:40:44.052Z", 2276 + "speed": 0, 2277 + "altitude": 0, 2278 + "latitude": 0, 2279 + "longitude": 0, 2280 + "satellites": 0, 2281 + "course": 0, 2282 + "voltage": 0, 2283 + "parameters": { 2284 + "additionalProp1": "string", 2285 + "additionalProp2": "string", 2286 + "additionalProp3": "string" 2287 + }, 2288 + "photoCount": 0, 2289 + "lbsCorrectedCoords": true, 2290 + "protocolType": 0 2291 + } 2292 + ] 2293 + } 2294 +] 2295 + 2296 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2297 +|deviceTime|Время сообщения терминала 2298 +|serverTime|Время когда сообщение поступило на сервер 2299 +|speed|Скорость 2300 +|altitude|Высота над уровнем моря 2301 +|latitude|Широта 2302 +|longitude|Долгота 2303 +|satellites|Кол-во спутников 2304 +|course|Курс 2305 +|voltage|Бортовое напряжение 2306 +|parameters|Список параметров и их значений 2307 +|photoCount|Количество фото 2308 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2309 +|protocolType|ID типа протокола 2310 + 2311 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2312 + 2313 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2314 + 2315 +(% class="box infomessage" %) 2316 +((( 2317 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2318 +))) 2319 + 2320 +(% style="color:#000000" %)Метод запроса: **POST** 2321 + 2322 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2323 + 2324 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2325 + 1142 1142 (% style="text-align:left" %) 2327 +Тело запроса: 2328 + 2329 +{ 2330 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2331 + "vehicleIds": [0], ~/~/ Список ID объектов 2332 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2333 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2334 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2335 +} 2336 + 2337 +Ответ: 2338 + 2339 +[ 2340 + { 2341 + "vehicleId": 0, ~/~/ ID объекта 2342 + "name": "string", ~/~/ Имя ТС 2343 + "periods": [ ~/~/ Периоды 2344 + { 2345 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2346 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2347 + "mileage": 0, ~/~/ Пробег за период, километры 2348 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2349 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2350 + "motohours": 0, ~/~/ Моточасы за период, секунды 2351 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2352 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2353 + } 2354 + ] 2355 + } 2356 +] 2357 + 2358 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2359 + 2360 +(% class="box infomessage" %) 2361 +((( 2362 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2363 +))) 2364 + 2365 +(% style="color:#000000" %)Метод запроса: **POST** 2366 + 2367 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2368 + 2369 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2370 + 2371 +(% style="text-align:left" %) 2372 +Тело запроса: 2373 + 2374 +{ 2375 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2376 + "vehicleIds": [0], ~/~/ Список ID объектов 2377 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2378 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2379 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2380 +} 2381 + 2382 +Ответ: 2383 + 2384 +[ 2385 + { 2386 + "vehicleId": 0, ~/~/ ID объекта 2387 + "name": "string", ~/~/ Имя ТС 2388 + "periods": [ ~/~/ Периоды 2389 + { 2390 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2391 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2392 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2393 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2394 + "fuelConsumption": 0, ~/~/ Расход топлива 2395 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2396 + } 2397 + ] 2398 + } 2399 +] 2400 + 2401 +(% class="box warningmessage" %) 2402 +((( 2403 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2404 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2405 +))) 2406 + 2407 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2408 + 2409 +(% class="box infomessage" %) 2410 +((( 2411 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2412 +))) 2413 + 2414 +(% style="color:#000000" %)Метод запроса: **POST** 2415 + 2416 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2417 + 2418 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2419 + 2420 +(% style="text-align:left" %) 2421 +Тело запроса: 2422 + 2423 +{ 2424 + "vehicleIds": [0], ~/~/ Список ID объектов 2425 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2426 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2427 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2428 +} 2429 + 2430 +Ответ: 2431 + 2432 +[ 2433 + { 2434 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2435 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2436 + "vehicleId": 0, ~/~/ ID объекта 2437 + "name": "string", ~/~/ Имя объекта 2438 + "model": "string", ~/~/ Модель объекта 2439 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2440 + { 2441 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2442 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2443 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2444 + "valueFuel": 0, ~/~/ Количество 2445 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2446 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2447 + } 2448 + ] 2449 + } 2450 +] 2451 + 2452 + 2453 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2454 + 2455 +(% class="box infomessage" %) 2456 +((( 2457 +**POST /api/v3/vehicles/moveStop** 2458 +))) 2459 + 2460 +Метод запроса: **POST** 2461 + 2462 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2463 + 2464 +В заголовках запроса: X-Auth: Токен авторизации 2465 + 2466 + 2467 +Тело запроса: 2468 + 2469 +{ 2470 + "vehicleIds": [ ], ~/~/ Список ID объектов 2471 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2472 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2473 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2474 +} 2475 + 2476 +Ответ: 2477 + 2478 +[ 2479 + { 2480 + "vehicleId": 0, ~/~/ ID объекта 2481 + "vehicleName": "string", ~/~/ Имя объекта 2482 + "moves": [ ~/~/ Событие движения 2483 + { 2484 + "mileage": 0, ~/~/ Пробег, км 2485 + "eventId": 0, ~/~/ Идентификатор события 2486 + "eventName": "string", ~/~/ Название события 2487 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2488 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2489 + "duration": 0 ~/~/ Продолжительность события, секунд 2490 + } 2491 + ], 2492 + "stops": [ ~/~/ События стоянок 2493 + { 2494 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2495 + "eventId": 0, ~/~/ Идентификатор события 2496 + "eventName": "string", ~/~/ Название события 2497 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2498 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2499 + "duration": 0 ~/~/ Продолжительность события, секунд 2500 + } 2501 + ] 2502 + } 2503 +] 2504 + 2505 + 2506 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2507 + 2508 +(% class="box infomessage" %) 2509 +((( 2510 +**POST /api/v3/vehicles/getlastdata** 2511 +))) 2512 + 2513 +Метод запроса: **POST** 2514 + 2515 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2516 + 2517 +В заголовках запроса: X-Auth: Токен авторизации 2518 + 2519 + 2520 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2521 + 2522 +Ответ: 2523 + { 2524 + "vehicleId": 0, ~/~/Идентификатор объекта. 2525 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2526 + "vehicleNumber": "string",~/~/Номер объекта. 2527 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2528 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2529 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2530 + "speed": 0,~/~/Скорость объекта. 2531 + "course": 0,~/~/Курс движения [0;360] 2532 + "latitude": 0,~/~/Широта [-90°;90°]. 2533 + "longitude": 0,~/~/Долгота [-180°;180°]. 2534 + "address": "string",~/~/Адрес. 2535 + "geozones": [ ~/~/Сведения по геозонам. 2536 + { 2537 + "id": 0, 2538 + "name": "string" 2539 + } 2540 + 2541 + 2542 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2543 + 2544 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2545 + 2546 +(% class="box infomessage" %) 2547 +((( 2548 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2549 +))) 2550 + 2551 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2552 + 2553 +(% style="color:#000000" %)Метод запроса: **POST** 2554 + 2555 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2556 + 2557 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2558 + 2559 +(% style="text-align:left" %) 2560 +Тело запроса: 2561 + 2562 +(% style="text-align:left" %) 2563 +{ 2564 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2565 +} 2566 + 2567 +(% style="text-align:left" %) 2568 +Ответ: 2569 + 2570 +[ 2571 + { 2572 + "id": 0, ~/~/ Идентификатор объекта геозоны 2573 + "name": "string", ~/~/ Название объекта геозоны 2574 + "type": 0, ~/~/ Тип объекта геозоны 2575 + "fname": "string", ~/~/ Имя файла 2576 + "parentId": "string", ~/~/ Идентификатор клиента 2577 + "radius": 0, ~/~/ Радиус геообъекта 2578 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2579 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2580 + "description": "string", ~/~/ Описание 2581 + "area": 0, ~/~/ Площадь, м^^2^^ 2582 + "perimetr": 0, ~/~/ Периметр, м 2583 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2584 + } 2585 +] 2586 + 2587 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2588 + 2589 +(% class="box infomessage" %) 2590 +((( 2591 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2592 +))) 2593 + 2594 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2595 + 2596 +(% style="color:#000000" %)Метод запроса: **POST** 2597 + 2598 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2599 + 2600 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2601 + 2602 +(% style="text-align:left" %) 2603 +Тело запроса: 2604 + 2605 +{ 2606 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2607 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2608 + "ids": [ ], ~/~/ Массив id объектов 2609 + "byTime": 0, ~/~/ Объединение событий по времени 2610 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2611 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2612 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2613 +} 2614 + 2615 +Ответ: 2616 +[ 2617 + { 2618 + "geozoneId": 0, ~/~/ ID геообъекта 2619 + "geozoneName": "string", ~/~/ Название геообъекта 2620 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2621 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2622 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2623 + "vehicleId": 0, ~/~/ ID объекта 2624 + "vehicleName": "string" ~/~/ Имя объекта 2625 + } 2626 +] 2627 + 2628 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2629 + 2630 +(% class="box infomessage" %) 2631 +((( 2632 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2633 +))) 2634 + 2635 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2636 + 2637 +(% style="color:#000000" %)Метод запроса: **POST** 2638 + 2639 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2640 + 2641 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2642 + 2643 +(% style="text-align:left" %) 2644 +Тело запроса: 2645 + 2646 +{ 2647 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2648 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2649 + "ids": [ ], ~/~/ Массив id геообъектов 2650 + "byTime": 0, ~/~/ Объединение событий по времени 2651 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2652 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2653 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2654 +} 2655 + 2656 +Ответ: 2657 + 2658 +[ 2659 + { 2660 + "geozoneId": 0, ~/~/ ID геообъекта 2661 + "geozoneName": "string", ~/~/ Название геообъекта 2662 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2663 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2664 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2665 + "vehicleId": 0, ~/~/ ID объекта 2666 + "vehicleName": "string" ~/~/ Имя объекта 2667 + } 2668 +] 2669 + 2670 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2671 + 2672 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2673 + 2674 +(% class="box infomessage" %) 2675 +((( 2676 +**POST /api/v3/notifications/find** 2677 +))) 2678 + 2679 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2680 + 2681 +(% style="text-align: left;" %) 2682 +Метод запроса **POST** 2683 + 2684 +(% style="text-align: left;" %) 2685 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2686 + 2687 +(% style="text-align: left;" %) 2688 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2689 + 2690 +{ 2691 + "parentId": "" ~/~/ id клиента 2692 +} 2693 + 2694 +Ответ: 2695 + 2696 +[ 2697 + { 2698 + "id": 0, ~/~/ ID уведомления 2699 + "name": "string", ~/~/ Название уведомления 2700 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2701 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2702 + "userId": "", ~/~/ Пользователь, создавший уведомление 2703 + "parentId": "", ~/~/ Идентификатор клиента 2704 + "parentName": "string" ~/~/ Имя клиента 2705 + } 2706 +] 2707 + 2708 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2709 + 2710 +(% class="box infomessage" %) 2711 +((( 2712 +**GET /api/v3/notifications/{id}** 2713 +))) 2714 + 2715 +Метод возвращает данные правил формирования выбранного уведомления. 2716 + 2717 +(% style="text-align: left;" %) 2718 +Метод запроса **GET** 2719 + 2720 +(% style="text-align: left;" %) 2721 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2722 + 2723 +(% style="text-align: left;" %) 2724 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2725 + 2726 +(% style="text-align: left;" %) 2727 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2728 + 2729 +(% style="text-align: left;" %) 2730 +(% style="color:#000000" %)Ответ: 2731 + 2732 +(% style="text-align: left;" %) 2733 +(% style="color:#000000" %){ 2734 + "id": 0, ~/~/ (%%)id уведомления 2735 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2736 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2737 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2738 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2739 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2740 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2741 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2742 +(% style="color:#000000" %) 0 2743 + ], 2744 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2745 +(% style="color:#000000" %) 0 2746 + ], 2747 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2748 +(% style="color:#000000" %) 0 2749 + ], 2750 + "settings": { ~/~/ Список параметров уведомления 2751 + "additionalProp1": "string", 2752 + "additionalProp2": "string", 2753 + "additionalProp3": "string" 2754 + }, 2755 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2756 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2757 +(% style="color:#000000" %) "" 2758 + ], 2759 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2760 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2761 +(% style="color:#000000" %) "string" 2762 + ], 2763 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2764 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2765 +(% style="color:#000000" %) { 2766 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2767 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2768 +(% style="color:#000000" %) } 2769 + ], 2770 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2771 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2772 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2773 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2774 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2775 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2776 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2777 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2778 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1143 1143 (% style="color:#000000" %)} 1144 1144 2781 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1145 1145 2783 +(% class="box warningmessage" %) 2784 +((( 2785 +**PUT /api/v3/notifications/** 2786 +))) 2787 + 2788 +Метод позволяет отредактировать уведомление. 2789 + 2790 +Метод запроса **PUT** 2791 + 2792 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2793 + 2794 +В заголовках запроса: X-Auth: Токен авторизации 2795 + 2796 +Тело запроса: 2797 +{ 2798 + "id": 0, ~/~/ id уведомления 2799 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2800 + "userId": "", ~/~/ Пользователь, создавший уведомление 2801 + "parentId": "", ~/~/ Идентификатор клиента 2802 + "parentName": "string", ~/~/ Имя клиента 2803 + "name": "string", ~/~/ Название уведомления 2804 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2805 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2806 + 0 2807 + ], 2808 + "geoids": [ ~/~/ Список id геообъектов для анализа 2809 + 0 2810 + ], 2811 + "fieldids": [ ~/~/ Список id полей для анализа 2812 + 0 2813 + ], 2814 + "settings": { ~/~/ Список параметров уведомления 2815 + "additionalProp1": "string", 2816 + "additionalProp2": "string", 2817 + "additionalProp3": "string" 2818 + }, 2819 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2820 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2821 + "" 2822 + ], 2823 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2824 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2825 + "string" 2826 + ], 2827 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2828 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2829 + { 2830 + "id": 0, ~/~/ Идентификатор участника чата 2831 + "info": "string" ~/~/ Дополнительные сведения 2832 + } 2833 + ], 2834 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2835 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2836 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2837 + "kind": 0, ~/~/ Определяет вид уведомления 2838 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2839 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2840 + "timezone": 0, ~/~/ Сдвиг часового пояса 2841 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2842 + "autoProlongation": true ~/~/ Автопродление срока действия 2843 +} 2844 + 2845 +Ответ: 2846 + 2847 +Success 2848 + 2849 + 2850 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2851 + 2852 +(% class="box warningmessage" %) 2853 +((( 2854 +**PUT** /api/v3/notifications/prolongation 2855 +))) 2856 + 2857 +Метод позволяет продлить уведомления. 2858 + 2859 +Метод запроса **PUT** 2860 + 2861 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2862 + 2863 +В заголовках запроса: X-Auth: Токен авторизации. 2864 + 2865 +Тело запроса: 2866 + 2867 +[ 2868 + 2869 +0 2870 + 2871 +] 2872 + 2873 +где 0 идентификатор ids. 2874 + 2875 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2876 + 2877 +(% class="box errormessage" %) 2878 +((( 2879 +**DELETE /api/v3/notifications/{id}** 2880 +))) 2881 + 2882 +Метод позволяет удалить выбранное уведомление. 2883 + 2884 +Метод запроса **DELETE** 2885 + 2886 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2887 + 2888 +Передаваемый параметр: {id} - id уведомления 2889 + 2890 +В заголовках запроса: X-Auth: Токен авторизации 2891 + 2892 +Ответ: 2893 + 2894 +Success 2895 + 2896 + 2897 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2898 + 2899 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2900 + 2901 +(% class="box infomessage" %) 2902 +((( 2903 +**POST /api/v3/Drivers/find** 2904 +))) 2905 + 2906 +Передается параметр: parentId - ID клиента-родителя 2907 + 2908 +Ответ: 2909 + 2910 +[ 2911 + { 2912 + "name": "string", ~/~/ Определяет наименование 2913 + "description": "string", ~/~/ Определяет описание 2914 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2915 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2916 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2917 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2918 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2919 + "deleted": true ~/~/ Признак удаления 2920 + } 2921 +] 2922 + 2923 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2924 + 2925 +(% class="box infomessage" %) 2926 +((( 2927 +**GET /api/v3/Drivers/{driverGuid}** 2928 +))) 2929 + 2930 +Передается параметр: ID водителя 2931 + 2932 +Ответ: 2933 + 2934 +{ 2935 + "name": "string", ~/~/ Определяет наименование 2936 + "description": "string", ~/~/ Определяет описание 2937 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2938 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2939 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2940 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2941 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2942 + "deleted": true ~/~/ Признак удаления 2943 +} 2944 + 2945 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2946 + 2947 +(% class="box successmessage" %) 2948 +((( 2949 +**POST /api/v3/Drivers** 2950 +))) 2951 + 2952 +Запрос: 2953 + 2954 +{ 2955 + "name": "string", 2956 + "description": "string", 2957 + "hiredate": "2023-06-30T12:50:54.020Z", 2958 + "chopdate": "2023-06-30T12:50:54.020Z", 2959 + "exclusive": true, 2960 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2961 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2962 + "deleted": true 2963 +} 2964 + 2965 +Ответ: 2966 + 2967 +{ 2968 + "name": "string", 2969 + "description": "string", 2970 + "hiredate": "2023-06-30T12:50:54.051Z", 2971 + "chopdate": "2023-06-30T12:50:54.051Z", 2972 + "exclusive": true, 2973 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2974 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 + "deleted": true 2976 +} 2977 + 2978 + 2979 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2980 + 2981 +(% class="box warningmessage" %) 2982 +((( 2983 +**PUT /api/v3/Drivers** 2984 +))) 2985 + 2986 +Запрос: 2987 + 2988 +{ 2989 + "name": "string", 2990 + "description": "string", 2991 + "hiredate": "2023-06-30T12:50:27.910Z", 2992 + "chopdate": "2023-06-30T12:50:27.910Z", 2993 + "exclusive": true, 2994 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2996 + "deleted": true 2997 +} 2998 + 2999 +Ответ: 3000 + 3001 +{ 3002 + "name": "string", 3003 + "description": "string", 3004 + "hiredate": "2023-06-30T12:50:27.929Z", 3005 + "chopdate": "2023-06-30T12:50:27.929Z", 3006 + "exclusive": true, 3007 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3008 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3009 + "deleted": true 3010 +} 3011 + 3012 + 3013 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 3014 + 3015 +(% class="box errormessage" %) 3016 +((( 3017 +**DELETE /api/v3/Drivers/{driverGuid}** 3018 +))) 3019 + 3020 +Передается параметр: ID водителя 3021 + 3022 +Ответ: 3023 + 3024 +Success 3025 + 3026 + 3027 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 3028 + 3029 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 3030 + 3031 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 3032 + 3033 +(% class="box infomessage" %) 3034 +((( 3035 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3036 +))) 3037 + 3038 +Запрос: 3039 + 3040 +{ 3041 + "Ids": [ 3042 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3043 + ], 3044 + "BeginTime": "2023-06-30T12:49:04.365Z", 3045 + "EndTime": "2023-06-30T12:49:04.365Z" 3046 +} 3047 + 3048 +Ответ: 3049 + 3050 +[ 3051 + { 3052 + "VehicleId": 0, 3053 + "CreateTime": "2023-06-30T09:52:31.240Z", 3054 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3055 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3056 + "BeginTime": "2023-06-30T09:52:31.240Z", 3057 + "EndTime": "2023-06-30T09:52:31.240Z" 3058 + } 3059 +] 3060 + 3061 + 3062 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 3063 + 3064 +(% class="box infomessage" %) 3065 +((( 3066 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3067 +))) 3068 + 3069 +Запрос: 3070 + 3071 +{ 3072 + "Ids": [ 3073 + 0 3074 + ], 3075 + "BeginTime": "2023-06-30T12:48:39.419Z", 3076 + "EndTime": "2023-06-30T12:48:39.419Z" 3077 +} 3078 + 3079 +Ответ: 3080 + 3081 +[ 3082 + { 3083 + "VehicleId": 0, 3084 + "CreateTime": "2023-06-30T09:54:01.631Z", 3085 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3086 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3087 + "BeginTime": "2023-06-30T09:54:01.631Z", 3088 + "EndTime": "2023-06-30T09:54:01.631Z" 3089 + } 3090 +] 3091 + 3092 + 3093 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 3094 + 3095 +(% class="box successmessage" %) 3096 +((( 3097 +**POST /api/v3/DriversVehiclesAssignments** 3098 +))) 3099 + 3100 +Передается массив назначений 3101 + 3102 +Запрос: 3103 + 3104 +[ 3105 + { 3106 + "VehicleId": 0, ~/~/ Идентификатор объекта 3107 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3108 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3109 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3110 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 3111 + } 3112 +] 3113 + 3114 +Ответ: 3115 + 3116 +[ 3117 + { 3118 + "VehicleId": 0, 3119 + "CreateTime": "2023-06-30T11:04:46.903Z", 3120 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3121 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3122 + "BeginTime": "2023-06-30T11:04:46.903Z", 3123 + "EndTime": "2023-06-30T11:04:46.903Z" 3124 + } 3125 +] 3126 + 3127 + 3128 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 3129 + 3130 +(% class="box warningmessage" %) 3131 +((( 3132 +**PUT /api/v3/DriversVehiclesAssignments** 3133 +))) 3134 + 3135 +Запрос: 3136 + 3137 +[ 3138 + { 3139 + "VehicleId": 0, 3140 + "CreateTime": "2023-06-30T11:14:08.117Z", 3141 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3142 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3143 + "BeginTime": "2023-06-30T11:14:08.117Z", 3144 + "EndTime": "2023-06-30T11:14:08.117Z" 3145 + } 3146 +] 3147 + 3148 +Ответ: 3149 + 3150 +[ 3151 + { 3152 + "VehicleId": 0, 3153 + "CreateTime": "2023-06-30T11:14:53.349Z", 3154 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3155 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3156 + "BeginTime": "2023-06-30T11:14:53.349Z", 3157 + "EndTime": "2023-06-30T11:14:53.349Z" 3158 + } 3159 +] 3160 + 3161 + 3162 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 3163 + 3164 +(% class="box errormessage" %) 3165 +((( 3166 +**DELETE /api/v3/DriversVehiclesAssignments** 3167 +))) 3168 + 3169 +Запрос: 3170 + 3171 +[ 3172 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3173 +] 3174 + 3175 +Ответ: 3176 + 3177 +Success 3178 + 3179 + 3180 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 3181 + 3182 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 3183 + 3184 +(% class="box infomessage" %) 3185 +((( 3186 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3187 +))) 3188 + 3189 +Запрос: 3190 + 3191 +{ 3192 + "Ids": [ 3193 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3194 + ], 3195 + "BeginTime": "2023-06-30T12:47:12.162Z", 3196 + "EndTime": "2023-06-30T12:47:12.162Z" 3197 +} 3198 + 3199 +Ответ: 3200 + 3201 +[ 3202 + { 3203 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3204 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3205 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3206 + "BeginTime": "2023-06-30T11:19:40.703Z", 3207 + "EndTime": "2023-06-30T11:19:40.703Z" 3208 + } 3209 +] 3210 + 3211 + 3212 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3213 + 3214 +(% class="box infomessage" %) 3215 +((( 3216 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3217 +))) 3218 + 3219 +Запрос: 3220 + 3221 +{ 3222 + "Ids": [ 3223 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3224 + ], 3225 + "BeginTime": "2023-06-30T12:47:12.162Z", 3226 + "EndTime": "2023-06-30T12:47:12.162Z" 3227 +} 3228 + 3229 +Ответ: 3230 + 3231 +[ 3232 + { 3233 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3234 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3235 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3236 + "BeginTime": "2023-06-30T11:19:40.703Z", 3237 + "EndTime": "2023-06-30T11:19:40.703Z" 3238 + } 3239 +] 3240 + 3241 + 3242 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3243 + 3244 +(% class="box successmessage" %) 3245 +((( 3246 +**POST /api/v3/DriversRfidsAssignments** 3247 +))) 3248 + 3249 +Запрос: 3250 + 3251 +[ 3252 + { 3253 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3254 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3255 + "BeginTime": "2023-06-30T11:27:08.635Z", 3256 + "EndTime": "2023-06-30T11:27:08.635Z" 3257 + } 3258 +] 3259 + 3260 +Ответ: 3261 + 3262 +[ 3263 + { 3264 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3265 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3266 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3267 + "BeginTime": "2023-06-30T11:27:08.677Z", 3268 + "EndTime": "2023-06-30T11:27:08.677Z" 3269 + } 3270 +] 3271 + 3272 + 3273 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3274 + 3275 +(% class="box warningmessage" %) 3276 +((( 3277 +**PUT /api/v3/DriversRfidsAssignments** 3278 +))) 3279 + 3280 +Запрос: 3281 + 3282 +[ 3283 + { 3284 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3285 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3286 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3287 + "BeginTime": "2023-06-30T11:28:43.330Z", 3288 + "EndTime": "2023-06-30T11:28:43.330Z" 3289 + } 3290 +] 3291 + 3292 +Ответ: 3293 + 3294 +[ 3295 + { 3296 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3297 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3298 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3299 + "BeginTime": "2023-06-30T11:28:43.331Z", 3300 + "EndTime": "2023-06-30T11:28:43.331Z" 3301 + } 3302 +] 3303 + 3304 + 3305 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3306 + 3307 +(% class="box errormessage" %) 3308 +((( 3309 +**DELETE /api/v3/DriversRfidsAssignments** 3310 +))) 3311 + 3312 +Запрос: 3313 + 3314 +[ 3315 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3316 +] 3317 + 3318 +Ответ: 3319 + 3320 +Success 3321 + 3322 + 3323 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3324 + 3325 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3326 + 3327 +(% class="box infomessage" %) 3328 +((( 3329 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3330 +))) 3331 + 3332 +Запрос: 3333 + 3334 +{ 3335 + "Ids": [ 3336 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3337 + ], 3338 + "BeginTime": "2023-06-30T12:45:10.852Z", 3339 + "EndTime": "2023-06-30T12:45:10.852Z" 3340 +} 3341 + 3342 +Ответ: 3343 + 3344 +[ 3345 + { 3346 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3347 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3348 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3349 + "BeginTime": "2023-06-30T11:58:04.695Z", 3350 + "EndTime": "2023-06-30T11:58:04.695Z" 3351 + } 3352 +] 3353 + 3354 + 3355 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3356 + 3357 +(% class="box infomessage" %) 3358 +((( 3359 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3360 +))) 3361 + 3362 +Запрос: 3363 + 3364 +{ 3365 + "Ids": [ 3366 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3367 + ], 3368 + "BeginTime": "2023-06-30T12:45:10.852Z", 3369 + "EndTime": "2023-06-30T12:45:10.852Z" 3370 +} 3371 + 3372 +Ответ: 3373 + 3374 +[ 3375 + { 3376 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3377 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3378 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3379 + "BeginTime": "2023-06-30T11:58:04.695Z", 3380 + "EndTime": "2023-06-30T11:58:04.695Z" 3381 + } 3382 +] 3383 + 3384 + 3385 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3386 + 3387 +(% class="box successmessage" %) 3388 +((( 3389 +**POST /api/v3/DriversFuelCardsAssignments** 3390 +))) 3391 + 3392 +Запрос: 3393 + 3394 +[ 3395 + { 3396 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3397 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3398 + "BeginTime": "2023-06-30T12:09:53.175Z", 3399 + "EndTime": "2023-06-30T12:09:53.175Z" 3400 + } 3401 +] 3402 + 3403 +Ответ: 3404 + 3405 +[ 3406 + { 3407 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3408 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3409 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3410 + "BeginTime": "2023-06-30T12:09:53.201Z", 3411 + "EndTime": "2023-06-30T12:09:53.201Z" 3412 + } 3413 +] 3414 + 3415 + 3416 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3417 + 3418 +(% class="box warningmessage" %) 3419 +((( 3420 +**PUT /api/v3/DriversFuelCardsAssignments** 3421 +))) 3422 + 3423 +Запрос: 3424 + 3425 +[ 3426 + { 3427 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3428 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3429 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3430 + "BeginTime": "2023-06-30T12:09:53.201Z", 3431 + "EndTime": "2023-06-30T12:09:53.201Z" 3432 + } 3433 +] 3434 + 3435 +Ответ: 3436 + 3437 +[ 3438 + { 3439 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3440 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3441 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3442 + "BeginTime": "2023-06-30T12:09:53.201Z", 3443 + "EndTime": "2023-06-30T12:09:53.201Z" 3444 + } 3445 +] 3446 + 3447 + 3448 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3449 + 3450 +(% class="box errormessage" %) 3451 +((( 3452 +**DELETE /api/v3/DriversFuelCardsAssignments** 3453 +))) 3454 + 3455 +Запрос: 3456 + 3457 +[ 3458 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3459 +] 3460 + 3461 +Ответ: 3462 + 3463 +Success 3464 + 3465 + 3466 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3467 + 3468 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3469 + 3470 +(% class="box infomessage" %) 3471 +((( 3472 +**POST /api/v3/Trailers** 3473 +))) 3474 + 3475 +Пример запроса: 3476 + 3477 +{ 3478 + "startDate": "2023-11-14T10:48:03.671Z", 3479 + "endDate": "2023-11-14T10:48:03.671Z", 3480 + "ids": [ 0 ], 3481 + "timezone": 0 3482 +} 3483 + 3484 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3485 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3486 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3487 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3488 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3489 + 3490 +Пример ответа: 3491 + 3492 +[ 3493 + { 3494 + "SD": "2023-11-14T10:48:03.717Z", 3495 + "ED": "2023-11-14T10:48:03.717Z", 3496 + "id": 0, 3497 + "SLat": 0, 3498 + "SLon": 0, 3499 + "ELat": 0, 3500 + "ELon": 0, 3501 + "mileage": 0 3502 + "Duration": 0 3503 + "Address": "string", 3504 + "Address2": "string", 3505 + "name": "string", 3506 + "rid": "string", 3507 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3508 + "trailer": { 3509 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3510 + "Number": "string", 3511 + "Description": "string", 3512 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3513 + "ExternalID": "string", 3514 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3515 + "CreateTime": "2023-11-14T10:48:03.717Z", 3516 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3517 + "IsDeleted": true 3518 + }, 3519 + "filesCount": 0, 3520 + } 3521 +] 3522 + 3523 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3524 +|SD|Дата и время начала события 3525 +|ED|Дата и время окончания события 3526 +|id|ID объекта 3527 +|SLat|Широта начальной координаты 3528 +|SLon|Долгота начальной координаты 3529 +|ELat|Широта конечной координаты 3530 +|ELon|Долгота конечной координаты 3531 +|mileage|Пробег 3532 +|Duration|Продолжительность 3533 +|Address|Адрес начального местоположения 3534 +|Address2|Адрес конечного местоположения 3535 +|name|Имя радиометки 3536 +|rid|Номер радиометки 3537 +|rguid|ID радиометки 3538 +|trailer|Информация об агрегате 3539 +|ModelGuid|ID агрегата 3540 +|Number|Название/номер агрегата 3541 +|Description|Текст примечания агрегата 3542 + 3543 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3544 + 3545 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3546 + 3547 +(% class="box infomessage" %) 3548 +((( 3549 +**POST /api/v3/Rfids/find** 3550 +))) 3551 + 3552 +Запрос: 3553 + 3554 +{ 3555 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3556 +} 3557 + 3558 +Ответ: 3559 + 3560 +[ 3561 + { 3562 + "name": "string", 3563 + "number": 0, 3564 + "period": 0, 3565 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3566 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3567 + } 3568 +] 3569 + 3570 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3571 +|parentId|ID клиента 3572 +|name|Название карты-метки 3573 +|number|Номер 3574 +|period|Период запросов в секундах (работает только для агрегатов) 3575 +|id|ID карты-метки 3576 + 3577 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3578 + 3579 +(% class="box infomessage" %) 3580 +((( 3581 +**GET /api/v3/Rfids/{rfidGuid}** 3582 +))) 3583 + 3584 +Передаем параметр rfidGuid - идентификатор карты-метки 3585 + 3586 +Ответ: 3587 + 3588 +[ 3589 + { 3590 + "name": "string", 3591 + "number": 0, 3592 + "period": 0, 3593 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3594 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3595 + } 3596 +] 3597 + 3598 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3599 +|name|Название карты-метки 3600 +|number|Номер 3601 +|period|Период запросов в секундах (работает только для агрегатов) 3602 +|id|ID карты-метки 3603 +|parentId|ID клиента 3604 + 3605 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3606 + 3607 +(% class="box successmessage" %) 3608 +((( 3609 +**POST /api/v3/Rfids** 3610 +))) 3611 + 3612 +Запрос: 3613 + 3614 +{ 3615 + "name": "string", 3616 + "number": 0, 3617 + "period": 0, 3618 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3619 +} 3620 + 3621 +Ответ: 3622 + 3623 +{ 3624 + "name": "string", 3625 + "number": 0, 3626 + "period": 0, 3627 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3628 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3629 +} 3630 + 3631 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3632 +|name|Название карты-метки 3633 +|number|Номер 3634 +|period|Период запросов в секундах (работает только для агрегатов) 3635 +|id|ID карты-метки 3636 +|parentId|ID клиента 3637 + 3638 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3639 + 3640 +(% class="box warningmessage" %) 3641 +((( 3642 +**PUT /api/v3/Rfids** 3643 +))) 3644 + 3645 +Запрос: 3646 + 3647 +{ 3648 + "name": "string", 3649 + "number": 0, 3650 + "period": 0, 3651 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3652 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3653 +} 3654 + 3655 +Ответ: 3656 + 3657 +{ 3658 + "name": "string", 3659 + "number": 0, 3660 + "period": 0, 3661 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3662 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3663 +} 3664 + 3665 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3666 +|name|Название карты-метки 3667 +|number|Номер 3668 +|period|Период запросов в секундах (работает только для агрегатов) 3669 +|id|ID карты-метки 3670 +|parentId|ID клиента 3671 + 3672 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3673 + 3674 +(% class="box errormessage" %) 3675 +((( 3676 +**DELETE /api/v3/Rfids/{rfidGuid}** 3677 +))) 3678 + 3679 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3680 + 3681 +Ответ: 3682 + 3683 +Success 3684 + 3685 + 3686 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3687 + 3688 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3689 + 3690 +(% class="box infomessage" %) 3691 +((( 3692 +**GET /api/v3/Billing/client/balance/{clientId}** 3693 +))) 3694 + 3695 +Параметр запроса: **clientId **- идентификатор клиента. 3696 + 3697 +Ответ: 3698 + 3699 +{ 3700 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3701 + "Balance": 0 3702 +} 3703 + 3704 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3705 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3706 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3707 + 3708 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3709 + 3710 +(% class="box infomessage" %) 3711 +((( 3712 +**GET /api/v3/Billing/client/constraint/{clientId}** 3713 +))) 3714 + 3715 +Параметр запроса: **clientId **- идентификатор клиента. 3716 + 3717 +Ответ: 3718 + 3719 +{ 3720 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3721 + "CalculationType": 0, 3722 + "PermissibleBalance": 0, 3723 + "DefermentDays": 0, 3724 + "SendUiNotifications": true, 3725 + "SendEmailNotifications": true, 3726 + "IsPrivate": true, 3727 +} 3728 + 3729 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3730 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3731 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3732 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3733 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3734 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3735 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3736 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3737 + 3738 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3739 + 3740 +(% class="box infomessage" %) 3741 +((( 3742 +**GET /api/v3/Billing/client/plan/{clientId}** 3743 +))) 3744 + 3745 +Параметры запроса: 3746 + 3747 +**clientId **- идентификатор клиента. 3748 + 3749 +**planId **- идентификатор тарифного плана. 3750 + 3751 +Ответ: 3752 + 3753 +{ 3754 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3755 + "Plan": { **~/~/ Описание тарифного плана** 3756 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3757 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3758 + "Name": "string", 3759 + "IsArchived": true, 3760 + "Constraint": { 3761 + "CalculationType": 0, 3762 + "PermissibleBalance": 0, 3763 + "DefermentDays": 0 3764 + }, 3765 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3766 + { 3767 + "Feature": "string", 3768 + "IsFactual": true, 3769 + "Limit": 0, 3770 + "Price": 0, 3771 + "PeriodValue": 0, 3772 + "PeriodType": 0 3773 + } 3774 + ] 3775 + }, 3776 + "DebitDate": "2023-10-18T12:46:24.213Z", 3777 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3778 + { 3779 + "Feature": "string", 3780 + "IsEnabled": true, 3781 + "IsPrivate": true, 3782 + "IsFactual": true, 3783 + "Limit": 0, 3784 + "Price": 0, 3785 + "DebitDate": "2023-10-18T12:46:24.213Z", 3786 + "PeriodValue": 0, 3787 + "PeriodType": 0 3788 + } 3789 + ] 3790 +} 3791 + 3792 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3793 +|ClientId|Идентификатор клиента 3794 +|Id|Идентификатор тарифного плана 3795 +|OwnerId|Идентификатор клиента-владельца 3796 +|Name|Наименование тарифного плана 3797 +|IsArchived|Признак, определяющий архивный тарифный план 3798 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3799 +|PermissibleBalance|Допустимый баланс 3800 +|DefermentDays|Отсрочка, количество дней 3801 +|Feature|Код услуги 3802 +|IsEnabled|Признак, определяющий активирована ли услуга 3803 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3804 +|IsFactual|Признак, определяющий расчёт по факту 3805 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3806 +|Price|Цена за единицу. 3807 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3808 +|PeriodValue|Значение периода. 3809 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3810 + 3811 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3812 + 3813 +(% class="box infomessage" %) 3814 +((( 3815 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3816 +))) 3817 + 3818 +Параметр запроса: **clientId **- идентификатор клиента. 3819 + 3820 +Ответ: 3821 + 3822 +[ 3823 + { 3824 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3825 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3826 + "Name": "string", 3827 + "IsArchived": true, 3828 + "Constraint": { 3829 + "CalculationType": 0, 3830 + "PermissibleBalance": 0, 3831 + "DefermentDays": 0 3832 + }, 3833 + "Features": [ 3834 + { 3835 + "Feature": "string", 3836 + "IsFactual": true, 3837 + "Limit": 0, 3838 + "Price": 0, 3839 + "PeriodValue": 0, 3840 + "PeriodType": 0 3841 + } 3842 + ] 3843 + } 3844 +] 3845 + 3846 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3847 +|ClientId|Идентификатор клиента 3848 +|Id|Идентификатор тарифного плана 3849 +|OwnerId|Идентификатор клиента-владельца 3850 +|Name|Наименование тарифного плана 3851 +|IsArchived|Признак, определяющий архивный тарифный план 3852 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3853 +|PermissibleBalance|Допустимый баланс 3854 +|DefermentDays|Отсрочка, количество дней 3855 +|Feature|Код услуги 3856 +|IsFactual|Признак, определяющий расчёт по факту 3857 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3858 +|Price|Цена за единицу. 3859 +|PeriodValue|Значение периода. 3860 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3861 + 3862 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3863 + 3864 +(% class="box infomessage" %) 3865 +((( 3866 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3867 +))) 3868 + 3869 +Параметр запроса: **clientId **- идентификатор клиента. 3870 + 3871 +Ответ: 3872 + 3873 +[ 3874 + { 3875 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3876 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3877 + "Name": "string", 3878 + "IsArchived": true, 3879 + "Constraint": { 3880 + "CalculationType": 0, 3881 + "PermissibleBalance": 0, 3882 + "DefermentDays": 0 3883 + }, 3884 + "Features": [ 3885 + { 3886 + "Feature": "string", 3887 + "IsFactual": true, 3888 + "Limit": 0, 3889 + "Price": 0, 3890 + "PeriodValue": 0, 3891 + "PeriodType": 0 3892 + } 3893 + ] 3894 + } 3895 +] 3896 + 3897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3898 +|ClientId|Идентификатор клиента 3899 +|Id|Идентификатор тарифного плана 3900 +|OwnerId|Идентификатор клиента-владельца 3901 +|Name|Наименование тарифного плана 3902 +|IsArchived|Признак, определяющий архивный тарифный план 3903 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3904 +|PermissibleBalance|Допустимый баланс 3905 +|DefermentDays|Отсрочка, количество дней 3906 +|Feature|Код услуги 3907 +|IsFactual|Признак, определяющий расчёт по факту 3908 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3909 +|Price|Цена за единицу. 3910 +|PeriodValue|Значение периода. 3911 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3912 + 3913 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3914 + 3915 +(% class="box warningmessage" %) 3916 +((( 3917 +**PUT /api/v3/Billing/client/balance** 3918 +))) 3919 + 3920 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3921 + 3922 +Тело запроса: 3923 + 3924 +{ 3925 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3926 + "Balance": 0 3927 +} 3928 + 3929 +Ответ: Success 3930 + 3931 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3932 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3933 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3934 + 3935 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3936 + 3937 +(% class="box warningmessage" %) 3938 +((( 3939 +**PUT /api/v3/billing/client/balance/deposit** 3940 +))) 3941 + 3942 +Создает операцию **Пополнение **с указанной суммой 3943 + 3944 +Тело запроса: 3945 + 3946 +{ 3947 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3948 + "Balance": 0 3949 +} 3950 + 3951 +Ответ: Success 3952 + 3953 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3954 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3955 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3956 + 3957 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3958 + 3959 +Создает операцию **Списание **с указанной суммой 3960 + 3961 +(% class="box warningmessage" %) 3962 +((( 3963 +**PUT /api/v3/billing/client/balance/withdraw** 3964 +))) 3965 + 3966 +Тело запроса: 3967 + 3968 +{ 3969 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3970 + "Balance": 0 3971 +} 3972 + 3973 +Ответ: Success 3974 + 3975 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3976 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3977 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3978 + 3979 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3980 + 3981 +(% class="box warningmessage" %) 3982 +((( 3983 +**PUT /api/v3/Billing/client/constraint** 3984 +))) 3985 + 3986 +Тело запроса: 3987 + 3988 +{ 3989 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3990 + "CalculationType": 0, 3991 + "PermissibleBalance": 0, 3992 + "DefermentDays": 0, 3993 + "SendUiNotifications": true, 3994 + "SendEmailNotifications": true, 3995 + "IsPrivate": true, 3996 +} 3997 + 3998 +Ответ: Success 3999 + 4000 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4001 +|ClientId|Идентификатор клиента 4002 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4003 +|PermissibleBalance|Допустимый баланс 4004 +|DefermentDays|((( 4005 +Отсрочка, количество дней 4006 +))) 4007 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4008 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4009 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4010 + 4011 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4012 + 4013 +(% class="box warningmessage" %) 4014 +((( 4015 +**PUT /api/v3/Billing/client/plan** 4016 +))) 4017 + 4018 +Тело запроса: 4019 + 4020 +{ 4021 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4022 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4023 + "Features": [ 4024 + { 4025 + "Feature": "string", 4026 + "IsEnabled": true, 4027 + "IsFactual": true, 4028 + "Limit": 0, 4029 + "Price": 0, 4030 + "DebitDate": "2023-10-18T13:26:58.987Z", 4031 + "PeriodValue": 0, 4032 + "PeriodType": 0 4033 + } 4034 + ] 4035 +} 4036 + 4037 +Ответ: Success 4038 + 4039 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4040 +|ClientId|Идентификатор клиента 4041 +|PlanId|Идентификатор тарифного плана 4042 +|Feature|Код услуги 4043 +|IsEnabled|Признак, определяющий активирована ли услуга 4044 +|IsFactual|Признак, определяющий расчёт по факту 4045 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4046 +|Price|Цена за единицу. 4047 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4048 +|PeriodValue|Значение периода. 4049 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4050 + 4051 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4052 + 4053 +(% class="box warningmessage" %) 4054 +((( 4055 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4056 +))) 4057 + 4058 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4059 + 4060 +(% class="box infomessage" %) 4061 +((( 4062 +**POST /api/v3/vehicles/import/{agentId}** 4063 +))) 4064 + 4065 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4066 + 4067 +В пути указывается **agentId** - id клиента. 4068 + 4069 +**Заголовок** 4070 + 4071 +**X-Auth: [токен авторизации]** 4072 + 4073 +**Параметры** 4074 + 4075 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4076 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4077 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4078 + 4079 +В теле использовать тип **form-data,** тип значения** file** 4080 + 4081 +**Ключи** 4082 + 4083 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4084 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4085 +|csv|В значении передаем файл датчиков, формат **csv** 4086 + 4087 +Ответ: 4088 + 4089 +{ 4090 + "vehicleId": 0, 4091 + "name": "string", 4092 + "errors": ["string"] 4093 +} 4094 + 4095 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4096 +|vehicleId|ID созданного объекта 4097 +|name|Имя созданного объекта 4098 +|errors|Ошибки и их описание 4099 + 4100 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4101 + 4102 +(% class="box infomessage" %) 4103 +((( 4104 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4105 +))) 4106 + 4107 +(% class="wikigeneratedid" %) 4108 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4109 + 4110 +(% class="wikigeneratedid" %) 4111 +В пути указывается **vehicleId **- id объекта. 4112 + 4113 +**Заголовок** 4114 + 4115 +**X-Auth: [токен авторизации]** 4116 + 4117 +В теле использовать тип **form-data.** 4118 + 4119 +Ключи: 4120 + 4121 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4122 +|**history**|В значении передавать файл с историей 4123 + 4124 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4125 + 4126 +Ответ: 4127 + 4128 +{ 4129 + "results": [ 4130 + { 4131 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4132 + "vehicleId": 0, 4133 + "errors": [ 4134 + "string" 4135 + ], 4136 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4137 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4138 + "producedCount": 0, 4139 + "msgCount": 0 4140 + } 4141 + ] 4142 +} 4143 + 4144 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4145 +|results|Результаты импорта в разрезе ТС 4146 +|vehicleGuid|Guid ТС 4147 +|vehicleId|ID ТС 4148 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4149 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4150 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4151 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4152 +|msgCount|Кол-во обработанных сообщений всего 4153 + 4154 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4155 + 4156 +(% class="box infomessage" %) 4157 +((( 4158 +**GET /api/v3/vehicles/import/history/status** 4159 +))) 4160 + 4161 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4162 + 4163 +Ответ: 4164 + 4165 +{ 4166 + "activity": true, 4167 + "progress": 0, 4168 + "message": "string" 4169 +} 4170 + 4171 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4172 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4173 +|progress|Guid ТС 4174 + 4175 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4176 + 4177 +(% class="box infomessage" %) 4178 +((( 4179 +**POST /api/v3/vehicles/export** 4180 +))) 4181 + 4182 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4183 + 4184 +Тело запроса: 4185 + 4186 +[ 4187 + id 4188 +] 4189 + 4190 +Ответ: Success 200, получаете файлы с настройками. 4191 + 4192 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4193 + 4194 +(% class="box infomessage" %) 4195 +((( 4196 +**POST /api/v3/vehicles/export/history** 4197 +))) 4198 + 4199 +Метод возвращает список сообщений терминала объекта за выбранный период. 4200 + 4201 +Тело запроса: 4202 + 4203 +{ 4204 + "vehicleId": 0, 4205 + "asArchive": true, 4206 + "from": "2023-09-27T12:17:45.973Z", 4207 + "to": "2023-09-27T12:17:45.973Z" 4208 +} 4209 + 4210 +Ответ: 4211 + 4212 +Получаете файл. Сообщение: Code 200/Success 4213 + 4214 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4215 +|vehicleId|ID объекта 4216 +|asArchive|true - Архивировать файл, False - не архивировать 4217 +|from|Дата и время начала запроса 4218 +|to|Дата и время окончания запроса 4219 + 4220 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4221 + 4222 +(% class="box infomessage" %) 4223 +((( 4224 +**GET /api/v3/vehicles/export/history/status** 4225 +))) 4226 + 4227 +Метод возвращает список сообщений терминала объекта за выбранный период. 4228 + 4229 +Ответ: 4230 + 4231 +{ 4232 + "activity": true, 4233 + "progress": 0, 4234 + "message": "string" 4235 +} 4236 + 4237 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4238 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4239 +|progress|Прогресс экспорта, от 0 до 100% 4240 +|message|Текст описывающий статус 4241 + 4242 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4243 + 4244 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4245 + 4246 +(% class="box infomessage" %) 4247 +((( 4248 +**POST /api/v3/EcoDriving/rating** 4249 +))) 4250 + 4251 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4252 + 4253 +Тело запроса: 4254 + 4255 +{ 4256 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4257 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4258 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4259 +} 4260 + 4261 +Ответ: 4262 + 4263 +{ 4264 + "items": [ ~/~/ Список в разрезе ТС 4265 + { 4266 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4267 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4268 + "vehicleId": 0, ~/~/ ID ТС 4269 + "vehicleName": "string", ~/~/ Название ТС 4270 + "vehicleModel": "string", ~/~/ Модель ТС 4271 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4272 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4273 + "totalViolations": 0, ~/~/ Нарушений всего 4274 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4275 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4276 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4277 + "brakingViolations": 0, ~/~/ Нарушений торможения 4278 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4279 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4280 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4281 + }, 4282 + 4283 +((( 4284 + 4285 +))) 4286 + 4287 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4288 + "mileage": 0, ~/~/ Пробег, м 4289 + "tripsCount": 0, ~/~/ Кол-во рейсов 4290 + "trips": [ ~/~/ Информация по рейсу 4291 + { 4292 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4293 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4294 + "violationsCount": 0, ~/~/ Всего нарушений 4295 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4296 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4297 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4298 + "brakingViolations": 0, ~/~/ Нарушений торможения 4299 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4300 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4301 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4302 + }, 4303 + 4304 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4305 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4306 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4307 + "mileage": 0, ~/~/ Пробег, м 4308 + "motohours": 0, ~/~/ Моточасы, секунды 4309 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4310 + "startAddress": "string", ~/~/ Адрес начала рейса 4311 + "endAddress": "string", ~/~/ Адрес конца рейса 4312 + "drivers": [ ~/~/ Список водителей 4313 + { 4314 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4315 + "driverName": "string", ~/~/ФИО водителя 4316 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4317 + } 4318 + ] 4319 + } 4320 + ] 4321 + } 4322 + ] 4323 +} 4324 + 4325 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4326 + 4327 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4328 + 4329 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4330 + 4331 +(% class="box infomessage" %) 4332 +((( 4333 +POST /api/v3/fuelcards/transactions 4334 +))) 4335 + 4336 +Метод запроса: POST 4337 + 4338 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4339 +\\В заголовках запроса: X-Auth: Токен авторизации 4340 + 4341 +Параметры в теле запроса (JSON): 4342 + 4343 +{ 4344 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4345 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4346 + "ids": [ 4347 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4348 + ], 4349 + "timezone": 0 ~/~/Таймзона 4350 +} 4351 + 4352 + 4353 +Ответ: 4354 + { 4355 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4356 + "driver": "string", ~/~/Водители, привязанные к ТК 4357 + "object": "string", ~/~/Наименование ТС 4358 + "amount": 0, ~/~/Количество топлива 4359 + "amountDut": 0, ~/~/Количество по ДУТ 4360 + "amountDiff": 0, ~/~/Разница, л 4361 + "amountDiffPerc": 0, ~/~/Разница, % 4362 + "summa": 0, ~/~/Стоимость, руб 4363 + "serviceName": "string", ~/~/Тип топлива 4364 + "price": 0, ~/~/Цена за литр, руб 4365 + "cardName": "string", ~/~/Наименование ТК 4366 + "cardNum": "string", ~/~/Номер ТК 4367 + "operator": "string", ~/~/Оператор ТК 4368 + "address": "string" ~/~/Адрес АЗС 4369 + } 4370 + 4371 + 4372 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4373 + 4374 + 4375 +== **Получение полных данных о ретрансляторе** == 4376 + 4377 +(% class="box infomessage" %) 4378 +((( 4379 +**GET ** **/api/v3/retranslations/{id}** 4380 +))) 4381 + 4382 +Идентификатор запроса: ID 4383 + 4384 + 4385 +Пример ответа: 4386 + 4387 +{ 4388 +"description": "", ~/~/ Определяет описание 4389 +"subscriberId": "", ~/~/ Подписчик 4390 +"protocolType": 0, ~/~/ Тип протокола 4391 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4392 +"address": "string", ~/~/ Адрес события 4393 +"objects": [ ~/~/Объекты для ретрансляции 4394 +{ 4395 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4396 +"name": "", ~/~/ Наименование объекта ретрансляции 4397 +"imei": "", ~/~/ IMEI объекта 4398 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4399 +} 4400 + ], 4401 +"id": "", ~/~/ идентификатор пользователя 4402 +"parentId": "", ~/~/Guid родителя 4403 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4404 +} 4405 + 4406 + 4407 +== **Удаление данных ретранслятора** == 4408 + 4409 +(% class="box infomessage" %) 4410 +((( 4411 +**DELETE** **/api/v3/retranslations/{id}** 4412 +))) 4413 + 4414 +Параметр запроса: ID 4415 + 4416 + 4417 +== **Создание ретранслятора** == 4418 + 4419 +(% class="box infomessage" %) 4420 +((( 4421 +**POST ** **/api/v3/retranslations/{id}** 4422 +))) 4423 + 4424 +Запрос: 4425 + 4426 +{ 4427 +"description": "", ~/~/ Описание 4428 +"subscriberId": "", ~/~/ Подписчик 4429 +"protocolType": 0, ~/~/ Тип протокола 4430 +"address": "", ~/~/ Адрес ретрансляции 4431 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4432 +"objects": [ ~/~/Объекты для ретрансляции 4433 +{ 4434 +"id": "", ~/~/ идентификатор пользователя 4435 +"imei": "", ~/~/IMEI объекта 4436 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4437 +} 4438 + ] 4439 +} 4440 + 4441 + 4442 +Ответ: 4443 + 4444 +{ 4445 +"description": "string", ~/~/ Определяет описание 4446 +"subscriberId": "", ~/~/ идентификатор запроса 4447 +"protocolType": 0, ~/~/ Тип протокола 4448 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4449 +"address": "", ~/~/ Адрес события 4450 +"objects": [ ~/~/Объекты для ретрансляции 4451 +{ 4452 +"id": "", ~/~/ идентификатор пользователя 4453 +"name": "string", ~/~/ Название уведомления 4454 +"imei": "string", ~/~/IMEI объекта 4455 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4456 +} 4457 + ], 4458 +"id": "", ~/~/ идентификатор пользователя 4459 +"parentId": "", ~/~/ Guid идентификатор родителя 4460 +"deleted": true ~/~/ Признак удаления 4461 +} 4462 + 4463 + 4464 +== **Редактирование ретранслятора** == 4465 + 4466 +(% class="box infomessage" %) 4467 +((( 4468 +**PUT** **/api/v3/retranslations** 4469 +))) 4470 + 4471 +Пример запроса: 4472 + 4473 +{ 4474 +"id": "", ~/~/ идентификатор пользователя 4475 +"description": "string", ~/~/ Определяет описание 4476 +"subscriberId": "", ~/~/ идентификатор запроса 4477 +"protocolType": 0, ~/~/ Тип протокола 4478 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4479 +"address": "string", ~/~/ Адрес события 4480 +"objects": ~/~/Объекты для ретрансляции 4481 +[ 4482 +{ 4483 +"id": "", ~/~/ идентификатор пользователя 4484 +"imei": "", ~/~/IMEI объекта 4485 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4486 +} 4487 + ] 4488 +} 4489 + 4490 + 4491 +Пример ответа: 4492 + 4493 +{ 4494 +"description": "", ~/~/ Определяет описание 4495 +"subscriberId": "", ~/~/ идентификатор запроса 4496 +"protocolType": 0, ~/~/ Тип протокола 4497 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4498 +"address": "string", ~/~/ Адрес события 4499 +"objects": [ ~/~/Объекты для ретрансляции 4500 +{ 4501 +"id": "", ~/~/ идентификатор пользователя 4502 +"name": "string", ~/~/ Название уведомления 4503 +"imei": "", ~/~/IMEI объекта 4504 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4505 +} 4506 + ], 4507 +"id": "", ~/~/ идентификатор пользователя 4508 +"parentId": "", ~/~/ Guid идентификатор родителя 4509 +"deleted": true ~/~/ Признак удаления 4510 +} 4511 + 4512 + 4513 +== **Получение списка ретранслятора клиента** == 4514 + 4515 +(% class="box infomessage" %) 4516 +((( 4517 +**POST /api/v3/retranslations/find** 4518 +))) 4519 + 4520 +Пример запроса: 4521 + 4522 +{ 4523 +"id": "", ~/~/ идентификатор пользователя 4524 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4525 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4526 +} 4527 + 4528 +Ответ: 4529 + 4530 +[ 4531 +{ 4532 +"description": "", ~/~/ Определяет описание 4533 +"subscriberId": "", ~/~/ идентификатор запроса 4534 +"protocolType": 0, ~/~/ Тип протокола 4535 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4536 +"address": "string", ~/~/ Адрес события 4537 +"id": "", ~/~/ идентификатор пользователя 4538 +"parentId": "", ~/~/ Guid идентификатор родителя 4539 +"deleted": true ~/~/ Признак удаления 4540 +} 4541 +] 4542 + 4543 + 4544 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4545 + 4546 +== **API для отчета по выгрузке комбайнов** == 4547 + 4548 +(% class="box infomessage" %) 4549 +((( 4550 +POST **/api/v3/Reports/harvesterUnloading** 4551 +))) 4552 + 4553 +Пример запроса: 4554 + 4555 +{ 4556 + "byTime": 0, ~/~/ Объединение событий по времени 4557 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4558 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4559 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4560 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4561 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4562 + 0 4563 + ], 4564 + "from": "", ~/~/ Дата и время начало запроса 4565 + "to": "", ~/~/ Дата и время окончания запроса 4566 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4567 +} 4568 + 4569 +Пример ответа: 4570 + 4571 +[ 4572 + { 4573 + "harvesterName": "", ~/~/Комбайн, номер 4574 + "harvesterId": 0, ~/~/Комбайн, id 4575 +"harvesterModel": "", ~/~/ Модель комбайна 4576 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4577 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4578 + "events": [ ~/~/Список событий в разрезе комбайна 4579 + { 4580 + "driverId": "", ~/~/Идентификатор водителя 4581 + "driverName": "", ~/~/Водитель комбайна, ФИО 4582 + "RFID": "", ~/~/ идентификатор карты-метки 4583 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4584 + "vehicleId": 0, ~/~/идентификатор объекта 4585 + "vehicleName": "string", ~/~/ Имя объекта 4586 + "modelName": "string", ~/~/ Имя модели объекта 4587 + "nearestVehicles": [ ~/~/Объекты рядом 4588 + { 4589 + "vehicleId": 0, ~/~/идентификатор объекта 4590 + "vehicleName": "string" ~/~/ Имя объекта 4591 + } 4592 + ], 4593 + "fields": [ ~/~/Поля, где происходила выгрузка 4594 + { 4595 + "id": 0, ~/~/ идентификатор пользователя 4596 + "name": "string" ~/~/ имя пользователя 4597 + } 4598 + ], 4599 + "event": "string", ~/~/Событие 4600 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4601 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4602 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4603 + "cultureName": "string", ~/~/ название культуры 4604 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4605 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4606 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4607 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4608 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4609 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4610 + "issued": 0, ~/~/Выдано, бункеров 4611 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4612 + "latitude": 0, ~/~/Широта 4613 + "longitude": 0, ~/~/ Долгота 4614 + "litresAway": 0, ~/~/Отдано, л 4615 + "m3Away": 0 ~/~/Отдано, м3 4616 + } 4617 + ] 4618 + } 4619 +] 4620 + 4621 + 4622 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4623 + 4624 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4625 + 4626 + 4627 +(% class="box infomessage" %) 4628 +((( 4629 +GET api/v3/Vehicles/recyclebin/all 4630 +))) 4631 + 4632 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4633 + 4634 +Параметр запроса: {parentId} - идентификатор агента 4635 + 4636 +В заголовках запроса: X-Auth: Токен авторизации 4637 + 4638 +Ответ: 4639 + 4640 +[ 4641 + { 4642 + "recordTime": "", ~/~/Время записи 4643 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4644 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4645 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4646 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4647 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4648 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4649 + "items": [ ~/~/ 4650 +nullable: true ~/~/Детали 4651 + { 4652 + "name": "string", ~/~/наименование столбца 4653 + "value": "string" ~/~/содержание столбца 4654 + } 4655 + ] 4656 + }, 4657 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4658 + "string" 4659 + ] 4660 + } 4661 +] 4662 + 4663 + 4664 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4665 + 4666 +(% class="box infomessage" %) 4667 +((( 4668 +POST/api/v3/Vehicles/recyclebin/erase 4669 +))) 4670 + 4671 +В заголовках запроса: X-Auth: Токен авторизации 4672 + 4673 +Пример запроса: 4674 + 4675 +[ 4676 +0 4677 +] 4678 + 4679 + 4680 +Пример ответа: 4681 + 4682 +[ 4683 +{ 4684 + "recordTime": "", ~/~/Время записи 4685 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4686 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4687 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4688 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4689 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4690 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4691 + "items": [ ~/~/Детали 4692 + { 4693 + "name": "", ~/~/Имя свойства 4694 + "value": "" ~/~/Значение свойства 4695 + } 4696 + ] 4697 + }, 4698 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4699 + "" 4700 + ] 4701 + } 4702 +] 4703 + 4704 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4705 + 4706 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4707 + 4708 +(% class="box infomessage" %) 4709 +((( 4710 +POST/api/v3/Vehicles/recyclebin/restore 4711 +))) 4712 + 4713 +В заголовках запроса: X-Auth: Токен авторизации 4714 + 4715 +Параметры в теле запроса (JSON): 4716 + 4717 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4718 + 4719 +В заголовках запроса: X-Auth: Токен авторизации 4720 + 4721 + 4722 +Пример запроса: 4723 + 4724 +((( 4725 +[ 4726 +))) 4727 + 4728 +((( 4729 + 0 4730 +))) 4731 + 4732 +((( 4733 +] 4734 +))) 4735 + 4736 + 4737 +Пример ответа: 4738 + 4739 +[ 4740 +{ 4741 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4742 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4743 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4744 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4745 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4746 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4747 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4748 + "items": [ ~/~/Детали 4749 + { 4750 + "name": "string", ~/~/Имя свойства 4751 + "value": "string" ~/~/Значение свойства 4752 + } 4753 + ] 4754 + }, 4755 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4756 + "string" 4757 + ] 4758 + } 4759 +] 4760 + 4761 + 4762 + 1146 1146 (% class="box" lang="en-US" style="text-align: center;" %) 1147 1147 ((( 1148 1148 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content