Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/21 14:13
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Artem1 +XWiki.SupportZhuchkov - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,62 +1,93 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API == 2 +((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 3 3 4 -== == 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 5 5 6 -(% class="box" style="text-align: center;" %) 7 -((( 8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 + 15 +**Содержание страницы:** 9 9 ))) 10 10 11 - (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).18 +{{toc/}} 12 12 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 14 14 21 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 22 + 23 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 24 + 25 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 26 + 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 - 17 17 18 -(% class="box" style="text-align: center;" %) 29 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 30 + 31 + 32 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 33 + 34 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 35 + 36 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 37 + 38 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 19 19 ((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 40 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 41 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 21 21 ))) 22 22 23 -(% class="box infomessage" %)44 +(% class="box successmessage" %) 24 24 ((( 25 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET**(%%)**/(% lang="en-US" %)api/v3/agents(%%)**46 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %) сновныепараметры клиентов: наименование,полноенаименование,тип, статусиидентификатор клиента-родителя.Методвозвращаетинформациюоклиентахс учетом настроекавторизованногопользователя,указанногов запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):49 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %) − информация о клиентах предоставляетсяпри наличииправа «Просмотрклиентов»;51 +(% style="color:#000000" %)Метод запроса: **POST** 31 31 32 -(% style="color:#000000" %) − возвращается информация о клиенте, которомупринадлежит авторизованныйпользователь, и его дочерних клиентах;53 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %) −информацияо клиентетипа «Партнер»и его подклиентоввозвращается при наличииправа «Доступ к партнёрским клиентам».55 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 -(% style="color:#000000" %) Методзапроса:**GET**57 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 38 -(% 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> 59 +(% style="color:#000000" %){ 60 + "login": "testuser", 61 + "password": "testuser" 62 +} 39 39 40 -(% style="color:#000000" %) Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)64 +(% style="color:#000000" %)**Ответ:** 41 41 42 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 66 +(% lang="en-US" %) 67 +(% style="color:#000000" %){ 68 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 69 + "User": "testuser" , ~/~/ имя пользователя(%%) 70 +} 43 43 44 - (% style="color:#000000"%)Ответ:[ { «agentId»: «», //идентификаторклиента«parentId»: «», //идентификаторклиента-родителя«name»: «», //наименованиеклиента«fullName»: «», //полноенаименованиеклиента«agentInfoType»: , //типклиента1«status»: //статус клиента }, … ]72 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 45 45 46 -(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] 74 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 75 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 76 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 77 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 78 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 47 47 80 +(% class="wikigeneratedid" %) 81 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 48 48 49 -(% class="box" style="text-align: center;" %) 50 -((( 51 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 52 -))) 83 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 53 53 54 54 (% class="box infomessage" %) 55 55 ((( 56 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**87 +(% lang="en-US" %)**GET /api/v3/auth/check** 57 57 ))) 58 58 59 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).90 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 60 60 61 61 (% style="color:#000000" %)Метод запроса: **GET** 62 62 ... ... @@ -67,98 +67,306 @@ 67 67 (% lang="en-US" %) 68 68 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 69 69 101 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 70 70 103 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 104 + 71 71 (% class="box infomessage" %) 72 72 ((( 73 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET/api/v3/auth/login**107 +**GET api/v3/agents/{id}** 74 74 ))) 75 75 76 -(% style="color:#000000" %) Метод позволяетполучить токенавторизации, которыйнеобходимо добавлятьвзаголовокдляработысовсемиметодами API.В параметрахметодапередаетсяимяпользователяипароль.110 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 77 77 112 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 113 + 78 78 (% style="color:#000000" %)Метод запроса: **GET** 79 79 80 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]116 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 81 81 82 - (% style="color:#000000" %)В случае успешноговыполненияметода, поле «AuthId»содержиттокен авторизации«X-Auth».118 +Запрос должен содержать данные параметра "**agentId**" 83 83 84 -(% lang="en-US" %) 85 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 120 +(% style="color:#000000" %)Ответ: 121 +{ 122 + "agentId": "", (%%) 123 + "parentId": "", 124 + "parentName": "string", 125 + "name": "string", 126 + "fullName": "string", 127 + "agentInfoType": 0, 128 + "isForeign": true/false, 129 + "district": "string", 130 + "region": "string", 131 + "city": "string", 132 + "inn": "string", 133 + "kpp": "string", 134 + "address": "string", 135 + "addressFact": "string", 136 + "email": "string", 137 + "director": "string", 138 + "bankName": "string", 139 + "bankBIK": "string", 140 + "bankRS": "string", 141 + "bankKS": "string" 142 + } 86 86 144 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 145 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 146 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 147 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 148 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 149 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 150 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 151 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 152 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 153 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 154 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 155 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 156 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 157 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 158 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 159 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 160 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 161 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 162 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 163 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 164 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 87 87 88 -(% class="box" lang="en-US" style="text-align: center;" %) 89 -((( 90 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 91 -))) 166 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 92 92 93 93 (% class="box infomessage" %) 94 94 ((( 95 -(% style="color:#000000; line-height:100%" %)**Получениесписка типов устройств**(%style="color:#000000"%)**— **(% lang="en-US" %)**GET /api/v3/devices/types**170 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 96 96 ))) 97 97 98 -(% style="color:#000000" %) списоктипов устройств. Метод возвращает информацию отипахустройствсучетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).173 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 99 99 100 -(% style="color:#000000" %) Методзапроса:**GET**175 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 101 101 102 -(% 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]]177 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 103 103 104 -(% style="color:#000000" %) Взаголовкахзапроса:X-Auth:Токенавторизации179 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 105 105 106 -(% style="color:#000000" %) Ответ:[181 +(% style="color:#000000" %)Метод запроса: **POST** 107 107 108 -(% class="western" %) 109 -{{{ { 110 - "deviceTypeId" : "", // ID типа устройства 111 - "deviceTypeName" : "" // Название типа устройства 112 - },}}} 183 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 113 113 114 -(% style="text-align:left" %) 115 -(% style="color:#000000" %)…** **] 185 +(% style="color:#000000" %)Параметр запроса: 116 116 187 +(% style="color:#000000" %){ 188 + "parentId": "string" 189 +} 117 117 118 -(% class="box" style="text-align: center;" %) 191 +(% style="color:#000000" %)Ответ: 192 + 193 +{ 194 + "agentId": "",(% style="color:#000000" %) (%%) 195 + "parentId": "", 196 + "name": "string", 197 + "fullName": "string", 198 + "agentInfoType": 0, 199 +(% style="color:#000000" %) "status": "", 200 +} 201 + 202 + 203 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 204 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 205 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 206 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 207 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 208 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 209 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 210 + 211 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 212 + 213 +(% class="box successmessage" %) 119 119 ((( 120 - (%style="color:#000000; font-size:14pt"%)**Раздел Датчики**215 +**POST /api/v3/agents ** 121 121 ))) 122 122 123 -(% class="box infomessage" %) 218 +Метод позволяет добавить клиента, указанного в запросе. 219 + 220 +Метод запроса: **POST** 221 + 222 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 223 + 224 +В заголовках запроса: X-Auth: Токен авторизации 225 + 226 +Параметры в теле запроса (JSON): 227 + 228 +{ 229 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 230 + "name": "string", ~/~/ имя 231 + "fullName": "string", ~/~/ полное наименование 232 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 233 + "isForeign": true, ~/~/ иностранный контрагент 234 + "district": "string", ~/~/ округ 235 + "region": "string", ~/~/ регион 236 + "city": "string", ~/~/ город 237 + "inn": "string", ~/~/ ИНН 238 + "kpp": "string", ~/~/ КПП 239 + "address": "string", ~/~/ юридический адрес 240 + "addressFact": "string", ~/~/ фактический адрес 241 + "email": "string", ~/~/ email 242 + "director": "string", ~/~/ ФИО руководителя 243 + "bankName": "string", ~/~/ банк 244 + "bankBIK": "string", ~/~/ БИК 245 + "bankRS": "string", ~/~/ номер счёта 246 + "bankKS": "string" ~/~/ корр. счёт 247 +} 248 + 249 +Ответ: 250 + 251 +{ 252 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 253 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 254 + "name": "string", ~/~/ имя 255 + "fullName": "string", ~/~/ полное наименование 256 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 257 + "isForeign": true, ~/~/ иностранный контрагент 258 + "district": "string", ~/~/ округ 259 + "region": "string", ~/~/ регион 260 + "city": "string", ~/~/ город 261 + "inn": "string", ~/~/ ИНН 262 + "kpp": "string", ~/~/ КПП 263 + "address": "string", ~/~/ юридический адрес 264 + "addressFact": "string", ~/~/ фактический адрес 265 + "email": "string", ~/~/ email 266 + "director": "string", ~/~/ ФИО руководителя 267 + "bankName": "string", ~/~/ банк 268 + "bankBIK": "string", ~/~/ БИК 269 + "bankRS": "string", ~/~/ номер счёта 270 + "bankKS": "string" ~/~/ корр. счёт 271 +} 272 + 273 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 274 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 275 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 276 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 277 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 278 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 279 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 280 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 281 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 282 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 283 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 284 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 285 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 286 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 287 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 288 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 289 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 290 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 291 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 292 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 293 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 294 + 295 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 296 + 297 +(% class="box warningmessage" %) 124 124 ((( 125 - (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GETsensors/types**299 +**PUT /api/v3/agents** 126 126 ))) 127 127 128 - (% style="color:#000000" %)Метод позволяетполучить список типовдатчиков. Метод возвращаетинформациюотипах датчиковс учетом настроекавторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).302 +Метод позволяет отредактировать клиента, указанного в запросе. 129 129 130 - (% style="color:#000000" %)Метод запроса: **GET**304 +Метод запроса: **PUT** 131 131 132 - (% style="color:#000000" %)URL(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]306 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 133 133 134 - (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации308 +В заголовках запроса: X-Auth: Токен авторизации 135 135 136 - (%style="color:#000000"%)Ответ:[310 +Параметры в теле запроса (JSON): 137 137 138 -(% class="western" style="margin-bottom:19px" %) 139 -{{{ {}}} 312 +{ 313 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 314 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 315 + "name": "string", ~/~/ имя 316 + "fullName": "string", ~/~/ полное наименование 317 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 318 + "isForeign": true, ~/~/ иностранный контрагент 319 + "district": "string", ~/~/ округ 320 + "region": "string", ~/~/ регион 321 + "city": "string", ~/~/ город 322 + "inn": "string", ~/~/ ИНН 323 + "kpp": "string", ~/~/ КПП 324 + "address": "string", ~/~/ юридический адрес 325 + "addressFact": "string", ~/~/ фактический адрес 326 + "email": "string", ~/~/ email 327 + "director": "string", ~/~/ ФИО руководителя 328 + "bankName": "string", ~/~/ банк 329 + "bankBIK": "string", ~/~/ БИК 330 + "bankRS": "string", ~/~/ номер счёта 331 + "bankKS": "string" ~/~/ корр. счёт 332 +} 140 140 141 - (% style="color:#000000" %)«id»: «», //IDтипа датчика «name»: «», //Название334 +Ответ: 142 142 143 -(% class="western" %) 144 -{{{ "description": "" // Описание 145 - },}}} 336 +{ 337 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 338 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 339 + "name": "string", ~/~/ имя 340 + "fullName": "string", ~/~/ полное наименование 341 + "isForeign": true, ~/~/ иностранный контрагент 342 + "district": "string", ~/~/ округ 343 + "region": "string", ~/~/ регион 344 + "city": "string", ~/~/ город 345 + "inn": "string", ~/~/ ИНН 346 + "kpp": "string", ~/~/ КПП 347 + "address": "string", ~/~/ юридический адрес 348 + "addressFact": "string", ~/~/ фактический адрес 349 + "email": "string", ~/~/ email 350 + "director": "string", ~/~/ ФИО руководителя 351 + "bankName": "string", ~/~/ банк 352 + "bankBIK": "string", ~/~/ БИК 353 + "bankRS": "string", ~/~/ номер счёта 354 + "bankKS": "string" ~/~/ корр. счёт 355 +} 146 146 147 -(% style="text-align:left" %) 148 -(% style="color:#000000" %)… ] 357 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 149 149 359 +(% class="box errormessage" %) 360 +((( 361 +**DELETE /api/v3/agents/{clientId}** 362 +))) 150 150 151 -(% class="box" style="text-align: center;" %) 364 +Метод позволяет удалить клиента, указанного в строке запроса. 365 + 366 +Метод запроса: **DELETE** 367 + 368 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 369 + 370 +Параметр запроса: **{clientId}** - Guid пользователя 371 + 372 +В заголовках запроса: X-Auth: Токен авторизации 373 + 374 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 375 + 376 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 377 + 378 +(% class="box warningmessage" %) 152 152 ((( 153 - (%style="color:#000000; font-size:14pt" %)**Раздел Пользователи**380 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 154 154 ))) 155 155 383 +Метод позволяет изменить статус клиента, указанного в запросе. 384 + 385 +В пути указывается GUID клиента и статус клиента. 386 + 387 +**status **- значение 0 - заблокирован, 1 - активен. 388 + 389 +Ответ: Code 204 390 + 391 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 392 + 393 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 394 + 156 156 (% class="box successmessage" %) 157 157 ((( 158 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**397 +(% lang="en-US" %)**POST /api/v3/users** 159 159 ))) 160 160 161 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).400 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 162 162 163 163 (% style="color:#000000" %)Метод запроса: **POST** 164 164 ... ... @@ -166,18 +166,178 @@ 166 166 167 167 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 168 168 169 -(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }408 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 170 170 410 +(% style="color:#000000" %) 411 +{ 412 + "lastName": "", ~/~/ фамилия 413 + "firstName": "", ~/~/ имя 414 + "position": "", ~/~/ должность 415 + "phone": "", ~/~/ телефон 416 + "organization": "", ~/~/ организация 417 + "login": "", ~/~/ логин (обязателен) 418 + "password": "", ~/~/ пароль (обязателен) 419 + "email": "", ~/~/ email (обязателен) 420 + "description": "string", ~/~/ Описание 421 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 422 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 423 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 424 + "parentId": "", ~/~/ Guid родительского агента 425 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 426 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 427 + "doubleAuth": 428 + { 429 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 430 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 431 + }, 432 + "groups": 433 + [ 434 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 435 + ], 436 + "customGroups": 437 + [ 438 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 439 + ], 440 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 441 +} 442 +{ 443 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 444 + "lastName": "string", 445 + "firstName": "string", 446 + "position": "string", 447 + "phone": "string", 448 + "organization": "string", 449 + "login": "string", 450 + "password": "string", 451 + "email": "string", 452 + 171 171 (% style="text-align:left" %) 172 -(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 454 +(% style="color:#000000; font-weight:normal" %)Ответ: 455 +{ 456 + "id": "" , ~/~/ ID пользователя 457 + "lastName": "" , ~/~/ Фамилия , 458 + "firstName": "" , ~/~/ Имя 459 + "position": "" , ~/~/ Должность 460 + "phone": "" , ~/~/ Телефон 461 + "organization": "" , ~/~/ Организация 462 + "login": "" , ~/~/ Логин 463 + "password": "" , ~/~/ Пароль 464 + "email": "" , ~/~/ Email 465 + "description": "" , ~/~/ Описание 466 + "isEnabled": "" , ~/~/ Признак включения 467 + "parentId": "" , ~/~/ Guid родительского агента 468 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 469 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 470 + "kind": "" , ~/~/ тип аутентификации 471 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 472 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 473 +} 173 173 174 174 476 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 477 + 478 +(% class="box infomessage" %) 479 +((( 480 +(% lang="en-US" %)**POST /api/v3/users/find** 481 +))) 482 + 483 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 484 + 485 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 486 + 487 +(% style="color:#000000" %)Метод запроса: **POST** 488 + 489 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 490 + 491 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 492 + 493 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 494 + 495 +(% style="color:#000000" %){(%%) 496 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 497 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 498 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 499 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 500 +(% style="color:#000000" %)} 501 + 502 +(% style="color:#000000" %)Ответ: 503 + 504 +(% style="color:#000000" %){ (%%) 505 + "id": "" , ~/~/ идентификатор пользователя 506 + "lastName": "" , ~/~/ фамилия 507 + "firstName": "" , ~/~/ имя 508 + "position": "" , ~/~/ должность 509 + "phone": "" , ~/~/ телефон 510 + "parentId": "" , ~/~/ идентификатор клиента-родителя 511 + "parentName": "" , ~/~/ наименование клиента-родителя 512 + "organization": "" , ~/~/ организация 513 + "login": "" , ~/~/ логин 514 + "email": "" , ~/~/ E-mail 515 + "sessionDuration":"", ~/~/ длительность сессии в минутах 516 + "status": "1", ~/~/ статус пользователя 517 + "lastLogged": "", ~/~/ дата/время последней авторизации 518 +(% style="color:#000000" %)} 519 + 520 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 521 + 522 +(% class="box infomessage" %) 523 +((( 524 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 525 +))) 526 + 527 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 528 + 529 +(% style="color:#000000" %)Метод запроса: **GET** 530 + 531 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 532 + 533 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 534 + 535 +(% style="color:#000000" %)Ответ: 536 + 537 +((( 538 +((( 539 +{ 540 + "id": "", ~/~/ GUID пользователя 541 + "lastName": "", ~/~/ Фамилия 542 + "firstName": "", ~/~/ Имя 543 + "position": "", ~/~/ Должность 544 + "phone": "", ~/~/ Номер телефона 545 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 546 + "parentName": "", Наименование клиента, которому принадлежит пользователь 547 + "organization": "", ~/~/ Организация 548 + "login": "", ~/~/ Логин пользователя 549 + "email": "", ~/~/ Адрес электронной почты 550 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 551 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 552 + "description": "", ~/~/ Описание 553 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен 554 + "doubleAuth": 555 + { 556 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 557 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 558 + }, 559 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 560 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 561 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 562 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 563 + "groups": [], ~/~/ Список ролей пользователя 564 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 565 + "authDevices": [ ], ~/~/ Список авторизованных устройств 566 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 567 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 568 +} 569 +))) 570 +))) 571 + 572 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 573 + 175 175 (% class="box warningmessage" %) 176 176 ((( 177 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**576 +(% lang="en-US" %)**PUT /api/v3/users** 178 178 ))) 179 179 180 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).579 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 181 181 182 182 (% style="color:#000000" %)Метод запроса: **PUT** 183 183 ... ... @@ -186,149 +186,598 @@ 186 186 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 187 187 188 188 (% lang="en-US" style="text-align:left" %) 189 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } //588 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 190 190 590 +(% lang="en-US" style="text-align:left" %) 591 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 592 + "id": "" , ~/~/ ID пользователя 593 + "lastName": "" , ~/~/ фамилия 594 + "firstName": "" , ~/~/ имя 595 + "position": "" , ~/~/ должность 596 + "phone": "" , ~/~/ телефон 597 + "organization": "" , ~/~/ организация 598 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 599 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 600 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 601 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 602 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 603 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 604 + "isEnabled": "" , ~/~/ признак включения 605 + "parentId": "" , ~/~/ Guid родительского агента 606 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 607 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 608 + "doubleAuth": 609 + { 610 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 611 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 612 + }, 613 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 614 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 615 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 191 191 617 +(% lang="en-US" style="text-align:left" %) 618 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 619 + 620 +(% lang="en-US" style="text-align:left" %) 621 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 622 + "id": "" , ~/~/ идентификатор пользователя 623 + "lastName": "" , ~/~/ фамилия 624 + "firstName": "" , ~/~/ имя 625 + "position": "" , ~/~/ должность 626 + "phone": "" , ~/~/ телефон 627 + "organization": "" , ~/~/ организация 628 + "login": "" , ~/~/ логин 629 + "password": "" , ~/~/ пароль 630 + "email": "" , ~/~/ email 631 + "description": "" , ~/~/ описание 632 + "isEnabled": "" , ~/~/ признак включения 633 + "parentId": "" , ~/~/ Guid родительского агента 634 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 635 + "doubleAuth": 636 + { 637 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 638 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 639 + }, 640 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 641 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 642 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 643 +} 644 + 645 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 646 + 192 192 (% class="box warningmessage" %) 193 193 ((( 194 -(% style="color:#000000" %) **Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**649 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 195 195 ))) 196 196 197 -(% style="color:#000000" %) . Метод позволяет изменить статус пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).652 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 198 198 199 199 (% style="color:#000000" %)Метод запроса: **PUT** 200 200 201 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:656 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 202 202 203 -(% style="color:#000000" %) {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизацииПараметрыв телезапроса(JSON): {«status»~:// «»,//статуспользователя(0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)658 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 204 204 205 -(% class="western" %) 206 -{{{ "description": "", // описание 207 - "data": "" // данные, связанные со сменой статуса}}} 660 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 208 208 662 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 663 + 664 +(% style="color:#000000" %){(%%) 665 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 666 + "description": "" , ~/~/ описание 667 + "data": "" , ~/~/ данные, связанные со сменой статуса 209 209 (% style="color:#000000" %)} 210 210 211 211 (% style="text-align:left" %) 212 212 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 213 213 673 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 214 214 215 -(% class="box successmessage" %)675 +(% class="box warningmessage" %) 216 216 ((( 217 - (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**677 +**POST /api/v3/users/disable** 218 218 ))) 219 219 220 - (% style="color:#000000" %)Метод позволяет получитьосновныепараметрыпользователей:логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.680 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 221 221 222 -(% style="color:#000000" %)Метод возвращает информацию опользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляетсяприналичииправа**«Просмотр пользователей»**.682 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 223 223 224 -(% style="color:#000000" %) Методзапроса:**POST**684 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 225 225 226 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]686 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 227 227 228 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 688 + [ 689 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 690 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 691 + ] 229 229 230 -(% class="western" %) 231 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 232 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 233 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 234 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 693 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 235 235 236 -(% style="color:#000000" %) }695 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 237 237 238 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 697 +(% class="box warningmessage" %) 698 +((( 699 +**POST /api/v3/users/enable** 700 +))) 239 239 240 -(% class="western" style="margin-bottom:19px" %) 241 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 702 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 242 242 243 -(% lang="en-US" style="text-align:left" %) 244 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 704 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 245 245 706 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 246 246 708 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 709 + 710 + [ 711 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 712 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 713 + ] 714 + 715 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 716 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 717 + 718 +((( 719 +В теле ответа: 720 +{ 721 + "errorMessages": [ 722 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 723 + ], 724 + "users": [ 725 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 726 + ] 727 +} 728 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 729 +"users" - массив id пользователей, которых не удалось включить или отключить. 730 +))) 731 + 732 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 733 + 247 247 (% class="box errormessage" %) 248 248 ((( 249 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**736 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 250 250 ))) 251 251 252 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).739 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 253 253 254 254 (% style="color:#000000" %)Метод запроса: **DELETE** 255 255 256 256 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 257 257 258 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации745 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 259 259 747 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 748 + 260 260 (% style="text-align:left" %) 261 261 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 262 262 752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 263 263 264 -(% class="box" style="text-align: center;" %) 754 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 755 + 756 +(% class="box infomessage" %) 265 265 ((( 266 -(% style="color:#000000; font-size:14pt" %)**РазделТранспортные средства**758 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 267 267 ))) 268 268 761 +Метод возвращает полную информацию о модели объекта. 762 + 763 +(% style="color:#000000" %)Метод запроса: **GET** 764 + 765 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 766 + 767 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 768 + 769 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 770 + 771 +(% style="color:#000000" %)Ответ: 772 + 773 +(% style="color:#000000" %){ 774 + "parentName": "string", 775 + "name": "string", 776 + "picture": "string", 777 + "minspeed": 0, 778 + "maxspeed": 0, 779 + "width": 0, 780 + "imbeddedtrailer": true, 781 + "hoppercapacity": 0, 782 + "hopperdischargespeed": 0, 783 + "modelType": 0, 784 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 785 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 786 + "deleted": true 787 +} 788 + 789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 790 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 791 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 792 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 793 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 794 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 795 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 796 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 797 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 798 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 799 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 800 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 801 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 802 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 803 + 804 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 805 + 806 +(% class="box successmessage" %) 807 +((( 808 +(% lang="en-US" %)**POST /api/v3/models/find** 809 +))) 810 + 811 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 812 + 813 +(% style="color:#000000" %)Метод запроса: **POST** 814 + 815 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 816 + 817 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 818 + 819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 820 + 821 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 822 +} 823 + 824 +(% style="color:#000000" %)Ответ: 825 + 826 +(% style="color:#000000" %)[ 827 + { 828 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 829 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 830 + "parentName": "string", 831 + "name": "string", 832 + "modelType": 0 833 + } 834 +] 835 + 836 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 837 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 838 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 839 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 840 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 841 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 842 + 843 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 844 + 845 +(% class="box successmessage" %) 846 +((( 847 +(% lang="en-US" %)**POST /api/v3/models** 848 +))) 849 + 850 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 851 + 852 +(% style="color:#000000" %)Метод запроса: **POST** 853 + 854 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 855 + 856 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 857 + 858 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 859 + 860 +{ 861 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 862 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 + "deleted": true, 864 + "extId": "string", 865 + "name": "string", 866 + "picture": "string", 867 + "minspeed": 0, 868 + "maxspeed": 0, 869 + "width": 0, 870 + "imbeddedtrailer": true, 871 + "fueloutlay": 0, 872 + "hoppercapacity": 0, 873 + "hopperdischargespeed": 0, 874 + "modelType": 0 875 +} 876 + 877 +Ответ: 878 + 879 +{ 880 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 881 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 882 + "deleted": true, 883 + "extId": "string", 884 + "name": "string", 885 + "picture": "string", 886 + "minspeed": 0, 887 + "maxspeed": 0, 888 + "width": 0, 889 + "imbeddedtrailer": true, 890 + "hoppercapacity": 0, 891 + "hopperdischargespeed": 0, 892 + "modelType": 0 893 +} 894 + 895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 896 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 897 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 898 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 900 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 901 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 902 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 903 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 904 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 905 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 906 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 907 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 908 + 909 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 910 + 911 +(% class="box warningmessage" %) 912 +((( 913 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 914 +))) 915 + 916 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 917 + 918 +(% style="color:#000000" %)Метод запроса: **PUT** 919 + 920 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 921 + 922 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 923 + 924 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 925 + 926 +{ 927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 928 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 929 + "deleted": true, 930 + "extId": "string", 931 + "name": "string", 932 + "picture": "string", 933 + "minspeed": 0, 934 + "maxspeed": 0, 935 + "width": 0, 936 + "imbeddedtrailer": true, 937 + "fueloutlay": 0, 938 + "hoppercapacity": 0, 939 + "hopperdischargespeed": 0, 940 + "modelType": 0 941 +} 942 + 943 +Ответ: 944 + 945 +{ 946 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 947 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 948 + "deleted": true, 949 + "extId": "string", 950 + "name": "string", 951 + "picture": "string", 952 + "minspeed": 0, 953 + "maxspeed": 0, 954 + "width": 0, 955 + "imbeddedtrailer": true, 956 + "fueloutlay": 0, 957 + "hoppercapacity": 0, 958 + "hopperdischargespeed": 0, 959 + "modelType": 0 960 +} 961 + 962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 963 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 964 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 965 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 967 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 968 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 969 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 970 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 971 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 972 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 973 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 974 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 975 + 976 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 977 + 269 269 (% class="box errormessage" %) 270 270 ((( 271 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**980 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 272 272 ))) 273 273 274 -(% style="color:#000000" %) бъект. Метод позволяет удалить объект, указанныйв строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).983 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 275 275 276 276 (% style="color:#000000" %)Метод запроса: **DELETE** 277 277 278 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}987 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 279 279 280 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта989 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 281 281 282 282 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 283 283 284 -(% style="text-align:left" %) 285 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 993 +Ответ: В случае успеха **Success 200** 286 286 995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 287 287 997 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 998 + 288 288 (% class="box infomessage" %) 289 289 ((( 290 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**1001 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 291 291 ))) 292 292 293 -(% style="color:#000000" %) 1004 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 294 294 295 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):1006 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 296 296 297 297 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 298 298 299 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 1010 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 300 300 301 301 (% style="color:#000000" %)Метод запроса: **GET** 302 302 303 -(% 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>1014 +(% 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} 304 304 305 -(% style="color:#000000" %)Параметр запроса: <vehicleid>- идентификатор объекта (опционально)1016 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 306 306 307 307 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 308 308 309 309 (% style="color:#000000" %)Ответ: 310 310 311 -(% style="color:#000000" %){ 1022 +((( 1023 +{ 1024 + "vehicleId": "", ~/~/ ID объекта 1025 + "name": "", ~/~/ Имя объекта 1026 + "imei": "", ~/~/ IMEI объекта 1027 + "deviceTypeId": , ~/~/ ID типа устройства 1028 + "deviceTypeName": "", ~/~/ Название типа устройства 1029 + "sim1": "", ~/~/ Номер SIM1 1030 + "sim2": "", ~/~/ Номер SIM2 1031 + "parentId": "", ~/~/ ID клиента-родителя 1032 + "parentName": "", ~/~/ Наименование клиента-родителя 1033 + "modelId": "", ~/~/ ID модели объекта 1034 + "modelName": "", ~/~/ Имя модели объекта 1035 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1036 + "unitName": "string", ~/~/ Наименование подразделения 1037 + "status": 0, ~/~/ Статус объекта 1038 + "createdAt": "", ~/~/ Дата создания объекта 1039 + }, 1040 +"customFields": [ ~/~/ Произвольные поля 1041 + { 1042 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1043 + "name": "string", ~/~/ Имя поля 1044 + "value": "string", ~/~/ Значение поля 1045 + "forClient": true, ~/~/ Не используемая функция 1046 + "forTooltip": true, ~/~/ Отображать в подсказке 1047 + "forReport": true ~/~/ Отображать в отчете 1048 + } 312 312 313 -(% class="western" %) 314 -{{{ "vehicleId": “”, // идентификатор объекта 315 - "name": "", // имя объекта 316 - "imei": "", // IMEI объекта 317 - "deviceTypeId": “”, // идентификатор устройства объекта 318 - "deviceTypeName": "" // наименование устройства объекта 319 - "parentId": "", // идентификатор клиента-родителя 320 - "parentName": "" // наименование клиента-родителя, 321 - "modelId": "", // идентификатор модели объекта 322 - "modelName": "" // наименование модели объекта, 323 - "unitId": "", // идентификатор подразделения 324 - "unitName": "", // наименование подразделения 325 - "status": “”, // статус объекта 326 - ... 1050 +], ~/~/ Данные с вкладки нормы 1051 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1052 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1053 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1054 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1055 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1056 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1057 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1058 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1059 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1060 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1061 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1062 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1063 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1064 + "mileageCoeff": 0, ~/~/ коэффициент пробега 1065 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1066 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1067 + "counters": { ~/~/ Счетчики 1068 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1069 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1070 + "mileage": 0, ~/~/ Текущий пробег 1071 + "motohours": 0, ~/~/ Текущие моточасы 1072 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1073 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 327 327 }, 328 - ...}}} 329 329 330 -(% style="color:#000000" %)} 1076 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1077 + "id": "string", ~/~/ ID объекта 1078 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 1079 + "host": "string", ~/~/ CMSV6 Web Host 1080 + "login": "string", ~/~/ CMSV6 Account 1081 + "password": "string" ~/~/ CMSV6 Password 1082 + }, 331 331 1084 +"commandTemplates": [ ~/~/ Шаблоны команд 1085 + { 1086 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1087 + "name": "string", ~/~/ Наименование команды 1088 + "command": "string", ~/~/ Текст команды 1089 + "retries": 0 ~/~/ Количество попыток 1090 + } 1091 + ], 1092 + "sensors": [ ~/~/ Датчики 1093 + { 1094 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1095 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1096 + "type": 0, ~/~/ Тип датчика 1097 + "name": "string", ~/~/ Имя датчика 1098 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1099 + "inputNumber": 0, ~/~/ Номер входа 1100 + "pseudonym": "string", ~/~/ Псевдоним 1101 + "medianDegree": 0, ~/~/ Медианная фильтрация 1102 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1103 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1104 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1105 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1106 + { 1107 + "grades": [ ~/~/ Таблица тарировки 1 1108 + { 1109 + "input": 0, ~/~/ Входящее значение 1110 + "output": 0 ~/~/ Выходящее значение 1111 + } 1112 + ], 1113 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1114 + } 1115 + ], 1116 + "showInTooltip": true, ~/~/ Отображать в подсказке 1117 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1118 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1119 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1120 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1121 + "expr": "string", ~/~/ Формула 1122 + "children": [ ~/~/ массив дочерних датчиков 1123 + "string" 1124 + ], 1125 + "customParams": { ~/~/ прочие произвольные параметры 1126 + "additionalProp1": "string", 1127 + "additionalProp2": "string", 1128 + "additionalProp3": "string" 1129 + }, 1130 + 1131 +~/~/ Характерные для произвольного: 1132 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1133 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1134 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1135 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1136 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1137 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1138 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1139 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1140 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1141 +~/~/ "ValueOn": "Вкл.", 1142 +~/~/ "ValueOff": "Выкл." 1143 + "summaryMaxValue": 0 ~/~/ Макс. значение 1144 + } 1145 + "drivers": [ ~/~/ Водители 1146 + { 1147 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1148 + "name": "string", ~/~/ Наименование 1149 + "description": "string", 1150 + "isDefault": true ~/~/ По умолчанию 1151 + } 1152 + ], 1153 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1154 + { 1155 + "id": "", ~/~/ ID задания 1156 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 1157 + "name": "", ~/~/ Наименование задания 1158 + "description": "", ~/~/ Описание задания 1159 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1160 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1161 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1162 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1163 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1164 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1165 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 1166 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1167 + } 1168 + ], 1169 +"statusHistory": [ ~/~/ История статусов 1170 + { 1171 + "status": 0, 1172 + "date": "2023-05-22T09:57:39.562Z", 1173 + "description": "string", 1174 + "additionalInfo": "string" 1175 + } 1176 + ] 1177 +} 1178 +))) 1179 + 332 332 (% style="text-align:left" %) 333 333 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 334 334 ... ... @@ -336,13 +336,83 @@ 336 336 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 337 337 338 338 1187 +== **Отправить команду на терминал** == 1188 + 339 339 (% class="box successmessage" %) 340 340 ((( 341 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**1191 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 342 342 ))) 343 343 344 - (% style="color:#000000" %) Методпозволяет добавитьобъект. Методпозволяетдобавить объект, указанный в запросе (обязательный параметрвзаголовкахзапроса - токенвторизации**«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).1194 +Команда для отправки на тс. 345 345 1196 +{ 1197 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1198 +"command": "", ~/~/ Текст отправляемой команды 1199 +"retries": "", ~/~/ Количество попыток отправки на терминал 1200 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1201 +} 1202 + 1203 +В ответ получаем cmdid 1204 + 1205 + 1206 +== **Получить ответ на отправленную на ТС команду** == 1207 + 1208 +(% class="box infomessage" %) 1209 +((( 1210 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1211 +))) 1212 + 1213 +Идентификатор команды: cmdId 1214 + 1215 +Запрос от терминала на ответ команды 1216 + 1217 +Пример ответ от терминала: 1218 + 1219 +ID= "" ~/~/ идентификатор объекта 1220 +Soft="" ~/~/ версия софта 1221 +GPS=4 ~/~/ тип трекера 1222 +Time=11:05:43 28.06.24 ~/~/ время запроса 1223 +Lat=45.056221 ~/~/ широта 1224 +Lon=39.035938 ~/~/ долгота 1225 +Speed=0.0 ~/~/ скорость 1226 +Course=181.4 ~/~/направление 1227 + 1228 +((( 1229 +== **Список отправленных объекту команд с ответами** == 1230 + 1231 +(% class="box infomessage" %) 1232 +((( 1233 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1234 +))) 1235 + 1236 +Идентификатор ТС: vehicleId 1237 + 1238 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1239 + 1240 +Пример ответа терминала 1241 + 1242 +[ 1243 +{ 1244 +"id": "", ~/~/ идентификатор пользователя 1245 +"commandText": "", ~/~/Текст команды. 1246 +"templateId": "", ~/~/Идентификатор шаблона 1247 +"updated": "", ~/~/ Время отправки 1248 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1249 +"answer": "", ~/~/ Ответ терминала. 1250 +"status": "" ~/~/ Статус отправки 1251 +} 1252 +] 1253 +))) 1254 + 1255 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1256 + 1257 +(% class="box successmessage" %) 1258 +((( 1259 +(% lang="en-US" %)**POST /api/v3/vehicles** 1260 +))) 1261 + 1262 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 1263 + 346 346 (% style="color:#000000" %)Метод запроса: **POST** 347 347 348 348 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] ... ... @@ -349,106 +349,537 @@ 349 349 350 350 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 351 351 352 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {1270 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 353 353 354 -(% class="western" %) 355 -{{{ "parentId": "", // ID клиента 356 - "name": "", // имя ТС 357 - "imei": "", // IMEI 358 - "deviceTypeId": "",// ID типа устройства 359 - "modelId": "", 360 - "unitId": "", // ID подразделения 361 - "sim1": "", // Номер SIM 1 362 - "sim2": "", // Номер SIM2 363 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 364 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 365 - "consumptionIdle": "",// Расход топлива на холостом ходу 366 - "counters": { 367 - "mileage": "", // пробег 368 - "mileageEnabled": true, // флаг активности счётчика "пробег" 369 - "motohours":"", // моточасы 370 - "motohoursEnabled": true // флаг активности счётчика "моточасы" 371 - }, 372 - "cmsv6Parameters": { // параметры CMSv6 373 - "enabled": true, // флаг включения 374 - //"id": "", // идентификатор 375 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 376 - "login": "", // имя учетной записи 377 - "password": "" // пароль учетной записи 1272 +(% style="color:#000000" %){(%%) 1273 + "parentId": "" , ~/~/ ID клиента 1274 + "name": "" , ~/~/ имя ТС 1275 + "imei": "" , ~/~/ IMEI 1276 + "deviceTypeId": "" , ~/~/ ID типа устройства 1277 + "modelId": "" , ~/~/ ID модели 1278 + "unitId": "" , ~/~/ ID подразделения 1279 + "sim1": "" , ~/~/ Номер SIM 1 1280 + "sim2": "" , ~/~/ Номер SIM2 1281 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1282 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1283 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1284 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1285 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1286 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1287 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1288 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1289 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1290 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1291 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1292 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1293 + "mileageCalcMethod": 0, 1294 + "mileageCoeff": 0, 1295 + "locationByCellId": true, 1296 + "dottedLineTrackWhenNoCoords": true, 1297 + "counters": ~/~/ счетчики 1298 + { 1299 + "mileage": "" , ~/~/ пробег 1300 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1301 + "motohours": "" , ~/~/ моточасы 1302 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 378 378 }, 379 - "inspectionTasks": [ // задания на ТО 1304 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1305 + "enabled": true, ~/~/ флаг включения 1306 + "id": "" , ~/~/ идентификатор 1307 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1308 + "login": "" , ~/~/ имя учетной записи 1309 + "password": "" ~/~/ пароль учетной записи 1310 + }, 1311 + "inspectionTasks": ~/~/ задания на ТО 380 380 { 381 - "enabled": "", // Признак включения 382 - "name": "", // Имя задания 383 - "description": "", // Описание задания 384 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 385 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 386 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 387 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 388 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 389 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 390 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 391 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 1313 + "enabled": "" , ~/~/ Признак включения 1314 + "name": "" , ~/~/ Имя задания 1315 + "description": "" , ~/~/ Описание задания 1316 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1317 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1318 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1319 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1320 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1321 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1322 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1323 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1324 + } 1325 +"drivers": [ ~/~/ Водители 1326 + { 1327 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1328 + "isDefault": true 1329 + } 1330 + ], 1331 + "commandTemplates": [ ~/~/ Шаблон команды 1332 + { 1333 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1334 + "name": "string", 1335 + "command": "string", 1336 + "retries": 0 1337 + } 1338 + ], 1339 +"sensors": [ ~/~/ Датчики 1340 + { 1341 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1342 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1343 + "type": 0, ~/~/ Тип датчика 1344 + "name": "string", ~/~/ Имя датчика 1345 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1346 + "inputNumber": 0, ~/~/ Номер входа 1347 + "pseudonym": "string", ~/~/ Псевдоним 1348 + "medianDegree": 0, ~/~/ Медианная фильтрация 1349 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1350 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1351 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1352 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1353 + { 1354 + "grades": [ ~/~/ Таблица тарировки 1 1355 + { 1356 + "input": 0, ~/~/ Входящее значение 1357 + "output": 0 ~/~/ Выходящее значение 1358 + } 1359 + ], 1360 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1361 + } 1362 + ], 1363 + "showInTooltip": true, ~/~/ Отображать в подсказке 1364 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1365 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1366 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1367 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1368 + "expr": "string", ~/~/ Формула 1369 + "children": [ ~/~/ массив дочерних датчиков 1370 + "string" 1371 + ], 1372 + "customParams": { ~/~/ прочие произвольные параметры 1373 + "additionalProp1": "string", 1374 + "additionalProp2": "string", 1375 + "additionalProp3": "string" 392 392 }, 393 - ]}}} 1377 +~/~/ Характерные для произвольного: 1378 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1379 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1380 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1381 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1382 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1383 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1384 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1385 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1386 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1387 +~/~/ "ValueOn": "Вкл.", 1388 +~/~/ "ValueOff": "Выкл." 1389 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 394 394 395 -(% style="color:#000000" %)… } 1391 +((( 1392 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1393 + { 1394 + "from": 0, ~/~/ С какого значения 1395 + "color": "string", ~/~/ Каким цветом 1396 + "text": "string" ~/~/ Текст подписи к этому интервалу 1397 + } 1398 + ] 1399 + } 1400 + ], 1401 +))) 396 396 1403 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1404 + 1405 + 1406 + "customFields": [ ~/~/ Произвольные поля 1407 + { 1408 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1409 + "name": "string", ~/~/ Наименование произвольного поля 1410 + "value": "string", ~/~/ Значение произвольного поля 1411 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1412 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1413 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1414 + } 1415 + ] 1416 +} 1417 + 397 397 (% style="color:#000000" %)Ответ: 398 398 399 -(% style="color:#000000" %){ 400 400 401 -(% class="western" %) 402 -{{{ "vehicleId": "", //ID ТС 403 - "parentId": "", //Guid владельца ТС 404 - "name": "", //Имя объекта 405 - "imei": "", //IMEI 406 - "deviceTypeId": "", //ID типа устройства 407 - "modelId": "", //ID модели 408 - "unitId": "", //ID подразделения 409 - "sim1": "", //SIM1 410 - "sim2": "", //SIM2 411 - "consumptionPer100Km": "", //Расход топлива на 100 км 412 - "consumptionIdle": "", //Расход топлива на холостом ходу 413 - "counters": { //Счётчики 414 - "mileageEnabled": true, 415 - "motohoursEnabled": true, 416 - "mileage": "", 417 - "motohours": 345.0 1421 +((( 1422 +((( 1423 +((( 1424 +{ 1425 + "vehicleId": 0, ~/~/ ID ТС 1426 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1427 + "name": "string", ~/~/ Имя объекта 1428 + "imei": "string", ~/~/ IMEI 1429 + "deviceTypeId": 0, ~/~/ ID типа устройства 1430 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1431 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1432 + "sim1": "string", ~/~/ SIM1 1433 + "sim2": "string", ~/~/ SIM2 1434 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1435 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1436 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1437 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1438 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1439 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1440 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1441 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1442 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1443 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1444 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1445 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1446 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1447 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1448 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1449 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1450 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1451 + "counters": { ~/~/ Dto для состояний счётчиков 1452 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1453 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1454 + "mileage": 0, ~/~/ Пробег 1455 + "motohours": 0 ~/~/ Моточасы 418 418 }, 419 - "cmsv6Parameters": { // ПараметрыCmsV6420 - ull,421 - флагвключения422 - 423 - 424 - 1457 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1458 + "id": "string", ~/~/ CMSV6 Идентификатор 1459 + "enabled": true, ~/~/ Признак включения 1460 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1461 + "login": "string", ~/~/ CMSV6 имя учетной записи 1462 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 425 425 }, 426 - "inspectionTasks": [ // задания на ТО 1464 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1465 + { 1466 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1467 + "enabled": true, ~/~/ Признак включения 1468 + "name": "string", ~/~/ Имя задания 1469 + "description": "string", ~/~/ Описание задания 1470 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1471 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1472 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1473 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1474 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1475 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1476 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1477 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1478 + } 1479 + ], 1480 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1481 + { 1482 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1483 + "inputNumber": 0, ~/~/ № входа. 1484 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1485 + "comment": "string", ~/~/ Комментарий 1486 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1487 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1488 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1489 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1490 + } 1491 + ], 1492 + "commandTemplates": [ ~/~/ Список шаблонов команд 1493 + { 1494 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1495 + "name": "string", ~/~/ Название шаблона команд 1496 + "command": "string", ~/~/ Команда на выполнение 1497 + "retries": 0 ~/~/ Лимит попыток отправки 1498 + } 1499 + ], 1500 + "sensors": [ ~/~/ Список датчиков 1501 + { 1502 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1503 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1504 + "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 1505 + "name": "string", ~/~/ Имя датчика 1506 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1507 + "inputNumber": 0, ~/~/ Номер входа 1508 + "pseudonym": "string", ~/~/ Псевдоним 1509 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1510 + "isInverted": true, ~/~/ Признак инверсии 1511 + "disabled": true, ~/~/ Датчик не участвует в обработке 1512 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1513 + "gradesTables": [ ~/~/ Тарировка 1514 + { 1515 + "grades": [ ~/~/ Таблицы тарировки 1516 + { 1517 + "input": 0, ~/~/ Вход 1518 + "output": 0 ~/~/ Выход 1519 + } 1520 + ], 1521 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1522 + } 1523 + ], 1524 + "showInTooltip": true, ~/~/ Отображение в подсказке 1525 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1526 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1527 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1528 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1529 + "expr": "string", ~/~/ Выражение 1530 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1531 + "string" 1532 + ], 1533 + "customParams": { 1534 + "additionalProp1": "string", 1535 + "additionalProp2": "string", 1536 + "additionalProp3": "string" 1537 + }, 1538 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1539 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1540 + { 1541 + "from": 0, ~/~/ С какого значения 1542 + "color": "string", ~/~/ Каким цветом 1543 +))) 1544 + 1545 +((( 1546 + "text": "string" ~/~/ Текст подписи к этому интервалу 1547 + } 1548 + ] 1549 + } 1550 + ], 1551 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1552 + "customFields": [ ~/~/ Список произвольных полей 1553 + { 1554 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1555 + "name": "string", ~/~/ Наименование произвольного поля 1556 + "value": "string", ~/~/ Значение произвольного поля 1557 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1558 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1559 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1560 + } 1561 + ], 1562 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1563 +} 1564 +))) 1565 +))) 1566 +))) 1567 + 1568 + 1569 +**Валидация:** 1570 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1571 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1572 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1573 + 1574 + 1575 +== **Импортировать историю ТС (Асинхронный запрос)** == 1576 + 1577 +(% class="box successmessage" %) 1578 +((( 1579 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1580 +))) 1581 + 1582 +Метод запроса: **POST** 1583 + 1584 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1585 + 1586 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1587 + 1588 + 1589 +Ответ: 1590 + 1591 +{ 1592 + 1593 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1594 + 1595 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1596 + 1597 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1598 + 1599 + "Message": "string", ~/~/ Информация о выполнении запроса 1600 + 1601 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1602 + 1603 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1604 + 1605 + "Data": "string" ~/~/ Данные 1606 + 1607 +} 1608 + 1609 + 1610 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1611 + 1612 +(% class="box infomessage" %) 1613 +((( 1614 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1615 +))) 1616 + 1617 +Метод запроса: **GET** 1618 + 1619 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1620 + 1621 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1622 + 1623 + 1624 +Ответ: 1625 + 1626 +{ 1627 + 1628 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1629 + 1630 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1631 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1632 + 1633 + "Message": "string", ~/~/ Информация о выполнении запроса 1634 + 1635 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1636 + 1637 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1638 + 1639 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1640 + 1641 + "Data": "string" ~/~/ Данные 1642 + 1643 +} 1644 + 1645 + 1646 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1647 + 1648 +(% class="box infomessage" %) 1649 +((( 1650 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 1651 +))) 1652 + 1653 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1654 + 1655 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1656 + 1657 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 1658 + 1659 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 1660 + 1661 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 1662 + 1663 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 1664 + 1665 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 1666 + 1667 +(% style="color:#000000" %)Метод запроса: **POST** 1668 + 1669 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 1670 + 1671 +(% style="color:#000000" %)В заголовках запроса: 1672 + 1673 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 1674 + 1675 +(% style="color:#000000" %)− X-Auth: Токен авторизации 1676 + 1677 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 1678 + 1679 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 1680 + 1681 +{ 1682 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1683 + "name": null, ~/~/ Имя ТС (string, опционально) 1684 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1685 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1686 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1687 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1688 + "unitName": "string", ~/~/ Название подразделения (опционально) 1689 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1690 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1691 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1692 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1693 +} 1694 + 1695 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 1696 + 1697 +(% style="color:#000000" %)Ответ: 1698 + 1699 +(% style="color:#000000" %)[ 1700 +{ 1701 + 1702 +((( 1703 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1704 +))) 1705 + 1706 +((( 1707 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1708 + "name": "" ~/~/ наименование объекта 1709 + "imei": "" ~/~/ IMEI объекта 1710 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 1711 + "deviceTypeName": "" ~/~/ наименование типа устройства 1712 + "sim1": "" ~/~/ первый номер телефона 1713 + "sim2": "" ~/~/ второй номер телефона 1714 + "parentId": "" ~/~/ идентификатор клиента-родителя 1715 + "parentName": "" ~/~/ наименование клиента-родителя 1716 + "modelId": "" ~/~/ идентификатор модели объекта 1717 + "modelName": "" ~/~/ наименование модели объекта 1718 + "unitId": "" ~/~/ идентификатор подразделения 1719 + "unitName": "" ~/~/ наименование подразделения 1720 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1721 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1722 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1723 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1724 + "customFields": [ 1725 + { 1726 + "id": "", ~/~/ идентификатор произвольного поля 1727 + "name": "", ~/~/ имя произвольного поля 1728 + "value": "", ~/~/ значение произвольного поля 1729 + "forClient": true, ~/~/ право на отображение у клиента 1730 + "forTooltip": false, ~/~/ право на отображение в подсказке 1731 + "forReport": false ~/~/ право на отображение в отчетах 1732 +))) 1733 + 1734 +((( 1735 + } 1736 + ], 1737 + "vehicleGroups": [ ~/~/ Группы ТС 427 427 { 428 - "id": "", // ID задачи 429 - "enabled": false, // Признак включения 430 - "name": "", // Имя задания 431 - "description": "", // Описание задания 432 - "mileageCondition": "", // Условие по пробегу 433 - "lastMileage": "", // Пробег (в метрах) 434 - "motohoursCondition": "", // Условие по моточасам 435 - "lastMotohours": "", // Моточасы 436 - "periodicCondition": "", // Условие периодичности по времени 437 - "kind": "", // Вид периодичности по времени 438 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 1739 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1740 + "name": "string" ~/~/ Наименование группы ТС 439 439 } 440 - ]}}} 1742 + ] 1743 + } 1744 +] 1745 +))) 441 441 442 -(% style="text-align:left" %) 1747 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1748 + 1749 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 1750 + 1751 +(% class="box successmessage" %) 1752 +((( 1753 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 1754 +))) 1755 + 1756 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 1757 + 1758 +(% style="color:#000000" %)Метод запроса: **POST** 1759 + 1760 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId} 1761 + 1762 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 1763 + 1764 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1765 + 1766 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 1767 + 1768 +(% style="color:#000000" %){ 1769 + 1770 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1771 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1772 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1773 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1774 + "description": "", ~/~/ Описание 1775 + "data": "", ~/~/ Данные 1776 + "overwrite": false, ~/~/ Флаг перезаписи 1777 + "stage": "", ~/~/ Состояние, может быть null 443 443 (% style="color:#000000" %)} 444 444 1780 +(% style="color:#000000" %)Ответ: 445 445 1782 +(% style="color:#000000" %){(%%) 1783 + "status": "", ~/~/ значение статуса 1784 + "date": "", ~/~/ Дата смены статуса 1785 + "description": "", ~/~/ Описание 1786 + "data": "", ~/~/ Данные 1787 + "overwrite": false, ~/~/ Флаг перезаписи 1788 + "stage": "", ~/~/ Состояние 1789 +(% style="color:#000000" %) } 1790 + 1791 +== == 1792 + 1793 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1794 + 446 446 (% class="box warningmessage" %) 447 447 ((( 448 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**1797 +(% lang="en-US" %)**PUT /api/v3/vehicles** 449 449 ))) 450 450 451 -(% style="color:#000000" %) . Метод позволяет отредактировать объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1800 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 452 452 453 453 (% style="color:#000000" %)Метод запроса: **PUT** 454 454 ... ... @@ -458,130 +458,3012 @@ 458 458 459 459 (% style="color:#000000" %)Параметры в теле запроса (JSON): 460 460 461 -(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 1810 +(% style="color:#000000" %){ 1811 + "vehicleId": , ~/~/ ID объекта 1812 + "parentId": "" , ~/~/ ID клиента 1813 + "name": "" , ~/~/ имя ТС 1814 + "imei": "" , ~/~/ IMEI 1815 + "deviceTypeId": "" , ~/~/ ID типа устройства 1816 + "modelId": "" , ~/~/ ID модели 1817 + "unitId": "" , ~/~/ ID подразделения 1818 + "sim1": "" , ~/~/ Номер SIM 1 1819 + "sim2": "" , ~/~/ Номер SIM2 1820 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1821 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1822 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1823 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1824 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1825 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1826 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1827 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1828 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1829 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1830 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1831 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 462 462 1833 + "mileageCalcMethod": 0, 1834 + "mileageCoeff": 0, 1835 + "locationByCellId": true, 1836 + "dottedLineTrackWhenNoCoords": true, 1837 + "counters": ~/~/ счетчики 1838 + { 1839 + "mileage": "" , ~/~/ пробег 1840 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1841 + "motohours": "" , ~/~/ моточасы 1842 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1843 + }, 1844 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1845 + "enabled": true, ~/~/ флаг включения 1846 + "id": "" , ~/~/ идентификатор 1847 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1848 + "login": "" , ~/~/ имя учетной записи 1849 + "password": "" ~/~/ пароль учетной записи 1850 + }, 1851 + "inspectionTasks": ~/~/ задания на ТО 1852 + { 1853 + "enabled": "" , ~/~/ Признак включения 1854 + "name": "" , ~/~/ Имя задания 1855 + "description": "" , ~/~/ Описание задания 1856 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1857 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1858 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1859 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1860 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1861 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1862 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1863 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1864 + } 1865 + 1866 +"drivers": [ ~/~/ Водители 1867 + { 1868 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1869 + "isDefault": true 1870 + } 1871 + ], 1872 + "commandTemplates": [ ~/~/ Шаблон команды 1873 + { 1874 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1875 + "name": "string", 1876 + "command": "string", 1877 + "retries": 0 1878 + } 1879 + ], 1880 +"sensors": [ ~/~/ Датчики 1881 + { 1882 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1883 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1884 + "type": 0, ~/~/ Тип датчика 1885 + "name": "string", ~/~/ Имя датчика 1886 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1887 + "inputNumber": 0, ~/~/ Номер входа 1888 + "pseudonym": "string", ~/~/ Псевдоним 1889 + "medianDegree": 0, ~/~/ Медианная фильтрация 1890 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1891 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1892 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1893 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1894 + { 1895 + "grades": [ ~/~/ Таблица тарировки 1 1896 + { 1897 + "input": 0, ~/~/ Входящее значение 1898 + "output": 0 ~/~/ Выходящее значение 1899 + } 1900 + ], 1901 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1902 + } 1903 + ], 1904 + "showInTooltip": true, ~/~/ Отображать в подсказке 1905 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1906 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1907 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1908 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1909 + "expr": "string", ~/~/ Формула 1910 + "children": [ ~/~/ массив дочерних датчиков 1911 + "string" 1912 + ], 1913 + "customParams": { ~/~/ прочие произвольные параметры 1914 + "additionalProp1": "string", 1915 + "additionalProp2": "string", 1916 + "additionalProp3": "string" 1917 + }, 1918 +~/~/ Характерные для произвольного: 1919 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1920 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1921 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1922 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1923 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1924 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1925 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1926 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1927 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1928 +~/~/ "ValueOn": "Вкл.", 1929 +~/~/ "ValueOff": "Выкл." 1930 + "summaryMaxValue": 0 ~/~/ Макс. значение 1931 + 1932 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1933 + { 1934 + "from": 0, ~/~/ С какого значения 1935 + "color": "string", ~/~/ Каким цветом 1936 + "text": "string" ~/~/ Текст подписи к этому интервалу 1937 + } 1938 + ] 1939 + } 1940 + ], 1941 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1942 + 1943 + "customFields": [ ~/~/ Произвольные поля 1944 + { 1945 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1946 + "name": "string", ~/~/ Наименование произвольного поля 1947 + "value": "string", ~/~/ Значение произвольного поля 1948 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1949 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1950 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1951 + } 1952 + ] 1953 +} 1954 + 1955 + 463 463 (% style="color:#000000" %)Ответ: 464 464 465 -(% lang="en-US" style="text-align:left" %) 466 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 1958 +((( 1959 +{ 1960 + "vehicleId": 0, ~/~/ ID ТС 1961 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1962 + "name": "string", ~/~/ Имя объекта 1963 + "imei": "string", ~/~/ IMEI 1964 + "deviceTypeId": 0, ~/~/ ID типа устройства 1965 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1966 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1967 + "sim1": "string", ~/~/ SIM1 1968 + "sim2": "string", ~/~/ SIM2 1969 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1970 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1971 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1972 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1973 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1974 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1975 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1976 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1977 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1978 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1979 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1980 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1981 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1982 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1983 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1984 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1985 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1986 + "counters": { ~/~/ состояний счётчиков 1987 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1988 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1989 + "mileage": 0, ~/~/ Пробег 1990 + "motohours": 0 ~/~/ Моточасы 1991 + }, 1992 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1993 + "id": "string", ~/~/ CMSV6 Идентификатор 1994 + "enabled": true, ~/~/ Признак включения 1995 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1996 +))) 467 467 468 468 469 -(% class="box successmessage" %) 470 470 ((( 471 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles** 2000 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2001 + "login": "string", ~/~/ CMSV6 имя учетной записи 2002 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2003 + }, 2004 + "inspectionTasks": [ ~/~/ Задания на ТО 2005 + { 2006 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2007 + "enabled": true, ~/~/ Признак включения 2008 + "name": "string", ~/~/ Имя задания 2009 + "description": "string", ~/~/ Описание задания 2010 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2011 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2012 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2013 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2014 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2015 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2016 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2017 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2018 + } 2019 + ], 2020 + "drivers": [ ~/~/ Список водителей 2021 + { 2022 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2023 + "inputNumber": 0, ~/~/ № входа. 2024 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2025 + "comment": "string", ~/~/ Комментарий. 2026 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2027 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2028 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2029 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2030 + } 2031 + ], 2032 + "commandTemplates": [ ~/~/ Список шаблонов команд 2033 + { 2034 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2035 + "name": "string", ~/~/ Название шаблона команд 2036 + "command": "string", ~/~/ Команда на выполнение 2037 + "retries": 0 ~/~/ Лимит попыток отправки 2038 + } 2039 + ], 2040 + "sensors": [ ~/~/ Список датчиков 2041 + { 2042 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2043 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2044 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 472 472 ))) 473 473 474 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 2047 +((( 2048 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2049 +))) 475 475 476 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 2051 +((( 2052 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2053 +))) 477 477 478 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 2055 +((( 2056 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2057 +))) 479 479 480 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 2059 +((( 2060 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2061 +))) 481 481 482 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 2063 +((( 2064 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2065 + "name": "string", ~/~/ Имя датчика 2066 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2067 +))) 483 483 484 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 2069 +((( 2070 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2071 + "inputNumber": 0, ~/~/ Номер входа 2072 + "pseudonym": "string", ~/~/ Псевдоним 2073 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2074 + "isInverted": true, ~/~/ Признак инверсии 2075 + "disabled": true, ~/~/ Датчик не участвует в обработке 2076 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2077 + "gradesTables": [ ~/~/ Тарировка 2078 + { 2079 + "grades": [ ~/~/ Таблицы тарировки 2080 + { 2081 + "input": 0, ~/~/ Вход 2082 + "output": 0 ~/~/ Выход 2083 + } 2084 + ], 2085 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 2086 + } 2087 + ], 2088 + "showInTooltip": true, ~/~/ Отображение в подсказке 2089 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 2090 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2091 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2092 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2093 + "expr": "string", ~/~/ Выражение 2094 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2095 + "string" 2096 + ], 2097 + "customParams": { ~/~/ Дополнительные настройки 2098 + "additionalProp1": "string", 2099 + "additionalProp2": "string", 2100 + "additionalProp3": "string" 2101 + }, 2102 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2103 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2104 + { 2105 + "from": 0, ~/~/ С какого значения 2106 + "color": "string", ~/~/ Каким цветом 2107 + "text": "string" ~/~/ Текст подписи к этому интервалу 2108 + } 2109 + ] 2110 + } 2111 + ], 2112 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2113 + "customFields": [ ~/~/ Список произвольных полей 2114 + { 2115 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2116 + "name": "string", ~/~/ Наименование произвольного поля 2117 + "value": "string", ~/~/ Значение произвольного поля 2118 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2119 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2120 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2121 + } 2122 + ], 2123 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2124 +} 2125 +))) 485 485 486 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 2127 +**Валидация:** 2128 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 2129 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 2130 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 487 487 488 -(% style="color:#000000" %) Методзапроса:**POST**2132 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 489 489 490 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 2134 +(% class="box errormessage" %) 2135 +((( 2136 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 2137 +))) 491 491 492 -(% style="color:#000000" %) Взаголовкахзапроса:2139 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 493 493 494 -(% style="color:#000000" %) −Content-Type:application/json2141 +(% style="color:#000000" %)Метод запроса: **DELETE** 495 495 496 -(% style="color:#000000" %) −X-Auth:Токен авторизации2143 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 497 497 498 -(% style="color:#000000" %) Условия фильтрации объектовзадаются в теле запроса.Параметрывтелезапроса(JSON):2145 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 499 499 500 -(% class="western" style="color:#000000" %)##{"vehicleId":null,~/~/84350, ~/~/ ID ТС (int, опционально)"name":null, ~/~/ Имя ТС (string,опционально) "imei": null,~/~/"710179307",##2147 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 501 501 502 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 2149 +(% style="text-align:left" %) 2150 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 503 503 504 -(% class="western" style="color:#000000" %)##~/~/ ID типаустройстваshort, опционально)"parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##2152 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 505 505 506 -(% class="western" style="color:#000000"%)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed"~/~/ ID подразделения(Guid, опционально)##(%style="color:#000000"%)}2154 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 507 507 508 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 2156 +(% class="box infomessage" %) 2157 +((( 2158 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 2159 +))) 509 509 510 -(% style="color:#000000" %) Ответ: [ { «vehicleId»: «», //идентификаторобъекта «name»: «», // наименованиеобъекта«imei»: «», // IMEIобъекта«deviceTypeId»: «», //идентификатортипаустройства«deviceTypeName»: «», // наименованиетипа устройства«sim1»: «», // первый номертелефона«sim2»: «», //второй номертелефона«parentId»: «», //идентификаторклиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатормоделиобъекта «modelName»: «», //наименованиемодели объекта «unitId»: «»,//идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статусобъекта//«//createdAt//»: «» дата созданияобъектов //}, … ]2161 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 511 511 512 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатсяв ответе при наличии у авторизованногопользователя права **«Просмотр номеров телефонов объектов»**. Параметр«status» содержится в ответе при наличии у авторизованного пользователя права**«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:2163 +(% style="color:#000000" %)Метод запроса: **GET** 513 513 514 -(% style="color:#000000" %) 0 - «Блокировка»2165 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 515 515 516 -(% style="color:#000000" %) 1-«Активен»,2167 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 517 517 518 -(% style="color:#000000" %) 2 - «Отменен»2169 +(% style="color:#000000" %)Ответ: 519 519 520 -(% style="color:#000000" %)3 - «Оборудован» 2171 +(% style="color:#000000" %){(%%) 2172 + "deviceTypeId" : "", ~/~/ ID типа устройства 2173 + "deviceTypeName" : "" ~/~/ Название типа устройства 2174 +(% style="color:#000000" %)} 521 521 522 -(% style="color:#000000" %) 4- «Диагностика»2176 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 523 523 524 -(% style="color:#000000" %) 5-«Сервис»2178 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 525 525 526 -(% style="color:#000000" %)6 - «Демонтаж» 2180 +(% class="box infomessage" %) 2181 +((( 2182 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 2183 +))) 527 527 528 -(% style="color:#000000" %) 7-«Монтаж»2185 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 529 529 530 -(% style="color:#000000" %) 8 - «Дозаказ»2187 +(% style="color:#000000" %)Метод запроса: **GET** 531 531 532 -(% style="color:#000000" %) 9 - «Обслужен»2189 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 533 533 534 -(% style="color:#000000" %) 10-«Списан»2191 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 535 535 536 -(% style="color:#000000" %) 11 - «Неисправен»2193 +(% style="color:#000000" %)Ответ: 537 537 538 -(% style="color:#000000" %)12 - «Проверен» 2195 +(% style="color:#000000" %){(%%) 2196 + "id": "", ~/~/ ID типа датчика 2197 + "name": "", ~/~/ Название 2198 + "description": "", ~/~/ Описание 2199 +(% style="color:#000000" %)} 539 539 2201 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 2202 + 2203 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 2204 + 2205 +(% class="box infomessage" style="text-align: left;" %) 2206 +((( 2207 +**POST /api/v3/terminalMessages/count** 2208 +))) 2209 + 2210 +(% style="text-align: left;" %) 2211 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 2212 + 2213 +(% style="text-align: left;" %) 2214 +Метод запроса **POST** 2215 + 2216 +(% style="text-align: left;" %) 2217 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 2218 + 2219 +(% style="text-align: left;" %) 2220 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2221 + 2222 +(% style="text-align: left;" %) 2223 +{ 2224 + "vehicleIds": [ 2225 + id ~/~/ здесь передается список идентификаторов объектов 2226 + ], 2227 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 2228 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 2229 +} 2230 + 2231 +(% style="text-align: left;" %) 2232 +Ответ: 2233 + 2234 +(% style="text-align: left;" %) 2235 +[ 2236 + { 2237 + "vehicleId": 0, ~/~/ идентификатор объекта 2238 + "count": 0 ~/~/ количество сообщений за период 2239 + } 2240 +] 2241 + 2242 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2243 + 2244 +(% class="box infomessage" style="text-align: left;" %) 2245 +((( 2246 +**POST /api/v3/terminalMessages/mapping** 2247 +))) 2248 + 2249 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2250 + 2251 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2252 + 2253 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2254 + 2255 +{ 2256 + "protocolType": 0, 2257 + "params": ["string"] 2258 +} 2259 + 2260 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2261 +|protocolType|ID типа протокола 2262 +|params|((( 2263 +Массив наименований параметров в сообщении 2264 +))) 2265 + 2266 +Ответ: 2267 + 2268 +{ 2269 + "protocolType": 0, 2270 + "mapping": { 2271 + "additionalProp1": { 2272 + "inputType": 0, 2273 + "inputNumber": 0 2274 + }, 2275 + "additionalProp2": { 2276 + "inputType": 0, 2277 + "inputNumber": 0 2278 + } 2279 + } 2280 +} 2281 + 2282 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2283 +|protocolType|Тип протокола 2284 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2285 +|inputNumber|((( 2286 +Номер входа 2287 +))) 2288 + 2289 +(% class="wikigeneratedid" %) 2290 +Перечень 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/]] 2291 + 2292 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 2293 + 2294 +(% class="box infomessage" %) 2295 +((( 2296 +**POST /api/v3/terminalMessages** 2297 +))) 2298 + 2299 +Метод возвращает список сообщений терминала объекта за выбранный период. 2300 + 2301 +(% style="text-align: left;" %) 2302 +Метод запроса **POST** 2303 + 2304 +(% style="text-align: left;" %) 2305 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2306 + 2307 +(% style="text-align: left;" %) 2308 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2309 + 2310 +{ 2311 + "vehicleId": 0, ~/~/ id объекта 2312 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 2313 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 2314 +} 2315 + 2316 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2317 +|vehicleId|ID объекта 2318 +|from|Дата и время начала периода запроса 2319 +|to|Дата и время окончания периода запроса 2320 + 2321 +Ответ: 2322 + 2323 +[ 2324 + { 2325 + "messages": [ 2326 + { 2327 + "deviceTime": "2023-11-29T07:40:44.052Z", 2328 + "serverTime": "2023-11-29T07:40:44.052Z", 2329 + "speed": 0, 2330 + "altitude": 0, 2331 + "latitude": 0, 2332 + "longitude": 0, 2333 + "satellites": 0, 2334 + "course": 0, 2335 + "voltage": 0, 2336 + "parameters": { 2337 + "additionalProp1": "string", 2338 + "additionalProp2": "string", 2339 + "additionalProp3": "string" 2340 + }, 2341 + "photoCount": 0, 2342 + "lbsCorrectedCoords": true, 2343 + "protocolType": 0 2344 + } 2345 + ] 2346 + } 2347 +] 2348 + 2349 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2350 +|deviceTime|Время сообщения терминала 2351 +|serverTime|Время когда сообщение поступило на сервер 2352 +|speed|Скорость 2353 +|altitude|Высота над уровнем моря 2354 +|latitude|Широта 2355 +|longitude|Долгота 2356 +|satellites|Кол-во спутников 2357 +|course|Курс 2358 +|voltage|Бортовое напряжение 2359 +|parameters|Список параметров и их значений 2360 +|photoCount|Количество фото 2361 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2362 +|protocolType|ID типа протокола 2363 + 2364 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2365 + 2366 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2367 + 2368 +(% class="box infomessage" %) 2369 +((( 2370 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2371 +))) 2372 + 2373 +(% style="color:#000000" %)Метод запроса: **POST** 2374 + 2375 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2376 + 2377 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2378 + 540 540 (% style="text-align:left" %) 541 - (% style="color:#000000; font-weight:normal" %)13 - «Неэксплуатируется»2380 +Тело запроса: 542 542 2382 +{ 2383 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2384 + "vehicleIds": [0], ~/~/ Список ID объектов 2385 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2386 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2387 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2388 +} 543 543 544 -(% class="box successmessage" %) 2390 +Ответ: 2391 + 2392 +[ 2393 + { 2394 + "vehicleId": 0, ~/~/ ID объекта 2395 + "name": "string", ~/~/ Имя ТС 2396 + "periods": [ ~/~/ Периоды 2397 + { 2398 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2399 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2400 + "mileage": 0, ~/~/ Пробег за период, километры 2401 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2402 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2403 + "motohours": 0, ~/~/ Моточасы за период, секунды 2404 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2405 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2406 + } 2407 + ] 2408 + } 2409 +] 2410 + 2411 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2412 + 2413 +(% class="box infomessage" %) 545 545 ((( 546 -(% style="color:#000000; line-height:100%" %)** Изменениестатуса объекта —**(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**2415 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 547 547 ))) 548 548 549 -(% style="color:#000000" %) позволяет изменить статус объекта. Методпозволяет изменить статус объекта, указанного в запросе (обязательныйпараметр в заголовках запроса - токен авторизации**«X-Auth»**).2418 +(% style="color:#000000" %)Метод запроса: **POST** 550 550 2420 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2421 + 2422 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2423 + 2424 +(% style="text-align:left" %) 2425 +Тело запроса: 2426 + 2427 +{ 2428 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2429 + "vehicleIds": [0], ~/~/ Список ID объектов 2430 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2431 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2432 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2433 +} 2434 + 2435 +Ответ: 2436 + 2437 +[ 2438 + { 2439 + "vehicleId": 0, ~/~/ ID объекта 2440 + "name": "string", ~/~/ Имя ТС 2441 + "periods": [ ~/~/ Периоды 2442 + { 2443 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2444 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2445 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2446 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2447 + "fuelConsumption": 0, ~/~/ Расход топлива 2448 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2449 + } 2450 + ] 2451 + } 2452 +] 2453 + 2454 +(% class="box warningmessage" %) 2455 +((( 2456 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2457 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2458 +))) 2459 + 2460 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2461 + 2462 +(% class="box infomessage" %) 2463 +((( 2464 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2465 +))) 2466 + 551 551 (% style="color:#000000" %)Метод запроса: **POST** 552 552 553 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}2469 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 554 554 555 -(% style="color:#000000" %) Параметрзапроса:{vehicleId}- IDТС2471 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 556 556 2473 +(% style="text-align:left" %) 2474 +Тело запроса: 2475 + 2476 +{ 2477 + "vehicleIds": [0], ~/~/ Список ID объектов 2478 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2479 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2480 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2481 +} 2482 + 2483 +Ответ: 2484 + 2485 +[ 2486 + { 2487 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2488 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2489 + "vehicleId": 0, ~/~/ ID объекта 2490 + "name": "string", ~/~/ Имя объекта 2491 + "model": "string", ~/~/ Модель объекта 2492 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2493 + { 2494 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2495 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2496 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2497 + "valueFuel": 0, ~/~/ Количество 2498 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2499 + "fuelEnd": 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/moveStop** 2511 +))) 2512 + 2513 +Метод запроса: **POST** 2514 + 2515 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2516 + 2517 +В заголовках запроса: X-Auth: Токен авторизации 2518 + 2519 + 2520 +Тело запроса: 2521 + 2522 +{ 2523 + "vehicleIds": [ ], ~/~/ Список ID объектов 2524 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2525 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2526 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2527 +} 2528 + 2529 +Ответ: 2530 + 2531 +[ 2532 + { 2533 + "vehicleId": 0, ~/~/ ID объекта 2534 + "vehicleName": "string", ~/~/ Имя объекта 2535 + "moves": [ ~/~/ Событие движения 2536 + { 2537 + "mileage": 0, ~/~/ Пробег, км 2538 + "eventId": 0, ~/~/ Идентификатор события 2539 + "eventName": "string", ~/~/ Название события 2540 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2541 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2542 + "duration": 0 ~/~/ Продолжительность события, секунд 2543 + } 2544 + ], 2545 + "stops": [ ~/~/ События стоянок 2546 + { 2547 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2548 + "eventId": 0, ~/~/ Идентификатор события 2549 + "eventName": "string", ~/~/ Название события 2550 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2551 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2552 + "duration": 0 ~/~/ Продолжительность события, секунд 2553 + } 2554 + ] 2555 + } 2556 +] 2557 + 2558 + 2559 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2560 + 2561 +(% class="box infomessage" %) 2562 +((( 2563 +**POST /api/v3/vehicles/getlastdata** 2564 +))) 2565 + 2566 +Метод запроса: **POST** 2567 + 2568 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2569 + 2570 +В заголовках запроса: X-Auth: Токен авторизации 2571 + 2572 + 2573 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2574 + 2575 +Ответ: 2576 + { 2577 + "vehicleId": 0, ~/~/Идентификатор объекта. 2578 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2579 + "vehicleNumber": "string",~/~/Номер объекта. 2580 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2581 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2582 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2583 + "speed": 0,~/~/Скорость объекта. 2584 + "course": 0,~/~/Курс движения [0;360] 2585 + "latitude": 0,~/~/Широта [-90°;90°]. 2586 + "longitude": 0,~/~/Долгота [-180°;180°]. 2587 + "address": "string",~/~/Адрес. 2588 + "geozones": [ ~/~/Сведения по геозонам. 2589 + { 2590 + "id": 0, 2591 + "name": "string" 2592 + } 2593 + 2594 + 2595 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2596 + 2597 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2598 + 2599 +(% class="box infomessage" %) 2600 +((( 2601 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2602 +))) 2603 + 2604 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2605 + 2606 +(% style="color:#000000" %)Метод запроса: **POST** 2607 + 2608 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2609 + 557 557 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 558 558 559 -(% style="color:#000000" %)Параметры в теле запроса (JSON): { 2612 +(% style="text-align:left" %) 2613 +Тело запроса: 560 560 561 -(% class="western" %) 562 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 563 - "date": "", // Дата смены статуса (null если сменить немедленно) 564 - "description": "", // Описание 565 - "data": "", // Данные 566 - "overwrite": false, // Флаг перезаписи 567 - "stage": "", // Состояние, может быть null}}} 2615 +(% style="text-align:left" %) 2616 +{ 2617 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2618 +} 568 568 569 -(% style="color:#000000" %)} 2620 +(% style="text-align:left" %) 2621 +Ответ: 570 570 571 -(% style="color:#000000" %)Ответ: { 2623 +[ 2624 + { 2625 + "id": 0, ~/~/ Идентификатор объекта геозоны 2626 + "name": "string", ~/~/ Название объекта геозоны 2627 + "type": 0, ~/~/ Тип объекта геозоны 2628 + "fname": "string", ~/~/ Имя файла 2629 + "parentId": "string", ~/~/ Идентификатор клиента 2630 + "radius": 0, ~/~/ Радиус геообъекта 2631 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2632 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2633 + "description": "string", ~/~/ Описание 2634 + "area": 0, ~/~/ Площадь, м^^2^^ 2635 + "perimetr": 0, ~/~/ Периметр, м 2636 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2637 + } 2638 +] 572 572 573 -(% class="western" %) 574 -{{{ "status": "", // значение статуса 575 - "date": "", // Дата смены статуса 576 - "description": "", // Описание 577 - "data": "", // Данные 578 - "overwrite": false, // Флаг перезаписи 579 - "stage": "", // Состояние}}} 2640 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 580 580 2642 +(% class="box infomessage" %) 2643 +((( 2644 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2645 +))) 2646 + 2647 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2648 + 2649 +(% style="color:#000000" %)Метод запроса: **POST** 2650 + 2651 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2652 + 2653 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2654 + 581 581 (% style="text-align:left" %) 2656 +Тело запроса: 2657 + 2658 +{ 2659 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2660 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2661 + "ids": [ ], ~/~/ Массив id объектов 2662 + "byTime": 0, ~/~/ Объединение событий по времени 2663 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2664 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2665 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2666 +} 2667 + 2668 +Ответ: 2669 +[ 2670 + { 2671 + "geozoneId": 0, ~/~/ ID геообъекта 2672 + "geozoneName": "string", ~/~/ Название геообъекта 2673 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2674 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2675 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2676 + "vehicleId": 0, ~/~/ ID объекта 2677 + "vehicleName": "string" ~/~/ Имя объекта 2678 + } 2679 +] 2680 + 2681 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2682 + 2683 +(% class="box infomessage" %) 2684 +((( 2685 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2686 +))) 2687 + 2688 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2689 + 2690 +(% style="color:#000000" %)Метод запроса: **POST** 2691 + 2692 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2693 + 2694 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2695 + 2696 +(% style="text-align:left" %) 2697 +Тело запроса: 2698 + 2699 +{ 2700 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2701 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2702 + "ids": [ ], ~/~/ Массив id геообъектов 2703 + "byTime": 0, ~/~/ Объединение событий по времени 2704 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2705 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2706 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2707 +} 2708 + 2709 +Ответ: 2710 + 2711 +[ 2712 + { 2713 + "geozoneId": 0, ~/~/ ID геообъекта 2714 + "geozoneName": "string", ~/~/ Название геообъекта 2715 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2716 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2717 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2718 + "vehicleId": 0, ~/~/ ID объекта 2719 + "vehicleName": "string" ~/~/ Имя объекта 2720 + } 2721 +] 2722 + 2723 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2724 + 2725 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2726 + 2727 +(% class="box infomessage" %) 2728 +((( 2729 +**POST /api/v3/notifications/find** 2730 +))) 2731 + 2732 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2733 + 2734 +(% style="text-align: left;" %) 2735 +Метод запроса **POST** 2736 + 2737 +(% style="text-align: left;" %) 2738 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2739 + 2740 +(% style="text-align: left;" %) 2741 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2742 + 2743 +{ 2744 + "parentId": "" ~/~/ id клиента 2745 +} 2746 + 2747 +Ответ: 2748 + 2749 +[ 2750 + { 2751 + "id": 0, ~/~/ ID уведомления 2752 + "name": "string", ~/~/ Название уведомления 2753 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2754 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2755 + "userId": "", ~/~/ Пользователь, создавший уведомление 2756 + "parentId": "", ~/~/ Идентификатор клиента 2757 + "parentName": "string" ~/~/ Имя клиента 2758 + } 2759 +] 2760 + 2761 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2762 + 2763 +(% class="box infomessage" %) 2764 +((( 2765 +**GET /api/v3/notifications/{id}** 2766 +))) 2767 + 2768 +Метод возвращает данные правил формирования выбранного уведомления. 2769 + 2770 +(% style="text-align: left;" %) 2771 +Метод запроса **GET** 2772 + 2773 +(% style="text-align: left;" %) 2774 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2775 + 2776 +(% style="text-align: left;" %) 2777 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2778 + 2779 +(% style="text-align: left;" %) 2780 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2781 + 2782 +(% style="text-align: left;" %) 2783 +(% style="color:#000000" %)Ответ: 2784 + 2785 +(% style="text-align: left;" %) 2786 +(% style="color:#000000" %){ 2787 + "id": 0, ~/~/ (%%)id уведомления 2788 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2789 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2790 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2791 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2792 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2793 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2794 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2795 +(% style="color:#000000" %) 0 2796 + ], 2797 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2798 +(% style="color:#000000" %) 0 2799 + ], 2800 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2801 +(% style="color:#000000" %) 0 2802 + ], 2803 + "settings": { ~/~/ Список параметров уведомления 2804 + "additionalProp1": "string", 2805 + "additionalProp2": "string", 2806 + "additionalProp3": "string" 2807 + }, 2808 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2809 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2810 +(% style="color:#000000" %) "" 2811 + ], 2812 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2813 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2814 +(% style="color:#000000" %) "string" 2815 + ], 2816 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2817 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2818 +(% style="color:#000000" %) { 2819 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2820 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2821 +(% style="color:#000000" %) } 2822 + ], 2823 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2824 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2825 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2826 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2827 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2828 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2829 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2830 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2831 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 582 582 (% style="color:#000000" %)} 583 583 2834 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 584 584 2836 +(% class="box warningmessage" %) 2837 +((( 2838 +**PUT /api/v3/notifications/** 2839 +))) 2840 + 2841 +Метод позволяет отредактировать уведомление. 2842 + 2843 +Метод запроса **PUT** 2844 + 2845 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2846 + 2847 +В заголовках запроса: X-Auth: Токен авторизации 2848 + 2849 +Тело запроса: 2850 +{ 2851 + "id": 0, ~/~/ id уведомления 2852 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2853 + "userId": "", ~/~/ Пользователь, создавший уведомление 2854 + "parentId": "", ~/~/ Идентификатор клиента 2855 + "parentName": "string", ~/~/ Имя клиента 2856 + "name": "string", ~/~/ Название уведомления 2857 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2858 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2859 + 0 2860 + ], 2861 + "geoids": [ ~/~/ Список id геообъектов для анализа 2862 + 0 2863 + ], 2864 + "fieldids": [ ~/~/ Список id полей для анализа 2865 + 0 2866 + ], 2867 + "settings": { ~/~/ Список параметров уведомления 2868 + "additionalProp1": "string", 2869 + "additionalProp2": "string", 2870 + "additionalProp3": "string" 2871 + }, 2872 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2873 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2874 + "" 2875 + ], 2876 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2877 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2878 + "string" 2879 + ], 2880 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2881 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2882 + { 2883 + "id": 0, ~/~/ Идентификатор участника чата 2884 + "info": "string" ~/~/ Дополнительные сведения 2885 + } 2886 + ], 2887 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2888 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2889 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2890 + "kind": 0, ~/~/ Определяет вид уведомления 2891 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2892 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2893 + "timezone": 0, ~/~/ Сдвиг часового пояса 2894 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2895 + "autoProlongation": true ~/~/ Автопродление срока действия 2896 +} 2897 + 2898 +Ответ: 2899 + 2900 +Success 2901 + 2902 + 2903 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2904 + 2905 +(% class="box warningmessage" %) 2906 +((( 2907 +**PUT** /api/v3/notifications/prolongation 2908 +))) 2909 + 2910 +Метод позволяет продлить уведомления. 2911 + 2912 +Метод запроса **PUT** 2913 + 2914 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2915 + 2916 +В заголовках запроса: X-Auth: Токен авторизации. 2917 + 2918 +Тело запроса: 2919 + 2920 +[ 2921 + 2922 +0 2923 + 2924 +] 2925 + 2926 +где 0 идентификатор ids. 2927 + 2928 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2929 + 2930 +(% class="box errormessage" %) 2931 +((( 2932 +**DELETE /api/v3/notifications/{id}** 2933 +))) 2934 + 2935 +Метод позволяет удалить выбранное уведомление. 2936 + 2937 +Метод запроса **DELETE** 2938 + 2939 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2940 + 2941 +Передаваемый параметр: {id} - id уведомления 2942 + 2943 +В заголовках запроса: X-Auth: Токен авторизации 2944 + 2945 +Ответ: 2946 + 2947 +Success 2948 + 2949 + 2950 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2951 + 2952 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2953 + 2954 +(% class="box infomessage" %) 2955 +((( 2956 +**POST /api/v3/Drivers/find** 2957 +))) 2958 + 2959 +Передается параметр: parentId - ID клиента-родителя 2960 + 2961 +Ответ: 2962 + 2963 +[ 2964 + { 2965 + "name": "string", ~/~/ Определяет наименование 2966 + "description": "string", ~/~/ Определяет описание 2967 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2968 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2969 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2970 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2971 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2972 + "deleted": true ~/~/ Признак удаления 2973 + } 2974 +] 2975 + 2976 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2977 + 2978 +(% class="box infomessage" %) 2979 +((( 2980 +**GET /api/v3/Drivers/{driverGuid}** 2981 +))) 2982 + 2983 +Передается параметр: ID водителя 2984 + 2985 +Ответ: 2986 + 2987 +{ 2988 + "name": "string", ~/~/ Определяет наименование 2989 + "description": "string", ~/~/ Определяет описание 2990 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2991 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2992 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2993 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2994 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2995 + "deleted": true ~/~/ Признак удаления 2996 +} 2997 + 2998 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2999 + 3000 +(% class="box successmessage" %) 3001 +((( 3002 +**POST /api/v3/Drivers** 3003 +))) 3004 + 3005 +Запрос: 3006 + 3007 +{ 3008 + "name": "string", 3009 + "description": "string", 3010 + "hiredate": "2023-06-30T12:50:54.020Z", 3011 + "chopdate": "2023-06-30T12:50:54.020Z", 3012 + "exclusive": true, 3013 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3014 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3015 + "deleted": true 3016 +} 3017 + 3018 +Ответ: 3019 + 3020 +{ 3021 + "name": "string", 3022 + "description": "string", 3023 + "hiredate": "2023-06-30T12:50:54.051Z", 3024 + "chopdate": "2023-06-30T12:50:54.051Z", 3025 + "exclusive": true, 3026 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3027 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3028 + "deleted": true 3029 +} 3030 + 3031 + 3032 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 3033 + 3034 +(% class="box warningmessage" %) 3035 +((( 3036 +**PUT /api/v3/Drivers** 3037 +))) 3038 + 3039 +Запрос: 3040 + 3041 +{ 3042 + "name": "string", 3043 + "description": "string", 3044 + "hiredate": "2023-06-30T12:50:27.910Z", 3045 + "chopdate": "2023-06-30T12:50:27.910Z", 3046 + "exclusive": true, 3047 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3048 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3049 + "deleted": true 3050 +} 3051 + 3052 +Ответ: 3053 + 3054 +{ 3055 + "name": "string", 3056 + "description": "string", 3057 + "hiredate": "2023-06-30T12:50:27.929Z", 3058 + "chopdate": "2023-06-30T12:50:27.929Z", 3059 + "exclusive": true, 3060 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3061 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3062 + "deleted": true 3063 +} 3064 + 3065 + 3066 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 3067 + 3068 +(% class="box errormessage" %) 3069 +((( 3070 +**DELETE /api/v3/Drivers/{driverGuid}** 3071 +))) 3072 + 3073 +Передается параметр: ID водителя 3074 + 3075 +Ответ: 3076 + 3077 +Success 3078 + 3079 + 3080 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 3081 + 3082 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 3083 + 3084 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 3085 + 3086 +(% class="box infomessage" %) 3087 +((( 3088 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3089 +))) 3090 + 3091 +Запрос: 3092 + 3093 +{ 3094 + "Ids": [ 3095 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3096 + ], 3097 + "BeginTime": "2023-06-30T12:49:04.365Z", 3098 + "EndTime": "2023-06-30T12:49:04.365Z" 3099 +} 3100 + 3101 +Ответ: 3102 + 3103 +[ 3104 + { 3105 + "VehicleId": 0, 3106 + "CreateTime": "2023-06-30T09:52:31.240Z", 3107 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3108 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3109 + "BeginTime": "2023-06-30T09:52:31.240Z", 3110 + "EndTime": "2023-06-30T09:52:31.240Z" 3111 + } 3112 +] 3113 + 3114 + 3115 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 3116 + 3117 +(% class="box infomessage" %) 3118 +((( 3119 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3120 +))) 3121 + 3122 +Запрос: 3123 + 3124 +{ 3125 + "Ids": [ 3126 + 0 3127 + ], 3128 + "BeginTime": "2023-06-30T12:48:39.419Z", 3129 + "EndTime": "2023-06-30T12:48:39.419Z" 3130 +} 3131 + 3132 +Ответ: 3133 + 3134 +[ 3135 + { 3136 + "VehicleId": 0, 3137 + "CreateTime": "2023-06-30T09:54:01.631Z", 3138 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3139 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3140 + "BeginTime": "2023-06-30T09:54:01.631Z", 3141 + "EndTime": "2023-06-30T09:54:01.631Z" 3142 + } 3143 +] 3144 + 3145 + 3146 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 3147 + 3148 +(% class="box successmessage" %) 3149 +((( 3150 +**POST /api/v3/DriversVehiclesAssignments** 3151 +))) 3152 + 3153 +Передается массив назначений 3154 + 3155 +Запрос: 3156 + 3157 +[ 3158 + { 3159 + "VehicleId": 0, ~/~/ Идентификатор объекта 3160 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3161 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3162 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3163 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 3164 + } 3165 +] 3166 + 3167 +Ответ: 3168 + 3169 +[ 3170 + { 3171 + "VehicleId": 0, 3172 + "CreateTime": "2023-06-30T11:04:46.903Z", 3173 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3174 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3175 + "BeginTime": "2023-06-30T11:04:46.903Z", 3176 + "EndTime": "2023-06-30T11:04:46.903Z" 3177 + } 3178 +] 3179 + 3180 + 3181 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 3182 + 3183 +(% class="box warningmessage" %) 3184 +((( 3185 +**PUT /api/v3/DriversVehiclesAssignments** 3186 +))) 3187 + 3188 +Запрос: 3189 + 3190 +[ 3191 + { 3192 + "VehicleId": 0, 3193 + "CreateTime": "2023-06-30T11:14:08.117Z", 3194 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3195 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3196 + "BeginTime": "2023-06-30T11:14:08.117Z", 3197 + "EndTime": "2023-06-30T11:14:08.117Z" 3198 + } 3199 +] 3200 + 3201 +Ответ: 3202 + 3203 +[ 3204 + { 3205 + "VehicleId": 0, 3206 + "CreateTime": "2023-06-30T11:14:53.349Z", 3207 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3208 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3209 + "BeginTime": "2023-06-30T11:14:53.349Z", 3210 + "EndTime": "2023-06-30T11:14:53.349Z" 3211 + } 3212 +] 3213 + 3214 + 3215 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 3216 + 3217 +(% class="box errormessage" %) 3218 +((( 3219 +**DELETE /api/v3/DriversVehiclesAssignments** 3220 +))) 3221 + 3222 +Запрос: 3223 + 3224 +[ 3225 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3226 +] 3227 + 3228 +Ответ: 3229 + 3230 +Success 3231 + 3232 + 3233 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 3234 + 3235 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 3236 + 3237 +(% class="box infomessage" %) 3238 +((( 3239 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3240 +))) 3241 + 3242 +Запрос: 3243 + 3244 +{ 3245 + "Ids": [ 3246 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3247 + ], 3248 + "BeginTime": "2023-06-30T12:47:12.162Z", 3249 + "EndTime": "2023-06-30T12:47:12.162Z" 3250 +} 3251 + 3252 +Ответ: 3253 + 3254 +[ 3255 + { 3256 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3257 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3258 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3259 + "BeginTime": "2023-06-30T11:19:40.703Z", 3260 + "EndTime": "2023-06-30T11:19:40.703Z" 3261 + } 3262 +] 3263 + 3264 + 3265 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3266 + 3267 +(% class="box infomessage" %) 3268 +((( 3269 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3270 +))) 3271 + 3272 +Запрос: 3273 + 3274 +{ 3275 + "Ids": [ 3276 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3277 + ], 3278 + "BeginTime": "2023-06-30T12:47:12.162Z", 3279 + "EndTime": "2023-06-30T12:47:12.162Z" 3280 +} 3281 + 3282 +Ответ: 3283 + 3284 +[ 3285 + { 3286 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3287 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3288 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3289 + "BeginTime": "2023-06-30T11:19:40.703Z", 3290 + "EndTime": "2023-06-30T11:19:40.703Z" 3291 + } 3292 +] 3293 + 3294 + 3295 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3296 + 3297 +(% class="box successmessage" %) 3298 +((( 3299 +**POST /api/v3/DriversRfidsAssignments** 3300 +))) 3301 + 3302 +Запрос: 3303 + 3304 +[ 3305 + { 3306 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3307 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3308 + "BeginTime": "2023-06-30T11:27:08.635Z", 3309 + "EndTime": "2023-06-30T11:27:08.635Z" 3310 + } 3311 +] 3312 + 3313 +Ответ: 3314 + 3315 +[ 3316 + { 3317 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3318 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3319 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3320 + "BeginTime": "2023-06-30T11:27:08.677Z", 3321 + "EndTime": "2023-06-30T11:27:08.677Z" 3322 + } 3323 +] 3324 + 3325 + 3326 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3327 + 3328 +(% class="box warningmessage" %) 3329 +((( 3330 +**PUT /api/v3/DriversRfidsAssignments** 3331 +))) 3332 + 3333 +Запрос: 3334 + 3335 +[ 3336 + { 3337 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3338 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3339 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3340 + "BeginTime": "2023-06-30T11:28:43.330Z", 3341 + "EndTime": "2023-06-30T11:28:43.330Z" 3342 + } 3343 +] 3344 + 3345 +Ответ: 3346 + 3347 +[ 3348 + { 3349 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3350 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3351 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3352 + "BeginTime": "2023-06-30T11:28:43.331Z", 3353 + "EndTime": "2023-06-30T11:28:43.331Z" 3354 + } 3355 +] 3356 + 3357 + 3358 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3359 + 3360 +(% class="box errormessage" %) 3361 +((( 3362 +**DELETE /api/v3/DriversRfidsAssignments** 3363 +))) 3364 + 3365 +Запрос: 3366 + 3367 +[ 3368 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3369 +] 3370 + 3371 +Ответ: 3372 + 3373 +Success 3374 + 3375 + 3376 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3377 + 3378 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3379 + 3380 +(% class="box infomessage" %) 3381 +((( 3382 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3383 +))) 3384 + 3385 +Запрос: 3386 + 3387 +{ 3388 + "Ids": [ 3389 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3390 + ], 3391 + "BeginTime": "2023-06-30T12:45:10.852Z", 3392 + "EndTime": "2023-06-30T12:45:10.852Z" 3393 +} 3394 + 3395 +Ответ: 3396 + 3397 +[ 3398 + { 3399 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3400 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3401 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3402 + "BeginTime": "2023-06-30T11:58:04.695Z", 3403 + "EndTime": "2023-06-30T11:58:04.695Z" 3404 + } 3405 +] 3406 + 3407 + 3408 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3409 + 3410 +(% class="box infomessage" %) 3411 +((( 3412 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3413 +))) 3414 + 3415 +Запрос: 3416 + 3417 +{ 3418 + "Ids": [ 3419 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3420 + ], 3421 + "BeginTime": "2023-06-30T12:45:10.852Z", 3422 + "EndTime": "2023-06-30T12:45:10.852Z" 3423 +} 3424 + 3425 +Ответ: 3426 + 3427 +[ 3428 + { 3429 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3430 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3431 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3432 + "BeginTime": "2023-06-30T11:58:04.695Z", 3433 + "EndTime": "2023-06-30T11:58:04.695Z" 3434 + } 3435 +] 3436 + 3437 + 3438 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3439 + 3440 +(% class="box successmessage" %) 3441 +((( 3442 +**POST /api/v3/DriversFuelCardsAssignments** 3443 +))) 3444 + 3445 +Запрос: 3446 + 3447 +[ 3448 + { 3449 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3450 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3451 + "BeginTime": "2023-06-30T12:09:53.175Z", 3452 + "EndTime": "2023-06-30T12:09:53.175Z" 3453 + } 3454 +] 3455 + 3456 +Ответ: 3457 + 3458 +[ 3459 + { 3460 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3461 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3462 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3463 + "BeginTime": "2023-06-30T12:09:53.201Z", 3464 + "EndTime": "2023-06-30T12:09:53.201Z" 3465 + } 3466 +] 3467 + 3468 + 3469 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3470 + 3471 +(% class="box warningmessage" %) 3472 +((( 3473 +**PUT /api/v3/DriversFuelCardsAssignments** 3474 +))) 3475 + 3476 +Запрос: 3477 + 3478 +[ 3479 + { 3480 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3481 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3482 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3483 + "BeginTime": "2023-06-30T12:09:53.201Z", 3484 + "EndTime": "2023-06-30T12:09:53.201Z" 3485 + } 3486 +] 3487 + 3488 +Ответ: 3489 + 3490 +[ 3491 + { 3492 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3493 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3494 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3495 + "BeginTime": "2023-06-30T12:09:53.201Z", 3496 + "EndTime": "2023-06-30T12:09:53.201Z" 3497 + } 3498 +] 3499 + 3500 + 3501 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3502 + 3503 +(% class="box errormessage" %) 3504 +((( 3505 +**DELETE /api/v3/DriversFuelCardsAssignments** 3506 +))) 3507 + 3508 +Запрос: 3509 + 3510 +[ 3511 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3512 +] 3513 + 3514 +Ответ: 3515 + 3516 +Success 3517 + 3518 + 3519 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3520 + 3521 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3522 + 3523 +(% class="box infomessage" %) 3524 +((( 3525 +**POST /api/v3/Trailers** 3526 +))) 3527 + 3528 +Пример запроса: 3529 + 3530 +{ 3531 + "startDate": "2023-11-14T10:48:03.671Z", 3532 + "endDate": "2023-11-14T10:48:03.671Z", 3533 + "ids": [ 0 ], 3534 + "timezone": 0 3535 +} 3536 + 3537 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3538 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3539 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3540 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3541 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3542 + 3543 +Пример ответа: 3544 + 3545 +[ 3546 + { 3547 + "SD": "2023-11-14T10:48:03.717Z", 3548 + "ED": "2023-11-14T10:48:03.717Z", 3549 + "id": 0, 3550 + "SLat": 0, 3551 + "SLon": 0, 3552 + "ELat": 0, 3553 + "ELon": 0, 3554 + "mileage": 0 3555 + "Duration": 0 3556 + "Address": "string", 3557 + "Address2": "string", 3558 + "name": "string", 3559 + "rid": "string", 3560 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3561 + "trailer": { 3562 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3563 + "Number": "string", 3564 + "Description": "string", 3565 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3566 + "ExternalID": "string", 3567 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3568 + "CreateTime": "2023-11-14T10:48:03.717Z", 3569 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3570 + "IsDeleted": true 3571 + }, 3572 + "filesCount": 0, 3573 + } 3574 +] 3575 + 3576 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3577 +|SD|Дата и время начала события 3578 +|ED|Дата и время окончания события 3579 +|id|ID объекта 3580 +|SLat|Широта начальной координаты 3581 +|SLon|Долгота начальной координаты 3582 +|ELat|Широта конечной координаты 3583 +|ELon|Долгота конечной координаты 3584 +|mileage|Пробег 3585 +|Duration|Продолжительность 3586 +|Address|Адрес начального местоположения 3587 +|Address2|Адрес конечного местоположения 3588 +|name|Имя радиометки 3589 +|rid|Номер радиометки 3590 +|rguid|ID радиометки 3591 +|trailer|Информация об агрегате 3592 +|ModelGuid|ID агрегата 3593 +|Number|Название/номер агрегата 3594 +|Description|Текст примечания агрегата 3595 + 3596 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3597 + 3598 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3599 + 3600 +(% class="box infomessage" %) 3601 +((( 3602 +**POST /api/v3/Rfids/find** 3603 +))) 3604 + 3605 +Запрос: 3606 + 3607 +{ 3608 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3609 +} 3610 + 3611 +Ответ: 3612 + 3613 +[ 3614 + { 3615 + "name": "string", 3616 + "number": 0, 3617 + "period": 0, 3618 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3619 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3620 + } 3621 +] 3622 + 3623 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3624 +|parentId|ID клиента 3625 +|name|Название карты-метки 3626 +|number|Номер 3627 +|period|Период запросов в секундах (работает только для агрегатов) 3628 +|id|ID карты-метки 3629 + 3630 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3631 + 3632 +(% class="box infomessage" %) 3633 +((( 3634 +**GET /api/v3/Rfids/{rfidGuid}** 3635 +))) 3636 + 3637 +Передаем параметр rfidGuid - идентификатор карты-метки 3638 + 3639 +Ответ: 3640 + 3641 +[ 3642 + { 3643 + "name": "string", 3644 + "number": 0, 3645 + "period": 0, 3646 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3647 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3648 + } 3649 +] 3650 + 3651 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3652 +|name|Название карты-метки 3653 +|number|Номер 3654 +|period|Период запросов в секундах (работает только для агрегатов) 3655 +|id|ID карты-метки 3656 +|parentId|ID клиента 3657 + 3658 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3659 + 3660 +(% class="box successmessage" %) 3661 +((( 3662 +**POST /api/v3/Rfids** 3663 +))) 3664 + 3665 +Запрос: 3666 + 3667 +{ 3668 + "name": "string", 3669 + "number": 0, 3670 + "period": 0, 3671 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3672 +} 3673 + 3674 +Ответ: 3675 + 3676 +{ 3677 + "name": "string", 3678 + "number": 0, 3679 + "period": 0, 3680 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3681 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3682 +} 3683 + 3684 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3685 +|name|Название карты-метки 3686 +|number|Номер 3687 +|period|Период запросов в секундах (работает только для агрегатов) 3688 +|id|ID карты-метки 3689 +|parentId|ID клиента 3690 + 3691 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3692 + 3693 +(% class="box warningmessage" %) 3694 +((( 3695 +**PUT /api/v3/Rfids** 3696 +))) 3697 + 3698 +Запрос: 3699 + 3700 +{ 3701 + "name": "string", 3702 + "number": 0, 3703 + "period": 0, 3704 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3705 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3706 +} 3707 + 3708 +Ответ: 3709 + 3710 +{ 3711 + "name": "string", 3712 + "number": 0, 3713 + "period": 0, 3714 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3715 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3716 +} 3717 + 3718 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3719 +|name|Название карты-метки 3720 +|number|Номер 3721 +|period|Период запросов в секундах (работает только для агрегатов) 3722 +|id|ID карты-метки 3723 +|parentId|ID клиента 3724 + 3725 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3726 + 3727 +(% class="box errormessage" %) 3728 +((( 3729 +**DELETE /api/v3/Rfids/{rfidGuid}** 3730 +))) 3731 + 3732 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3733 + 3734 +Ответ: 3735 + 3736 +Success 3737 + 3738 + 3739 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3740 + 3741 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3742 + 3743 +(% class="box infomessage" %) 3744 +((( 3745 +**GET /api/v3/Billing/client/balance/{clientId}** 3746 +))) 3747 + 3748 +Параметр запроса: **clientId **- идентификатор клиента. 3749 + 3750 +Ответ: 3751 + 3752 +{ 3753 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3754 + "Balance": 0 3755 +} 3756 + 3757 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3758 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3759 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3760 + 3761 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3762 + 3763 +(% class="box infomessage" %) 3764 +((( 3765 +**GET /api/v3/Billing/client/constraint/{clientId}** 3766 +))) 3767 + 3768 +Параметр запроса: **clientId **- идентификатор клиента. 3769 + 3770 +Ответ: 3771 + 3772 +{ 3773 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3774 + "CalculationType": 0, 3775 + "PermissibleBalance": 0, 3776 + "DefermentDays": 0, 3777 + "SendUiNotifications": true, 3778 + "SendEmailNotifications": true, 3779 + "IsPrivate": true, 3780 +} 3781 + 3782 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3783 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3784 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3785 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3786 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3787 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3788 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3789 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3790 + 3791 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3792 + 3793 +(% class="box infomessage" %) 3794 +((( 3795 +**GET /api/v3/Billing/client/plan/{clientId}** 3796 +))) 3797 + 3798 +Параметры запроса: 3799 + 3800 +**clientId **- идентификатор клиента. 3801 + 3802 +**planId **- идентификатор тарифного плана. 3803 + 3804 +Ответ: 3805 + 3806 +{ 3807 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3808 + "Plan": { **~/~/ Описание тарифного плана** 3809 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3810 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3811 + "Name": "string", 3812 + "IsArchived": true, 3813 + "Constraint": { 3814 + "CalculationType": 0, 3815 + "PermissibleBalance": 0, 3816 + "DefermentDays": 0 3817 + }, 3818 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3819 + { 3820 + "Feature": "string", 3821 + "IsFactual": true, 3822 + "Limit": 0, 3823 + "Price": 0, 3824 + "PeriodValue": 0, 3825 + "PeriodType": 0 3826 + } 3827 + ] 3828 + }, 3829 + "DebitDate": "2023-10-18T12:46:24.213Z", 3830 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3831 + { 3832 + "Feature": "string", 3833 + "IsEnabled": true, 3834 + "IsPrivate": true, 3835 + "IsFactual": true, 3836 + "Limit": 0, 3837 + "Price": 0, 3838 + "DebitDate": "2023-10-18T12:46:24.213Z", 3839 + "PeriodValue": 0, 3840 + "PeriodType": 0 3841 + } 3842 + ] 3843 +} 3844 + 3845 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3846 +|ClientId|Идентификатор клиента 3847 +|Id|Идентификатор тарифного плана 3848 +|OwnerId|Идентификатор клиента-владельца 3849 +|Name|Наименование тарифного плана 3850 +|IsArchived|Признак, определяющий архивный тарифный план 3851 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3852 +|PermissibleBalance|Допустимый баланс 3853 +|DefermentDays|Отсрочка, количество дней 3854 +|Feature|Код услуги 3855 +|IsEnabled|Признак, определяющий активирована ли услуга 3856 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3857 +|IsFactual|Признак, определяющий расчёт по факту 3858 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3859 +|Price|Цена за единицу. 3860 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3861 +|PeriodValue|Значение периода. 3862 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3863 + 3864 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3865 + 3866 +(% class="box infomessage" %) 3867 +((( 3868 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3869 +))) 3870 + 3871 +Параметр запроса: **clientId **- идентификатор клиента. 3872 + 3873 +Ответ: 3874 + 3875 +[ 3876 + { 3877 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3878 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3879 + "Name": "string", 3880 + "IsArchived": true, 3881 + "Constraint": { 3882 + "CalculationType": 0, 3883 + "PermissibleBalance": 0, 3884 + "DefermentDays": 0 3885 + }, 3886 + "Features": [ 3887 + { 3888 + "Feature": "string", 3889 + "IsFactual": true, 3890 + "Limit": 0, 3891 + "Price": 0, 3892 + "PeriodValue": 0, 3893 + "PeriodType": 0 3894 + } 3895 + ] 3896 + } 3897 +] 3898 + 3899 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3900 +|ClientId|Идентификатор клиента 3901 +|Id|Идентификатор тарифного плана 3902 +|OwnerId|Идентификатор клиента-владельца 3903 +|Name|Наименование тарифного плана 3904 +|IsArchived|Признак, определяющий архивный тарифный план 3905 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3906 +|PermissibleBalance|Допустимый баланс 3907 +|DefermentDays|Отсрочка, количество дней 3908 +|Feature|Код услуги 3909 +|IsFactual|Признак, определяющий расчёт по факту 3910 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3911 +|Price|Цена за единицу. 3912 +|PeriodValue|Значение периода. 3913 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3914 + 3915 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3916 + 3917 +(% class="box infomessage" %) 3918 +((( 3919 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3920 +))) 3921 + 3922 +Параметр запроса: **clientId **- идентификатор клиента. 3923 + 3924 +Ответ: 3925 + 3926 +[ 3927 + { 3928 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3929 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3930 + "Name": "string", 3931 + "IsArchived": true, 3932 + "Constraint": { 3933 + "CalculationType": 0, 3934 + "PermissibleBalance": 0, 3935 + "DefermentDays": 0 3936 + }, 3937 + "Features": [ 3938 + { 3939 + "Feature": "string", 3940 + "IsFactual": true, 3941 + "Limit": 0, 3942 + "Price": 0, 3943 + "PeriodValue": 0, 3944 + "PeriodType": 0 3945 + } 3946 + ] 3947 + } 3948 +] 3949 + 3950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3951 +|ClientId|Идентификатор клиента 3952 +|Id|Идентификатор тарифного плана 3953 +|OwnerId|Идентификатор клиента-владельца 3954 +|Name|Наименование тарифного плана 3955 +|IsArchived|Признак, определяющий архивный тарифный план 3956 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3957 +|PermissibleBalance|Допустимый баланс 3958 +|DefermentDays|Отсрочка, количество дней 3959 +|Feature|Код услуги 3960 +|IsFactual|Признак, определяющий расчёт по факту 3961 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3962 +|Price|Цена за единицу. 3963 +|PeriodValue|Значение периода. 3964 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3965 + 3966 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3967 + 3968 +(% class="box warningmessage" %) 3969 +((( 3970 +**PUT /api/v3/Billing/client/balance** 3971 +))) 3972 + 3973 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3974 + 3975 +Тело запроса: 3976 + 3977 +{ 3978 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3979 + "Balance": 0 3980 +} 3981 + 3982 +Ответ: Success 3983 + 3984 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3985 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3986 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3987 + 3988 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3989 + 3990 +(% class="box warningmessage" %) 3991 +((( 3992 +**PUT /api/v3/billing/client/balance/deposit** 3993 +))) 3994 + 3995 +Создает операцию **Пополнение **с указанной суммой 3996 + 3997 +Тело запроса: 3998 + 3999 +{ 4000 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4001 + "Balance": 0 4002 +} 4003 + 4004 +Ответ: Success 4005 + 4006 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4007 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4008 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4009 + 4010 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4011 + 4012 +Создает операцию **Списание **с указанной суммой 4013 + 4014 +(% class="box warningmessage" %) 4015 +((( 4016 +**PUT /api/v3/billing/client/balance/withdraw** 4017 +))) 4018 + 4019 +Тело запроса: 4020 + 4021 +{ 4022 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4023 + "Balance": 0 4024 +} 4025 + 4026 +Ответ: Success 4027 + 4028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4029 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4030 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4031 + 4032 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4033 + 4034 +(% class="box warningmessage" %) 4035 +((( 4036 +**PUT /api/v3/Billing/client/constraint** 4037 +))) 4038 + 4039 +Тело запроса: 4040 + 4041 +{ 4042 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4043 + "CalculationType": 0, 4044 + "PermissibleBalance": 0, 4045 + "DefermentDays": 0, 4046 + "SendUiNotifications": true, 4047 + "SendEmailNotifications": true, 4048 + "IsPrivate": true, 4049 +} 4050 + 4051 +Ответ: Success 4052 + 4053 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4054 +|ClientId|Идентификатор клиента 4055 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4056 +|PermissibleBalance|Допустимый баланс 4057 +|DefermentDays|((( 4058 +Отсрочка, количество дней 4059 +))) 4060 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4061 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4062 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4063 + 4064 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4065 + 4066 +(% class="box warningmessage" %) 4067 +((( 4068 +**PUT /api/v3/Billing/client/plan** 4069 +))) 4070 + 4071 +Тело запроса: 4072 + 4073 +{ 4074 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4075 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4076 + "Features": [ 4077 + { 4078 + "Feature": "string", 4079 + "IsEnabled": true, 4080 + "IsFactual": true, 4081 + "Limit": 0, 4082 + "Price": 0, 4083 + "DebitDate": "2023-10-18T13:26:58.987Z", 4084 + "PeriodValue": 0, 4085 + "PeriodType": 0 4086 + } 4087 + ] 4088 +} 4089 + 4090 +Ответ: Success 4091 + 4092 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4093 +|ClientId|Идентификатор клиента 4094 +|PlanId|Идентификатор тарифного плана 4095 +|Feature|Код услуги 4096 +|IsEnabled|Признак, определяющий активирована ли услуга 4097 +|IsFactual|Признак, определяющий расчёт по факту 4098 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4099 +|Price|Цена за единицу. 4100 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4101 +|PeriodValue|Значение периода. 4102 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4103 + 4104 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4105 + 4106 +(% class="box warningmessage" %) 4107 +((( 4108 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4109 +))) 4110 + 4111 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4112 + 4113 +(% class="box infomessage" %) 4114 +((( 4115 +**POST /api/v3/vehicles/import/{agentId}** 4116 +))) 4117 + 4118 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4119 + 4120 +В пути указывается **agentId** - id клиента. 4121 + 4122 +**Заголовок** 4123 + 4124 +**X-Auth: [токен авторизации]** 4125 + 4126 +**Параметры** 4127 + 4128 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4129 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4130 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4131 + 4132 +В теле использовать тип **form-data,** тип значения** file** 4133 + 4134 +**Ключи** 4135 + 4136 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4137 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4138 +|csv|В значении передаем файл датчиков, формат **csv** 4139 + 4140 +Ответ: 4141 + 4142 +{ 4143 + "vehicleId": 0, 4144 + "name": "string", 4145 + "errors": ["string"] 4146 +} 4147 + 4148 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4149 +|vehicleId|ID созданного объекта 4150 +|name|Имя созданного объекта 4151 +|errors|Ошибки и их описание 4152 + 4153 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4154 + 4155 +(% class="box infomessage" %) 4156 +((( 4157 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4158 +))) 4159 + 4160 +(% class="wikigeneratedid" %) 4161 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4162 + 4163 +(% class="wikigeneratedid" %) 4164 +В пути указывается **vehicleId **- id объекта. 4165 + 4166 +**Заголовок** 4167 + 4168 +**X-Auth: [токен авторизации]** 4169 + 4170 +В теле использовать тип **form-data.** 4171 + 4172 +Ключи: 4173 + 4174 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4175 +|**history**|В значении передавать файл с историей 4176 + 4177 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4178 + 4179 +Ответ: 4180 + 4181 +{ 4182 + "results": [ 4183 + { 4184 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4185 + "vehicleId": 0, 4186 + "errors": [ 4187 + "string" 4188 + ], 4189 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4190 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4191 + "producedCount": 0, 4192 + "msgCount": 0 4193 + } 4194 + ] 4195 +} 4196 + 4197 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4198 +|results|Результаты импорта в разрезе ТС 4199 +|vehicleGuid|Guid ТС 4200 +|vehicleId|ID ТС 4201 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4202 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4203 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4204 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4205 +|msgCount|Кол-во обработанных сообщений всего 4206 + 4207 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4208 + 4209 +(% class="box infomessage" %) 4210 +((( 4211 +**GET /api/v3/vehicles/import/history/status** 4212 +))) 4213 + 4214 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4215 + 4216 +Ответ: 4217 + 4218 +{ 4219 + "activity": true, 4220 + "progress": 0, 4221 + "message": "string" 4222 +} 4223 + 4224 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4225 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4226 +|progress|Guid ТС 4227 + 4228 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4229 + 4230 +(% class="box infomessage" %) 4231 +((( 4232 +**POST /api/v3/vehicles/export** 4233 +))) 4234 + 4235 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4236 + 4237 +Тело запроса: 4238 + 4239 +[ 4240 + id 4241 +] 4242 + 4243 +Ответ: Success 200, получаете файлы с настройками. 4244 + 4245 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4246 + 4247 +(% class="box infomessage" %) 4248 +((( 4249 +**POST /api/v3/vehicles/export/history** 4250 +))) 4251 + 4252 +Метод возвращает список сообщений терминала объекта за выбранный период. 4253 + 4254 +Тело запроса: 4255 + 4256 +{ 4257 + "vehicleId": 0, 4258 + "asArchive": true, 4259 + "from": "2023-09-27T12:17:45.973Z", 4260 + "to": "2023-09-27T12:17:45.973Z" 4261 +} 4262 + 4263 +Ответ: 4264 + 4265 +Получаете файл. Сообщение: Code 200/Success 4266 + 4267 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4268 +|vehicleId|ID объекта 4269 +|asArchive|true - Архивировать файл, False - не архивировать 4270 +|from|Дата и время начала запроса 4271 +|to|Дата и время окончания запроса 4272 + 4273 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4274 + 4275 +(% class="box infomessage" %) 4276 +((( 4277 +**GET /api/v3/vehicles/export/history/status** 4278 +))) 4279 + 4280 +Метод возвращает список сообщений терминала объекта за выбранный период. 4281 + 4282 +Ответ: 4283 + 4284 +{ 4285 + "activity": true, 4286 + "progress": 0, 4287 + "message": "string" 4288 +} 4289 + 4290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4291 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4292 +|progress|Прогресс экспорта, от 0 до 100% 4293 +|message|Текст описывающий статус 4294 + 4295 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4296 + 4297 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4298 + 4299 +(% class="box infomessage" %) 4300 +((( 4301 +**POST /api/v3/EcoDriving/rating** 4302 +))) 4303 + 4304 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4305 + 4306 +Тело запроса: 4307 + 4308 +{ 4309 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4310 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4311 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4312 +} 4313 + 4314 +Ответ: 4315 + 4316 +{ 4317 + "items": [ ~/~/ Список в разрезе ТС 4318 + { 4319 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4320 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4321 + "vehicleId": 0, ~/~/ ID ТС 4322 + "vehicleName": "string", ~/~/ Название ТС 4323 + "vehicleModel": "string", ~/~/ Модель ТС 4324 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4325 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4326 + "totalViolations": 0, ~/~/ Нарушений всего 4327 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4328 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4329 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4330 + "brakingViolations": 0, ~/~/ Нарушений торможения 4331 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4332 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4333 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4334 + }, 4335 + 4336 +((( 4337 + 4338 +))) 4339 + 4340 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4341 + "mileage": 0, ~/~/ Пробег, м 4342 + "tripsCount": 0, ~/~/ Кол-во рейсов 4343 + "trips": [ ~/~/ Информация по рейсу 4344 + { 4345 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4346 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4347 + "violationsCount": 0, ~/~/ Всего нарушений 4348 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4349 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4350 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4351 + "brakingViolations": 0, ~/~/ Нарушений торможения 4352 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4353 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4354 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4355 + }, 4356 + 4357 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4358 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4359 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4360 + "mileage": 0, ~/~/ Пробег, м 4361 + "motohours": 0, ~/~/ Моточасы, секунды 4362 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4363 + "startAddress": "string", ~/~/ Адрес начала рейса 4364 + "endAddress": "string", ~/~/ Адрес конца рейса 4365 + "drivers": [ ~/~/ Список водителей 4366 + { 4367 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4368 + "driverName": "string", ~/~/ФИО водителя 4369 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4370 + } 4371 + ] 4372 + } 4373 + ] 4374 + } 4375 + ] 4376 +} 4377 + 4378 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4379 + 4380 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4381 + 4382 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4383 + 4384 +(% class="box infomessage" %) 4385 +((( 4386 +POST /api/v3/fuelcards/transactions 4387 +))) 4388 + 4389 +Метод запроса: POST 4390 + 4391 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4392 +\\В заголовках запроса: X-Auth: Токен авторизации 4393 + 4394 +Параметры в теле запроса (JSON): 4395 + 4396 +{ 4397 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4398 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4399 + "ids": [ 4400 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4401 + ], 4402 + "timezone": 0 ~/~/ Часовой пояс 4403 +} 4404 + 4405 + 4406 +Ответ: 4407 + { 4408 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4409 + "driver": "string", ~/~/ Водители, привязанные к ТК 4410 + "object": "string", ~/~/ Наименование ТС 4411 + "amount": 0, ~/~/ Количество топлива 4412 + "amountDut": 0, ~/~/ Количество по ДУТ 4413 + "amountDiff": 0, ~/~/ Разница, л 4414 + "amountDiffPerc": 0, ~/~/ Разница, % 4415 + "summa": 0, ~/~/ Стоимость, руб 4416 + "serviceName": "string", ~/~/ Тип топлива 4417 + "price": 0, ~/~/ Цена за литр, руб 4418 + "cardName": "string", ~/~/ Наименование ТК 4419 + "cardNum": "string", ~/~/ Номер ТК 4420 + "operator": "string", ~/~/ Оператор ТК 4421 + "address": "string" ~/~/ Адрес АЗС 4422 + } 4423 + 4424 + 4425 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4426 + 4427 + 4428 +== **Получение полных данных о ретрансляторе** == 4429 + 4430 +(% class="box infomessage" %) 4431 +((( 4432 +**GET ** **/api/v3/retranslations/{id}** 4433 +))) 4434 + 4435 +id - Идентификатор ретранслятора 4436 + 4437 + 4438 +Пример ответа: 4439 + 4440 +{ 4441 +"description": "", ~/~/ Поле описания ретранслятора 4442 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4443 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4444 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4445 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4446 +"objects": [ ~/~/ Объекты для ретрансляции 4447 +{ 4448 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4449 +"name": "", ~/~/ Наименование объекта ретрансляции 4450 +"imei": "", ~/~/ IMEI объекта ретрансляции 4451 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4452 +} 4453 + ], 4454 +"id": "", ~/~/ Идентификатор ретранслятора 4455 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4456 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4457 +} 4458 + 4459 + 4460 +== **Удаление данных ретранслятора** == 4461 + 4462 +(% class="box infomessage" %) 4463 +((( 4464 +**DELETE** **/api/v3/retranslations/{id}** 4465 +))) 4466 + 4467 +id - Идентификатор ретранслятора 4468 + 4469 + 4470 +== **Создание ретранслятора** == 4471 + 4472 +(% class="box infomessage" %) 4473 +((( 4474 +**POST ** **/api/v3/retranslations/{id}** 4475 +))) 4476 + 4477 +Запрос: 4478 + 4479 +{ 4480 +"description": "", ~/~/ Поле описания ретранслятора 4481 +"subscriberId": "", ~/~/ Идентификатор подписчика 4482 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4483 +"address": "", ~/~/ Адрес и порт принимающего сервера 4484 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4485 +"objects": [ ~/~/Объекты для ретрансляции 4486 +{ 4487 +"id": "", ~/~/ Идентификатор ретранслятора 4488 +"imei": "", ~/~/ IMEI объекта ретрансляции 4489 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4490 +} 4491 + ] 4492 +} 4493 + 4494 + 4495 +Ответ: 4496 + 4497 +{ 4498 +"description": "", ~/~/ Поле описания ретранслятора 4499 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4500 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4501 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4502 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4503 +"objects": [ ~/~/ Объекты для ретрансляции 4504 +{ 4505 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4506 +"name": "string", ~/~/ Наименование объекта ретрансляции 4507 +"imei": "", ~/~/ IMEI объекта ретрансляции 4508 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4509 +} 4510 + ], 4511 +"id": "", ~/~/ Идентификатор ретранслятора 4512 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4513 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4514 +} 4515 + 4516 + 4517 +== **Редактирование ретранслятора** == 4518 + 4519 +(% class="box infomessage" %) 4520 +((( 4521 +**PUT** **/api/v3/retranslations** 4522 +))) 4523 + 4524 +Пример запроса: 4525 + 4526 +{ 4527 +"id": "", ~/~/ Идентификатор ретранслятора 4528 +"description": "string", ~/~/ Поле описания ретранслятора 4529 +"subscriberId": "", ~/~/ Идентификатор подписчика 4530 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4531 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4532 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4533 +"objects": ~/~/ Объекты для ретрансляции 4534 +[ 4535 +{ 4536 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4537 +"imei": "", ~/~/ IMEI объекта ретрансляции 4538 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4539 +} 4540 + ] 4541 +} 4542 + 4543 + 4544 +Пример ответа: 4545 + 4546 +{ 4547 +"description": "", ~/~/ Поле описания ретранслятора 4548 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4549 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4550 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4551 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4552 +"objects": [ ~/~/ Объекты для ретрансляции 4553 +{ 4554 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4555 +"name": "string", ~/~/ Наименование объекта ретрансляции 4556 +"imei": "", ~/~/ IMEI объекта ретрансляции 4557 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4558 +} 4559 + ], 4560 +"id": "", ~/~/ Идентификатор ретранслятора 4561 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4562 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4563 +} 4564 + 4565 + 4566 +== **Получение списка ретранслятора клиента** == 4567 + 4568 +(% class="box infomessage" %) 4569 +((( 4570 +**POST /api/v3/retranslations/find** 4571 +))) 4572 + 4573 +Пример запроса: 4574 + 4575 +{ 4576 +"id": "", ~/~/ Идентификатор ретранслятора 4577 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4578 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (вышестоящего клиента). 4579 +} 4580 + 4581 +Ответ: 4582 + 4583 +[ 4584 +{ 4585 +"description": "", ~/~/ Поле описания ретранслятора 4586 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4587 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4588 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4589 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4590 +"id": "", ~/~/ Идентификатор ретранслятора 4591 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4592 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4593 +} 4594 +] 4595 + 4596 + 4597 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4598 + 4599 +== **API для отчета по выгрузке комбайнов** == 4600 + 4601 +(% class="box infomessage" %) 4602 +((( 4603 +POST **/api/v3/Reports/harvesterUnloading** 4604 +))) 4605 + 4606 +Пример запроса: 4607 + 4608 +{ 4609 + "byTime": 0, ~/~/ Объединение событий по времени 4610 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4611 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4612 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4613 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4614 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4615 + 0 4616 + ], 4617 + "from": "", ~/~/ Дата и время начало запроса 4618 + "to": "", ~/~/ Дата и время окончания запроса 4619 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4620 +} 4621 + 4622 +Пример ответа: 4623 + 4624 +[ 4625 + { 4626 + "harvesterName": "", ~/~/Комбайн, номер 4627 + "harvesterId": 0, ~/~/Комбайн, id 4628 +"harvesterModel": "", ~/~/ Модель комбайна 4629 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4630 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4631 + "events": [ ~/~/Список событий в разрезе комбайна 4632 + { 4633 + "driverId": "", ~/~/Идентификатор водителя 4634 + "driverName": "", ~/~/Водитель комбайна, ФИО 4635 + "RFID": "", ~/~/ идентификатор карты-метки 4636 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4637 + "vehicleId": 0, ~/~/идентификатор объекта 4638 + "vehicleName": "string", ~/~/ Имя объекта 4639 + "modelName": "string", ~/~/ Имя модели объекта 4640 + "nearestVehicles": [ ~/~/Объекты рядом 4641 + { 4642 + "vehicleId": 0, ~/~/идентификатор объекта 4643 + "vehicleName": "string" ~/~/ Имя объекта 4644 + } 4645 + ], 4646 + "fields": [ ~/~/Поля, где происходила выгрузка 4647 + { 4648 + "id": 0, ~/~/ идентификатор пользователя 4649 + "name": "string" ~/~/ имя пользователя 4650 + } 4651 + ], 4652 + "event": "string", ~/~/Событие 4653 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4654 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4655 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4656 + "cultureName": "string", ~/~/ название культуры 4657 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4658 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4659 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4660 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4661 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4662 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4663 + "issued": 0, ~/~/Выдано, бункеров 4664 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4665 + "latitude": 0, ~/~/Широта 4666 + "longitude": 0, ~/~/ Долгота 4667 + "litresAway": 0, ~/~/Отдано, л 4668 + "m3Away": 0 ~/~/Отдано, м3 4669 + } 4670 + ] 4671 + } 4672 +] 4673 + 4674 + 4675 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4676 + 4677 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4678 + 4679 + 4680 +(% class="box infomessage" %) 4681 +((( 4682 +GET api/v3/Vehicles/recyclebin/all 4683 +))) 4684 + 4685 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4686 + 4687 +Параметр запроса: {parentId} - идентификатор агента 4688 + 4689 +В заголовках запроса: X-Auth: Токен авторизации 4690 + 4691 +Ответ: 4692 + 4693 +[ 4694 + { 4695 + "recordTime": "", ~/~/Время записи 4696 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4697 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4698 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4699 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4700 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4701 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4702 + "items": [ ~/~/ 4703 +nullable: true ~/~/Детали 4704 + { 4705 + "name": "string", ~/~/наименование столбца 4706 + "value": "string" ~/~/содержание столбца 4707 + } 4708 + ] 4709 + }, 4710 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4711 + "string" 4712 + ] 4713 + } 4714 +] 4715 + 4716 + 4717 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4718 + 4719 +(% class="box infomessage" %) 4720 +((( 4721 +POST/api/v3/Vehicles/recyclebin/erase 4722 +))) 4723 + 4724 +В заголовках запроса: X-Auth: Токен авторизации 4725 + 4726 +Пример запроса: 4727 + 4728 +[ 4729 +0 4730 +] 4731 + 4732 + 4733 +Пример ответа: 4734 + 4735 +[ 4736 +{ 4737 + "recordTime": "", ~/~/Время записи 4738 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4739 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4740 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4741 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4742 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4743 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4744 + "items": [ ~/~/Детали 4745 + { 4746 + "name": "", ~/~/Имя свойства 4747 + "value": "" ~/~/Значение свойства 4748 + } 4749 + ] 4750 + }, 4751 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4752 + "" 4753 + ] 4754 + } 4755 +] 4756 + 4757 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4758 + 4759 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4760 + 4761 +(% class="box infomessage" %) 4762 +((( 4763 +POST/api/v3/Vehicles/recyclebin/restore 4764 +))) 4765 + 4766 +В заголовках запроса: X-Auth: Токен авторизации 4767 + 4768 +Параметры в теле запроса (JSON): 4769 + 4770 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4771 + 4772 +В заголовках запроса: X-Auth: Токен авторизации 4773 + 4774 + 4775 +Пример запроса: 4776 + 4777 +((( 4778 +[ 4779 +))) 4780 + 4781 +((( 4782 + 0 4783 +))) 4784 + 4785 +((( 4786 +] 4787 +))) 4788 + 4789 + 4790 +Пример ответа: 4791 + 4792 +[ 4793 +{ 4794 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4795 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4796 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4797 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4798 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4799 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4800 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4801 + "items": [ ~/~/Детали 4802 + { 4803 + "name": "string", ~/~/Имя свойства 4804 + "value": "string" ~/~/Значение свойства 4805 + } 4806 + ] 4807 + }, 4808 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4809 + "string" 4810 + ] 4811 + } 4812 +] 4813 + 4814 + 4815 + 585 585 (% class="box" lang="en-US" style="text-align: center;" %) 586 586 ((( 587 587 (% 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