Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/24 15:46
<
>
edited by Андрей Калиновский
on 2022/08/31 14:11
on 2022/08/31 14:11
edited by Андрей Калиновский
on 2024/11/22 14:55
on 2024/11/22 14:55
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -API 1 +Методы API для работы с ГЛОНАССSoft - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,440 +1,4817 @@ 1 -== Описание ГЛОНАССSoft Public API == 1 +(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 +((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 2 2 3 -== == 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 4 4 5 - **Действующие ограничения** 6 - 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд. 7 7 8 -- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов) 9 9 10 -- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 15 +**Содержание страницы:** 16 +))) 11 11 18 +{{toc/}} 19 + 20 + 21 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 22 + 23 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 24 + 25 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 26 + 12 12 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 13 -\\ 14 14 15 - Авторизация**29 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 16 16 17 -Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 18 18 19 - Методзапроса: GET32 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 20 20 21 - 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]]34 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 22 22 23 - Вслучаеуспешноговыполнения метода, поле «AuthId»содержиттокен авторизации«X-Auth».36 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 24 24 25 -Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ] 38 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 39 +((( 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/]] или другие) 42 +))) 26 26 27 - **Получение списка объектов** 44 +(% class="box successmessage" %) 45 +((( 46 +(% lang="en-US" %)**POST /api/v3/auth/login** 47 +))) 28 28 29 -Метод позволяет получить о сновныепараметрыобъектов: наименование,IMEI,тип устройства,модельобъекта, подразделение, номера телефонови идентификатор клиента,ккоторому прикрепленобъект(клиент-родитель):Методвозвращает информациюобобъектахс учетом настроекавторизованногопользователя,указанногов запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):49 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 30 30 31 - −возвращаетсяинформацияоб объектах клиента-родителяавторизованногопользователяи объектах его дочерних клиентов;51 +(% style="color:#000000" %)Метод запроса: **POST** 32 32 33 - −возвращаетинформациюоб объектах с учетомзаданных настроек видимостиобъектов;53 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 34 34 35 - −информацияпредоставляетсясучетомналичия прав на просмотр объектов заблокированных договоров(объекты,принадлежащие заблокированному договору возвращаютсяпри наличии любого из прав «Видимость объектов заблокированныхдоговоров в панелиуправления»или«Видимостьобъектов заблокированныхдоговоров в мониторинге»;55 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 36 36 37 - −информацияотелефонах SIM1/SIM2 предоставляется приналичии права«Просмотр номеров телефоновобъектов»;57 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 38 38 39 -−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 59 +(% style="color:#000000" %){ 60 + "login": "testuser", 61 + "password": "testuser" 62 +} 40 40 41 - Методзапроса:POST64 +(% style="color:#000000" %)**Ответ:** 42 42 43 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 66 +(% lang="en-US" %) 67 +(% style="color:#000000" %){ 68 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 69 + "User": "testuser" , ~/~/ имя пользователя(%%) 70 +} 44 44 45 -В за головках запроса:72 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 46 46 47 -−Content-Type: application/json 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" %)Логин пользователя 48 48 49 -−X-Auth: Токен авторизации 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}]]) 50 50 51 - Условияфильтрацииобъектовзадаютсявтеле запроса.Параметрывелезапроса(JSON):83 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 52 52 53 -{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}} 85 +(% class="box infomessage" %) 86 +((( 87 +(% lang="en-US" %)**GET /api/v3/auth/check** 88 +))) 54 54 55 - Фильтрацияосуществляетсяпоточному совпадению значений параметров«vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному- «name», «imei», «sim». Фильтрация позначениюпараметра«sim»осуществляетсяприналичии у авторизованногопользователяправа «Просмотр номеровтелефоновобъектов».90 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 56 56 57 - Ответ:[ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»:«», //наименование модели объекта «unitId»: «», //идентификатор подразделения«unitName»: «», //наименованиеподразделения «status»: «», //статус объекта //«//createdAt//»:«» дата создания объектов //}, … ]92 +(% style="color:#000000" %)Метод запроса: **GET** 58 58 59 - Параметры«sim1»и «sim2» содержатся в ответе при наличии у авторизованногопользователя права «Просмотр номеров телефонов объектов». Параметр«status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта».Параметр «status»содержитid статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.94 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]] 60 60 61 -0 -«Блокировка»96 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 62 62 63 -1 - «Активен», 98 +(% lang="en-US" %) 99 +(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 64 64 65 - 2-«Отменен»101 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 66 66 67 - 3-«Оборудован»103 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 68 68 69 -4 - «Диагностика» 105 +(% class="box infomessage" %) 106 +((( 107 +**GET api/v3/agents/{id}** 108 +))) 70 70 71 - 5-«Сервис»110 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 72 72 73 - 6-«Демонтаж»112 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 74 74 75 - 7-«Монтаж»114 +(% style="color:#000000" %)Метод запроса: **GET** 76 76 77 - 8-«Дозаказ»116 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 78 78 79 - 9 - «Обслужен»118 +Запрос должен содержать данные параметра "**agentId**" 80 80 81 -10 - «Списан» 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 + } 82 82 83 -11 - «Неисправен» 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" %)Корр. счет 84 84 85 - 12-«Проверен»166 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 86 86 87 -13 - «Не эксплуатируется» 168 +(% class="box infomessage" %) 169 +((( 170 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 171 +))) 88 88 89 - **Получениесписка клиентов.**173 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 90 90 91 - Методпозволяет получить основные параметры клиентов:наименование,полное наименование, тип, статус и идентификаторклиента-родителя. Метод возвращает информациюо клиентахс учетом настроекавторизованного пользователя,указанного в запросе(обязательныйпараметрвзаголовкахзапроса - токенавторизации «X-Auth»)175 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 92 92 93 -−информация о клиент ах предоставлетсяпричииправа«Просмотр клиентов»;177 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 94 94 95 -− возвращаетсяинформация о клиенте,которомупринадлежитавторизованныйпользователь,иегодочернихклиентах;179 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 96 96 97 - −информацияоклиенте типа «Партнер» и егоподклиентоввозвращаетсяпри наличии права «Доступ к партнёрскимклиентам».181 +(% style="color:#000000" %)Метод запроса: **POST** 98 98 99 - Методзапроса:GET183 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 100 100 101 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>185 +(% style="color:#000000" %)Параметр запроса: 102 102 103 -Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 187 +(% style="color:#000000" %){ 188 + "parentId": "string" 189 +} 104 104 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" %) 214 +((( 215 +**POST /api/v3/agents ** 216 +))) 217 + 218 +Метод позволяет добавить клиента, указанного в запросе. 219 + 220 +Метод запроса: **POST** 221 + 222 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 223 + 105 105 В заголовках запроса: X-Auth: Токен авторизации 106 106 107 - Ответ: [ { «agentId»: «», //идентификаторклиента«parentId»: «», //идентификаторклиента-родителя «name»: «», //наименованиеклиента «fullName»: «», //полноенаименование клиента«agentInfoType»: , //тип клиента1 «status»: //статусклиента }, … ]226 +Параметры в теле запроса (JSON): 108 108 109 -Примечание. Возможные значение параметра agentInfoType: 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 +} 110 110 111 - **Получение списка пользователей.**249 +Ответ: 112 112 113 -Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр. 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 +} 114 114 115 -Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей». 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" %)Корр. счет 116 116 117 - Методзапроса:POST295 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 118 118 119 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 297 +(% class="box warningmessage" %) 298 +((( 299 +**PUT /api/v3/agents** 300 +))) 120 120 121 - Условияфильтрацииобъектовзадаютсяв теле запроса.Параметрывтелезапроса (JSON): {302 +Метод позволяет отредактировать клиента, указанного в запросе. 122 122 123 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 124 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 125 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 126 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 304 +Метод запроса: **PUT** 127 127 306 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 307 + 308 +В заголовках запроса: X-Auth: Токен авторизации 309 + 310 +Параметры в теле запроса (JSON): 311 + 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" ~/~/ корр. счёт 128 128 } 129 129 130 -Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail334 +Ответ: 131 131 132 -{{{ "sessionDuration": "", // длительность сессии в минутах}}} 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 +} 133 133 134 - «status»:1, //статуспользователя «lastLogged»:«»//дата/время последнейавторизации}, … ]357 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 135 135 136 - **Получение списка типов устройств** 359 +(% class="box errormessage" %) 360 +((( 361 +**DELETE /api/v3/agents/{clientId}** 362 +))) 137 137 138 -Метод позволяет получитьсписоктипов устройств. Метод возвращает информацию отипах устройств с учетом настроек авторизованного пользователя, указанного взапросе (обязательный параметр в заголовкахзапроса- токен авторизации «X-Auth»)364 +Метод позволяет удалить клиента, указанного в строке запроса. 139 139 140 -Метод запроса: GET366 +Метод запроса: **DELETE** 141 141 142 -URL users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]368 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 143 143 144 - В заголовкахзапроса:X-Auth:Токен авторизации370 +Параметр запроса: **{clientId}** - Guid пользователя 145 145 146 - Ответ:[372 +В заголовках запроса: X-Auth: Токен авторизации 147 147 148 -{{{ { 149 - "deviceTypeId" : "", // ID типа устройства 150 - "deviceTypeName" : "" // Название типа устройства 151 - },}}} 374 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 152 152 153 - …]376 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 154 154 155 - **Получение списка типов датчиков** 378 +(% class="box warningmessage" %) 379 +((( 380 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 381 +))) 156 156 157 -Метод позволяет получить список типов датчиков. Метод возвращает информацию отипахдатчиковсучетом настроекавторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)383 +Метод позволяет изменить статус клиента, указанного в запросе. 158 158 159 - Методзапроса:GET385 +В пути указывается GUID клиента и статус клиента. 160 160 161 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]387 +**status **- значение 0 - заблокирован, 1 - активен. 162 162 163 - В заголовках запроса:X-Auth:Токенавторизации389 +Ответ: Code 204 164 164 165 - Ответ:[391 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 166 166 167 - {{{{}}}393 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 168 168 169 -«id»: «», //ID типа датчика «name»: «», //Название 395 +(% class="box successmessage" %) 396 +((( 397 +(% lang="en-US" %)**POST /api/v3/users** 398 +))) 170 170 171 -{{{ "description": "" // Описание 172 - },}}} 400 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 173 173 174 - …]402 +(% style="color:#000000" %)Метод запроса: **POST** 175 175 176 - **Получение информацииоб объекте**404 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 177 177 178 - Методпозволяет получить всю информацию из карточки объекта:ID,имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта,ID подразделения, водители, ТО, текущийпробег, моточасы, нормы расхода,полнуюисторию статусов со всемикомментариями,список датчиков(тип, наименование, тип входа, номервхода, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».406 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 179 179 180 - Методвозвращаетинформацию об объекте с учетомнастроек авторизованногопользователя,указанного в запросе (обязательный параметрвзаголовках запроса- токен авторизации «X-Auth»):408 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 181 181 182 -−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание». 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", 183 183 184 -Метод запроса: GET 453 +(% style="text-align:left" %) 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 +} 185 185 186 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID> 187 187 188 - Параметрзапроса:<vehicleid>-идентификаторобъекта (опционально)476 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 189 189 190 -В заголовках запроса: X-Auth: Токен авторизации 478 +(% class="box infomessage" %) 479 +((( 480 +(% lang="en-US" %)**POST /api/v3/users/find** 481 +))) 191 191 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 + 574 +(% class="box warningmessage" %) 575 +((( 576 +(% lang="en-US" %)**PUT /api/v3/users** 577 +))) 578 + 579 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 580 + 581 +(% style="color:#000000" %)Метод запроса: **PUT** 582 + 583 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 584 + 585 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 586 + 587 +(% lang="en-US" style="text-align:left" %) 588 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 589 + 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" %)__}__ 616 + 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 + 647 +(% class="box warningmessage" %) 648 +((( 649 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 650 +))) 651 + 652 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 653 + 654 +(% style="color:#000000" %)Метод запроса: **PUT** 655 + 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} 657 + 658 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 659 + 660 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 661 + 662 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 663 + 664 +(% style="color:#000000" %){(%%) 665 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 666 + "description": "" , ~/~/ описание 667 + "data": "" , ~/~/ данные, связанные со сменой статуса 668 +(% style="color:#000000" %)} 669 + 670 +(% style="text-align:left" %) 671 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 672 + 673 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 674 + 675 +(% class="box warningmessage" %) 676 +((( 677 +**POST /api/v3/users/disable** 678 +))) 679 + 680 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 681 + 682 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 683 + 684 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 685 + 686 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 687 + 688 + [ 689 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 690 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 691 + ] 692 + 693 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 694 + 695 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 696 + 697 +(% class="box warningmessage" %) 698 +((( 699 +**POST /api/v3/users/enable** 700 +))) 701 + 702 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 703 + 704 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 705 + 706 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 707 + 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 + 734 +(% class="box errormessage" %) 735 +((( 736 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 737 +))) 738 + 739 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 740 + 741 +(% style="color:#000000" %)Метод запроса: **DELETE** 742 + 743 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 744 + 745 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 746 + 747 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 748 + 749 +(% style="text-align:left" %) 750 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 751 + 752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 753 + 754 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 755 + 756 +(% class="box infomessage" %) 757 +((( 758 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 759 +))) 760 + 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 + 192 192 Ответ: 193 193 194 194 { 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 +} 195 195 196 -{{{ "vehicleId": “”, // идентификатор объекта 197 - "name": "", // имя объекта 198 - "imei": "", // IMEI объекта 199 - "deviceTypeId": “”, // идентификатор устройства объекта 200 - "deviceTypeName": "" // наименование устройства объекта 201 - "parentId": "", // идентификатор клиента-родителя 202 - "parentName": "" // наименование клиента-родителя, 203 - "modelId": "", // идентификатор модели объекта 204 - "modelName": "" // наименование модели объекта, 205 - "unitId": "", // идентификатор подразделения 206 - "unitName": "", // наименование подразделения 207 - "status": “”, // статус объекта 208 - ... 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 + 978 +(% class="box errormessage" %) 979 +((( 980 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 981 +))) 982 + 983 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 984 + 985 +(% style="color:#000000" %)Метод запроса: **DELETE** 986 + 987 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 988 + 989 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 990 + 991 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 992 + 993 +Ответ: В случае успеха **Success 200** 994 + 995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 996 + 997 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 998 + 999 +(% class="box infomessage" %) 1000 +((( 1001 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 1002 +))) 1003 + 1004 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 1005 + 1006 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 1007 + 1008 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 1009 + 1010 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 1011 + 1012 +(% style="color:#000000" %)Метод запроса: **GET** 1013 + 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} 1015 + 1016 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 1017 + 1018 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1019 + 1020 +(% style="color:#000000" %)Ответ: 1021 + 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 + } 1049 + 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" ~/~/ Дата пересчета последних моточасов 209 209 }, 210 - ...}}} 211 211 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 + }, 1083 + 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 + ] 212 212 } 1178 +))) 213 213 214 -Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется» 1180 +(% style="text-align:left" %) 1181 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 215 215 216 - **Добавление пользователя** 1183 +(% style="text-align:left" %) 1184 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 217 217 218 -Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 219 219 220 - Методзапроса:POST1187 +== **Отправить команду на терминал** == 221 221 222 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 1189 +(% class="box successmessage" %) 1190 +((( 1191 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1192 +))) 223 223 224 - В заголовках запроса:X-Auth:Токен авторизации1194 +Команда для отправки на тс. 225 225 226 -Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] } 1196 +{ 1197 +"id": "", ~/~/идентификатор произвольного поля 1198 +"command": "", ~/~/ Текст команды 1199 +"retries": "", ~/~/ Количество попыток 1200 +"idTemplate": "" ~/~/ ID шаблона команды 1201 +} 227 227 228 -Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 229 229 230 - Редактированиепользователя**1204 +== **Получить ответ на отправленную на ТС команду** == 231 231 232 -Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 1206 +(% class="box infomessage" %) 1207 +((( 1208 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1209 +))) 233 233 234 - Метод запроса:PUT1211 +Идентификатор команды: cmdid 235 235 236 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]1213 +Запрос от терминала на ответ команды 237 237 238 - Взаголовкахзапроса:X-Auth: Токен авторизации1215 +Пример ответ от терминала: 239 239 240 -Параметры в теле запроса (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» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 1217 +ID= "" ~/~/ идентификатор произвольного поля 1218 +Soft="" ~/~/ версия софта 1219 +GPS=4 ~/~/ тип трекера 1220 +Time=11:05:43 28.06.24 ~/~/ время запроса 1221 +Lat=45.056221 ~/~/ широта 1222 +Lon=39.035938 ~/~/ долгота 1223 +Speed=0.0 ~/~/ скорость 1224 +Course=181.4 ~/~/направление 241 241 242 - {{{ "description": "", // описание243 - "data": "" // данные, связанныесосменойстатуса}}}1226 +((( 1227 +== **Список отправленных объекту команд с ответами** == 244 244 1229 +(% class="box infomessage" %) 1230 +((( 1231 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1232 +))) 1233 + 1234 +Идентификатор ТС: vehicleId 1235 + 1236 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1237 + 1238 +Пример ответа терминала 1239 + 1240 +[ 1241 +{ 1242 +"id": "", ~/~/ идентификатор пользователя 1243 +"commandText": "", ~/~/Текст команды. 1244 +"templateId": "", ~/~/Идентификатор шаблона 1245 +"updated": "", ~/~/ Время отправки 1246 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1247 +"answer": "", ~/~/ Ответ терминала. 1248 +"status": "" ~/~/ Статус отправки 245 245 } 1250 +] 1251 +))) 246 246 247 - Ответ:Вслучаеуспешноговыполнения запроса вернетсяHTTPответ«200»1253 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 248 248 249 - **Удаление пользователя** 1255 +(% class="box successmessage" %) 1256 +((( 1257 +(% lang="en-US" %)**POST /api/v3/vehicles** 1258 +))) 250 250 251 - Методпозволяетудалить пользователя.Метод позволяетудалитьпользователя, указанного в строке запроса (обязательныйпараметрв заголовках запроса - токен авторизации «X-Auth»)1260 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 252 252 253 -Метод запроса: DELETE1262 +(% style="color:#000000" %)Метод запроса: **POST** 254 254 255 -URL запроса: users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}1264 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 256 256 257 - Параметрзапроса:{id} - Guid пользователяВ заголовках запроса: X-Auth: Токен авторизации1266 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 258 258 259 - Ответ:ВслучаеуспешноговыполнениязапросавернетсяHTTPответ«200»1268 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 260 260 261 - **Добавление объекта** 1270 +(% style="color:#000000" %){(%%) 1271 + "parentId": "" , ~/~/ ID клиента 1272 + "name": "" , ~/~/ имя ТС 1273 + "imei": "" , ~/~/ IMEI 1274 + "deviceTypeId": "" , ~/~/ ID типа устройства 1275 + "modelId": "" , ~/~/ ID модели 1276 + "unitId": "" , ~/~/ ID подразделения 1277 + "sim1": "" , ~/~/ Номер SIM 1 1278 + "sim2": "" , ~/~/ Номер SIM2 1279 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1280 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1281 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1282 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1283 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1284 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1285 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1286 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1287 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1288 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1289 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1290 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1291 + "mileageCalcMethod": 0, 1292 + "mileageCoeff": 0, 1293 + "locationByCellId": true, 1294 + "dottedLineTrackWhenNoCoords": true, 1295 + "counters": ~/~/ счетчики 1296 + { 1297 + "mileage": "" , ~/~/ пробег 1298 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1299 + "motohours": "" , ~/~/ моточасы 1300 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1301 + }, 1302 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1303 + "enabled": true, ~/~/ флаг включения 1304 + "id": "" , ~/~/ идентификатор 1305 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1306 + "login": "" , ~/~/ имя учетной записи 1307 + "password": "" ~/~/ пароль учетной записи 1308 + }, 1309 + "inspectionTasks": ~/~/ задания на ТО 1310 + { 1311 + "enabled": "" , ~/~/ Признак включения 1312 + "name": "" , ~/~/ Имя задания 1313 + "description": "" , ~/~/ Описание задания 1314 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1315 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1316 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1317 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1318 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1319 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1320 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1321 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1322 + } 1323 +"drivers": [ ~/~/ Водители 1324 + { 1325 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1326 + "isDefault": true 1327 + } 1328 + ], 1329 + "commandTemplates": [ ~/~/ Шаблон команды 1330 + { 1331 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1332 + "name": "string", 1333 + "command": "string", 1334 + "retries": 0 1335 + } 1336 + ], 1337 +"sensors": [ ~/~/ Датчики 1338 + { 1339 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1340 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1341 + "type": 0, ~/~/ Тип датчика 1342 + "name": "string", ~/~/ Имя датчика 1343 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1344 + "inputNumber": 0, ~/~/ Номер входа 1345 + "pseudonym": "string", ~/~/ Псевдоним 1346 + "medianDegree": 0, ~/~/ Медианная фильтрация 1347 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1348 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1349 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1350 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1351 + { 1352 + "grades": [ ~/~/ Таблица тарировки 1 1353 + { 1354 + "input": 0, ~/~/ Входящее значение 1355 + "output": 0 ~/~/ Выходящее значение 1356 + } 1357 + ], 1358 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1359 + } 1360 + ], 1361 + "showInTooltip": true, ~/~/ Отображать в подсказке 1362 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1363 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1364 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1365 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1366 + "expr": "string", ~/~/ Формула 1367 + "children": [ ~/~/ массив дочерних датчиков 1368 + "string" 1369 + ], 1370 + "customParams": { ~/~/ прочие произвольные параметры 1371 + "additionalProp1": "string", 1372 + "additionalProp2": "string", 1373 + "additionalProp3": "string" 1374 + }, 1375 +~/~/ Характерные для произвольного: 1376 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1377 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1378 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1379 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1380 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1381 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1382 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1383 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1384 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1385 +~/~/ "ValueOn": "Вкл.", 1386 +~/~/ "ValueOff": "Выкл." 1387 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 262 262 263 -Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8) 1389 +((( 1390 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1391 + { 1392 + "from": 0, ~/~/ С какого значения 1393 + "color": "string", ~/~/ Каким цветом 1394 + "text": "string" ~/~/ Текст подписи к этому интервалу 1395 + } 1396 + ] 1397 + } 1398 + ], 1399 +))) 264 264 265 - Методзапроса:POST1401 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 266 266 267 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 268 268 269 -В заголовках запроса: X-Auth: Токен авторизации 1404 + "customFields": [ ~/~/ Произвольные поля 1405 + { 1406 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1407 + "name": "string", ~/~/ Наименование произвольного поля 1408 + "value": "string", ~/~/ Значение произвольного поля 1409 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1410 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1411 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1412 + } 1413 + ] 1414 +} 270 270 271 - Параметрывтеле запроса (JSON): //Обязательные параметры наименованиеи модель объекта //В теле запроса - объект JSON {1416 +(% style="color:#000000" %)Ответ: 272 272 273 -{{{ "parentId": "", // ID клиента 274 - "name": "", // имя ТС 275 - "imei": "", // IMEI 276 - "deviceTypeId": "",// ID типа устройства 277 - "modelId": "", 278 - "unitId": "", // ID подразделения 279 - "sim1": "", // Номер SIM 1 280 - "sim2": "", // Номер SIM2 281 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 282 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 283 - "consumptionIdle": "",// Расход топлива на холостом ходу 284 - "counters": { 285 - "mileage": "", // пробег 286 - "mileageEnabled": true, // флаг активности счётчика "пробег" 287 - "motohours":"", // моточасы 288 - "motohoursEnabled": true // флаг активности счётчика "моточасы" 1418 + 1419 +((( 1420 +((( 1421 +((( 1422 +{ 1423 + "vehicleId": 0, ~/~/ ID ТС 1424 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1425 + "name": "string", ~/~/ Имя объекта 1426 + "imei": "string", ~/~/ IMEI 1427 + "deviceTypeId": 0, ~/~/ ID типа устройства 1428 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1429 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1430 + "sim1": "string", ~/~/ SIM1 1431 + "sim2": "string", ~/~/ SIM2 1432 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1433 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1434 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1435 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1436 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1437 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1438 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1439 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1440 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1441 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1442 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1443 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1444 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1445 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1446 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1447 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1448 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1449 + "counters": { ~/~/ Dto для состояний счётчиков 1450 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1451 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1452 + "mileage": 0, ~/~/ Пробег 1453 + "motohours": 0 ~/~/ Моточасы 289 289 }, 290 - "cmsv6Parameters": { // параметры CMSv6 291 - "enabled": true, // флаг включения 292 - //"id": "", // идентификатор 293 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 294 - "login": "", // имя учетной записи 295 - "password": "" // пароль учетной записи 1455 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1456 + "id": "string", ~/~/ CMSV6 Идентификатор 1457 + "enabled": true, ~/~/ Признак включения 1458 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1459 + "login": "string", ~/~/ CMSV6 имя учетной записи 1460 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1461 + }, 1462 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1463 + { 1464 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1465 + "enabled": true, ~/~/ Признак включения 1466 + "name": "string", ~/~/ Имя задания 1467 + "description": "string", ~/~/ Описание задания 1468 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1469 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1470 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1471 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1472 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1473 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1474 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1475 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1476 + } 1477 + ], 1478 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1479 + { 1480 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1481 + "inputNumber": 0, ~/~/ № входа. 1482 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1483 + "comment": "string", ~/~/ Комментарий 1484 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1485 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1486 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1487 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1488 + } 1489 + ], 1490 + "commandTemplates": [ ~/~/ Список шаблонов команд 1491 + { 1492 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1493 + "name": "string", ~/~/ Название шаблона команд 1494 + "command": "string", ~/~/ Команда на выполнение 1495 + "retries": 0 ~/~/ Лимит попыток отправки 1496 + } 1497 + ], 1498 + "sensors": [ ~/~/ Список датчиков 1499 + { 1500 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1501 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1502 + "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 1503 + "name": "string", ~/~/ Имя датчика 1504 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1505 + "inputNumber": 0, ~/~/ Номер входа 1506 + "pseudonym": "string", ~/~/ Псевдоним 1507 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1508 + "isInverted": true, ~/~/ Признак инверсии 1509 + "disabled": true, ~/~/ Датчик не участвует в обработке 1510 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1511 + "gradesTables": [ ~/~/ Тарировка 1512 + { 1513 + "grades": [ ~/~/ Таблицы тарировки 1514 + { 1515 + "input": 0, ~/~/ Вход 1516 + "output": 0 ~/~/ Выход 1517 + } 1518 + ], 1519 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1520 + } 1521 + ], 1522 + "showInTooltip": true, ~/~/ Отображение в подсказке 1523 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1524 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1525 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1526 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1527 + "expr": "string", ~/~/ Выражение 1528 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1529 + "string" 1530 + ], 1531 + "customParams": { 1532 + "additionalProp1": "string", 1533 + "additionalProp2": "string", 1534 + "additionalProp3": "string" 296 296 }, 297 - "inspectionTasks": [ // задания на ТО 1536 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1537 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1538 + { 1539 + "from": 0, ~/~/ С какого значения 1540 + "color": "string", ~/~/ Каким цветом 1541 +))) 1542 + 1543 +((( 1544 + "text": "string" ~/~/ Текст подписи к этому интервалу 1545 + } 1546 + ] 1547 + } 1548 + ], 1549 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1550 + "customFields": [ ~/~/ Список произвольных полей 1551 + { 1552 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1553 + "name": "string", ~/~/ Наименование произвольного поля 1554 + "value": "string", ~/~/ Значение произвольного поля 1555 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1556 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1557 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1558 + } 1559 + ], 1560 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1561 +} 1562 +))) 1563 +))) 1564 +))) 1565 + 1566 + 1567 +**Валидация:** 1568 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1569 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1570 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1571 + 1572 + 1573 +== **Импортировать историю ТС (Асинхронный запрос)** == 1574 + 1575 +(% class="box successmessage" %) 1576 +((( 1577 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1578 +))) 1579 + 1580 +Метод запроса: **POST** 1581 + 1582 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1583 + 1584 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1585 + 1586 + 1587 +Ответ: 1588 + 1589 +{ 1590 + 1591 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1592 + 1593 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1594 + 1595 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1596 + 1597 + "Message": "string", ~/~/ Информация о выполнении запроса 1598 + 1599 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1600 + 1601 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1602 + 1603 + "Data": "string" ~/~/ Данные 1604 + 1605 +} 1606 + 1607 + 1608 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1609 + 1610 +(% class="box infomessage" %) 1611 +((( 1612 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1613 +))) 1614 + 1615 +Метод запроса: **GET** 1616 + 1617 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1618 + 1619 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1620 + 1621 + 1622 +Ответ: 1623 + 1624 +{ 1625 + 1626 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1627 + 1628 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1629 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1630 + 1631 + "Message": "string", ~/~/ Информация о выполнении запроса 1632 + 1633 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1634 + 1635 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1636 + 1637 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1638 + 1639 + "Data": "string" ~/~/ Данные 1640 + 1641 +} 1642 + 1643 + 1644 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1645 + 1646 +(% class="box infomessage" %) 1647 +((( 1648 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 1649 +))) 1650 + 1651 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1652 + 1653 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1654 + 1655 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 1656 + 1657 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 1658 + 1659 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 1660 + 1661 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 1662 + 1663 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 1664 + 1665 +(% style="color:#000000" %)Метод запроса: **POST** 1666 + 1667 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 1668 + 1669 +(% style="color:#000000" %)В заголовках запроса: 1670 + 1671 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 1672 + 1673 +(% style="color:#000000" %)− X-Auth: Токен авторизации 1674 + 1675 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 1676 + 1677 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 1678 + 1679 +{ 1680 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1681 + "name": null, ~/~/ Имя ТС (string, опционально) 1682 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1683 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1684 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1685 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1686 + "unitName": "string", ~/~/ Название подразделения (опционально) 1687 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1688 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1689 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1690 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1691 +} 1692 + 1693 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 1694 + 1695 +(% style="color:#000000" %)Ответ: 1696 + 1697 +(% style="color:#000000" %)[ 1698 +{ 1699 + 1700 +((( 1701 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1702 +))) 1703 + 1704 +((( 1705 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1706 + "name": "" ~/~/ наименование объекта 1707 + "imei": "" ~/~/ IMEI объекта 1708 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 1709 + "deviceTypeName": "" ~/~/ наименование типа устройства 1710 + "sim1": "" ~/~/ первый номер телефона 1711 + "sim2": "" ~/~/ второй номер телефона 1712 + "parentId": "" ~/~/ идентификатор клиента-родителя 1713 + "parentName": "" ~/~/ наименование клиента-родителя 1714 + "modelId": "" ~/~/ идентификатор модели объекта 1715 + "modelName": "" ~/~/ наименование модели объекта 1716 + "unitId": "" ~/~/ идентификатор подразделения 1717 + "unitName": "" ~/~/ наименование подразделения 1718 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1719 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1720 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1721 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1722 + "customFields": [ 1723 + { 1724 + "id": "", ~/~/ идентификатор произвольного поля 1725 + "name": "", ~/~/ имя произвольного поля 1726 + "value": "", ~/~/ значение произвольного поля 1727 + "forClient": true, ~/~/ право на отображение у клиента 1728 + "forTooltip": false, ~/~/ право на отображение в подсказке 1729 + "forReport": false ~/~/ право на отображение в отчетах 1730 +))) 1731 + 1732 +((( 1733 + } 1734 + ], 1735 + "vehicleGroups": [ ~/~/ Группы ТС 298 298 { 299 - "enabled": "", // Признак включения 300 - "name": "", // Имя задания 301 - "description": "", // Описание задания 302 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 303 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 304 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 305 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 306 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 307 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 308 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 309 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 1737 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1738 + "name": "string" ~/~/ Наименование группы ТС 1739 + } 1740 + ] 1741 + } 1742 +] 1743 +))) 1744 + 1745 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1746 + 1747 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 1748 + 1749 +(% class="box successmessage" %) 1750 +((( 1751 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 1752 +))) 1753 + 1754 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 1755 + 1756 +(% style="color:#000000" %)Метод запроса: **POST** 1757 + 1758 +(% 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} 1759 + 1760 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 1761 + 1762 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1763 + 1764 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 1765 + 1766 +(% style="color:#000000" %){ 1767 + 1768 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1769 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1770 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1771 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1772 + "description": "", ~/~/ Описание 1773 + "data": "", ~/~/ Данные 1774 + "overwrite": false, ~/~/ Флаг перезаписи 1775 + "stage": "", ~/~/ Состояние, может быть null 1776 +(% style="color:#000000" %)} 1777 + 1778 +(% style="color:#000000" %)Ответ: 1779 + 1780 +(% style="color:#000000" %){(%%) 1781 + "status": "", ~/~/ значение статуса 1782 + "date": "", ~/~/ Дата смены статуса 1783 + "description": "", ~/~/ Описание 1784 + "data": "", ~/~/ Данные 1785 + "overwrite": false, ~/~/ Флаг перезаписи 1786 + "stage": "", ~/~/ Состояние 1787 +(% style="color:#000000" %) } 1788 + 1789 +== == 1790 + 1791 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1792 + 1793 +(% class="box warningmessage" %) 1794 +((( 1795 +(% lang="en-US" %)**PUT /api/v3/vehicles** 1796 +))) 1797 + 1798 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 1799 + 1800 +(% style="color:#000000" %)Метод запроса: **PUT** 1801 + 1802 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 1803 + 1804 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1805 + 1806 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 1807 + 1808 +(% style="color:#000000" %){ 1809 + "vehicleId": , ~/~/ ID объекта 1810 + "parentId": "" , ~/~/ ID клиента 1811 + "name": "" , ~/~/ имя ТС 1812 + "imei": "" , ~/~/ IMEI 1813 + "deviceTypeId": "" , ~/~/ ID типа устройства 1814 + "modelId": "" , ~/~/ ID модели 1815 + "unitId": "" , ~/~/ ID подразделения 1816 + "sim1": "" , ~/~/ Номер SIM 1 1817 + "sim2": "" , ~/~/ Номер SIM2 1818 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1819 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1820 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1821 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1822 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1823 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1824 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1825 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1826 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1827 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1828 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1829 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1830 + 1831 + "mileageCalcMethod": 0, 1832 + "mileageCoeff": 0, 1833 + "locationByCellId": true, 1834 + "dottedLineTrackWhenNoCoords": true, 1835 + "counters": ~/~/ счетчики 1836 + { 1837 + "mileage": "" , ~/~/ пробег 1838 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1839 + "motohours": "" , ~/~/ моточасы 1840 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 310 310 }, 311 - ]}}} 1842 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1843 + "enabled": true, ~/~/ флаг включения 1844 + "id": "" , ~/~/ идентификатор 1845 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1846 + "login": "" , ~/~/ имя учетной записи 1847 + "password": "" ~/~/ пароль учетной записи 1848 + }, 1849 + "inspectionTasks": ~/~/ задания на ТО 1850 + { 1851 + "enabled": "" , ~/~/ Признак включения 1852 + "name": "" , ~/~/ Имя задания 1853 + "description": "" , ~/~/ Описание задания 1854 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1855 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1856 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1857 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1858 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1859 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1860 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1861 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1862 + } 312 312 313 -… } 1864 +"drivers": [ ~/~/ Водители 1865 + { 1866 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1867 + "isDefault": true 1868 + } 1869 + ], 1870 + "commandTemplates": [ ~/~/ Шаблон команды 1871 + { 1872 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1873 + "name": "string", 1874 + "command": "string", 1875 + "retries": 0 1876 + } 1877 + ], 1878 +"sensors": [ ~/~/ Датчики 1879 + { 1880 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1881 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1882 + "type": 0, ~/~/ Тип датчика 1883 + "name": "string", ~/~/ Имя датчика 1884 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1885 + "inputNumber": 0, ~/~/ Номер входа 1886 + "pseudonym": "string", ~/~/ Псевдоним 1887 + "medianDegree": 0, ~/~/ Медианная фильтрация 1888 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1889 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1890 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1891 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1892 + { 1893 + "grades": [ ~/~/ Таблица тарировки 1 1894 + { 1895 + "input": 0, ~/~/ Входящее значение 1896 + "output": 0 ~/~/ Выходящее значение 1897 + } 1898 + ], 1899 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1900 + } 1901 + ], 1902 + "showInTooltip": true, ~/~/ Отображать в подсказке 1903 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1904 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1905 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1906 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1907 + "expr": "string", ~/~/ Формула 1908 + "children": [ ~/~/ массив дочерних датчиков 1909 + "string" 1910 + ], 1911 + "customParams": { ~/~/ прочие произвольные параметры 1912 + "additionalProp1": "string", 1913 + "additionalProp2": "string", 1914 + "additionalProp3": "string" 1915 + }, 1916 +~/~/ Характерные для произвольного: 1917 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1918 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1919 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1920 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1921 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1922 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1923 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1924 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1925 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1926 +~/~/ "ValueOn": "Вкл.", 1927 +~/~/ "ValueOff": "Выкл." 1928 + "summaryMaxValue": 0 ~/~/ Макс. значение 314 314 315 -Ответ: 1930 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1931 + { 1932 + "from": 0, ~/~/ С какого значения 1933 + "color": "string", ~/~/ Каким цветом 1934 + "text": "string" ~/~/ Текст подписи к этому интервалу 1935 + } 1936 + ] 1937 + } 1938 + ], 1939 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 316 316 1941 + "customFields": [ ~/~/ Произвольные поля 1942 + { 1943 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1944 + "name": "string", ~/~/ Наименование произвольного поля 1945 + "value": "string", ~/~/ Значение произвольного поля 1946 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1947 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1948 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1949 + } 1950 + ] 1951 +} 1952 + 1953 + 1954 +(% style="color:#000000" %)Ответ: 1955 + 1956 +((( 317 317 { 1958 + "vehicleId": 0, ~/~/ ID ТС 1959 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1960 + "name": "string", ~/~/ Имя объекта 1961 + "imei": "string", ~/~/ IMEI 1962 + "deviceTypeId": 0, ~/~/ ID типа устройства 1963 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1964 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1965 + "sim1": "string", ~/~/ SIM1 1966 + "sim2": "string", ~/~/ SIM2 1967 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1968 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1969 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1970 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1971 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1972 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1973 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1974 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1975 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1976 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1977 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1978 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1979 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1980 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1981 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1982 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1983 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1984 + "counters": { ~/~/ состояний счётчиков 1985 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1986 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1987 + "mileage": 0, ~/~/ Пробег 1988 + "motohours": 0 ~/~/ Моточасы 1989 + }, 1990 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1991 + "id": "string", ~/~/ CMSV6 Идентификатор 1992 + "enabled": true, ~/~/ Признак включения 1993 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1994 +))) 318 318 319 -{{{ "vehicleId": "", //ID ТС 320 - "parentId": "", //Guid владельца ТС 321 - "name": "", //Имя объекта 322 - "imei": "", //IMEI 323 - "deviceTypeId": "", //ID типа устройства 324 - "modelId": "", //ID модели 325 - "unitId": "", //ID подразделения 326 - "sim1": "", //SIM1 327 - "sim2": "", //SIM2 328 - "consumptionPer100Km": "", //Расход топлива на 100 км 329 - "consumptionIdle": "", //Расход топлива на холостом ходу 330 - "counters": { //Счётчики 331 - "mileageEnabled": true, 332 - "motohoursEnabled": true, 333 - "mileage": "", 334 - "motohours": 345.0 1996 + 1997 +((( 1998 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1999 + "login": "string", ~/~/ CMSV6 имя учетной записи 2000 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 335 335 }, 336 - "cmsv6Parameters": { //Параметры CmsV6 337 - "id": null, 338 - "enabled": true, //флаг включения 339 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 340 - "login": "", // имя учетной записи 341 - "password": "" // пароль учетной записи 342 - }, 343 - "inspectionTasks": [ // задания на ТО 2002 + "inspectionTasks": [ ~/~/ Задания на ТО 2003 + { 2004 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2005 + "enabled": true, ~/~/ Признак включения 2006 + "name": "string", ~/~/ Имя задания 2007 + "description": "string", ~/~/ Описание задания 2008 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2009 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2010 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2011 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2012 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2013 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2014 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2015 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2016 + } 2017 + ], 2018 + "drivers": [ ~/~/ Список водителей 2019 + { 2020 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2021 + "inputNumber": 0, ~/~/ № входа. 2022 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2023 + "comment": "string", ~/~/ Комментарий. 2024 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2025 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2026 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2027 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2028 + } 2029 + ], 2030 + "commandTemplates": [ ~/~/ Список шаблонов команд 2031 + { 2032 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2033 + "name": "string", ~/~/ Название шаблона команд 2034 + "command": "string", ~/~/ Команда на выполнение 2035 + "retries": 0 ~/~/ Лимит попыток отправки 2036 + } 2037 + ], 2038 + "sensors": [ ~/~/ Список датчиков 2039 + { 2040 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2041 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2042 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2043 +))) 2044 + 2045 +((( 2046 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2047 +))) 2048 + 2049 +((( 2050 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2051 +))) 2052 + 2053 +((( 2054 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2055 +))) 2056 + 2057 +((( 2058 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2059 +))) 2060 + 2061 +((( 2062 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2063 + "name": "string", ~/~/ Имя датчика 2064 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2065 +))) 2066 + 2067 +((( 2068 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2069 + "inputNumber": 0, ~/~/ Номер входа 2070 + "pseudonym": "string", ~/~/ Псевдоним 2071 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2072 + "isInverted": true, ~/~/ Признак инверсии 2073 + "disabled": true, ~/~/ Датчик не участвует в обработке 2074 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2075 + "gradesTables": [ ~/~/ Тарировка 2076 + { 2077 + "grades": [ ~/~/ Таблицы тарировки 2078 + { 2079 + "input": 0, ~/~/ Вход 2080 + "output": 0 ~/~/ Выход 2081 + } 2082 + ], 2083 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 2084 + } 2085 + ], 2086 + "showInTooltip": true, ~/~/ Отображение в подсказке 2087 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 2088 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2089 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2090 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2091 + "expr": "string", ~/~/ Выражение 2092 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2093 + "string" 2094 + ], 2095 + "customParams": { ~/~/ Дополнительные настройки 2096 + "additionalProp1": "string", 2097 + "additionalProp2": "string", 2098 + "additionalProp3": "string" 2099 + }, 2100 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2101 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2102 + { 2103 + "from": 0, ~/~/ С какого значения 2104 + "color": "string", ~/~/ Каким цветом 2105 + "text": "string" ~/~/ Текст подписи к этому интервалу 2106 + } 2107 + ] 2108 + } 2109 + ], 2110 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2111 + "customFields": [ ~/~/ Список произвольных полей 2112 + { 2113 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2114 + "name": "string", ~/~/ Наименование произвольного поля 2115 + "value": "string", ~/~/ Значение произвольного поля 2116 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2117 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2118 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2119 + } 2120 + ], 2121 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2122 +} 2123 +))) 2124 + 2125 +**Валидация:** 2126 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 2127 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 2128 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 2129 + 2130 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 2131 + 2132 +(% class="box errormessage" %) 2133 +((( 2134 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 2135 +))) 2136 + 2137 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 2138 + 2139 +(% style="color:#000000" %)Метод запроса: **DELETE** 2140 + 2141 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 2142 + 2143 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 2144 + 2145 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2146 + 2147 +(% style="text-align:left" %) 2148 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 2149 + 2150 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 2151 + 2152 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 2153 + 2154 +(% class="box infomessage" %) 2155 +((( 2156 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 2157 +))) 2158 + 2159 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 2160 + 2161 +(% style="color:#000000" %)Метод запроса: **GET** 2162 + 2163 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 2164 + 2165 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2166 + 2167 +(% style="color:#000000" %)Ответ: 2168 + 2169 +(% style="color:#000000" %){(%%) 2170 + "deviceTypeId" : "", ~/~/ ID типа устройства 2171 + "deviceTypeName" : "" ~/~/ Название типа устройства 2172 +(% style="color:#000000" %)} 2173 + 2174 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 2175 + 2176 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 2177 + 2178 +(% class="box infomessage" %) 2179 +((( 2180 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 2181 +))) 2182 + 2183 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 2184 + 2185 +(% style="color:#000000" %)Метод запроса: **GET** 2186 + 2187 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 2188 + 2189 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2190 + 2191 +(% style="color:#000000" %)Ответ: 2192 + 2193 +(% style="color:#000000" %){(%%) 2194 + "id": "", ~/~/ ID типа датчика 2195 + "name": "", ~/~/ Название 2196 + "description": "", ~/~/ Описание 2197 +(% style="color:#000000" %)} 2198 + 2199 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 2200 + 2201 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 2202 + 2203 +(% class="box infomessage" style="text-align: left;" %) 2204 +((( 2205 +**POST /api/v3/terminalMessages/count** 2206 +))) 2207 + 2208 +(% style="text-align: left;" %) 2209 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 2210 + 2211 +(% style="text-align: left;" %) 2212 +Метод запроса **POST** 2213 + 2214 +(% style="text-align: left;" %) 2215 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 2216 + 2217 +(% style="text-align: left;" %) 2218 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2219 + 2220 +(% style="text-align: left;" %) 2221 +{ 2222 + "vehicleIds": [ 2223 + id ~/~/ здесь передается список идентификаторов объектов 2224 + ], 2225 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 2226 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 2227 +} 2228 + 2229 +(% style="text-align: left;" %) 2230 +Ответ: 2231 + 2232 +(% style="text-align: left;" %) 2233 +[ 2234 + { 2235 + "vehicleId": 0, ~/~/ идентификатор объекта 2236 + "count": 0 ~/~/ количество сообщений за период 2237 + } 2238 +] 2239 + 2240 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2241 + 2242 +(% class="box infomessage" style="text-align: left;" %) 2243 +((( 2244 +**POST /api/v3/terminalMessages/mapping** 2245 +))) 2246 + 2247 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2248 + 2249 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2250 + 2251 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2252 + 2253 +{ 2254 + "protocolType": 0, 2255 + "params": ["string"] 2256 +} 2257 + 2258 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2259 +|protocolType|ID типа протокола 2260 +|params|((( 2261 +Массив наименований параметров в сообщении 2262 +))) 2263 + 2264 +Ответ: 2265 + 2266 +{ 2267 + "protocolType": 0, 2268 + "mapping": { 2269 + "additionalProp1": { 2270 + "inputType": 0, 2271 + "inputNumber": 0 2272 + }, 2273 + "additionalProp2": { 2274 + "inputType": 0, 2275 + "inputNumber": 0 2276 + } 2277 + } 2278 +} 2279 + 2280 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2281 +|protocolType|Тип протокола 2282 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2283 +|inputNumber|((( 2284 +Номер входа 2285 +))) 2286 + 2287 +(% class="wikigeneratedid" %) 2288 +Перечень 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/]] 2289 + 2290 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 2291 + 2292 +(% class="box infomessage" %) 2293 +((( 2294 +**POST /api/v3/terminalMessages** 2295 +))) 2296 + 2297 +Метод возвращает список сообщений терминала объекта за выбранный период. 2298 + 2299 +(% style="text-align: left;" %) 2300 +Метод запроса **POST** 2301 + 2302 +(% style="text-align: left;" %) 2303 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2304 + 2305 +(% style="text-align: left;" %) 2306 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2307 + 2308 +{ 2309 + "vehicleId": 0, ~/~/ id объекта 2310 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 2311 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 2312 +} 2313 + 2314 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2315 +|vehicleId|ID объекта 2316 +|from|Дата и время начала периода запроса 2317 +|to|Дата и время окончания периода запроса 2318 + 2319 +Ответ: 2320 + 2321 +[ 2322 + { 2323 + "messages": [ 344 344 { 345 - "id": "", // ID задачи 346 - "enabled": false, // Признак включения 347 - "name": "", // Имя задания 348 - "description": "", // Описание задания 349 - "mileageCondition": "", // Условие по пробегу 350 - "lastMileage": "", // Пробег (в метрах) 351 - "motohoursCondition": "", // Условие по моточасам 352 - "lastMotohours": "", // Моточасы 353 - "periodicCondition": "", // Условие периодичности по времени}}} 2325 + "deviceTime": "2023-11-29T07:40:44.052Z", 2326 + "serverTime": "2023-11-29T07:40:44.052Z", 2327 + "speed": 0, 2328 + "altitude": 0, 2329 + "latitude": 0, 2330 + "longitude": 0, 2331 + "satellites": 0, 2332 + "course": 0, 2333 + "voltage": 0, 2334 + "parameters": { 2335 + "additionalProp1": "string", 2336 + "additionalProp2": "string", 2337 + "additionalProp3": "string" 2338 + }, 2339 + "photoCount": 0, 2340 + "lbsCorrectedCoords": true, 2341 + "protocolType": 0 2342 + } 2343 + ] 2344 + } 2345 +] 354 354 355 -{{{ "kind": "", // Вид периодичности по времени 356 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 2347 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2348 +|deviceTime|Время сообщения терминала 2349 +|serverTime|Время когда сообщение поступило на сервер 2350 +|speed|Скорость 2351 +|altitude|Высота над уровнем моря 2352 +|latitude|Широта 2353 +|longitude|Долгота 2354 +|satellites|Кол-во спутников 2355 +|course|Курс 2356 +|voltage|Бортовое напряжение 2357 +|parameters|Список параметров и их значений 2358 +|photoCount|Количество фото 2359 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2360 +|protocolType|ID типа протокола 2361 + 2362 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2363 + 2364 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2365 + 2366 +(% class="box infomessage" %) 2367 +((( 2368 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2369 +))) 2370 + 2371 +(% style="color:#000000" %)Метод запроса: **POST** 2372 + 2373 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2374 + 2375 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2376 + 2377 +(% style="text-align:left" %) 2378 +Тело запроса: 2379 + 2380 +{ 2381 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2382 + "vehicleIds": [0], ~/~/ Список ID объектов 2383 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2384 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2385 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2386 +} 2387 + 2388 +Ответ: 2389 + 2390 +[ 2391 + { 2392 + "vehicleId": 0, ~/~/ ID объекта 2393 + "name": "string", ~/~/ Имя ТС 2394 + "periods": [ ~/~/ Периоды 2395 + { 2396 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2397 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2398 + "mileage": 0, ~/~/ Пробег за период, километры 2399 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2400 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2401 + "motohours": 0, ~/~/ Моточасы за период, секунды 2402 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2403 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 357 357 } 358 - ]}}} 2405 + ] 2406 + } 2407 +] 359 359 2409 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2410 + 2411 +(% class="box infomessage" %) 2412 +((( 2413 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2414 +))) 2415 + 2416 +(% style="color:#000000" %)Метод запроса: **POST** 2417 + 2418 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2419 + 2420 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2421 + 2422 +(% style="text-align:left" %) 2423 +Тело запроса: 2424 + 2425 +{ 2426 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2427 + "vehicleIds": [0], ~/~/ Список ID объектов 2428 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2429 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2430 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 360 360 } 361 361 362 - **Удаление объекта**2433 +Ответ: 363 363 364 -Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 2435 +[ 2436 + { 2437 + "vehicleId": 0, ~/~/ ID объекта 2438 + "name": "string", ~/~/ Имя ТС 2439 + "periods": [ ~/~/ Периоды 2440 + { 2441 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2442 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2443 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2444 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2445 + "fuelConsumption": 0, ~/~/ Расход топлива 2446 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2447 + } 2448 + ] 2449 + } 2450 +] 365 365 366 -Метод запроса: DELETE 2452 +(% class="box warningmessage" %) 2453 +((( 2454 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2455 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2456 +))) 367 367 368 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}2458 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 369 369 370 -Параметр запроса: {id} - Guid объекта 2460 +(% class="box infomessage" %) 2461 +((( 2462 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2463 +))) 371 371 2465 +(% style="color:#000000" %)Метод запроса: **POST** 2466 + 2467 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2468 + 2469 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2470 + 2471 +(% style="text-align:left" %) 2472 +Тело запроса: 2473 + 2474 +{ 2475 + "vehicleIds": [0], ~/~/ Список ID объектов 2476 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2477 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2478 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2479 +} 2480 + 2481 +Ответ: 2482 + 2483 +[ 2484 + { 2485 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2486 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2487 + "vehicleId": 0, ~/~/ ID объекта 2488 + "name": "string", ~/~/ Имя объекта 2489 + "model": "string", ~/~/ Модель объекта 2490 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2491 + { 2492 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2493 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2494 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2495 + "valueFuel": 0, ~/~/ Количество 2496 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2497 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2498 + } 2499 + ] 2500 + } 2501 +] 2502 + 2503 + 2504 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2505 + 2506 +(% class="box infomessage" %) 2507 +((( 2508 +**POST /api/v3/vehicles/moveStop** 2509 +))) 2510 + 2511 +Метод запроса: **POST** 2512 + 2513 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2514 + 372 372 В заголовках запроса: X-Auth: Токен авторизации 373 373 374 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 375 375 376 - **Редактирование объекта**2518 +Тело запроса: 377 377 378 -Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 2520 +{ 2521 + "vehicleIds": [ ], ~/~/ Список ID объектов 2522 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2523 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2524 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2525 +} 379 379 380 - Метод запроса:PUT2527 +Ответ: 381 381 382 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 2529 +[ 2530 + { 2531 + "vehicleId": 0, ~/~/ ID объекта 2532 + "vehicleName": "string", ~/~/ Имя объекта 2533 + "moves": [ ~/~/ Событие движения 2534 + { 2535 + "mileage": 0, ~/~/ Пробег, км 2536 + "eventId": 0, ~/~/ Идентификатор события 2537 + "eventName": "string", ~/~/ Название события 2538 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2539 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2540 + "duration": 0 ~/~/ Продолжительность события, секунд 2541 + } 2542 + ], 2543 + "stops": [ ~/~/ События стоянок 2544 + { 2545 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2546 + "eventId": 0, ~/~/ Идентификатор события 2547 + "eventName": "string", ~/~/ Название события 2548 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2549 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2550 + "duration": 0 ~/~/ Продолжительность события, секунд 2551 + } 2552 + ] 2553 + } 2554 +] 383 383 2556 + 2557 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2558 + 2559 +(% class="box infomessage" %) 2560 +((( 2561 +**POST /api/v3/vehicles/getlastdata** 2562 +))) 2563 + 2564 +Метод запроса: **POST** 2565 + 2566 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2567 + 384 384 В заголовках запроса: X-Auth: Токен авторизации 385 385 386 -Параметры в теле запроса (JSON): 387 387 388 - //Обязательные параметры наименование и модель объекта //В теле запроса- объект 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»: «» //Сколько развыполнитьзадание } ] }2571 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 389 389 390 390 Ответ: 2574 + { 2575 + "vehicleId": 0, ~/~/Идентификатор объекта. 2576 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2577 + "vehicleNumber": "string",~/~/Номер объекта. 2578 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2579 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2580 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2581 + "speed": 0,~/~/Скорость объекта. 2582 + "course": 0,~/~/Курс движения [0;360] 2583 + "latitude": 0,~/~/Широта [-90°;90°]. 2584 + "longitude": 0,~/~/Долгота [-180°;180°]. 2585 + "address": "string",~/~/Адрес. 2586 + "geozones": [ ~/~/Сведения по геозонам. 2587 + { 2588 + "id": 0, 2589 + "name": "string" 2590 + } 2591 + 391 391 392 - {«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»: «» //Сколько развыполнитьзадание } ] }2593 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 393 393 394 - Изменение статуса объекта**2595 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 395 395 396 -Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 2597 +(% class="box infomessage" %) 2598 +((( 2599 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2600 +))) 397 397 398 -Метод з апроса:POST2602 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 399 399 400 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}2604 +(% style="color:#000000" %)Метод запроса: **POST** 401 401 402 - Параметрзапроса:{vehicleId} - ID ТС2606 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 403 403 2608 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2609 + 2610 +(% style="text-align:left" %) 2611 +Тело запроса: 2612 + 2613 +(% style="text-align:left" %) 2614 +{ 2615 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2616 +} 2617 + 2618 +(% style="text-align:left" %) 2619 +Ответ: 2620 + 2621 +[ 2622 + { 2623 + "id": 0, ~/~/ Идентификатор объекта геозоны 2624 + "name": "string", ~/~/ Название объекта геозоны 2625 + "type": 0, ~/~/ Тип объекта геозоны 2626 + "fname": "string", ~/~/ Имя файла 2627 + "parentId": "string", ~/~/ Идентификатор клиента 2628 + "radius": 0, ~/~/ Радиус геообъекта 2629 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2630 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2631 + "description": "string", ~/~/ Описание 2632 + "area": 0, ~/~/ Площадь, м^^2^^ 2633 + "perimetr": 0, ~/~/ Периметр, м 2634 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2635 + } 2636 +] 2637 + 2638 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2639 + 2640 +(% class="box infomessage" %) 2641 +((( 2642 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2643 +))) 2644 + 2645 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2646 + 2647 +(% style="color:#000000" %)Метод запроса: **POST** 2648 + 2649 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2650 + 2651 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2652 + 2653 +(% style="text-align:left" %) 2654 +Тело запроса: 2655 + 2656 +{ 2657 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2658 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2659 + "ids": [ ], ~/~/ Массив id объектов 2660 + "byTime": 0, ~/~/ Объединение событий по времени 2661 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2662 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2663 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2664 +} 2665 + 2666 +Ответ: 2667 +[ 2668 + { 2669 + "geozoneId": 0, ~/~/ ID геообъекта 2670 + "geozoneName": "string", ~/~/ Название геообъекта 2671 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2672 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2673 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2674 + "vehicleId": 0, ~/~/ ID объекта 2675 + "vehicleName": "string" ~/~/ Имя объекта 2676 + } 2677 +] 2678 + 2679 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2680 + 2681 +(% class="box infomessage" %) 2682 +((( 2683 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2684 +))) 2685 + 2686 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2687 + 2688 +(% style="color:#000000" %)Метод запроса: **POST** 2689 + 2690 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2691 + 2692 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2693 + 2694 +(% style="text-align:left" %) 2695 +Тело запроса: 2696 + 2697 +{ 2698 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2699 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2700 + "ids": [ ], ~/~/ Массив id геообъектов 2701 + "byTime": 0, ~/~/ Объединение событий по времени 2702 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2703 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2704 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2705 +} 2706 + 2707 +Ответ: 2708 + 2709 +[ 2710 + { 2711 + "geozoneId": 0, ~/~/ ID геообъекта 2712 + "geozoneName": "string", ~/~/ Название геообъекта 2713 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2714 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2715 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2716 + "vehicleId": 0, ~/~/ ID объекта 2717 + "vehicleName": "string" ~/~/ Имя объекта 2718 + } 2719 +] 2720 + 2721 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2722 + 2723 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2724 + 2725 +(% class="box infomessage" %) 2726 +((( 2727 +**POST /api/v3/notifications/find** 2728 +))) 2729 + 2730 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2731 + 2732 +(% style="text-align: left;" %) 2733 +Метод запроса **POST** 2734 + 2735 +(% style="text-align: left;" %) 2736 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2737 + 2738 +(% style="text-align: left;" %) 2739 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2740 + 2741 +{ 2742 + "parentId": "" ~/~/ id клиента 2743 +} 2744 + 2745 +Ответ: 2746 + 2747 +[ 2748 + { 2749 + "id": 0, ~/~/ ID уведомления 2750 + "name": "string", ~/~/ Название уведомления 2751 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2752 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2753 + "userId": "", ~/~/ Пользователь, создавший уведомление 2754 + "parentId": "", ~/~/ Идентификатор клиента 2755 + "parentName": "string" ~/~/ Имя клиента 2756 + } 2757 +] 2758 + 2759 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2760 + 2761 +(% class="box infomessage" %) 2762 +((( 2763 +**GET /api/v3/notifications/{id}** 2764 +))) 2765 + 2766 +Метод возвращает данные правил формирования выбранного уведомления. 2767 + 2768 +(% style="text-align: left;" %) 2769 +Метод запроса **GET** 2770 + 2771 +(% style="text-align: left;" %) 2772 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2773 + 2774 +(% style="text-align: left;" %) 2775 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2776 + 2777 +(% style="text-align: left;" %) 2778 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2779 + 2780 +(% style="text-align: left;" %) 2781 +(% style="color:#000000" %)Ответ: 2782 + 2783 +(% style="text-align: left;" %) 2784 +(% style="color:#000000" %){ 2785 + "id": 0, ~/~/ (%%)id уведомления 2786 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2787 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2788 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2789 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2790 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2791 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2792 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2793 +(% style="color:#000000" %) 0 2794 + ], 2795 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2796 +(% style="color:#000000" %) 0 2797 + ], 2798 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2799 +(% style="color:#000000" %) 0 2800 + ], 2801 + "settings": { ~/~/ Список параметров уведомления 2802 + "additionalProp1": "string", 2803 + "additionalProp2": "string", 2804 + "additionalProp3": "string" 2805 + }, 2806 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2807 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2808 +(% style="color:#000000" %) "" 2809 + ], 2810 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2811 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2812 +(% style="color:#000000" %) "string" 2813 + ], 2814 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2815 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2816 +(% style="color:#000000" %) { 2817 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2818 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2819 +(% style="color:#000000" %) } 2820 + ], 2821 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2822 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2823 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2824 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2825 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2826 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2827 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2828 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2829 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2830 +(% style="color:#000000" %)} 2831 + 2832 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2833 + 2834 +(% class="box warningmessage" %) 2835 +((( 2836 +**PUT /api/v3/notifications/** 2837 +))) 2838 + 2839 +Метод позволяет отредактировать уведомление. 2840 + 2841 +Метод запроса **PUT** 2842 + 2843 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2844 + 404 404 В заголовках запроса: X-Auth: Токен авторизации 405 405 406 -Параметры в теле запроса (JSON): { 2847 +Тело запроса: 2848 +{ 2849 + "id": 0, ~/~/ id уведомления 2850 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2851 + "userId": "", ~/~/ Пользователь, создавший уведомление 2852 + "parentId": "", ~/~/ Идентификатор клиента 2853 + "parentName": "string", ~/~/ Имя клиента 2854 + "name": "string", ~/~/ Название уведомления 2855 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2856 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2857 + 0 2858 + ], 2859 + "geoids": [ ~/~/ Список id геообъектов для анализа 2860 + 0 2861 + ], 2862 + "fieldids": [ ~/~/ Список id полей для анализа 2863 + 0 2864 + ], 2865 + "settings": { ~/~/ Список параметров уведомления 2866 + "additionalProp1": "string", 2867 + "additionalProp2": "string", 2868 + "additionalProp3": "string" 2869 + }, 2870 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2871 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2872 + "" 2873 + ], 2874 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2875 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2876 + "string" 2877 + ], 2878 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2879 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2880 + { 2881 + "id": 0, ~/~/ Идентификатор участника чата 2882 + "info": "string" ~/~/ Дополнительные сведения 2883 + } 2884 + ], 2885 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2886 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2887 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2888 + "kind": 0, ~/~/ Определяет вид уведомления 2889 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2890 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2891 + "timezone": 0, ~/~/ Сдвиг часового пояса 2892 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2893 + "autoProlongation": true ~/~/ Автопродление срока действия 2894 +} 407 407 408 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 409 - "date": "", // Дата смены статуса (null если сменить немедленно) 410 - "description": "", // Описание 411 - "data": "", // Данные 412 - "overwrite": false, // Флаг перезаписи 413 - "stage": "", // Состояние, может быть null}}} 2896 +Ответ: 414 414 2898 +Success 2899 + 2900 + 2901 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2902 + 2903 +(% class="box warningmessage" %) 2904 +((( 2905 +**PUT** /api/v3/notifications/prolongation 2906 +))) 2907 + 2908 +Метод позволяет продлить уведомления. 2909 + 2910 +Метод запроса **PUT** 2911 + 2912 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2913 + 2914 +В заголовках запроса: X-Auth: Токен авторизации. 2915 + 2916 +Тело запроса: 2917 + 2918 +[ 2919 + 2920 +0 2921 + 2922 +] 2923 + 2924 +где 0 идентификатор ids. 2925 + 2926 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2927 + 2928 +(% class="box errormessage" %) 2929 +((( 2930 +**DELETE /api/v3/notifications/{id}** 2931 +))) 2932 + 2933 +Метод позволяет удалить выбранное уведомление. 2934 + 2935 +Метод запроса **DELETE** 2936 + 2937 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2938 + 2939 +Передаваемый параметр: {id} - id уведомления 2940 + 2941 +В заголовках запроса: X-Auth: Токен авторизации 2942 + 2943 +Ответ: 2944 + 2945 +Success 2946 + 2947 + 2948 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2949 + 2950 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2951 + 2952 +(% class="box infomessage" %) 2953 +((( 2954 +**POST /api/v3/Drivers/find** 2955 +))) 2956 + 2957 +Передается параметр: parentId - ID клиента-родителя 2958 + 2959 +Ответ: 2960 + 2961 +[ 2962 + { 2963 + "name": "string", ~/~/ Определяет наименование 2964 + "description": "string", ~/~/ Определяет описание 2965 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2966 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2967 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2968 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2969 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2970 + "deleted": true ~/~/ Признак удаления 2971 + } 2972 +] 2973 + 2974 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2975 + 2976 +(% class="box infomessage" %) 2977 +((( 2978 +**GET /api/v3/Drivers/{driverGuid}** 2979 +))) 2980 + 2981 +Передается параметр: ID водителя 2982 + 2983 +Ответ: 2984 + 2985 +{ 2986 + "name": "string", ~/~/ Определяет наименование 2987 + "description": "string", ~/~/ Определяет описание 2988 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2989 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2990 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 2991 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2992 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2993 + "deleted": true ~/~/ Признак удаления 415 415 } 416 416 417 - Ответ:{2996 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 418 418 419 -{{{ "status": "", // значение статуса 420 - "date": "", // Дата смены статуса 421 - "description": "", // Описание 422 - "data": "", // Данные 423 - "overwrite": false, // Флаг перезаписи 424 - "stage": "", // Состояние}}} 2998 +(% class="box successmessage" %) 2999 +((( 3000 +**POST /api/v3/Drivers** 3001 +))) 425 425 3003 +Запрос: 3004 + 3005 +{ 3006 + "name": "string", 3007 + "description": "string", 3008 + "hiredate": "2023-06-30T12:50:54.020Z", 3009 + "chopdate": "2023-06-30T12:50:54.020Z", 3010 + "exclusive": true, 3011 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3012 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3013 + "deleted": true 426 426 } 427 427 428 - **Проверка авторизации**3016 +Ответ: 429 429 430 -Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth» 3018 +{ 3019 + "name": "string", 3020 + "description": "string", 3021 + "hiredate": "2023-06-30T12:50:54.051Z", 3022 + "chopdate": "2023-06-30T12:50:54.051Z", 3023 + "exclusive": true, 3024 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3025 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3026 + "deleted": true 3027 +} 431 431 432 -Метод запроса: GET 433 433 434 - URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]3030 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 435 435 3032 +(% class="box warningmessage" %) 3033 +((( 3034 +**PUT /api/v3/Drivers** 3035 +))) 3036 + 3037 +Запрос: 3038 + 3039 +{ 3040 + "name": "string", 3041 + "description": "string", 3042 + "hiredate": "2023-06-30T12:50:27.910Z", 3043 + "chopdate": "2023-06-30T12:50:27.910Z", 3044 + "exclusive": true, 3045 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3046 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3047 + "deleted": true 3048 +} 3049 + 3050 +Ответ: 3051 + 3052 +{ 3053 + "name": "string", 3054 + "description": "string", 3055 + "hiredate": "2023-06-30T12:50:27.929Z", 3056 + "chopdate": "2023-06-30T12:50:27.929Z", 3057 + "exclusive": true, 3058 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3059 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3060 + "deleted": true 3061 +} 3062 + 3063 + 3064 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 3065 + 3066 +(% class="box errormessage" %) 3067 +((( 3068 +**DELETE /api/v3/Drivers/{driverGuid}** 3069 +))) 3070 + 3071 +Передается параметр: ID водителя 3072 + 3073 +Ответ: 3074 + 3075 +Success 3076 + 3077 + 3078 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 3079 + 3080 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 3081 + 3082 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 3083 + 3084 +(% class="box infomessage" %) 3085 +((( 3086 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3087 +))) 3088 + 3089 +Запрос: 3090 + 3091 +{ 3092 + "Ids": [ 3093 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3094 + ], 3095 + "BeginTime": "2023-06-30T12:49:04.365Z", 3096 + "EndTime": "2023-06-30T12:49:04.365Z" 3097 +} 3098 + 3099 +Ответ: 3100 + 3101 +[ 3102 + { 3103 + "VehicleId": 0, 3104 + "CreateTime": "2023-06-30T09:52:31.240Z", 3105 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3106 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3107 + "BeginTime": "2023-06-30T09:52:31.240Z", 3108 + "EndTime": "2023-06-30T09:52:31.240Z" 3109 + } 3110 +] 3111 + 3112 + 3113 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 3114 + 3115 +(% class="box infomessage" %) 3116 +((( 3117 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3118 +))) 3119 + 3120 +Запрос: 3121 + 3122 +{ 3123 + "Ids": [ 3124 + 0 3125 + ], 3126 + "BeginTime": "2023-06-30T12:48:39.419Z", 3127 + "EndTime": "2023-06-30T12:48:39.419Z" 3128 +} 3129 + 3130 +Ответ: 3131 + 3132 +[ 3133 + { 3134 + "VehicleId": 0, 3135 + "CreateTime": "2023-06-30T09:54:01.631Z", 3136 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3137 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3138 + "BeginTime": "2023-06-30T09:54:01.631Z", 3139 + "EndTime": "2023-06-30T09:54:01.631Z" 3140 + } 3141 +] 3142 + 3143 + 3144 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 3145 + 3146 +(% class="box successmessage" %) 3147 +((( 3148 +**POST /api/v3/DriversVehiclesAssignments** 3149 +))) 3150 + 3151 +Передается массив назначений 3152 + 3153 +Запрос: 3154 + 3155 +[ 3156 + { 3157 + "VehicleId": 0, ~/~/ Идентификатор объекта 3158 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3159 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3160 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3161 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 3162 + } 3163 +] 3164 + 3165 +Ответ: 3166 + 3167 +[ 3168 + { 3169 + "VehicleId": 0, 3170 + "CreateTime": "2023-06-30T11:04:46.903Z", 3171 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3172 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3173 + "BeginTime": "2023-06-30T11:04:46.903Z", 3174 + "EndTime": "2023-06-30T11:04:46.903Z" 3175 + } 3176 +] 3177 + 3178 + 3179 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 3180 + 3181 +(% class="box warningmessage" %) 3182 +((( 3183 +**PUT /api/v3/DriversVehiclesAssignments** 3184 +))) 3185 + 3186 +Запрос: 3187 + 3188 +[ 3189 + { 3190 + "VehicleId": 0, 3191 + "CreateTime": "2023-06-30T11:14:08.117Z", 3192 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3193 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3194 + "BeginTime": "2023-06-30T11:14:08.117Z", 3195 + "EndTime": "2023-06-30T11:14:08.117Z" 3196 + } 3197 +] 3198 + 3199 +Ответ: 3200 + 3201 +[ 3202 + { 3203 + "VehicleId": 0, 3204 + "CreateTime": "2023-06-30T11:14:53.349Z", 3205 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3206 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3207 + "BeginTime": "2023-06-30T11:14:53.349Z", 3208 + "EndTime": "2023-06-30T11:14:53.349Z" 3209 + } 3210 +] 3211 + 3212 + 3213 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 3214 + 3215 +(% class="box errormessage" %) 3216 +((( 3217 +**DELETE /api/v3/DriversVehiclesAssignments** 3218 +))) 3219 + 3220 +Запрос: 3221 + 3222 +[ 3223 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3224 +] 3225 + 3226 +Ответ: 3227 + 3228 +Success 3229 + 3230 + 3231 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 3232 + 3233 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 3234 + 3235 +(% class="box infomessage" %) 3236 +((( 3237 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3238 +))) 3239 + 3240 +Запрос: 3241 + 3242 +{ 3243 + "Ids": [ 3244 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3245 + ], 3246 + "BeginTime": "2023-06-30T12:47:12.162Z", 3247 + "EndTime": "2023-06-30T12:47:12.162Z" 3248 +} 3249 + 3250 +Ответ: 3251 + 3252 +[ 3253 + { 3254 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3255 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3256 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3257 + "BeginTime": "2023-06-30T11:19:40.703Z", 3258 + "EndTime": "2023-06-30T11:19:40.703Z" 3259 + } 3260 +] 3261 + 3262 + 3263 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3264 + 3265 +(% class="box infomessage" %) 3266 +((( 3267 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3268 +))) 3269 + 3270 +Запрос: 3271 + 3272 +{ 3273 + "Ids": [ 3274 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3275 + ], 3276 + "BeginTime": "2023-06-30T12:47:12.162Z", 3277 + "EndTime": "2023-06-30T12:47:12.162Z" 3278 +} 3279 + 3280 +Ответ: 3281 + 3282 +[ 3283 + { 3284 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3285 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3286 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3287 + "BeginTime": "2023-06-30T11:19:40.703Z", 3288 + "EndTime": "2023-06-30T11:19:40.703Z" 3289 + } 3290 +] 3291 + 3292 + 3293 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3294 + 3295 +(% class="box successmessage" %) 3296 +((( 3297 +**POST /api/v3/DriversRfidsAssignments** 3298 +))) 3299 + 3300 +Запрос: 3301 + 3302 +[ 3303 + { 3304 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3305 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3306 + "BeginTime": "2023-06-30T11:27:08.635Z", 3307 + "EndTime": "2023-06-30T11:27:08.635Z" 3308 + } 3309 +] 3310 + 3311 +Ответ: 3312 + 3313 +[ 3314 + { 3315 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3316 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3317 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3318 + "BeginTime": "2023-06-30T11:27:08.677Z", 3319 + "EndTime": "2023-06-30T11:27:08.677Z" 3320 + } 3321 +] 3322 + 3323 + 3324 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3325 + 3326 +(% class="box warningmessage" %) 3327 +((( 3328 +**PUT /api/v3/DriversRfidsAssignments** 3329 +))) 3330 + 3331 +Запрос: 3332 + 3333 +[ 3334 + { 3335 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3336 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3337 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3338 + "BeginTime": "2023-06-30T11:28:43.330Z", 3339 + "EndTime": "2023-06-30T11:28:43.330Z" 3340 + } 3341 +] 3342 + 3343 +Ответ: 3344 + 3345 +[ 3346 + { 3347 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3348 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3349 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3350 + "BeginTime": "2023-06-30T11:28:43.331Z", 3351 + "EndTime": "2023-06-30T11:28:43.331Z" 3352 + } 3353 +] 3354 + 3355 + 3356 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3357 + 3358 +(% class="box errormessage" %) 3359 +((( 3360 +**DELETE /api/v3/DriversRfidsAssignments** 3361 +))) 3362 + 3363 +Запрос: 3364 + 3365 +[ 3366 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3367 +] 3368 + 3369 +Ответ: 3370 + 3371 +Success 3372 + 3373 + 3374 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3375 + 3376 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3377 + 3378 +(% class="box infomessage" %) 3379 +((( 3380 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3381 +))) 3382 + 3383 +Запрос: 3384 + 3385 +{ 3386 + "Ids": [ 3387 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3388 + ], 3389 + "BeginTime": "2023-06-30T12:45:10.852Z", 3390 + "EndTime": "2023-06-30T12:45:10.852Z" 3391 +} 3392 + 3393 +Ответ: 3394 + 3395 +[ 3396 + { 3397 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3398 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3399 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3400 + "BeginTime": "2023-06-30T11:58:04.695Z", 3401 + "EndTime": "2023-06-30T11:58:04.695Z" 3402 + } 3403 +] 3404 + 3405 + 3406 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3407 + 3408 +(% class="box infomessage" %) 3409 +((( 3410 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3411 +))) 3412 + 3413 +Запрос: 3414 + 3415 +{ 3416 + "Ids": [ 3417 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3418 + ], 3419 + "BeginTime": "2023-06-30T12:45:10.852Z", 3420 + "EndTime": "2023-06-30T12:45:10.852Z" 3421 +} 3422 + 3423 +Ответ: 3424 + 3425 +[ 3426 + { 3427 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3428 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3429 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3430 + "BeginTime": "2023-06-30T11:58:04.695Z", 3431 + "EndTime": "2023-06-30T11:58:04.695Z" 3432 + } 3433 +] 3434 + 3435 + 3436 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3437 + 3438 +(% class="box successmessage" %) 3439 +((( 3440 +**POST /api/v3/DriversFuelCardsAssignments** 3441 +))) 3442 + 3443 +Запрос: 3444 + 3445 +[ 3446 + { 3447 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3448 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3449 + "BeginTime": "2023-06-30T12:09:53.175Z", 3450 + "EndTime": "2023-06-30T12:09:53.175Z" 3451 + } 3452 +] 3453 + 3454 +Ответ: 3455 + 3456 +[ 3457 + { 3458 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3459 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3460 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3461 + "BeginTime": "2023-06-30T12:09:53.201Z", 3462 + "EndTime": "2023-06-30T12:09:53.201Z" 3463 + } 3464 +] 3465 + 3466 + 3467 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3468 + 3469 +(% class="box warningmessage" %) 3470 +((( 3471 +**PUT /api/v3/DriversFuelCardsAssignments** 3472 +))) 3473 + 3474 +Запрос: 3475 + 3476 +[ 3477 + { 3478 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3479 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3480 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3481 + "BeginTime": "2023-06-30T12:09:53.201Z", 3482 + "EndTime": "2023-06-30T12:09:53.201Z" 3483 + } 3484 +] 3485 + 3486 +Ответ: 3487 + 3488 +[ 3489 + { 3490 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3491 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3492 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3493 + "BeginTime": "2023-06-30T12:09:53.201Z", 3494 + "EndTime": "2023-06-30T12:09:53.201Z" 3495 + } 3496 +] 3497 + 3498 + 3499 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3500 + 3501 +(% class="box errormessage" %) 3502 +((( 3503 +**DELETE /api/v3/DriversFuelCardsAssignments** 3504 +))) 3505 + 3506 +Запрос: 3507 + 3508 +[ 3509 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3510 +] 3511 + 3512 +Ответ: 3513 + 3514 +Success 3515 + 3516 + 3517 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3518 + 3519 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3520 + 3521 +(% class="box infomessage" %) 3522 +((( 3523 +**POST /api/v3/Trailers** 3524 +))) 3525 + 3526 +Пример запроса: 3527 + 3528 +{ 3529 + "startDate": "2023-11-14T10:48:03.671Z", 3530 + "endDate": "2023-11-14T10:48:03.671Z", 3531 + "ids": [ 0 ], 3532 + "timezone": 0 3533 +} 3534 + 3535 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3536 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3537 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3538 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3539 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3540 + 3541 +Пример ответа: 3542 + 3543 +[ 3544 + { 3545 + "SD": "2023-11-14T10:48:03.717Z", 3546 + "ED": "2023-11-14T10:48:03.717Z", 3547 + "id": 0, 3548 + "SLat": 0, 3549 + "SLon": 0, 3550 + "ELat": 0, 3551 + "ELon": 0, 3552 + "mileage": 0 3553 + "Duration": 0 3554 + "Address": "string", 3555 + "Address2": "string", 3556 + "name": "string", 3557 + "rid": "string", 3558 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3559 + "trailer": { 3560 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3561 + "Number": "string", 3562 + "Description": "string", 3563 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3564 + "ExternalID": "string", 3565 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3566 + "CreateTime": "2023-11-14T10:48:03.717Z", 3567 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3568 + "IsDeleted": true 3569 + }, 3570 + "filesCount": 0, 3571 + } 3572 +] 3573 + 3574 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3575 +|SD|Дата и время начала события 3576 +|ED|Дата и время окончания события 3577 +|id|ID объекта 3578 +|SLat|Широта начальной координаты 3579 +|SLon|Долгота начальной координаты 3580 +|ELat|Широта конечной координаты 3581 +|ELon|Долгота конечной координаты 3582 +|mileage|Пробег 3583 +|Duration|Продолжительность 3584 +|Address|Адрес начального местоположения 3585 +|Address2|Адрес конечного местоположения 3586 +|name|Имя радиометки 3587 +|rid|Номер радиометки 3588 +|rguid|ID радиометки 3589 +|trailer|Информация об агрегате 3590 +|ModelGuid|ID агрегата 3591 +|Number|Название/номер агрегата 3592 +|Description|Текст примечания агрегата 3593 + 3594 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3595 + 3596 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3597 + 3598 +(% class="box infomessage" %) 3599 +((( 3600 +**POST /api/v3/Rfids/find** 3601 +))) 3602 + 3603 +Запрос: 3604 + 3605 +{ 3606 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3607 +} 3608 + 3609 +Ответ: 3610 + 3611 +[ 3612 + { 3613 + "name": "string", 3614 + "number": 0, 3615 + "period": 0, 3616 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3617 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3618 + } 3619 +] 3620 + 3621 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3622 +|parentId|ID клиента 3623 +|name|Название карты-метки 3624 +|number|Номер 3625 +|period|Период запросов в секундах (работает только для агрегатов) 3626 +|id|ID карты-метки 3627 + 3628 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3629 + 3630 +(% class="box infomessage" %) 3631 +((( 3632 +**GET /api/v3/Rfids/{rfidGuid}** 3633 +))) 3634 + 3635 +Передаем параметр rfidGuid - идентификатор карты-метки 3636 + 3637 +Ответ: 3638 + 3639 +[ 3640 + { 3641 + "name": "string", 3642 + "number": 0, 3643 + "period": 0, 3644 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3645 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3646 + } 3647 +] 3648 + 3649 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3650 +|name|Название карты-метки 3651 +|number|Номер 3652 +|period|Период запросов в секундах (работает только для агрегатов) 3653 +|id|ID карты-метки 3654 +|parentId|ID клиента 3655 + 3656 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3657 + 3658 +(% class="box successmessage" %) 3659 +((( 3660 +**POST /api/v3/Rfids** 3661 +))) 3662 + 3663 +Запрос: 3664 + 3665 +{ 3666 + "name": "string", 3667 + "number": 0, 3668 + "period": 0, 3669 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3670 +} 3671 + 3672 +Ответ: 3673 + 3674 +{ 3675 + "name": "string", 3676 + "number": 0, 3677 + "period": 0, 3678 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3679 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3680 +} 3681 + 3682 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3683 +|name|Название карты-метки 3684 +|number|Номер 3685 +|period|Период запросов в секундах (работает только для агрегатов) 3686 +|id|ID карты-метки 3687 +|parentId|ID клиента 3688 + 3689 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3690 + 3691 +(% class="box warningmessage" %) 3692 +((( 3693 +**PUT /api/v3/Rfids** 3694 +))) 3695 + 3696 +Запрос: 3697 + 3698 +{ 3699 + "name": "string", 3700 + "number": 0, 3701 + "period": 0, 3702 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3703 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3704 +} 3705 + 3706 +Ответ: 3707 + 3708 +{ 3709 + "name": "string", 3710 + "number": 0, 3711 + "period": 0, 3712 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3713 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3714 +} 3715 + 3716 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3717 +|name|Название карты-метки 3718 +|number|Номер 3719 +|period|Период запросов в секундах (работает только для агрегатов) 3720 +|id|ID карты-метки 3721 +|parentId|ID клиента 3722 + 3723 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3724 + 3725 +(% class="box errormessage" %) 3726 +((( 3727 +**DELETE /api/v3/Rfids/{rfidGuid}** 3728 +))) 3729 + 3730 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3731 + 3732 +Ответ: 3733 + 3734 +Success 3735 + 3736 + 3737 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3738 + 3739 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3740 + 3741 +(% class="box infomessage" %) 3742 +((( 3743 +**GET /api/v3/Billing/client/balance/{clientId}** 3744 +))) 3745 + 3746 +Параметр запроса: **clientId **- идентификатор клиента. 3747 + 3748 +Ответ: 3749 + 3750 +{ 3751 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3752 + "Balance": 0 3753 +} 3754 + 3755 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3756 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3757 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3758 + 3759 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3760 + 3761 +(% class="box infomessage" %) 3762 +((( 3763 +**GET /api/v3/Billing/client/constraint/{clientId}** 3764 +))) 3765 + 3766 +Параметр запроса: **clientId **- идентификатор клиента. 3767 + 3768 +Ответ: 3769 + 3770 +{ 3771 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3772 + "CalculationType": 0, 3773 + "PermissibleBalance": 0, 3774 + "DefermentDays": 0, 3775 + "SendUiNotifications": true, 3776 + "SendEmailNotifications": true, 3777 + "IsPrivate": true, 3778 +} 3779 + 3780 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3781 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3782 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3783 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3784 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3785 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3786 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3787 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3788 + 3789 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3790 + 3791 +(% class="box infomessage" %) 3792 +((( 3793 +**GET /api/v3/Billing/client/plan/{clientId}** 3794 +))) 3795 + 3796 +Параметры запроса: 3797 + 3798 +**clientId **- идентификатор клиента. 3799 + 3800 +**planId **- идентификатор тарифного плана. 3801 + 3802 +Ответ: 3803 + 3804 +{ 3805 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3806 + "Plan": { **~/~/ Описание тарифного плана** 3807 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3808 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3809 + "Name": "string", 3810 + "IsArchived": true, 3811 + "Constraint": { 3812 + "CalculationType": 0, 3813 + "PermissibleBalance": 0, 3814 + "DefermentDays": 0 3815 + }, 3816 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3817 + { 3818 + "Feature": "string", 3819 + "IsFactual": true, 3820 + "Limit": 0, 3821 + "Price": 0, 3822 + "PeriodValue": 0, 3823 + "PeriodType": 0 3824 + } 3825 + ] 3826 + }, 3827 + "DebitDate": "2023-10-18T12:46:24.213Z", 3828 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3829 + { 3830 + "Feature": "string", 3831 + "IsEnabled": true, 3832 + "IsPrivate": true, 3833 + "IsFactual": true, 3834 + "Limit": 0, 3835 + "Price": 0, 3836 + "DebitDate": "2023-10-18T12:46:24.213Z", 3837 + "PeriodValue": 0, 3838 + "PeriodType": 0 3839 + } 3840 + ] 3841 +} 3842 + 3843 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3844 +|ClientId|Идентификатор клиента 3845 +|Id|Идентификатор тарифного плана 3846 +|OwnerId|Идентификатор клиента-владельца 3847 +|Name|Наименование тарифного плана 3848 +|IsArchived|Признак, определяющий архивный тарифный план 3849 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3850 +|PermissibleBalance|Допустимый баланс 3851 +|DefermentDays|Отсрочка, количество дней 3852 +|Feature|Код услуги 3853 +|IsEnabled|Признак, определяющий активирована ли услуга 3854 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3855 +|IsFactual|Признак, определяющий расчёт по факту 3856 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3857 +|Price|Цена за единицу. 3858 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3859 +|PeriodValue|Значение периода. 3860 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3861 + 3862 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3863 + 3864 +(% class="box infomessage" %) 3865 +((( 3866 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3867 +))) 3868 + 3869 +Параметр запроса: **clientId **- идентификатор клиента. 3870 + 3871 +Ответ: 3872 + 3873 +[ 3874 + { 3875 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3876 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3877 + "Name": "string", 3878 + "IsArchived": true, 3879 + "Constraint": { 3880 + "CalculationType": 0, 3881 + "PermissibleBalance": 0, 3882 + "DefermentDays": 0 3883 + }, 3884 + "Features": [ 3885 + { 3886 + "Feature": "string", 3887 + "IsFactual": true, 3888 + "Limit": 0, 3889 + "Price": 0, 3890 + "PeriodValue": 0, 3891 + "PeriodType": 0 3892 + } 3893 + ] 3894 + } 3895 +] 3896 + 3897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3898 +|ClientId|Идентификатор клиента 3899 +|Id|Идентификатор тарифного плана 3900 +|OwnerId|Идентификатор клиента-владельца 3901 +|Name|Наименование тарифного плана 3902 +|IsArchived|Признак, определяющий архивный тарифный план 3903 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3904 +|PermissibleBalance|Допустимый баланс 3905 +|DefermentDays|Отсрочка, количество дней 3906 +|Feature|Код услуги 3907 +|IsFactual|Признак, определяющий расчёт по факту 3908 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3909 +|Price|Цена за единицу. 3910 +|PeriodValue|Значение периода. 3911 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3912 + 3913 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3914 + 3915 +(% class="box infomessage" %) 3916 +((( 3917 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3918 +))) 3919 + 3920 +Параметр запроса: **clientId **- идентификатор клиента. 3921 + 3922 +Ответ: 3923 + 3924 +[ 3925 + { 3926 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3927 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3928 + "Name": "string", 3929 + "IsArchived": true, 3930 + "Constraint": { 3931 + "CalculationType": 0, 3932 + "PermissibleBalance": 0, 3933 + "DefermentDays": 0 3934 + }, 3935 + "Features": [ 3936 + { 3937 + "Feature": "string", 3938 + "IsFactual": true, 3939 + "Limit": 0, 3940 + "Price": 0, 3941 + "PeriodValue": 0, 3942 + "PeriodType": 0 3943 + } 3944 + ] 3945 + } 3946 +] 3947 + 3948 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3949 +|ClientId|Идентификатор клиента 3950 +|Id|Идентификатор тарифного плана 3951 +|OwnerId|Идентификатор клиента-владельца 3952 +|Name|Наименование тарифного плана 3953 +|IsArchived|Признак, определяющий архивный тарифный план 3954 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3955 +|PermissibleBalance|Допустимый баланс 3956 +|DefermentDays|Отсрочка, количество дней 3957 +|Feature|Код услуги 3958 +|IsFactual|Признак, определяющий расчёт по факту 3959 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3960 +|Price|Цена за единицу. 3961 +|PeriodValue|Значение периода. 3962 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3963 + 3964 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3965 + 3966 +(% class="box warningmessage" %) 3967 +((( 3968 +**PUT /api/v3/Billing/client/balance** 3969 +))) 3970 + 3971 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3972 + 3973 +Тело запроса: 3974 + 3975 +{ 3976 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3977 + "Balance": 0 3978 +} 3979 + 3980 +Ответ: Success 3981 + 3982 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3983 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3984 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3985 + 3986 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3987 + 3988 +(% class="box warningmessage" %) 3989 +((( 3990 +**PUT /api/v3/billing/client/balance/deposit** 3991 +))) 3992 + 3993 +Создает операцию **Пополнение **с указанной суммой 3994 + 3995 +Тело запроса: 3996 + 3997 +{ 3998 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3999 + "Balance": 0 4000 +} 4001 + 4002 +Ответ: Success 4003 + 4004 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4005 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4006 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4007 + 4008 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4009 + 4010 +Создает операцию **Списание **с указанной суммой 4011 + 4012 +(% class="box warningmessage" %) 4013 +((( 4014 +**PUT /api/v3/billing/client/balance/withdraw** 4015 +))) 4016 + 4017 +Тело запроса: 4018 + 4019 +{ 4020 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4021 + "Balance": 0 4022 +} 4023 + 4024 +Ответ: Success 4025 + 4026 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4027 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4028 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4029 + 4030 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4031 + 4032 +(% class="box warningmessage" %) 4033 +((( 4034 +**PUT /api/v3/Billing/client/constraint** 4035 +))) 4036 + 4037 +Тело запроса: 4038 + 4039 +{ 4040 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4041 + "CalculationType": 0, 4042 + "PermissibleBalance": 0, 4043 + "DefermentDays": 0, 4044 + "SendUiNotifications": true, 4045 + "SendEmailNotifications": true, 4046 + "IsPrivate": true, 4047 +} 4048 + 4049 +Ответ: Success 4050 + 4051 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4052 +|ClientId|Идентификатор клиента 4053 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4054 +|PermissibleBalance|Допустимый баланс 4055 +|DefermentDays|((( 4056 +Отсрочка, количество дней 4057 +))) 4058 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4059 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4060 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4061 + 4062 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4063 + 4064 +(% class="box warningmessage" %) 4065 +((( 4066 +**PUT /api/v3/Billing/client/plan** 4067 +))) 4068 + 4069 +Тело запроса: 4070 + 4071 +{ 4072 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4073 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4074 + "Features": [ 4075 + { 4076 + "Feature": "string", 4077 + "IsEnabled": true, 4078 + "IsFactual": true, 4079 + "Limit": 0, 4080 + "Price": 0, 4081 + "DebitDate": "2023-10-18T13:26:58.987Z", 4082 + "PeriodValue": 0, 4083 + "PeriodType": 0 4084 + } 4085 + ] 4086 +} 4087 + 4088 +Ответ: Success 4089 + 4090 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4091 +|ClientId|Идентификатор клиента 4092 +|PlanId|Идентификатор тарифного плана 4093 +|Feature|Код услуги 4094 +|IsEnabled|Признак, определяющий активирована ли услуга 4095 +|IsFactual|Признак, определяющий расчёт по факту 4096 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4097 +|Price|Цена за единицу. 4098 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4099 +|PeriodValue|Значение периода. 4100 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4101 + 4102 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4103 + 4104 +(% class="box warningmessage" %) 4105 +((( 4106 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4107 +))) 4108 + 4109 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4110 + 4111 +(% class="box infomessage" %) 4112 +((( 4113 +**POST /api/v3/vehicles/import/{agentId}** 4114 +))) 4115 + 4116 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4117 + 4118 +В пути указывается **agentId** - id клиента. 4119 + 4120 +**Заголовок** 4121 + 4122 +**X-Auth: [токен авторизации]** 4123 + 4124 +**Параметры** 4125 + 4126 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4127 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4128 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4129 + 4130 +В теле использовать тип **form-data,** тип значения** file** 4131 + 4132 +**Ключи** 4133 + 4134 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4135 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4136 +|csv|В значении передаем файл датчиков, формат **csv** 4137 + 4138 +Ответ: 4139 + 4140 +{ 4141 + "vehicleId": 0, 4142 + "name": "string", 4143 + "errors": ["string"] 4144 +} 4145 + 4146 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4147 +|vehicleId|ID созданного объекта 4148 +|name|Имя созданного объекта 4149 +|errors|Ошибки и их описание 4150 + 4151 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4152 + 4153 +(% class="box infomessage" %) 4154 +((( 4155 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4156 +))) 4157 + 4158 +(% class="wikigeneratedid" %) 4159 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4160 + 4161 +(% class="wikigeneratedid" %) 4162 +В пути указывается **vehicleId **- id объекта. 4163 + 4164 +**Заголовок** 4165 + 4166 +**X-Auth: [токен авторизации]** 4167 + 4168 +В теле использовать тип **form-data.** 4169 + 4170 +Ключи: 4171 + 4172 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4173 +|**history**|В значении передавать файл с историей 4174 + 4175 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4176 + 4177 +Ответ: 4178 + 4179 +{ 4180 + "results": [ 4181 + { 4182 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4183 + "vehicleId": 0, 4184 + "errors": [ 4185 + "string" 4186 + ], 4187 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4188 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4189 + "producedCount": 0, 4190 + "msgCount": 0 4191 + } 4192 + ] 4193 +} 4194 + 4195 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4196 +|results|Результаты импорта в разрезе ТС 4197 +|vehicleGuid|Guid ТС 4198 +|vehicleId|ID ТС 4199 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4200 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4201 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4202 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4203 +|msgCount|Кол-во обработанных сообщений всего 4204 + 4205 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4206 + 4207 +(% class="box infomessage" %) 4208 +((( 4209 +**GET /api/v3/vehicles/import/history/status** 4210 +))) 4211 + 4212 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4213 + 4214 +Ответ: 4215 + 4216 +{ 4217 + "activity": true, 4218 + "progress": 0, 4219 + "message": "string" 4220 +} 4221 + 4222 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4223 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4224 +|progress|Guid ТС 4225 + 4226 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4227 + 4228 +(% class="box infomessage" %) 4229 +((( 4230 +**POST /api/v3/vehicles/export** 4231 +))) 4232 + 4233 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4234 + 4235 +Тело запроса: 4236 + 4237 +[ 4238 + id 4239 +] 4240 + 4241 +Ответ: Success 200, получаете файлы с настройками. 4242 + 4243 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4244 + 4245 +(% class="box infomessage" %) 4246 +((( 4247 +**POST /api/v3/vehicles/export/history** 4248 +))) 4249 + 4250 +Метод возвращает список сообщений терминала объекта за выбранный период. 4251 + 4252 +Тело запроса: 4253 + 4254 +{ 4255 + "vehicleId": 0, 4256 + "asArchive": true, 4257 + "from": "2023-09-27T12:17:45.973Z", 4258 + "to": "2023-09-27T12:17:45.973Z" 4259 +} 4260 + 4261 +Ответ: 4262 + 4263 +Получаете файл. Сообщение: Code 200/Success 4264 + 4265 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4266 +|vehicleId|ID объекта 4267 +|asArchive|true - Архивировать файл, False - не архивировать 4268 +|from|Дата и время начала запроса 4269 +|to|Дата и время окончания запроса 4270 + 4271 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4272 + 4273 +(% class="box infomessage" %) 4274 +((( 4275 +**GET /api/v3/vehicles/export/history/status** 4276 +))) 4277 + 4278 +Метод возвращает список сообщений терминала объекта за выбранный период. 4279 + 4280 +Ответ: 4281 + 4282 +{ 4283 + "activity": true, 4284 + "progress": 0, 4285 + "message": "string" 4286 +} 4287 + 4288 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4289 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4290 +|progress|Прогресс экспорта, от 0 до 100% 4291 +|message|Текст описывающий статус 4292 + 4293 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4294 + 4295 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4296 + 4297 +(% class="box infomessage" %) 4298 +((( 4299 +**POST /api/v3/EcoDriving/rating** 4300 +))) 4301 + 4302 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4303 + 4304 +Тело запроса: 4305 + 4306 +{ 4307 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4308 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4309 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4310 +} 4311 + 4312 +Ответ: 4313 + 4314 +{ 4315 + "items": [ ~/~/ Список в разрезе ТС 4316 + { 4317 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4318 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4319 + "vehicleId": 0, ~/~/ ID ТС 4320 + "vehicleName": "string", ~/~/ Название ТС 4321 + "vehicleModel": "string", ~/~/ Модель ТС 4322 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4323 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4324 + "totalViolations": 0, ~/~/ Нарушений всего 4325 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4326 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4327 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4328 + "brakingViolations": 0, ~/~/ Нарушений торможения 4329 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4330 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4331 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4332 + }, 4333 + 4334 +((( 4335 + 4336 +))) 4337 + 4338 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4339 + "mileage": 0, ~/~/ Пробег, м 4340 + "tripsCount": 0, ~/~/ Кол-во рейсов 4341 + "trips": [ ~/~/ Информация по рейсу 4342 + { 4343 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4344 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4345 + "violationsCount": 0, ~/~/ Всего нарушений 4346 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4347 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4348 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4349 + "brakingViolations": 0, ~/~/ Нарушений торможения 4350 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4351 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4352 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4353 + }, 4354 + 4355 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4356 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4357 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4358 + "mileage": 0, ~/~/ Пробег, м 4359 + "motohours": 0, ~/~/ Моточасы, секунды 4360 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4361 + "startAddress": "string", ~/~/ Адрес начала рейса 4362 + "endAddress": "string", ~/~/ Адрес конца рейса 4363 + "drivers": [ ~/~/ Список водителей 4364 + { 4365 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4366 + "driverName": "string", ~/~/ФИО водителя 4367 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4368 + } 4369 + ] 4370 + } 4371 + ] 4372 + } 4373 + ] 4374 +} 4375 + 4376 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4377 + 4378 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4379 + 4380 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4381 + 4382 +(% class="box infomessage" %) 4383 +((( 4384 +POST /api/v3/fuelcards/transactions 4385 +))) 4386 + 4387 +Метод запроса: POST 4388 + 4389 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4390 +\\В заголовках запроса: X-Auth: Токен авторизации 4391 + 4392 +Параметры в теле запроса (JSON): 4393 + 4394 +{ 4395 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4396 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4397 + "ids": [ 4398 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4399 + ], 4400 + "timezone": 0 ~/~/Таймзона 4401 +} 4402 + 4403 + 4404 +Ответ: 4405 + { 4406 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4407 + "driver": "string", ~/~/Водители, привязанные к ТК 4408 + "object": "string", ~/~/Наименование ТС 4409 + "amount": 0, ~/~/Количество топлива 4410 + "amountDut": 0, ~/~/Количество по ДУТ 4411 + "amountDiff": 0, ~/~/Разница, л 4412 + "amountDiffPerc": 0, ~/~/Разница, % 4413 + "summa": 0, ~/~/Стоимость, руб 4414 + "serviceName": "string", ~/~/Тип топлива 4415 + "price": 0, ~/~/Цена за литр, руб 4416 + "cardName": "string", ~/~/Наименование ТК 4417 + "cardNum": "string", ~/~/Номер ТК 4418 + "operator": "string", ~/~/Оператор ТК 4419 + "address": "string" ~/~/Адрес АЗС 4420 + } 4421 + 4422 + 4423 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4424 + 4425 + 4426 +== **Получение полных данных о ретрансляторе** == 4427 + 4428 +(% class="box infomessage" %) 4429 +((( 4430 +**GET ** **/api/v3/retranslations/{id}** 4431 +))) 4432 + 4433 +Идентификатор запроса: ID 4434 + 4435 + 4436 +Пример ответа: 4437 + 4438 +{ 4439 +"description": "", ~/~/ Определяет описание 4440 +"subscriberId": "", ~/~/ Подписчик 4441 +"protocolType": 0, ~/~/ Тип протокола 4442 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4443 +"address": "string", ~/~/ Адрес события 4444 +"objects": [ ~/~/Объекты для ретрансляции 4445 +{ 4446 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4447 +"name": "", ~/~/ Наименование объекта ретрансляции 4448 +"imei": "", ~/~/ IMEI объекта 4449 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4450 +} 4451 + ], 4452 +"id": "", ~/~/ идентификатор пользователя 4453 +"parentId": "", ~/~/Guid родителя 4454 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4455 +} 4456 + 4457 + 4458 +== **Удаление данных ретранслятора** == 4459 + 4460 +(% class="box infomessage" %) 4461 +((( 4462 +**DELETE** **/api/v3/retranslations/{id}** 4463 +))) 4464 + 4465 +Параметр запроса: ID 4466 + 4467 + 4468 +== **Создание ретранслятора** == 4469 + 4470 +(% class="box infomessage" %) 4471 +((( 4472 +**POST ** **/api/v3/retranslations/{id}** 4473 +))) 4474 + 4475 +Запрос: 4476 + 4477 +{ 4478 +"description": "", ~/~/ Описание 4479 +"subscriberId": "", ~/~/ Подписчик 4480 +"protocolType": 0, ~/~/ Тип протокола 4481 +"address": "", ~/~/ Адрес ретрансляции 4482 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4483 +"objects": [ ~/~/Объекты для ретрансляции 4484 +{ 4485 +"id": "", ~/~/ идентификатор пользователя 4486 +"imei": "", ~/~/IMEI объекта 4487 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4488 +} 4489 + ] 4490 +} 4491 + 4492 + 4493 +Ответ: 4494 + 4495 +{ 4496 +"description": "string", ~/~/ Определяет описание 4497 +"subscriberId": "", ~/~/ идентификатор запроса 4498 +"protocolType": 0, ~/~/ Тип протокола 4499 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4500 +"address": "", ~/~/ Адрес события 4501 +"objects": [ ~/~/Объекты для ретрансляции 4502 +{ 4503 +"id": "", ~/~/ идентификатор пользователя 4504 +"name": "string", ~/~/ Название уведомления 4505 +"imei": "string", ~/~/IMEI объекта 4506 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4507 +} 4508 + ], 4509 +"id": "", ~/~/ идентификатор пользователя 4510 +"parentId": "", ~/~/ Guid идентификатор родителя 4511 +"deleted": true ~/~/ Признак удаления 4512 +} 4513 + 4514 + 4515 +== **Редактирование ретранслятора** == 4516 + 4517 +(% class="box infomessage" %) 4518 +((( 4519 +**PUT** **/api/v3/retranslations** 4520 +))) 4521 + 4522 +Пример запроса: 4523 + 4524 +{ 4525 +"id": "", ~/~/ идентификатор пользователя 4526 +"description": "string", ~/~/ Определяет описание 4527 +"subscriberId": "", ~/~/ идентификатор запроса 4528 +"protocolType": 0, ~/~/ Тип протокола 4529 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4530 +"address": "string", ~/~/ Адрес события 4531 +"objects": ~/~/Объекты для ретрансляции 4532 +[ 4533 +{ 4534 +"id": "", ~/~/ идентификатор пользователя 4535 +"imei": "", ~/~/IMEI объекта 4536 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4537 +} 4538 + ] 4539 +} 4540 + 4541 + 4542 +Пример ответа: 4543 + 4544 +{ 4545 +"description": "", ~/~/ Определяет описание 4546 +"subscriberId": "", ~/~/ идентификатор запроса 4547 +"protocolType": 0, ~/~/ Тип протокола 4548 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4549 +"address": "string", ~/~/ Адрес события 4550 +"objects": [ ~/~/Объекты для ретрансляции 4551 +{ 4552 +"id": "", ~/~/ идентификатор пользователя 4553 +"name": "string", ~/~/ Название уведомления 4554 +"imei": "", ~/~/IMEI объекта 4555 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4556 +} 4557 + ], 4558 +"id": "", ~/~/ идентификатор пользователя 4559 +"parentId": "", ~/~/ Guid идентификатор родителя 4560 +"deleted": true ~/~/ Признак удаления 4561 +} 4562 + 4563 + 4564 +== **Получение списка ретранслятора клиента** == 4565 + 4566 +(% class="box infomessage" %) 4567 +((( 4568 +**POST /api/v3/retranslations/find** 4569 +))) 4570 + 4571 +Пример запроса: 4572 + 4573 +{ 4574 +"id": "", ~/~/ идентификатор пользователя 4575 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4576 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4577 +} 4578 + 4579 +Ответ: 4580 + 4581 +[ 4582 +{ 4583 +"description": "", ~/~/ Определяет описание 4584 +"subscriberId": "", ~/~/ идентификатор запроса 4585 +"protocolType": 0, ~/~/ Тип протокола 4586 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4587 +"address": "string", ~/~/ Адрес события 4588 +"id": "", ~/~/ идентификатор пользователя 4589 +"parentId": "", ~/~/ Guid идентификатор родителя 4590 +"deleted": true ~/~/ Признак удаления 4591 +} 4592 +] 4593 + 4594 + 4595 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4596 + 4597 +== **API для отчета по выгрузке комбайнов** == 4598 + 4599 +(% class="box infomessage" %) 4600 +((( 4601 +POST **/api/v3/Reports/harvesterUnloading** 4602 +))) 4603 + 4604 +Пример запроса: 4605 + 4606 +{ 4607 + "byTime": 0, ~/~/ Объединение событий по времени 4608 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4609 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4610 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4611 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4612 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4613 + 0 4614 + ], 4615 + "from": "", ~/~/ Дата и время начало запроса 4616 + "to": "", ~/~/ Дата и время окончания запроса 4617 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4618 +} 4619 + 4620 +Пример ответа: 4621 + 4622 +[ 4623 + { 4624 + "harvesterName": "", ~/~/Комбайн, номер 4625 + "harvesterId": 0, ~/~/Комбайн, id 4626 +"harvesterModel": "", ~/~/ Модель комбайна 4627 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4628 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4629 + "events": [ ~/~/Список событий в разрезе комбайна 4630 + { 4631 + "driverId": "", ~/~/Идентификатор водителя 4632 + "driverName": "", ~/~/Водитель комбайна, ФИО 4633 + "RFID": "", ~/~/ идентификатор карты-метки 4634 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4635 + "vehicleId": 0, ~/~/идентификатор объекта 4636 + "vehicleName": "string", ~/~/ Имя объекта 4637 + "modelName": "string", ~/~/ Имя модели объекта 4638 + "nearestVehicles": [ ~/~/Объекты рядом 4639 + { 4640 + "vehicleId": 0, ~/~/идентификатор объекта 4641 + "vehicleName": "string" ~/~/ Имя объекта 4642 + } 4643 + ], 4644 + "fields": [ ~/~/Поля, где происходила выгрузка 4645 + { 4646 + "id": 0, ~/~/ идентификатор пользователя 4647 + "name": "string" ~/~/ имя пользователя 4648 + } 4649 + ], 4650 + "event": "string", ~/~/Событие 4651 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4652 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4653 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4654 + "cultureName": "string", ~/~/ название культуры 4655 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4656 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4657 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4658 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4659 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4660 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4661 + "issued": 0, ~/~/Выдано, бункеров 4662 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4663 + "latitude": 0, ~/~/Широта 4664 + "longitude": 0, ~/~/ Долгота 4665 + "litresAway": 0, ~/~/Отдано, л 4666 + "m3Away": 0 ~/~/Отдано, м3 4667 + } 4668 + ] 4669 + } 4670 +] 4671 + 4672 + 4673 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4674 + 4675 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4676 + 4677 + 4678 +(% class="box infomessage" %) 4679 +((( 4680 +GET api/v3/Vehicles/recyclebin/all 4681 +))) 4682 + 4683 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4684 + 4685 +Параметр запроса: {parentId} - идентификатор агента 4686 + 436 436 В заголовках запроса: X-Auth: Токен авторизации 437 437 438 -Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»4689 +Ответ: 439 439 440 -**Расширенное описание API доступно по запросу на support@glonasssoft.ru** 4691 +[ 4692 + { 4693 + "recordTime": "", ~/~/Время записи 4694 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4695 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4696 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4697 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4698 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4699 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4700 + "items": [ ~/~/ 4701 +nullable: true ~/~/Детали 4702 + { 4703 + "name": "string", ~/~/наименование столбца 4704 + "value": "string" ~/~/содержание столбца 4705 + } 4706 + ] 4707 + }, 4708 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4709 + "string" 4710 + ] 4711 + } 4712 +] 4713 + 4714 + 4715 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4716 + 4717 +(% class="box infomessage" %) 4718 +((( 4719 +POST/api/v3/Vehicles/recyclebin/erase 4720 +))) 4721 + 4722 +В заголовках запроса: X-Auth: Токен авторизации 4723 + 4724 +Пример запроса: 4725 + 4726 +[ 4727 +0 4728 +] 4729 + 4730 + 4731 +Пример ответа: 4732 + 4733 +[ 4734 +{ 4735 + "recordTime": "", ~/~/Время записи 4736 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4737 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4738 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4739 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4740 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4741 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4742 + "items": [ ~/~/Детали 4743 + { 4744 + "name": "", ~/~/Имя свойства 4745 + "value": "" ~/~/Значение свойства 4746 + } 4747 + ] 4748 + }, 4749 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4750 + "" 4751 + ] 4752 + } 4753 +] 4754 + 4755 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4756 + 4757 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4758 + 4759 +(% class="box infomessage" %) 4760 +((( 4761 +POST/api/v3/Vehicles/recyclebin/restore 4762 +))) 4763 + 4764 +В заголовках запроса: X-Auth: Токен авторизации 4765 + 4766 +Параметры в теле запроса (JSON): 4767 + 4768 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4769 + 4770 +В заголовках запроса: X-Auth: Токен авторизации 4771 + 4772 + 4773 +Пример запроса: 4774 + 4775 +((( 4776 +[ 4777 +))) 4778 + 4779 +((( 4780 + 0 4781 +))) 4782 + 4783 +((( 4784 +] 4785 +))) 4786 + 4787 + 4788 +Пример ответа: 4789 + 4790 +[ 4791 +{ 4792 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4793 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4794 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4795 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4796 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4797 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4798 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4799 + "items": [ ~/~/Детали 4800 + { 4801 + "name": "string", ~/~/Имя свойства 4802 + "value": "string" ~/~/Значение свойства 4803 + } 4804 + ] 4805 + }, 4806 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4807 + "string" 4808 + ] 4809 + } 4810 +] 4811 + 4812 + 4813 + 4814 +(% class="box" lang="en-US" style="text-align: center;" %) 4815 +((( 4816 +(% 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]] ** 4817 +)))
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content