Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/21 14:13
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Просмотреть отметки "Нравится"
Change comment:
There is no comment for this version
Summary
Details
-
Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Tags
-
... ... @@ -1,1 +1,0 @@ 1 -Public API|API - Content
-
... ... @@ -1,3453 +1,454 @@ 1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -((( 3 -**Содержание страницы:** 4 -))) 1 +== Описание ГЛОНАССSoft Public API == 5 5 6 - {{toc/}}3 +== == 7 7 5 + **Действующие ограничения** 6 + 8 8 9 - =(%style="color:#000000;font-size:16px"%)**Действующие ограничения**(%%)=8 +- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов) 10 10 11 - (%style="color:#000000"%)−(%%) **Между запросами должнабытьпаузав1секунду** (превышениеотвергается системойсуведомлениемопревышении частотызапросов).10 +- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 12 12 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 - 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 13 +\\ 16 16 17 - (%style="color:#000000"%)−(%%)При**редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры,значениякоторых не будут переданы - будут стерты!15 + **Авторизация** 18 18 19 - =(%style="color:#000000;font-size:18.6667px"%)Раздел:**Авторизация**(%%)=17 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 20 20 21 - == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%)==19 +Метод запроса: GET 22 22 23 -(% class="box successmessage" %) 24 -((( 25 -(% lang="en-US" %)**POST /api/v3/auth/login** 26 -))) 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]] 27 27 28 - (%style="color:#000000" %)Методпозволяетполучить токенавторизации,который необходимо добавлятьв заголовокдляработысовсемиметодами API.В параметрах метода передаетсяимя пользователяипароль.23 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 29 29 30 -(% style="color:#000000" %)Метод запроса: **POST** 25 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ] 26 + 31 31 32 - (%style="color:#000000"%)URL запроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]28 + **Получение списка объектов** 33 33 34 - (%style="color:#000000"%)В случае успешноговыполненияметода,поле«AuthId»содержит токен авторизации «X-Auth».30 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 35 35 36 - (% style="color:#000000" %)Параметрывтеле запроса(JSON):32 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 37 37 38 -(% style="color:#000000" %){ 39 - "login": "testuser", 40 - "password": "testuser" 41 -} 34 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов; 42 42 43 -( %style="color:#000000"%)**Ответ:**36 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 44 44 45 -(% lang="en-US" %) 46 -(% style="color:#000000" %){ 38 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 47 47 48 -(% lang="en-US" %) 49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 50 - "User": "testuser" , ~/~/ имя пользователя 40 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 51 51 52 -(% lang="en-US" %) 53 -} 42 +Метод запроса: POST 54 54 55 - **Примечание: **Время жизни токенаавторизации задается в настройкахпользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.44 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 56 56 57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 46 +В заголовках запроса: 62 62 63 - == (% style="color:#000000; font-size:16px"%)**Проверка авторизации**(%%) ==48 +−Content-Type: application/json 64 64 65 -(% class="box infomessage" %) 66 -((( 67 -(% lang="en-US" %)**GET /api/v3/auth/check** 68 -))) 50 +−X-Auth: Токен авторизации 69 69 70 - (% style="color:#000000" %)Метод позволяетпроверитьстатус авторизации.Методпозволяетпроверитьактивентокенавторизацииили нет.52 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 71 71 72 - (%style="color:#000000"%)Методзапроса:**GET**54 +{{{{"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, опционально)}}}} 73 73 74 - (%style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]56 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 75 75 76 - (%style="color:#000000"%)В заголовкахзапроса:X-Auth:Токен авторизации58 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 77 77 78 -(% lang="en-US" %) 79 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 60 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 80 80 81 - = (% style="color:#000000;font-size:18.6667px"%)Раздел: **Клиенты**(%%) =62 +0 - «Блокировка» 82 82 83 - ==(% style="color:#000000; font-size:16px"%)**Получение информации оклиенте**(%%) ==64 +1 - «Активен», 84 84 85 -(% class="box infomessage" %) 86 -((( 87 -**GET api/v3/agents/{id}** 88 -))) 66 +2 - «Отменен» 89 89 90 - Методпозволяетполучить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Методвозвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:68 +3 - «Оборудован» 91 91 92 - (%style="color:#000000"%)−информация о клиенте предоставляется приналичии права «Просмотрклиентов»;70 +4 - «Диагностика» 93 93 94 - (%style="color:#000000"%)Метод запроса: **GET**72 +5 - «Сервис» 95 95 96 - (%style="color:#000000"%)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}74 +6 - «Демонтаж» 97 97 98 - Запросдолженсодержать данные параметра"**agentId**"76 +7 - «Монтаж» 99 99 100 -(% style="color:#000000" %)Ответ: 101 -{ 102 - "agentId": "", (%%) 103 - "parentId": "", 104 - "parentName": "string", 105 - "name": "string", 106 - "fullName": "string", 107 - "agentInfoType": 0, 108 - "isForeign": true/false, 109 - "district": "string", 110 - "region": "string", 111 - "city": "string", 112 - "inn": "string", 113 - "kpp": "string", 114 - "address": "string", 115 - "addressFact": "string", 116 - "email": "string", 117 - "director": "string", 118 - "bankName": "string", 119 - "bankBIK": "string", 120 - "bankRS": "string", 121 - "bankKS": "string" 122 - } 78 +8 - «Дозаказ» 123 123 124 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 125 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 126 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 127 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 128 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 129 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 130 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 131 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 132 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 133 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 134 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 135 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 136 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 137 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 138 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 139 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 140 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 141 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 142 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 143 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 144 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 80 +9 - «Обслужен» 145 145 146 - == (% style="color:#000000;font-size:16px"%)**Получениепараметров дочерних клиентов**(%%) ==82 +10 - «Списан» 147 147 148 -(% class="box infomessage" %) 149 -((( 150 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 151 -))) 84 +11 - «Неисправен» 152 152 153 - (%style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителяи т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:86 +12 - «Проверен» 154 154 155 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 88 +13 - «Не эксплуатируется» 89 + 156 156 157 - (%style="color:#000000"%)−возвращаетсяинформацияоклиенте,которомупринадлежитавторизованный пользователь, и его дочернихклиентах;91 + **Получение списка клиентов.** 158 158 159 - (%style="color:#000000"%)−информацияоклиенте типа«Партнер»и его клиентоввозвращаетсяприииправа«__**Доступкпартнёрскимклиентам**__».93 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 160 160 161 - (%style="color:#000000"%)Методзапроса:**POST**95 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»; 162 162 163 - (%style="color:#000000"%)URLзапроса:(%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find97 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 164 164 165 - (%style="color:#000000"%)Параметрзапроса:99 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 166 166 167 -(% style="color:#000000" %){ 168 - "parentId": "string" 169 -} 101 +Метод запроса: GET 170 170 171 - (%style="color:#000000" %)Ответ:103 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId> 172 172 173 -{ 174 - "agentId": "",(% style="color:#000000" %) (%%) 175 - "parentId": "", 176 - "parentName": "string", 177 - "name": "string", 178 - "fullName": "string", 179 - "agentInfoType": 0, 180 -(% style="color:#000000" %) "status": "", 181 -} 105 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 182 182 183 - 184 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 185 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 186 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 188 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 189 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 190 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 191 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 192 - 193 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 194 - 195 -(% class="box successmessage" %) 196 -((( 197 -**POST /api/v3/agents ** 198 -))) 199 - 200 -Метод позволяет добавить клиента, указанного в запросе. 201 - 202 -Метод запроса: **POST** 203 - 204 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 205 - 206 206 В заголовках запроса: X-Auth: Токен авторизации 207 207 208 - Параметрывтелезапроса(JSON):109 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 209 209 210 -{ 211 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 212 - "name": "string", ~/~/ имя 213 - "fullName": "string", ~/~/ полное наименование 214 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 215 - "isForeign": true, ~/~/ иностранный контрагент 216 - "district": "string", ~/~/ округ 217 - "region": "string", ~/~/ регион 218 - "city": "string", ~/~/ город 219 - "inn": "string", ~/~/ ИНН 220 - "kpp": "string", ~/~/ КПП 221 - "address": "string", ~/~/ юридический адрес 222 - "addressFact": "string", ~/~/ фактический адрес 223 - "email": "string", ~/~/ email 224 - "director": "string", ~/~/ ФИО руководителя 225 - "bankName": "string", ~/~/ банк 226 - "bankBIK": "string", ~/~/ БИК 227 - "bankRS": "string", ~/~/ номер счёта 228 - "bankKS": "string" ~/~/ корр. счёт 229 -} 111 +Примечание. Возможные значение параметра agentInfoType: 112 + 230 230 114 + **Получение списка пользователей.** 231 231 232 - Ответ:116 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр. 233 233 234 -{ 235 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 236 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 237 - "name": "string", ~/~/ имя 238 - "fullName": "string", ~/~/ полное наименование 239 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 240 - "isForeign": true, ~/~/ иностранный контрагент 241 - "district": "string", ~/~/ округ 242 - "region": "string", ~/~/ регион 243 - "city": "string", ~/~/ город 244 - "inn": "string", ~/~/ ИНН 245 - "kpp": "string", ~/~/ КПП 246 - "address": "string", ~/~/ юридический адрес 247 - "addressFact": "string", ~/~/ фактический адрес 248 - "email": "string", ~/~/ email 249 - "director": "string", ~/~/ ФИО руководителя 250 - "bankName": "string", ~/~/ банк 251 - "bankBIK": "string", ~/~/ БИК 252 - "bankRS": "string", ~/~/ номер счёта 253 - "bankKS": "string" ~/~/ корр. счёт 254 -} 118 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей». 255 255 256 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 257 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 258 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 259 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 260 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 261 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 262 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 263 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 264 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 265 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 266 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 267 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 268 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 269 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 270 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 271 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 272 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 273 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 274 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 275 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 276 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 120 +Метод запроса: POST 277 277 278 - == (%style="color:#000000;font-size:16px" %)**Редактирование клиента**(%%) ==122 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 279 279 280 -(% class="box warningmessage" %) 281 -((( 282 -**PUT /api/v3/agents** 283 -))) 124 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 284 284 285 -Метод позволяет отредактировать клиента, указанного в запросе. 126 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 127 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 128 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 129 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 286 286 287 -Метод запроса: **PUT** 288 - 289 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 290 - 291 -В заголовках запроса: X-Auth: Токен авторизации 292 - 293 -Параметры в теле запроса (JSON): 294 - 295 -{ 296 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 297 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 298 - "name": "string", ~/~/ имя 299 - "fullName": "string", ~/~/ полное наименование 300 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 301 - "isForeign": true, ~/~/ иностранный контрагент 302 - "district": "string", ~/~/ округ 303 - "region": "string", ~/~/ регион 304 - "city": "string", ~/~/ город 305 - "inn": "string", ~/~/ ИНН 306 - "kpp": "string", ~/~/ КПП 307 - "address": "string", ~/~/ юридический адрес 308 - "addressFact": "string", ~/~/ фактический адрес 309 - "email": "string", ~/~/ email 310 - "director": "string", ~/~/ ФИО руководителя 311 - "bankName": "string", ~/~/ банк 312 - "bankBIK": "string", ~/~/ БИК 313 - "bankRS": "string", ~/~/ номер счёта 314 - "bankKS": "string" ~/~/ корр. счёт 315 315 } 316 316 317 -Ответ: 133 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 318 318 319 -{ 320 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 321 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 322 - "name": "string", ~/~/ имя 323 - "fullName": "string", ~/~/ полное наименование 324 - "isForeign": true, ~/~/ иностранный контрагент 325 - "district": "string", ~/~/ округ 326 - "region": "string", ~/~/ регион 327 - "city": "string", ~/~/ город 328 - "inn": "string", ~/~/ ИНН 329 - "kpp": "string", ~/~/ КПП 330 - "address": "string", ~/~/ юридический адрес 331 - "addressFact": "string", ~/~/ фактический адрес 332 - "email": "string", ~/~/ email 333 - "director": "string", ~/~/ ФИО руководителя 334 - "bankName": "string", ~/~/ банк 335 - "bankBIK": "string", ~/~/ БИК 336 - "bankRS": "string", ~/~/ номер счёта 337 - "bankKS": "string" ~/~/ корр. счёт 338 -} 135 +{{{ "sessionDuration": "", // длительность сессии в минутах}}} 339 339 340 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 137 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ] 138 + 341 341 342 -(% class="box errormessage" %) 343 -((( 344 -**DELETE /api/v3/agents/{clientId}** 345 -))) 140 + **Получение списка типов устройств** 346 346 347 -Метод позволяет удалить клиента, указанного в строкезапроса.142 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 348 348 349 -Метод запроса: **DELETE**144 +Метод запроса: GET 350 350 351 -URL gents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**146 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 352 352 353 - Параметрзапроса:**{clientId}**-Guidпользователя148 +В заголовках запроса:X-Auth: Токен авторизации 354 354 355 - В заголовках запроса: X-Auth: Токен авторизации150 +Ответ: [ 356 356 357 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 152 +{{{ { 153 + "deviceTypeId" : "", // ID типа устройства 154 + "deviceTypeName" : "" // Название типа устройства 155 + },}}} 358 358 359 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 157 +… ] 158 + 360 360 361 - ==(%style="color:#000000;font-size:16px"%)**Добавление пользователя**(%%) ==160 + **Получение списка типов датчиков** 362 362 363 -(% class="box successmessage" %) 364 -((( 365 -(% lang="en-US" %)**POST /api/v3/users** 366 -))) 162 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 367 367 368 - (% style="color:#000000" %)Методпозволяет добавитьпользователя. Метод позволяет добавить пользователя, указанного в запросе.164 +Метод запроса: GET 369 369 370 - (% style="color:#000000" %)Методзапроса:**POST**166 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 371 371 372 - (%style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]168 +В заголовках запроса:X-Auth: Токен авторизации 373 373 374 - (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации170 +Ответ: [ 375 375 376 - (%style="color:#000000"%)Параметрыв теле запроса (JSON):172 +{{{ {}}} 377 377 378 -(% style="color:#000000" %) 379 -{ 380 - "lastName": "", ~/~/ фамилия 381 - "firstName": "", ~/~/ имя 382 - "position": "", ~/~/ должность 383 - "phone": "", ~/~/ телефон 384 - "organization": "", ~/~/ организация 385 - "login": "", ~/~/ логин (обязателен) 386 - "password": "", ~/~/ пароль (обязателен) 387 - "email": "", ~/~/ email (обязателен) 388 - "description": "string", ~/~/ Описание 389 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 390 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 391 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 392 - "parentId": "", ~/~/ Guid родительского агента 393 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 394 - "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 395 - "doubleAuth": 396 - { 397 - "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 398 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 399 - }, 400 - "groups": 401 - [ 402 - "string" ~/~/ группы пользователя, перечисление названия системных ролей 403 - ], 404 - "customGroups": 405 - [ 406 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 407 - ], 408 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 409 -} 174 +«id»: «», //ID типа датчика «name»: «», //Название 410 410 411 -{ 412 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 413 - "lastName": "string", 414 - "firstName": "string", 415 - "position": "string", 416 - "phone": "string", 417 - "organization": "string", 418 - "login": "string", 419 - "password": "string", 420 - "email": "string", 176 +{{{ "description": "" // Описание 177 + },}}} 421 421 422 - (%style="text-align:left" %)423 - (%style="color:#000000; font-weight:normal" %)Ответ:179 +… ] 180 + 424 424 425 -(% style="text-align:left" %) 426 -(% style="color:#000000; font-weight:normal" %){ 182 + **Получение информации об объекте** 427 427 428 -(% style="text-align:left" %) 429 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 430 - "lastName": "" , ~/~/ Фамилия , 431 - "firstName": "" , ~/~/ Имя 432 - "position": "" , ~/~/ Должность 433 - "phone": "" , ~/~/ Телефон 434 - "organization": "" , ~/~/ Организация 435 - "login": "" , ~/~/ Логин 436 - "password": "" , ~/~/ Пароль 437 - "email": "" , ~/~/ Email 438 - "description": "" , ~/~/ Описание 439 - "isEnabled": "" , ~/~/ Признак включения 440 - "parentId": "" , ~/~/ Guid родительского агента 441 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 442 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 443 - "kind": "" , ~/~/ тип аутентификации 444 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 445 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 184 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 446 446 447 -(% style="text-align:left" %) 448 -(% style="color:#000000; font-weight:normal" %)} 186 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»): 449 449 188 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание». 450 450 451 - == (% style="color:#000000; font-size:16px" %)**Получениеспискальзователей**(%%)==190 +Метод запроса: GET 452 452 453 -(% class="box infomessage" %) 454 -((( 455 -(% lang="en-US" %)**POST /api/v3/users/find** 456 -))) 192 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID> 457 457 458 - (% style="color:#000000" %)Метод позволяет получить основные параметрыпользователей: логин, имя, адрес электроннойпочты, номертелефона,статус,идентификаторклиента-родителя и прочее.194 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 459 459 460 - (%style="color:#000000" %)Метод возвращает информацию о пользователяхклиента-родителя авторизованногопользователяипользователях его дочернихклиентов.Информация о пользователях предоставляется приналичии права **«__Просмотр пользователей__»**.196 +В заголовках запроса: X-Auth: Токен авторизации 461 461 462 -(% style="color:#000000" %)Метод запроса: **POST** 463 - 464 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 465 - 466 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 467 - 468 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 469 - 470 -(% style="color:#000000" %){ 471 - 472 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 473 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 474 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 475 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 476 - 477 -(% style="color:#000000" %)} 478 - 479 -(% style="color:#000000" %)Ответ: 480 - 481 -(% style="color:#000000" %){ (%%) 482 - 483 - "id": "" , ~/~/ идентификатор пользователя 484 - "lastName": "" , ~/~/ фамилия 485 - "firstName": "" , ~/~/ имя 486 - "position": "" , ~/~/ должность 487 - "phone": "" , ~/~/ телефон 488 - "parentId": "" , ~/~/ идентификатор клиента-родителя 489 - "parentName": "" , ~/~/ наименование клиента-родителя 490 - "organization": "" , ~/~/ организация 491 - "login": "" , ~/~/ логин 492 - "email": "" , ~/~/ E-mail 493 - "sessionDuration":"", ~/~/ длительность сессии в минутах 494 - "status": "1", ~/~/ статус пользователя 495 - "lastLogged": "", ~/~/ дата/время последней авторизации 496 - 497 -(% style="color:#000000" %)} 498 - 499 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 500 - 501 -(% class="box infomessage" %) 502 -((( 503 -(% lang="en-US" %)**GET /api/v3/users/{GUID}** 504 -))) 505 - 506 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 507 - 508 -(% style="color:#000000" %)Метод запроса: **GET** 509 - 510 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 511 - 512 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 513 - 514 -(% style="color:#000000" %)Ответ: 515 - 516 -((( 517 -((( 518 -{ 519 - "id": "", ~/~/ GUID пользователя 520 - "lastName": "", ~/~/ Фамилия 521 - "firstName": "", ~/~/ Имя 522 - "position": "", ~/~/ Должность 523 - "phone": "", ~/~/ Номер телефона 524 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 525 - "parentName": "", Наименование клиента, которому принадлежит пользователь 526 - "organization": "", ~/~/ Организация 527 - "login": "", ~/~/ Логин пользователя 528 - "email": "", ~/~/ Адрес электронной почты 529 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 530 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 531 - "description": "", ~/~/ Описание 532 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 533 - "doubleAuth": 534 - { 535 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 - }, 538 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 540 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 541 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 542 - "groups": [], ~/~/ Список ролей пользователя 543 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 544 - "authDevices": [ ], ~/~/ Список авторизованных устройств 545 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 546 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 547 -} 548 -))) 549 -))) 550 - 551 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 552 - 553 -(% class="box warningmessage" %) 554 -((( 555 -(% lang="en-US" %)**PUT /api/v3/users** 556 -))) 557 - 558 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 559 - 560 -(% style="color:#000000" %)Метод запроса: **PUT** 561 - 562 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 563 - 564 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 565 - 566 -(% lang="en-US" style="text-align:left" %) 567 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 568 - 569 -(% lang="en-US" style="text-align:left" %) 570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 - 572 -(% lang="en-US" style="text-align:left" %) 573 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 574 - "lastName": "" , ~/~/ фамилия 575 - "firstName": "" , ~/~/ имя 576 - "position": "" , ~/~/ должность 577 - "phone": "" , ~/~/ телефон 578 - "organization": "" , ~/~/ организация 579 - "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 580 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 581 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 582 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 583 - "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 584 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 585 - "isEnabled": "" , ~/~/ признак включения 586 - "parentId": "" , ~/~/ Guid родительского агента 587 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 588 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 589 - "doubleAuth": 590 - { 591 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 592 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 593 - }, 594 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 595 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 596 - 597 -(% lang="en-US" style="text-align:left" %) 598 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 599 - 600 -(% lang="en-US" style="text-align:left" %) 601 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 602 - 603 -(% lang="en-US" style="text-align:left" %) 604 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 605 - 606 -(% lang="en-US" style="text-align:left" %) 607 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 608 - "lastName": "" , ~/~/ фамилия 609 - "firstName": "" , ~/~/ имя 610 - "position": "" , ~/~/ должность 611 - "phone": "" , ~/~/ телефон 612 - "organization": "" , ~/~/ организация 613 - "login": "" , ~/~/ логин 614 - "password": "" , ~/~/ пароль 615 - "email": "" , ~/~/ email 616 - "description": "" , ~/~/ описание 617 - "isEnabled": "" , ~/~/ признак включения 618 - "parentId": "" , ~/~/ Guid родительского агента 619 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 620 - "doubleAuth": 621 - { 622 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 623 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 624 - }, 625 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 626 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 627 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 628 - 629 -(% lang="en-US" style="text-align:left" %) 630 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 631 - 632 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 633 - 634 -(% class="box warningmessage" %) 635 -((( 636 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 637 -))) 638 - 639 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 640 - 641 -(% style="color:#000000" %)Метод запроса: **PUT** 642 - 643 -(% 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} 644 - 645 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 646 - 647 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 648 - 649 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 650 - 651 -(% style="color:#000000" %){ 652 - 653 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 654 - "description": "" , ~/~/ описание 655 - "data": "" , ~/~/ данные, связанные со сменой статуса 656 - 657 -(% style="color:#000000" %)} 658 - 659 -(% style="text-align:left" %) 660 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 661 - 662 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 663 - 664 -(% class="box warningmessage" %) 665 -((( 666 -**POST /api/v3/users/disable** 667 -))) 668 - 669 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 670 - 671 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 672 - 673 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 674 - 675 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 676 - 677 - [ 678 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 679 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 680 - ] 681 - 682 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 683 - 684 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 685 - 686 -(% class="box warningmessage" %) 687 -((( 688 -**POST /api/v3/users/enable** 689 -))) 690 - 691 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 692 - 693 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 694 - 695 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 696 - 697 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 698 - 699 - [ 700 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 701 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 702 - ] 703 - 704 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 705 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 706 - 707 -((( 708 -В теле ответа: 709 -{ 710 - "errorMessages": [ 711 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 712 - ], 713 - "users": [ 714 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 715 - ] 716 -} 717 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 718 -"users" - массив id пользователей, которых не удалось включить или отключить. 719 -))) 720 - 721 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 722 - 723 -(% class="box errormessage" %) 724 -((( 725 -(% lang="en-US" %)**DELETE /api/v3/users/{id}** 726 -))) 727 - 728 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 729 - 730 -(% style="color:#000000" %)Метод запроса: **DELETE** 731 - 732 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 733 - 734 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 735 - 736 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 737 - 738 -(% style="text-align:left" %) 739 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 740 - 741 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 742 - 743 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 744 - 745 -(% class="box infomessage" %) 746 -((( 747 -(% lang="en-US" %)**GET /api/v3/models/{Id}** 748 -))) 749 - 750 -Метод возвращает полную информацию о модели объекта. 751 - 752 -(% style="color:#000000" %)Метод запроса: **GET** 753 - 754 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 755 - 756 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 757 - 758 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 759 - 760 -(% style="color:#000000" %)Ответ: 761 - 762 -(% style="color:#000000" %){ 763 - "parentName": "string", 764 - "name": "string", 765 - "picture": "string", 766 - "minspeed": 0, 767 - "maxspeed": 0, 768 - "width": 0, 769 - "imbeddedtrailer": true, 770 - "hoppercapacity": 0, 771 - "hopperdischargespeed": 0, 772 - "modelType": 0, 773 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 774 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 775 - "deleted": true 776 -} 777 - 778 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 779 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 780 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 781 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 782 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 783 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 784 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 785 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 786 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 787 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 788 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 789 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 790 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 791 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 792 - 793 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 794 - 795 -(% class="box successmessage" %) 796 -((( 797 -(% lang="en-US" %)**POST /api/v3/models/find** 798 -))) 799 - 800 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 801 - 802 -(% style="color:#000000" %)Метод запроса: **POST** 803 - 804 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 805 - 806 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 807 - 808 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 809 - 810 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 811 -} 812 - 813 -(% style="color:#000000" %)Ответ: 814 - 815 -(% style="color:#000000" %)[ 816 - { 817 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 818 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 819 - "parentName": "string", 820 - "name": "string", 821 - "modelType": 0 822 - } 823 -] 824 - 825 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 826 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 827 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 828 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 829 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 830 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 831 - 832 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 833 - 834 -(% class="box successmessage" %) 835 -((( 836 -(% lang="en-US" %)**POST /api/v3/models** 837 -))) 838 - 839 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 840 - 841 -(% style="color:#000000" %)Метод запроса: **POST** 842 - 843 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 844 - 845 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 846 - 847 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 848 - 849 -{ 850 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 851 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 852 - "deleted": true, 853 - "extId": "string", 854 - "name": "string", 855 - "picture": "string", 856 - "minspeed": 0, 857 - "maxspeed": 0, 858 - "width": 0, 859 - "imbeddedtrailer": true, 860 - "fueloutlay": 0, 861 - "hoppercapacity": 0, 862 - "hopperdischargespeed": 0, 863 - "modelType": 0 864 -} 865 - 866 866 Ответ: 867 867 868 868 { 869 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 871 - "deleted": true, 872 - "extId": "string", 873 - "name": "string", 874 - "picture": "string", 875 - "minspeed": 0, 876 - "maxspeed": 0, 877 - "width": 0, 878 - "imbeddedtrailer": true, 879 - "hoppercapacity": 0, 880 - "hopperdischargespeed": 0, 881 - "modelType": 0 882 -} 883 883 884 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 885 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 886 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 887 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 888 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 889 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 890 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 891 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 892 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 893 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 894 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 895 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 896 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 897 - 898 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 899 - 900 -(% class="box warningmessage" %) 901 -((( 902 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 903 -))) 904 - 905 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 906 - 907 -(% style="color:#000000" %)Метод запроса: **PUT** 908 - 909 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 910 - 911 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 912 - 913 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 914 - 915 -{ 916 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 917 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 918 - "deleted": true, 919 - "extId": "string", 920 - "name": "string", 921 - "picture": "string", 922 - "minspeed": 0, 923 - "maxspeed": 0, 924 - "width": 0, 925 - "imbeddedtrailer": true, 926 - "fueloutlay": 0, 927 - "hoppercapacity": 0, 928 - "hopperdischargespeed": 0, 929 - "modelType": 0 930 -} 931 - 932 -Ответ: 933 - 934 -{ 935 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 936 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 937 - "deleted": true, 938 - "extId": "string", 939 - "name": "string", 940 - "picture": "string", 941 - "minspeed": 0, 942 - "maxspeed": 0, 943 - "width": 0, 944 - "imbeddedtrailer": true, 945 - "fueloutlay": 0, 946 - "hoppercapacity": 0, 947 - "hopperdischargespeed": 0, 948 - "modelType": 0 949 -} 950 - 951 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 952 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 953 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 954 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 955 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 956 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 957 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 958 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 959 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 960 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 961 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 962 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 963 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 964 - 965 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 966 - 967 -(% class="box errormessage" %) 968 -((( 969 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 970 -))) 971 - 972 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 973 - 974 -(% style="color:#000000" %)Метод запроса: **DELETE** 975 - 976 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 977 - 978 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 979 - 980 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 981 - 982 -Ответ: В случае успеха **Success 200** 983 - 984 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 985 - 986 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 987 - 988 -(% class="box infomessage" %) 989 -((( 990 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 991 -))) 992 - 993 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 994 - 995 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 996 - 997 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 998 - 999 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 1000 - 1001 -(% style="color:#000000" %)Метод запроса: **GET** 1002 - 1003 -(% 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} 1004 - 1005 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 1006 - 1007 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1008 - 1009 -(% style="color:#000000" %)Ответ: 1010 - 1011 -((( 1012 -{ 1013 - "vehicleId": "", ~/~/ ID объекта 1014 - "name": "", ~/~/ Имя объекта 1015 - "imei": "", ~/~/ IMEI объекта 1016 - "deviceTypeId": , ~/~/ ID типа устройства 1017 - "deviceTypeName": "", ~/~/ Название типа устройства 1018 - "sim1": "", ~/~/ Номер SIM1 1019 - "sim2": "", ~/~/ Номер SIM2 1020 - 1021 - "parentId": "", ~/~/ ID клиента-родителя 1022 - "parentName": "", ~/~/ Наименование клиента-родителя 1023 - "modelId": "", ~/~/ ID модели объекта 1024 - "modelName": "", ~/~/ Имя модели объекта 1025 - 1026 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1027 - "unitName": "string", ~/~/ Наименование подразделения 1028 - "status": 0, ~/~/ Статус объекта 1029 - 1030 - "createdAt": "", ~/~/ Дата создания объекта 1031 - }, 1032 - 1033 -"customFields": [ ~/~/ Произвольные поля 1034 - { 1035 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1036 - "name": "string", ~/~/ Имя поля 1037 - "value": "string", ~/~/ Значение поля 1038 - "forClient": true, ~/~/ Не используемая функция 1039 - "forTooltip": true, ~/~/ Отображать в подсказке 1040 - "forReport": true ~/~/ Отображать в отчете 1041 - } 1042 - 1043 -], ~/~/ Данные с вкладки нормы 1044 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1045 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1046 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1047 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1048 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1049 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1050 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1051 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1052 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1053 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1054 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1055 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1056 - 1057 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1058 - "mileageCoeff": 0, ~/~/ коэффициент пробега 1059 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1060 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1061 - "counters": { ~/~/ Счетчики 1062 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1063 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1064 - "mileage": 0, ~/~/ Текущий пробег 1065 - "motohours": 0, ~/~/ Текущие моточасы 1066 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1067 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 202 +{{{ "vehicleId": “”, // идентификатор объекта 203 + "name": "", // имя объекта 204 + "imei": "", // IMEI объекта 205 + "deviceTypeId": “”, // идентификатор устройства объекта 206 + "deviceTypeName": "" // наименование устройства объекта 207 + "parentId": "", // идентификатор клиента-родителя 208 + "parentName": "" // наименование клиента-родителя, 209 + "modelId": "", // идентификатор модели объекта 210 + "modelName": "" // наименование модели объекта, 211 + "unitId": "", // идентификатор подразделения 212 + "unitName": "", // наименование подразделения 213 + "status": “”, // статус объекта 214 + ... 1068 1068 }, 216 + ...}}} 1069 1069 1070 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1071 - "id": "string", ~/~/ ID объекта 1072 - "enabled": true, ~/~/ Включить, true - активна, false - не активна 1073 - "host": "string", ~/~/ CMSV6 Web Host 1074 - "login": "string", ~/~/ CMSV6 Account 1075 - "password": "string" ~/~/ CMSV6 Password 1076 - }, 1077 - 1078 -"commandTemplates": [ ~/~/ Шаблоны команд 1079 - { 1080 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1081 - "name": "string", ~/~/ Наименование команды 1082 - "command": "string", ~/~/ Текст команды 1083 - "retries": 0 ~/~/ Количество попыток 1084 - } 1085 - ], 1086 - 1087 - "sensors": [ ~/~/ Датчики 1088 - { 1089 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1090 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1091 - "type": 0, ~/~/ Тип датчика 1092 - "name": "string", ~/~/ Имя датчика 1093 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1094 - "inputNumber": 0, ~/~/ Номер входа 1095 - "pseudonym": "string", ~/~/ Псевдоним 1096 - "medianDegree": 0, ~/~/ Медианная фильтрация 1097 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1098 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1099 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1100 - "gradesTables": [ ~/~/ Массив таблиц тарировки 1101 - { 1102 - "grades": [ ~/~/ Таблица тарировки 1 1103 - { 1104 - "input": 0, ~/~/ Входящее значение 1105 - "output": 0 ~/~/ Выходящее значение 1106 - } 1107 - ], 1108 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1109 - } 1110 - ], 1111 - "showInTooltip": true, ~/~/ Отображать в подсказке 1112 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 1113 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1114 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1115 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1116 - "expr": "string", ~/~/ Формула 1117 - "children": [ ~/~/ массив дочерних датчиков 1118 - "string" 1119 - ], 1120 - "customParams": { ~/~/ прочие произвольные параметры 1121 - "additionalProp1": "string", 1122 - "additionalProp2": "string", 1123 - "additionalProp3": "string" 1124 - }, 1125 - 1126 -~/~/ Характерные для произвольного: 1127 - 1128 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1129 - 1130 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1131 - 1132 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1133 - 1134 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1135 - 1136 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1137 - 1138 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1139 - 1140 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1141 - 1142 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1143 - 1144 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1145 - 1146 -~/~/ "ValueOn": "Вкл.", 1147 - 1148 -~/~/ "ValueOff": "Выкл." 1149 - "summaryMaxValue": 0 ~/~/ Макс. значение 1150 - } 1151 - 1152 - "drivers": [ ~/~/ Водители 1153 - { 1154 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1155 - "name": "string", ~/~/ Наименование 1156 - "description": "string", 1157 - "isDefault": true ~/~/ По умолчанию 1158 - } 1159 - ], 1160 - 1161 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1162 - { 1163 - "id": "", ~/~/ ID задания 1164 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 1165 - "name": "", ~/~/ Наименование задания 1166 - "description": "", ~/~/ Описание задания 1167 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1168 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1169 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1170 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1171 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1172 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1173 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 1174 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1175 - } 1176 - ], 1177 - 1178 - "statusHistory": [ ~/~/ История статусов 1179 - { 1180 - "status": 0, 1181 - "date": "2023-05-22T09:57:39.562Z", 1182 - "description": "string", 1183 - "additionalInfo": "string" 1184 - } 1185 - ] 1186 - 1187 1187 } 1188 -))) 1189 1189 1190 - (%style="text-align:left"%)1191 - Параметр«status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:220 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется» 221 + 1192 1192 1193 -(% style="text-align:left" %) 1194 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 223 + **Добавление пользователя** 1195 1195 1196 - ==(%style="color:#000000;font-size:16px"%)**Добавление объекта**(%%)==225 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 1197 1197 1198 -(% class="box successmessage" %) 1199 -((( 1200 -(% lang="en-US" %)**POST /api/v3/vehicles** 1201 -))) 227 +Метод запроса: POST 1202 1202 1203 - (%style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.229 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 1204 1204 1205 - (%style="color:#000000" %)Методзапроса:**POST**231 +В заголовках запроса: X-Auth: Токен авторизации 1206 1206 1207 - (%style="color:#000000"%)URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]233 +Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] } 1208 1208 1209 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 235 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 236 + 1210 1210 1211 - (%style="color:#000000"%)Параметрывтелезапроса (JSON): //Обязательные параметры наименованиеи модельбъекта//Втеле запроса - объект JSON238 + **Редактирование пользователя** 1212 1212 1213 -( %style="color:#000000"%){240 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 1214 1214 1215 - "parentId": "" , ~/~/ ID клиента 1216 - "name": "" , ~/~/ имя ТС 1217 - "imei": "" , ~/~/ IMEI 1218 - "deviceTypeId": "" , ~/~/ ID типа устройства 1219 - "modelId": "" , ~/~/ ID модели 1220 - "unitId": "" , ~/~/ ID подразделения 1221 - "sim1": "" , ~/~/ Номер SIM 1 1222 - "sim2": "" , ~/~/ Номер SIM2 1223 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1224 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1225 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1226 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1227 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1228 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1229 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1230 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1231 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1232 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1233 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1234 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 242 +Метод запроса: PUT 1235 1235 1236 - "mileageCalcMethod": 0, 1237 - "mileageCoeff": 0, 1238 - "locationByCellId": true, 1239 - "dottedLineTrackWhenNoCoords": true, 1240 - "counters": ~/~/ счетчики 1241 - { 1242 - "mileage": "" , ~/~/ пробег 1243 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1244 - "motohours": "" , ~/~/ моточасы 1245 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1246 - }, 1247 - "cmsv6Parameters": { ~/~/ параметры CMSv6 1248 - "enabled": true, ~/~/ флаг включения 1249 - "id": "" , ~/~/ идентификатор 1250 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1251 - "login": "" , ~/~/ имя учетной записи 1252 - "password": "" ~/~/ пароль учетной записи 1253 - }, 1254 - "inspectionTasks": ~/~/ задания на ТО 1255 - { 1256 - "enabled": "" , ~/~/ Признак включения 1257 - "name": "" , ~/~/ Имя задания 1258 - "description": "" , ~/~/ Описание задания 1259 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1260 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1261 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1262 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1263 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1264 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1265 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1266 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1267 - } 244 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]] 1268 1268 1269 -"drivers": [ ~/~/ Водители 1270 - { 1271 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1272 - "isDefault": true 1273 - } 1274 - ], 1275 - "commandTemplates": [ ~/~/ Шаблон команды 1276 - { 1277 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1278 - "name": "string", 1279 - "command": "string", 1280 - "retries": 0 1281 - } 1282 - ], 246 +В заголовках запроса: X-Auth: Токен авторизации 1283 1283 1284 - "sensors": [ ~/~/ Датчики 1285 - { 1286 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1287 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1288 - "type": 0, ~/~/ Тип датчика 1289 - "name": "string", ~/~/ Имя датчика 1290 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1291 - "inputNumber": 0, ~/~/ Номер входа 1292 - "pseudonym": "string", ~/~/ Псевдоним 1293 - "medianDegree": 0, ~/~/ Медианная фильтрация 1294 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1295 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1296 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1297 - "gradesTables": [ ~/~/ Массив таблиц тарировки 1298 - { 1299 - "grades": [ ~/~/ Таблица тарировки 1 1300 - { 1301 - "input": 0, ~/~/ Входящее значение 1302 - "output": 0 ~/~/ Выходящее значение 1303 - } 1304 - ], 1305 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1306 - } 1307 - ], 1308 - "showInTooltip": true, ~/~/ Отображать в подсказке 1309 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 1310 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1311 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1312 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1313 - "expr": "string", ~/~/ Формула 1314 - "children": [ ~/~/ массив дочерних датчиков 1315 - "string" 1316 - ], 1317 - "customParams": { ~/~/ прочие произвольные параметры 1318 - "additionalProp1": "string", 1319 - "additionalProp2": "string", 1320 - "additionalProp3": "string" 1321 - }, 248 +Параметры в теле запроса (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 - блокирован) 1322 1322 1323 -~/~/ Характерные для произвольного: 250 +{{{ "description": "", // описание 251 + "data": "" // данные, связанные со сменой статуса}}} 1324 1324 1325 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1326 - 1327 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1328 - 1329 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1330 - 1331 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1332 - 1333 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1334 - 1335 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1336 - 1337 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1338 - 1339 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1340 - 1341 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1342 - 1343 -~/~/ "ValueOn": "Вкл.", 1344 - 1345 -~/~/ "ValueOff": "Выкл." 1346 - "summaryMaxValue": 0 ~/~/ Макс. значение 1347 - } 1348 - ], 1349 - "customFields": [ ~/~/ Произвольные поля 1350 - { 1351 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1352 - "name": "string", 1353 - "value": "string", 1354 - "forClient": true, 1355 - "forTooltip": true, 1356 - "forReport": true 1357 - } 1358 - ] 1359 1359 } 1360 1360 1361 -(% style="color:#000000" %)Ответ: 255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 256 + 1362 1362 1363 - (%style="color:#000000"%){258 + **Удаление пользователя** 1364 1364 1365 - "vehicleId": "", ~/~/ID ТС 1366 - "parentId": "", ~/~/Guid владельца ТС 1367 - "name": "", ~/~/Имя объекта 1368 - "imei": "", ~/~/IMEI 1369 - "deviceTypeId": "", ~/~/ID типа устройства 1370 - "modelId": "", ~/~/ID модели 1371 - "unitId": "", ~/~/ID подразделения 1372 - "sim1": "", ~/~/SIM1 1373 - "sim2": "", ~/~/SIM2 1374 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1375 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1376 - "counters": { ~/~/Счётчики 1377 - "mileageEnabled": true, 1378 - "motohoursEnabled": true, 1379 - "mileage": "", 1380 - "motohours": 345.0 1381 - }, 1382 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1383 - "id": null, 1384 - "enabled": true, ~/~/флаг включения 1385 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1386 - "login": "", ~/~/ имя учетной записи 1387 - "password": "" ~/~/ пароль учетной записи 1388 - }, 1389 - "inspectionTasks": { ~/~/ задания на ТО 1390 - "id": "", ~/~/ ID задачи 1391 - "enabled": false, ~/~/ Признак включения 1392 - "name": "", ~/~/ Имя задания 1393 - "description": "", ~/~/ Описание задания 1394 - "mileageCondition": "", ~/~/ Условие по пробегу 1395 - "lastMileage": "", ~/~/ Пробег (в метрах) 1396 - "motohoursCondition": "", ~/~/ Условие по моточасам 1397 - "lastMotohours": "", ~/~/ Моточасы 1398 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1399 - "kind": "", ~/~/ Вид периодичности по времени 1400 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1401 - } 260 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 1402 1402 1403 -(% style="text-align:left" %) 1404 -(% style="color:#000000" %)} 262 +Метод запроса: DELETE 1405 1405 1406 -**Валидация:** 1407 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1408 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1409 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 264 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id} 1410 1410 1411 - ==(% style="color:#000000;font-size:16px"%)**Получениепараметровобъектов**(%%) ==266 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 1412 1412 1413 -(% class="box infomessage" %) 1414 -((( 1415 -(% lang="en-US" %)**POST /api/v3/vehicles/find** 1416 -))) 268 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 269 + 1417 1417 1418 - (%style="color:#000000"%)Методпозволяетполучитьосновные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение,номера телефонов и идентификатор клиента, к которому прикреплен объект(клиент-родитель).271 + **Добавление объекта** 1419 1419 1420 - (% style="color:#000000" %)Методвозвращаетинформациюобобъектахс учетомнастроекавторизованногопользователя,указанного273 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8) 1421 1421 1422 - (% style="color:#000000" %)− возвращается информация об объектах клиента-родителяавторизованногопользователяи объектах его дочерних клиентов;275 +Метод запроса: POST 1423 1423 1424 - (%style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;277 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 1425 1425 1426 - (%style="color:#000000" %)− информация предоставляется с учетом наличия правна просмотр объектов заблокированныхдоговоров (объекты, принадлежащиезаблокированному договору возвращаются при наличиилюбогоиз прав **«__Видимость объектов заблокированныхдоговоров в панели управления__»** или **«__Видимостьобъектовзаблокированных договоров в мониторинге__»**;279 +В заголовках запроса: X-Auth: Токен авторизации 1427 1427 1428 - (% style="color:#000000" %)− информацияотелефонахSIM1/SIM2предоставляется приналичии права**«__Просмотрномеровтелефоновобъектов__»**;281 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 1429 1429 1430 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 1431 - 1432 -(% style="color:#000000" %)Метод запроса: **POST** 1433 - 1434 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 1435 - 1436 -(% style="color:#000000" %)В заголовках запроса: 1437 - 1438 -(% style="color:#000000" %)− Content-Type: __**application/json**__ 1439 - 1440 -(% style="color:#000000" %)− X-Auth: Токен авторизации 1441 - 1442 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 1443 - 1444 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 1445 - 1446 -{ 1447 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1448 - "name": null, ~/~/ Имя ТС (string, опционально) 1449 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1450 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1451 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1452 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1453 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1454 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1455 -} 1456 - 1457 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 1458 - 1459 -(% style="color:#000000" %)Ответ: 1460 - 1461 -(% style="color:#000000" %){ 1462 - 1463 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1464 - "name": "" ~/~/ наименование объекта 1465 - "imei": "" ~/~/ IMEI объекта 1466 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 1467 - "deviceTypeName": "" ~/~/ наименование типа устройства 1468 - "sim1": "" ~/~/ первый номер телефона 1469 - "sim2": "" ~/~/ второй номер телефона 1470 - "parentId": "" ~/~/ идентификатор клиента-родителя 1471 - "parentName": "" ~/~/ наименование клиента-родителя 1472 - "modelId": "" ~/~/ идентификатор модели объекта 1473 - "modelName": "" ~/~/ наименование модели объекта 1474 - "unitId": "" ~/~/ идентификатор подразделения 1475 - "unitName": "" ~/~/ наименование подразделения 1476 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1477 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1478 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1479 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1480 - "customFields": [ 1481 - { 1482 - "id": "", ~/~/ идентификатор произвольного поля 1483 - "name": "", ~/~/ имя произвольного поля 1484 - "value": "", ~/~/ значение произвольного поля 1485 - "forClient": true, ~/~/ право на отображение у клиента 1486 - "forTooltip": false, ~/~/ право на отображение в подсказке 1487 - "forReport": false ~/~/ право на отображение в отчетах 1488 - }(%%) 1489 -(% style="color:#000000" %)} 1490 - 1491 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1492 - 1493 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 1494 - 1495 -(% class="box successmessage" %) 1496 -((( 1497 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 1498 -))) 1499 - 1500 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 1501 - 1502 -(% style="color:#000000" %)Метод запроса: **POST** 1503 - 1504 -(% 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} 1505 - 1506 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 1507 - 1508 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1509 - 1510 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 1511 - 1512 -(% style="color:#000000" %){ 1513 - 1514 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1515 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1516 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1517 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1518 - "description": "", ~/~/ Описание 1519 - "data": "", ~/~/ Данные 1520 - "overwrite": false, ~/~/ Флаг перезаписи 1521 - "stage": "", ~/~/ Состояние, может быть null 1522 - 1523 -(% style="color:#000000" %)} 1524 - 1525 -(% style="color:#000000" %)Ответ: 1526 - 1527 -(% style="color:#000000" %){ 1528 - 1529 - "status": "", ~/~/ значение статуса 1530 - "date": "", ~/~/ Дата смены статуса 1531 - "description": "", ~/~/ Описание 1532 - "data": "", ~/~/ Данные 1533 - "overwrite": false, ~/~/ Флаг перезаписи 1534 - "stage": "", ~/~/ Состояние 1535 - 1536 -(% style="text-align:left" %) 1537 -(% style="color:#000000" %) } 1538 - 1539 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1540 - 1541 -(% class="box warningmessage" %) 1542 -((( 1543 -(% lang="en-US" %)**PUT /api/v3/vehicles** 1544 -))) 1545 - 1546 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 1547 - 1548 -(% style="color:#000000" %)Метод запроса: **PUT** 1549 - 1550 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 1551 - 1552 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1553 - 1554 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 1555 - 1556 -(% style="color:#000000" %){ 1557 - "vehicleId": , ~/~/ ID объекта 1558 - "parentId": "" , ~/~/ ID клиента 1559 - "name": "" , ~/~/ имя ТС 1560 - "imei": "" , ~/~/ IMEI 1561 - "deviceTypeId": "" , ~/~/ ID типа устройства 1562 - "modelId": "" , ~/~/ ID модели 1563 - "unitId": "" , ~/~/ ID подразделения 1564 - "sim1": "" , ~/~/ Номер SIM 1 1565 - "sim2": "" , ~/~/ Номер SIM2 1566 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1567 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1568 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1569 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1570 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1571 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1572 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1573 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1574 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1575 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1576 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1577 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1578 - 1579 - "mileageCalcMethod": 0, 1580 - "mileageCoeff": 0, 1581 - "locationByCellId": true, 1582 - "dottedLineTrackWhenNoCoords": true, 1583 - "counters": ~/~/ счетчики 1584 - { 1585 - "mileage": "" , ~/~/ пробег 1586 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1587 - "motohours": "" , ~/~/ моточасы 1588 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 283 +{{{ "parentId": "", // ID клиента 284 + "name": "", // имя ТС 285 + "imei": "", // IMEI 286 + "deviceTypeId": "",// ID типа устройства 287 + "modelId": "", 288 + "unitId": "", // ID подразделения 289 + "sim1": "", // Номер SIM 1 290 + "sim2": "", // Номер SIM2 291 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 292 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 293 + "consumptionIdle": "",// Расход топлива на холостом ходу 294 + "counters": { 295 + "mileage": "", // пробег 296 + "mileageEnabled": true, // флаг активности счётчика "пробег" 297 + "motohours":"", // моточасы 298 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 299 + }, 300 + "cmsv6Parameters": { // параметры CMSv6 301 + "enabled": true, // флаг включения 302 + //"id": "", // идентификатор 303 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 304 + "login": "", // имя учетной записи 305 + "password": "" // пароль учетной записи 1589 1589 }, 1590 - "cmsv6Parameters": { ~/~/ параметры CMSv6 1591 - "enabled": true, ~/~/ флаг включения 1592 - "id": "" , ~/~/ идентификатор 1593 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1594 - "login": "" , ~/~/ имя учетной записи 1595 - "password": "" ~/~/ пароль учетной записи 1596 - }, 1597 - "inspectionTasks": ~/~/ задания на ТО 307 + "inspectionTasks": [ // задания на ТО 1598 1598 { 1599 - "enabled": "" , ~/~/ Признак включения 1600 - "name": "" , ~/~/ Имя задания 1601 - "description": "" , ~/~/ Описание задания 1602 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1603 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1604 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1605 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1606 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1607 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1608 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1609 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1610 - } 1611 - 1612 -"drivers": [ ~/~/ Водители 1613 - { 1614 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1615 - "isDefault": true 1616 - } 1617 - ], 1618 - "commandTemplates": [ ~/~/ Шаблон команды 1619 - { 1620 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1621 - "name": "string", 1622 - "command": "string", 1623 - "retries": 0 1624 - } 1625 - ], 1626 - 1627 - "sensors": [ ~/~/ Датчики 1628 - { 1629 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1630 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1631 - "type": 0, ~/~/ Тип датчика 1632 - "name": "string", ~/~/ Имя датчика 1633 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1634 - "inputNumber": 0, ~/~/ Номер входа 1635 - "pseudonym": "string", ~/~/ Псевдоним 1636 - "medianDegree": 0, ~/~/ Медианная фильтрация 1637 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1638 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1639 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1640 - "gradesTables": [ ~/~/ Массив таблиц тарировки 1641 - { 1642 - "grades": [ ~/~/ Таблица тарировки 1 1643 - { 1644 - "input": 0, ~/~/ Входящее значение 1645 - "output": 0 ~/~/ Выходящее значение 1646 - } 1647 - ], 1648 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1649 - } 1650 - ], 1651 - "showInTooltip": true, ~/~/ Отображать в подсказке 1652 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 1653 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1654 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1655 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1656 - "expr": "string", ~/~/ Формула 1657 - "children": [ ~/~/ массив дочерних датчиков 1658 - "string" 1659 - ], 1660 - "customParams": { ~/~/ прочие произвольные параметры 1661 - "additionalProp1": "string", 1662 - "additionalProp2": "string", 1663 - "additionalProp3": "string" 309 + "enabled": "", // Признак включения 310 + "name": "", // Имя задания 311 + "description": "", // Описание задания 312 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 313 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 314 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 315 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 316 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 317 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 318 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 319 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 1664 1664 }, 321 + ]}}} 1665 1665 1666 - ~/~/Характерные для произвольного:323 +… } 1667 1667 1668 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1669 - 1670 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1671 - 1672 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1673 - 1674 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1675 - 1676 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1677 - 1678 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1679 - 1680 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1681 - 1682 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1683 - 1684 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1685 - 1686 -~/~/ "ValueOn": "Вкл.", 1687 - 1688 -~/~/ "ValueOff": "Выкл." 1689 - "summaryMaxValue": 0 ~/~/ Макс. значение 1690 - } 1691 - ], 1692 - "customFields": [ ~/~/ Произвольные поля 1693 - { 1694 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1695 - "name": "string", 1696 - "value": "string", 1697 - "forClient": true, 1698 - "forTooltip": true, 1699 - "forReport": true 1700 - } 1701 - ] 1702 -} 1703 - 1704 -(% style="color:#000000" %)Ответ: 1705 - 1706 -(% lang="en-US" style="text-align:left" %) 1707 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1708 - 1709 -(% lang="en-US" style="text-align:left" %) 1710 - "vehicleId": "", ~/~/ ID ТС 1711 - "parentId": "", ~/~/ ID клиента 1712 - "name": "", ~/~/ имя ТС 1713 - "imei": "", ~/~/ IMEI 1714 - "deviceTypeId": "", ~/~/ типа устройства 1715 - "modelId": "", ~/~/ ID модели 1716 - "unitId": "", ~/~/ ID подразделения 1717 - "sim1": "", ~/~/ SIM 1 1718 - "sim2": "", ~/~/ SIM2 1719 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1720 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1721 - "counters": 1722 - { 1723 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1724 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1725 - "mileage": "", ~/~/ пробег 1726 - "motohours": "", ~/~/ моточасы 1727 - } 1728 - "cmsv6Parameters": ~/~/ параметры CMSv6 1729 - { 1730 - "id": ~/~/ идентификатор 1731 - "enabled": true, ~/~/ флаг включения 1732 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1733 - "login": "", ~/~/ имя учетной записи 1734 - "password": "", ~/~/ пароль учетной записи 1735 - } 1736 - "inspectionTasks": ~/~/ задания на ТО 1737 - { 1738 - "id": "", ~/~/ ID задания 1739 - "enabled": false, ~/~/ Признак включения 1740 - "name": "", ~/~/ Имя задания 1741 - "description": "", ~/~/ Описание задания 1742 - "mileageCondition": "", ~/~/ Условие по пробегу 1743 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1744 - "motohoursCondition": "", ~/~/ Условие по моточасам 1745 - "lastMotohours": "", ~/~/ Моточасы 1746 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1747 - "kind": "", ~/~/ Вид периодичности по времени 1748 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1749 - } 1750 - 1751 -(% lang="en-US" style="text-align:left" %) 1752 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1753 - 1754 -**Валидация:** 1755 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1756 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1757 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1758 - 1759 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1760 - 1761 -(% class="box errormessage" %) 1762 -((( 1763 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1764 -))) 1765 - 1766 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1767 - 1768 -(% style="color:#000000" %)Метод запроса: **DELETE** 1769 - 1770 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 1771 - 1772 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 1773 - 1774 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1775 - 1776 -(% style="text-align:left" %) 1777 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1778 - 1779 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1780 - 1781 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1782 - 1783 -(% class="box infomessage" %) 1784 -((( 1785 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1786 -))) 1787 - 1788 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1789 - 1790 -(% style="color:#000000" %)Метод запроса: **GET** 1791 - 1792 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1793 - 1794 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1795 - 1796 -(% style="color:#000000" %)Ответ: 1797 - 1798 -(% style="color:#000000" %){ 1799 - 1800 - "deviceTypeId" : "", ~/~/ ID типа устройства 1801 - "deviceTypeName" : "" ~/~/ Название типа устройства 1802 - 1803 -(% style="text-align:left" %) 1804 -(% style="color:#000000" %)} 1805 - 1806 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1807 - 1808 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1809 - 1810 -(% class="box infomessage" %) 1811 -((( 1812 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1813 -))) 1814 - 1815 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1816 - 1817 -(% style="color:#000000" %)Метод запроса: **GET** 1818 - 1819 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1820 - 1821 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1822 - 1823 -(% style="color:#000000" %)Ответ: 1824 - 1825 -(% style="color:#000000" %){ 1826 - 1827 - "id": "", ~/~/ ID типа датчика 1828 - "name": "", ~/~/ Название 1829 - "description": "", ~/~/ Описание 1830 - 1831 -(% style="text-align:left" %) 1832 -(% style="color:#000000" %)} 1833 - 1834 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1835 - 1836 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1837 - 1838 -(% class="box infomessage" style="text-align: left;" %) 1839 -((( 1840 -**POST /api/v3/terminalMessages/count** 1841 -))) 1842 - 1843 -(% style="text-align: left;" %) 1844 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1845 - 1846 -(% style="text-align: left;" %) 1847 -Метод запроса **POST** 1848 - 1849 -(% style="text-align: left;" %) 1850 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1851 - 1852 -(% style="text-align: left;" %) 1853 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1854 - 1855 -(% style="text-align: left;" %) 1856 -{ 1857 - "vehicleIds": [ 1858 - id ~/~/ здесь передается список идентификаторов объектов 1859 - ], 1860 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1861 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1862 -} 1863 - 1864 -(% style="text-align: left;" %) 1865 1865 Ответ: 1866 1866 1867 -(% style="text-align: left;" %) 1868 -[ 1869 - { 1870 - "vehicleId": 0, ~/~/ идентификатор объекта 1871 - "count": 0 ~/~/ количество сообщений за период 1872 - } 1873 -] 1874 - 1875 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1876 - 1877 -(% class="box infomessage" %) 1878 -((( 1879 -**POST /api/v3/terminalMessages** 1880 -))) 1881 - 1882 -Метод возвращает список сообщений терминала объекта за выбранный период. 1883 - 1884 -(% style="text-align: left;" %) 1885 -Метод запроса **POST** 1886 - 1887 -(% style="text-align: left;" %) 1888 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1889 - 1890 -(% style="text-align: left;" %) 1891 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1892 - 1893 1893 { 1894 - "vehicleId": 0, ~/~/ id объекта 1895 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1896 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1897 -} 1898 1898 1899 -Ответ: 1900 - 1901 -[ 1902 - { 1903 - "messages": [ 329 +{{{ "vehicleId": "", //ID ТС 330 + "parentId": "", //Guid владельца ТС 331 + "name": "", //Имя объекта 332 + "imei": "", //IMEI 333 + "deviceTypeId": "", //ID типа устройства 334 + "modelId": "", //ID модели 335 + "unitId": "", //ID подразделения 336 + "sim1": "", //SIM1 337 + "sim2": "", //SIM2 338 + "consumptionPer100Km": "", //Расход топлива на 100 км 339 + "consumptionIdle": "", //Расход топлива на холостом ходу 340 + "counters": { //Счётчики 341 + "mileageEnabled": true, 342 + "motohoursEnabled": true, 343 + "mileage": "", 344 + "motohours": 345.0 345 + }, 346 + "cmsv6Parameters": { //Параметры CmsV6 347 + "id": null, 348 + "enabled": true, //флаг включения 349 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 350 + "login": "", // имя учетной записи 351 + "password": "" // пароль учетной записи 352 + }, 353 + "inspectionTasks": [ // задания на ТО 1904 1904 { 1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1907 - "speed": 0, ~/~/ Скорость, км/ч 1908 - "altitude": 0, ~/~/ Высота, м 1909 - "latitude": 0, ~/~/ Широта [-90°;90°] 1910 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1911 - "satellites": 0, ~/~/ Кол-во спутников 1912 - "voltage": 0, ~/~/ Напряжение 1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1914 - "additionalProp1": "string", 1915 - "additionalProp2": "string", 1916 - "additionalProp3": "string" 1917 - }, 1918 - "photoCount": 0 ~/~/ Кол-во фото 1919 - } 1920 - ] 1921 - } 1922 -] 355 + "id": "", // ID задачи 356 + "enabled": false, // Признак включения 357 + "name": "", // Имя задания 358 + "description": "", // Описание задания 359 + "mileageCondition": "", // Условие по пробегу 360 + "lastMileage": "", // Пробег (в метрах) 361 + "motohoursCondition": "", // Условие по моточасам 362 + "lastMotohours": "", // Моточасы 363 + "periodicCondition": "", // Условие периодичности по времени}}} 1923 1923 1924 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1925 - 1926 -(% class="box infomessage" %) 1927 -((( 1928 -**POST /api/v3/vehicles/export/history** 1929 -))) 1930 - 1931 -Метод возвращает список сообщений терминала объекта за выбранный период. 1932 - 1933 -(% style="text-align: left;" %) 1934 -Метод запроса **POST** 1935 - 1936 -(% style="text-align: left;" %) 1937 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1938 - 1939 -(% style="text-align: left;" %) 1940 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1941 - 1942 -{ 1943 - "vehicleId": 0, ~/~/ ID объекта 1944 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1945 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1946 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1947 -} 1948 - 1949 -Ответ: 1950 - 1951 -Получаете файл. Сообщение: Code 200/Success 1952 - 1953 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1954 - 1955 -(% class="box infomessage" %) 1956 -((( 1957 -**GET /api/v3/vehicles/export/history/status** 1958 -))) 1959 - 1960 -Метод возвращает список сообщений терминала объекта за выбранный период. 1961 - 1962 -(% style="text-align: left;" %) 1963 -Метод запроса **GET** 1964 - 1965 -(% style="text-align: left;" %) 1966 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1967 - 1968 -(% style="text-align: left;" %) 1969 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1970 - 1971 -Ответ: 1972 - 1973 -{ 1974 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1975 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1976 - "message": "string" ~/~/ текст описывающий статус. 1977 -} 1978 - 1979 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1980 - 1981 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1982 - 1983 -(% class="box infomessage" %) 1984 -((( 1985 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1986 -))) 1987 - 1988 -(% style="color:#000000" %)Метод запроса: **POST** 1989 - 1990 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1991 - 1992 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1993 - 1994 -(% style="text-align:left" %) 1995 -Тело запроса: 1996 - 1997 -{ 1998 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1999 - "vehicleIds": [0], ~/~/ Список ID объектов 2000 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2001 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2002 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2003 -} 2004 - 2005 -Ответ: 2006 - 2007 -[ 2008 - { 2009 - "vehicleId": 0, ~/~/ ID объекта 2010 - "name": "string", ~/~/ Имя ТС 2011 - "periods": [ ~/~/ Периоды 2012 - { 2013 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2014 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2015 - "mileageBegin": 0, ~/~/ Пробег на начало периода 2016 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 2017 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2018 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 365 +{{{ "kind": "", // Вид периодичности по времени 366 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 2019 2019 } 2020 - ] 2021 - } 2022 -] 368 + ]}}} 2023 2023 2024 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2025 - 2026 -(% class="box infomessage" %) 2027 -((( 2028 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2029 -))) 2030 - 2031 -(% style="color:#000000" %)Метод запроса: **POST** 2032 - 2033 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2034 - 2035 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2036 - 2037 -(% style="text-align:left" %) 2038 -Тело запроса: 2039 - 2040 -{ 2041 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2042 - "vehicleIds": [0], ~/~/ Список ID объектов 2043 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2044 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2045 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2046 2046 } 371 + 2047 2047 2048 - Ответ:373 + **Удаление объекта** 2049 2049 2050 -[ 2051 - { 2052 - "vehicleId": 0, ~/~/ ID объекта 2053 - "name": "string", ~/~/ Имя ТС 2054 - "periods": [ ~/~/ Периоды 2055 - { 2056 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2057 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2058 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2059 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2060 - "fuelConsumption": 0, ~/~/ Расход топлива 2061 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2062 - } 2063 - ] 2064 - } 2065 -] 375 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 2066 2066 2067 - == (% style="color:#000000; font-size:16px" %)**Получениеданныхозаправках и сливах транспортногосредства**(%%)==377 +Метод запроса: DELETE 2068 2068 2069 -(% class="box infomessage" %) 2070 -((( 2071 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2072 -))) 379 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId} 2073 2073 2074 - (% style="color:#000000" %)Методзапроса:**POST**381 +Параметр запроса: {id} - Guid объекта 2075 2075 2076 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2077 - 2078 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2079 - 2080 -(% style="text-align:left" %) 2081 -Тело запроса: 2082 - 2083 -{ 2084 - "vehicleIds": [0], ~/~/ Список ID объектов 2085 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2086 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2087 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2088 -} 2089 - 2090 -Ответ: 2091 - 2092 -[ 2093 - { 2094 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2095 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2096 - "vehicleId": 0, ~/~/ ID объекта 2097 - "name": "string", ~/~/ Имя объекта 2098 - "model": "string", ~/~/ Модель объекта 2099 - "fuels": [ ~/~/ Массив данным по заправкам и сливам 2100 - { 2101 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2102 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2103 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2104 - "valueFuel": 0, ~/~/ Количество 2105 - "fuelStart": 0, ~/~/ Уровень топлива на начало события 2106 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2107 - } 2108 - ] 2109 - } 2110 -] 2111 - 2112 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2113 - 2114 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2115 - 2116 -(% class="box infomessage" %) 2117 -((( 2118 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2119 -))) 2120 - 2121 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2122 - 2123 -(% style="color:#000000" %)Метод запроса: **POST** 2124 - 2125 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2126 - 2127 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2128 - 2129 -(% style="text-align:left" %) 2130 -Тело запроса: 2131 - 2132 -(% style="text-align:left" %) 2133 -{ 2134 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2135 -} 2136 - 2137 -(% style="text-align:left" %) 2138 -Ответ: 2139 - 2140 -[ 2141 - { 2142 - "id": 0, ~/~/ Идентификатор объекта геозоны 2143 - "name": "string", ~/~/ Название объекта геозоны 2144 - "type": 0, ~/~/ Тип объекта геозоны 2145 - "fname": "string", ~/~/ Имя файла 2146 - "parentId": "string", ~/~/ Идентификатор клиента 2147 - "radius": 0, ~/~/ Радиус геообъекта 2148 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2149 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2150 - "description": "string", ~/~/ Описание 2151 - "area": 0, ~/~/ Площадь, м^^2^^ 2152 - "perimetr": 0, ~/~/ Периметр, м 2153 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2154 - } 2155 -] 2156 - 2157 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2158 - 2159 -(% class="box infomessage" %) 2160 -((( 2161 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2162 -))) 2163 - 2164 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2165 - 2166 -(% style="color:#000000" %)Метод запроса: **POST** 2167 - 2168 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2169 - 2170 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2171 - 2172 -(% style="text-align:left" %) 2173 -Тело запроса: 2174 - 2175 -{ 2176 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2177 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2178 - "ids": [ ], ~/~/ Массив id объектов 2179 - "byTime": 0, ~/~/ Объединение событий по времени 2180 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2181 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2182 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2183 -} 2184 - 2185 -Ответ: 2186 -[ 2187 - { 2188 - "geozoneId": 0, ~/~/ ID геообъекта 2189 - "geozoneName": "string", ~/~/ Название геообъекта 2190 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2191 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2192 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2193 - "vehicleId": 0, ~/~/ ID объекта 2194 - "vehicleName": "string" ~/~/ Имя объекта 2195 - } 2196 -] 2197 - 2198 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2199 - 2200 -(% class="box infomessage" %) 2201 -((( 2202 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2203 -))) 2204 - 2205 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2206 - 2207 -(% style="color:#000000" %)Метод запроса: **POST** 2208 - 2209 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2210 - 2211 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2212 - 2213 -(% style="text-align:left" %) 2214 -Тело запроса: 2215 - 2216 -{ 2217 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2218 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2219 - "ids": [ ], ~/~/ Массив id геообъектов 2220 - "byTime": 0, ~/~/ Объединение событий по времени 2221 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2222 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2223 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2224 -} 2225 - 2226 -Ответ: 2227 - 2228 -[ 2229 - { 2230 - "geozoneId": 0, ~/~/ ID геообъекта 2231 - "geozoneName": "string", ~/~/ Название геообъекта 2232 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2233 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2234 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2235 - "vehicleId": 0, ~/~/ ID объекта 2236 - "vehicleName": "string" ~/~/ Имя объекта 2237 - } 2238 -] 2239 - 2240 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2241 - 2242 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2243 - 2244 -(% class="box infomessage" %) 2245 -((( 2246 -**POST /api/v3/notifications/find** 2247 -))) 2248 - 2249 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2250 - 2251 -(% style="text-align: left;" %) 2252 -Метод запроса **POST** 2253 - 2254 -(% style="text-align: left;" %) 2255 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2256 - 2257 -(% style="text-align: left;" %) 2258 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2259 - 2260 -{ 2261 - "parentId": "" ~/~/ id клиента 2262 -} 2263 - 2264 -Ответ: 2265 - 2266 -[ 2267 - { 2268 - "id": 0, ~/~/ ID уведомления 2269 - "name": "string", ~/~/ Название уведомления 2270 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2271 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2272 - "userId": "", ~/~/ Пользователь, создавший уведомление 2273 - "parentId": "", ~/~/ Идентификатор клиента 2274 - "parentName": "string" ~/~/ Имя клиента 2275 - } 2276 -] 2277 - 2278 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2279 - 2280 -(% class="box infomessage" %) 2281 -((( 2282 -**GET /api/v3/notifications/{id}** 2283 -))) 2284 - 2285 -Метод возвращает данные правил формирования выбранного уведомления. 2286 - 2287 -(% style="text-align: left;" %) 2288 -Метод запроса **GET** 2289 - 2290 -(% style="text-align: left;" %) 2291 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2292 - 2293 -(% style="text-align: left;" %) 2294 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2295 - 2296 -(% style="text-align: left;" %) 2297 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2298 - 2299 -(% style="text-align: left;" %) 2300 -(% style="color:#000000" %)Ответ: 2301 - 2302 -(% style="text-align: left;" %) 2303 -(% style="color:#000000" %){ 2304 - "id": 0, ~/~/ (%%)id уведомления 2305 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2306 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2307 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2308 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2309 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2310 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2311 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2312 -(% style="color:#000000" %) 0 2313 - ], 2314 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2315 -(% style="color:#000000" %) 0 2316 - ], 2317 - "fieldids": [ ~/~/ (%%)Список id полей для анализа 2318 -(% style="color:#000000" %) 0 2319 - ], 2320 - "settings": { ~/~/ Список параметров уведомления 2321 - "additionalProp1": "string", 2322 - "additionalProp2": "string", 2323 - "additionalProp3": "string" 2324 - }, 2325 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2326 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2327 -(% style="color:#000000" %) "" 2328 - ], 2329 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2330 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2331 -(% style="color:#000000" %) "string" 2332 - ], 2333 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2334 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2335 -(% style="color:#000000" %) { 2336 - "id": 0, ~/~/ (%%)Идентификатор участника чата 2337 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2338 -(% style="color:#000000" %) } 2339 - ], 2340 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2341 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2342 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2343 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2344 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2345 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2346 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2347 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2348 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2349 -(% style="color:#000000" %)} 2350 - 2351 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2352 - 2353 -(% class="box warningmessage" %) 2354 -((( 2355 -**PUT /api/v3/notifications/** 2356 -))) 2357 - 2358 -Метод позволяет отредактировать уведомление. 2359 - 2360 -Метод запроса **PUT** 2361 - 2362 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2363 - 2364 2364 В заголовках запроса: X-Auth: Токен авторизации 2365 2365 2366 -Тело запроса: 2367 -{ 2368 - "id": 0, ~/~/ id уведомления 2369 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2370 - "userId": "", ~/~/ Пользователь, создавший уведомление 2371 - "parentId": "", ~/~/ Идентификатор клиента 2372 - "parentName": "string", ~/~/ Имя клиента 2373 - "name": "string", ~/~/ Название уведомления 2374 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2375 - "vehicleIds": [ ~/~/ Список id объектов для анализа 2376 - 0 2377 - ], 2378 - "geoids": [ ~/~/ Список id геообъектов для анализа 2379 - 0 2380 - ], 2381 - "fieldids": [ ~/~/ Список id полей для анализа 2382 - 0 2383 - ], 2384 - "settings": { ~/~/ Список параметров уведомления 2385 - "additionalProp1": "string", 2386 - "additionalProp2": "string", 2387 - "additionalProp3": "string" 2388 - }, 2389 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2390 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2391 - "" 2392 - ], 2393 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2394 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2395 - "string" 2396 - ], 2397 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2398 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2399 - { 2400 - "id": 0, ~/~/ Идентификатор участника чата 2401 - "info": "string" ~/~/ Дополнительные сведения 2402 - } 2403 - ], 2404 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2405 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2406 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2407 - "kind": 0, ~/~/ Определяет вид уведомления 2408 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2409 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2410 - "timezone": 0, ~/~/ Сдвиг часового пояса 2411 - "validity": 0, ~/~/ Срок действия в днях (1-90) 2412 - "autoProlongation": true ~/~/ Автопродление срока действия 2413 -} 385 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200» 386 + 2414 2414 2415 - Ответ:388 + **Редактирование объекта** 2416 2416 2417 - Success390 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 2418 2418 2419 - == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%)==392 +Метод запроса: PUT 2420 2420 2421 -(% class="box errormessage" %) 2422 -((( 2423 -**DELETE /api/v3/notifications/{id}** 2424 -))) 394 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 2425 2425 2426 -Метод позволяет удалить выбранное уведомление. 2427 - 2428 -Метод запроса **DELETE** 2429 - 2430 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2431 - 2432 -Передаваемый параметр: {id} - id уведомления 2433 - 2434 2434 В заголовках запроса: X-Auth: Токен авторизации 2435 2435 2436 - Ответ:398 +Параметры в теле запроса (JSON): 2437 2437 2438 -Success 400 +//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] } 2439 2439 2440 - 2441 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2442 - 2443 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2444 - 2445 -(% class="box infomessage" %) 2446 -((( 2447 -**POST /api/v3/Drivers/find** 2448 -))) 2449 - 2450 -Передается параметр: parentId - ID клиента-родителя 2451 - 2452 2452 Ответ: 2453 2453 2454 -[ 2455 - { 2456 - "name": "string", ~/~/ Определяет наименование 2457 - "description": "string", ~/~/ Определяет описание 2458 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2459 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2460 - "exclusive": true, ~/~/ Определяет признак "Исключительный" 2461 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2462 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2463 - "deleted": true ~/~/ Признак удаления 2464 - } 2465 -] 404 +{ «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»: «» //Сколько раз выполнить задание } ] } 405 + 2466 2466 2467 - ==(%style="color:#000000;font-size:16px"%)**Получить данныеоводителе**(%%) ==407 + **Изменение статуса объекта** 2468 2468 2469 -(% class="box infomessage" %) 2470 -((( 2471 -**GET /api/v3/Drivers/{driverGuid}** 2472 -))) 409 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») 2473 2473 2474 - Передаетсяпараметр:ID водителя411 +Метод запроса: POST 2475 2475 2476 - Ответ:413 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId} 2477 2477 2478 -{ 2479 - "name": "string", ~/~/ Определяет наименование 2480 - "description": "string", ~/~/ Определяет описание 2481 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2482 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2483 - "exclusive": true, ~/~/ Определяет признак "Исключительный" 2484 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2485 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2486 - "deleted": true ~/~/ Признак удаления 2487 -} 415 +Параметр запроса: {vehicleId} - ID ТС 2488 2488 2489 - ==(%style="color:#000000;font-size:16px"%)**Добавить водителя**(%%) ==417 +В заголовках запроса: X-Auth: Токен авторизации 2490 2490 2491 -(% class="box successmessage" %) 2492 -((( 2493 -**POST /api/v3/Drivers** 2494 -))) 419 +Параметры в теле запроса (JSON): { 2495 2495 2496 -Запрос: 421 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 422 + "date": "", // Дата смены статуса (null если сменить немедленно) 423 + "description": "", // Описание 424 + "data": "", // Данные 425 + "overwrite": false, // Флаг перезаписи 426 + "stage": "", // Состояние, может быть null}}} 2497 2497 2498 -{ 2499 - "name": "string", 2500 - "description": "string", 2501 - "hiredate": "2023-06-30T12:50:54.020Z", 2502 - "chopdate": "2023-06-30T12:50:54.020Z", 2503 - "exclusive": true, 2504 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2505 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2506 - "deleted": true 2507 2507 } 2508 2508 2509 -Ответ: 430 +Ответ: { 2510 2510 2511 -{ 2512 - "name": "string", 2513 - "description": "string", 2514 - "hiredate": "2023-06-30T12:50:54.051Z", 2515 - "chopdate": "2023-06-30T12:50:54.051Z", 2516 - "exclusive": true, 2517 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2518 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2519 - "deleted": true 2520 -} 432 +{{{ "status": "", // значение статуса 433 + "date": "", // Дата смены статуса 434 + "description": "", // Описание 435 + "data": "", // Данные 436 + "overwrite": false, // Флаг перезаписи 437 + "stage": "", // Состояние}}} 2521 2521 2522 - 2523 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2524 - 2525 -(% class="box warningmessage" %) 2526 -((( 2527 -**PUT /api/v3/Drivers** 2528 -))) 2529 - 2530 -Запрос: 2531 - 2532 -{ 2533 - "name": "string", 2534 - "description": "string", 2535 - "hiredate": "2023-06-30T12:50:27.910Z", 2536 - "chopdate": "2023-06-30T12:50:27.910Z", 2537 - "exclusive": true, 2538 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2539 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2540 - "deleted": true 2541 2541 } 440 + 2542 2542 2543 - Ответ:442 + **Проверка авторизации** 2544 2544 2545 -{ 2546 - "name": "string", 2547 - "description": "string", 2548 - "hiredate": "2023-06-30T12:50:27.929Z", 2549 - "chopdate": "2023-06-30T12:50:27.929Z", 2550 - "exclusive": true, 2551 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2552 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2553 - "deleted": true 2554 -} 444 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth» 2555 2555 446 +Метод запроса: GET 2556 2556 2557 - == (%style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==448 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]] 2558 2558 2559 -(% class="box errormessage" %) 2560 -((( 2561 -**DELETE /api/v3/Drivers/{driverGuid}** 2562 -))) 450 +В заголовках запроса: X-Auth: Токен авторизации 2563 2563 2564 - Передаетсяпараметр:IDводителя452 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401» 2565 2565 2566 -Ответ: 2567 - 2568 -Success 2569 - 2570 - 2571 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 2572 - 2573 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 2574 - 2575 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2576 - 2577 -(% class="box infomessage" %) 2578 -((( 2579 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2580 -))) 2581 - 2582 -Запрос: 2583 - 2584 -{ 2585 - "Ids": [ 2586 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2587 - ], 2588 - "BeginTime": "2023-06-30T12:49:04.365Z", 2589 - "EndTime": "2023-06-30T12:49:04.365Z" 2590 -} 2591 - 2592 -Ответ: 2593 - 2594 -[ 2595 - { 2596 - "VehicleId": 0, 2597 - "CreateTime": "2023-06-30T09:52:31.240Z", 2598 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2599 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2600 - "BeginTime": "2023-06-30T09:52:31.240Z", 2601 - "EndTime": "2023-06-30T09:52:31.240Z" 2602 - } 2603 -] 2604 - 2605 - 2606 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2607 - 2608 -(% class="box infomessage" %) 2609 -((( 2610 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2611 -))) 2612 - 2613 -Запрос: 2614 - 2615 -{ 2616 - "Ids": [ 2617 - 0 2618 - ], 2619 - "BeginTime": "2023-06-30T12:48:39.419Z", 2620 - "EndTime": "2023-06-30T12:48:39.419Z" 2621 -} 2622 - 2623 -Ответ: 2624 - 2625 -[ 2626 - { 2627 - "VehicleId": 0, 2628 - "CreateTime": "2023-06-30T09:54:01.631Z", 2629 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2630 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2631 - "BeginTime": "2023-06-30T09:54:01.631Z", 2632 - "EndTime": "2023-06-30T09:54:01.631Z" 2633 - } 2634 -] 2635 - 2636 - 2637 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2638 - 2639 -(% class="box successmessage" %) 2640 -((( 2641 -**POST /api/v3/DriversVehiclesAssignments** 2642 -))) 2643 - 2644 -Передается массив назначений 2645 - 2646 -Запрос: 2647 - 2648 -[ 2649 - { 2650 - "VehicleId": 0, ~/~/ Идентификатор объекта 2651 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2652 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2653 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2654 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2655 - } 2656 -] 2657 - 2658 -Ответ: 2659 - 2660 -[ 2661 - { 2662 - "VehicleId": 0, 2663 - "CreateTime": "2023-06-30T11:04:46.903Z", 2664 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2665 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2666 - "BeginTime": "2023-06-30T11:04:46.903Z", 2667 - "EndTime": "2023-06-30T11:04:46.903Z" 2668 - } 2669 -] 2670 - 2671 - 2672 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2673 - 2674 -(% class="box warningmessage" %) 2675 -((( 2676 -**PUT /api/v3/DriversVehiclesAssignments** 2677 -))) 2678 - 2679 -Запрос: 2680 - 2681 -[ 2682 - { 2683 - "VehicleId": 0, 2684 - "CreateTime": "2023-06-30T11:14:08.117Z", 2685 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2686 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2687 - "BeginTime": "2023-06-30T11:14:08.117Z", 2688 - "EndTime": "2023-06-30T11:14:08.117Z" 2689 - } 2690 -] 2691 - 2692 -Ответ: 2693 - 2694 -[ 2695 - { 2696 - "VehicleId": 0, 2697 - "CreateTime": "2023-06-30T11:14:53.349Z", 2698 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2699 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2700 - "BeginTime": "2023-06-30T11:14:53.349Z", 2701 - "EndTime": "2023-06-30T11:14:53.349Z" 2702 - } 2703 -] 2704 - 2705 - 2706 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2707 - 2708 -(% class="box errormessage" %) 2709 -((( 2710 -**DELETE /api/v3/DriversVehiclesAssignments** 2711 -))) 2712 - 2713 -Запрос: 2714 - 2715 -[ 2716 - "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2717 -] 2718 - 2719 -Ответ: 2720 - 2721 -Success 2722 - 2723 - 2724 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2725 - 2726 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2727 - 2728 -(% class="box infomessage" %) 2729 -((( 2730 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2731 -))) 2732 - 2733 -Запрос: 2734 - 2735 -{ 2736 - "Ids": [ 2737 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2738 - ], 2739 - "BeginTime": "2023-06-30T12:47:12.162Z", 2740 - "EndTime": "2023-06-30T12:47:12.162Z" 2741 -} 2742 - 2743 -Ответ: 2744 - 2745 -[ 2746 - { 2747 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2748 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2749 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2750 - "BeginTime": "2023-06-30T11:19:40.703Z", 2751 - "EndTime": "2023-06-30T11:19:40.703Z" 2752 - } 2753 -] 2754 - 2755 - 2756 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2757 - 2758 -(% class="box infomessage" %) 2759 -((( 2760 -**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2761 -))) 2762 - 2763 -Запрос: 2764 - 2765 -{ 2766 - "Ids": [ 2767 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2768 - ], 2769 - "BeginTime": "2023-06-30T12:47:12.162Z", 2770 - "EndTime": "2023-06-30T12:47:12.162Z" 2771 -} 2772 - 2773 -Ответ: 2774 - 2775 -[ 2776 - { 2777 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2778 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2779 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2780 - "BeginTime": "2023-06-30T11:19:40.703Z", 2781 - "EndTime": "2023-06-30T11:19:40.703Z" 2782 - } 2783 -] 2784 - 2785 - 2786 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2787 - 2788 -(% class="box successmessage" %) 2789 -((( 2790 -**POST /api/v3/DriversRfidsAssignments** 2791 -))) 2792 - 2793 -Запрос: 2794 - 2795 -[ 2796 - { 2797 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2798 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2799 - "BeginTime": "2023-06-30T11:27:08.635Z", 2800 - "EndTime": "2023-06-30T11:27:08.635Z" 2801 - } 2802 -] 2803 - 2804 -Ответ: 2805 - 2806 -[ 2807 - { 2808 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2809 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2810 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2811 - "BeginTime": "2023-06-30T11:27:08.677Z", 2812 - "EndTime": "2023-06-30T11:27:08.677Z" 2813 - } 2814 -] 2815 - 2816 - 2817 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2818 - 2819 -(% class="box warningmessage" %) 2820 -((( 2821 -**PUT /api/v3/DriversRfidsAssignments** 2822 -))) 2823 - 2824 -Запрос: 2825 - 2826 -[ 2827 - { 2828 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2829 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2830 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2831 - "BeginTime": "2023-06-30T11:28:43.330Z", 2832 - "EndTime": "2023-06-30T11:28:43.330Z" 2833 - } 2834 -] 2835 - 2836 -Ответ: 2837 - 2838 -[ 2839 - { 2840 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2841 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2842 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2843 - "BeginTime": "2023-06-30T11:28:43.331Z", 2844 - "EndTime": "2023-06-30T11:28:43.331Z" 2845 - } 2846 -] 2847 - 2848 - 2849 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2850 - 2851 -(% class="box errormessage" %) 2852 -((( 2853 -**DELETE /api/v3/DriversRfidsAssignments** 2854 -))) 2855 - 2856 -Запрос: 2857 - 2858 -[ 2859 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2860 -] 2861 - 2862 -Ответ: 2863 - 2864 -Success 2865 - 2866 - 2867 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 2868 - 2869 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2870 - 2871 -(% class="box infomessage" %) 2872 -((( 2873 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 2874 -))) 2875 - 2876 -Запрос: 2877 - 2878 -{ 2879 - "Ids": [ 2880 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2881 - ], 2882 - "BeginTime": "2023-06-30T12:45:10.852Z", 2883 - "EndTime": "2023-06-30T12:45:10.852Z" 2884 -} 2885 - 2886 -Ответ: 2887 - 2888 -[ 2889 - { 2890 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2891 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2892 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2893 - "BeginTime": "2023-06-30T11:58:04.695Z", 2894 - "EndTime": "2023-06-30T11:58:04.695Z" 2895 - } 2896 -] 2897 - 2898 - 2899 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2900 - 2901 -(% class="box infomessage" %) 2902 -((( 2903 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 2904 -))) 2905 - 2906 -Запрос: 2907 - 2908 -{ 2909 - "Ids": [ 2910 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2911 - ], 2912 - "BeginTime": "2023-06-30T12:45:10.852Z", 2913 - "EndTime": "2023-06-30T12:45:10.852Z" 2914 -} 2915 - 2916 -Ответ: 2917 - 2918 -[ 2919 - { 2920 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2921 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2922 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2923 - "BeginTime": "2023-06-30T11:58:04.695Z", 2924 - "EndTime": "2023-06-30T11:58:04.695Z" 2925 - } 2926 -] 2927 - 2928 - 2929 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2930 - 2931 -(% class="box successmessage" %) 2932 -((( 2933 -**POST /api/v3/DriversFuelCardsAssignments** 2934 -))) 2935 - 2936 -Запрос: 2937 - 2938 -[ 2939 - { 2940 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2941 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2942 - "BeginTime": "2023-06-30T12:09:53.175Z", 2943 - "EndTime": "2023-06-30T12:09:53.175Z" 2944 - } 2945 -] 2946 - 2947 -Ответ: 2948 - 2949 -[ 2950 - { 2951 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2952 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "BeginTime": "2023-06-30T12:09:53.201Z", 2955 - "EndTime": "2023-06-30T12:09:53.201Z" 2956 - } 2957 -] 2958 - 2959 - 2960 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2961 - 2962 -(% class="box warningmessage" %) 2963 -((( 2964 -**PUT /api/v3/DriversFuelCardsAssignments** 2965 -))) 2966 - 2967 -Запрос: 2968 - 2969 -[ 2970 - { 2971 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2972 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2973 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2974 - "BeginTime": "2023-06-30T12:09:53.201Z", 2975 - "EndTime": "2023-06-30T12:09:53.201Z" 2976 - } 2977 -] 2978 - 2979 -Ответ: 2980 - 2981 -[ 2982 - { 2983 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2984 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2985 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2986 - "BeginTime": "2023-06-30T12:09:53.201Z", 2987 - "EndTime": "2023-06-30T12:09:53.201Z" 2988 - } 2989 -] 2990 - 2991 - 2992 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2993 - 2994 -(% class="box errormessage" %) 2995 -((( 2996 -**DELETE /api/v3/DriversFuelCardsAssignments** 2997 -))) 2998 - 2999 -Запрос: 3000 - 3001 -[ 3002 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3003 -] 3004 - 3005 -Ответ: 3006 - 3007 -Success 3008 - 3009 - 3010 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3011 - 3012 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3013 - 3014 -(% class="box infomessage" %) 3015 -((( 3016 -**POST /api/v3/Rfids/find** 3017 -))) 3018 - 3019 -Запрос: 3020 - 3021 -{ 3022 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3023 -} 3024 - 3025 -Ответ: 3026 - 3027 -[ 3028 - { 3029 - "name": "string", 3030 - "number": 0, 3031 - "period": 0, ~/~/ Частота трансляции радиометки 3032 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3033 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 - "deleted": true 3035 - } 3036 -] 3037 - 3038 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3039 - 3040 -(% class="box infomessage" %) 3041 -((( 3042 -**GET /api/v3/Rfids/{rfidGuid}** 3043 -))) 3044 - 3045 -Передаем параметр rfidGuid - идентификатор карты-метки 3046 - 3047 -Ответ: 3048 - 3049 -[ 3050 - { 3051 - "name": "string", 3052 - "number": 0, 3053 - "period": 0, ~/~/ Частота трансляции радиометки 3054 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3055 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3056 - "deleted": true 3057 - } 3058 -] 3059 - 3060 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3061 - 3062 -(% class="box successmessage" %) 3063 -((( 3064 -**POST /api/v3/Rfids** 3065 -))) 3066 - 3067 -Запрос: 3068 - 3069 -{ 3070 - "name": "string", 3071 - "number": 0, 3072 - "period": 0, 3073 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3074 - "deleted": true 3075 -} 3076 - 3077 -Ответ: 3078 - 3079 -{ 3080 - "name": "string", 3081 - "number": 0, 3082 - "period": 0, 3083 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3084 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3085 - "deleted": true 3086 -} 3087 - 3088 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3089 - 3090 -(% class="box warningmessage" %) 3091 -((( 3092 -**PUT /api/v3/Rfids** 3093 -))) 3094 - 3095 -Запрос: 3096 - 3097 -{ 3098 - "name": "string", 3099 - "number": 0, 3100 - "period": 0, 3101 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3102 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3103 - "deleted": true 3104 -} 3105 - 3106 -Ответ: 3107 - 3108 -{ 3109 - "name": "string", 3110 - "number": 0, 3111 - "period": 0, 3112 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3113 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3114 - "deleted": true 3115 -} 3116 - 3117 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3118 - 3119 -(% class="box errormessage" %) 3120 -((( 3121 -**DELETE /api/v3/Rfids/{rfidGuid}** 3122 -))) 3123 - 3124 -Передаем параметр **rfidGuid** - идентификатор карты-метки 3125 - 3126 -Ответ: 3127 - 3128 -Success 3129 - 3130 - 3131 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3132 - 3133 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3134 - 3135 -(% class="box infomessage" %) 3136 -((( 3137 -**GET /api/v3/Billing/client/balance/{clientId}** 3138 -))) 3139 - 3140 -Параметр запроса: **clientId **- идентификатор клиента. 3141 - 3142 -Ответ: 3143 - 3144 -{ 3145 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3146 - "Balance": 0 3147 -} 3148 - 3149 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3150 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3151 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3152 - 3153 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3154 - 3155 -(% class="box infomessage" %) 3156 -((( 3157 -**GET /api/v3/Billing/client/constraint/{clientId}** 3158 -))) 3159 - 3160 -Параметр запроса: **clientId **- идентификатор клиента. 3161 - 3162 -Ответ: 3163 - 3164 -{ 3165 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3166 - "CalculationType": 0, 3167 - "PermissibleBalance": 0, 3168 - "DefermentDays": 0, 3169 - "SendUiNotifications": true, 3170 - "SendEmailNotifications": true, 3171 - "IsPrivate": true, 3172 -} 3173 - 3174 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3175 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3176 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3177 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3178 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3179 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3180 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3181 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3182 - 3183 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3184 - 3185 -(% class="box infomessage" %) 3186 -((( 3187 -**GET /api/v3/Billing/client/plan/{clientId}** 3188 -))) 3189 - 3190 -Параметры запроса: 3191 - 3192 -**clientId **- идентификатор клиента. 3193 - 3194 -**planId **- идентификатор тарифного плана. 3195 - 3196 -Ответ: 3197 - 3198 -{ 3199 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3200 - "Plan": { **~/~/ Описание тарифного плана** 3201 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3202 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3203 - "Name": "string", 3204 - "IsArchived": true, 3205 - "Constraint": { 3206 - "CalculationType": 0, 3207 - "PermissibleBalance": 0, 3208 - "DefermentDays": 0 3209 - }, 3210 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3211 - { 3212 - "Feature": "string", 3213 - "IsFactual": true, 3214 - "Limit": 0, 3215 - "Price": 0, 3216 - "PeriodValue": 0, 3217 - "PeriodType": 0 3218 - } 3219 - ] 3220 - }, 3221 - "DebitDate": "2023-10-18T12:46:24.213Z", 3222 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3223 - { 3224 - "Feature": "string", 3225 - "IsEnabled": true, 3226 - "IsPrivate": true, 3227 - "IsFactual": true, 3228 - "Limit": 0, 3229 - "Price": 0, 3230 - "DebitDate": "2023-10-18T12:46:24.213Z", 3231 - "PeriodValue": 0, 3232 - "PeriodType": 0 3233 - } 3234 - ] 3235 -} 3236 - 3237 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3238 -|ClientId|Идентификатор клиента 3239 -|Id|Идентификатор тарифного плана 3240 -|OwnerId|Идентификатор клиента-владельца 3241 -|Name|Наименование тарифного плана 3242 -|IsArchived|Признак, определяющий архивный тарифный план 3243 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3244 -|PermissibleBalance|Допустимый баланс 3245 -|DefermentDays|Отсрочка, количество дней 3246 -|Feature|Код услуги 3247 -|IsEnabled|Признак, определяющий активирована ли услуга 3248 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3249 -|IsFactual|Признак, определяющий расчёт по факту 3250 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3251 -|Price|Цена за единицу. 3252 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3253 -|PeriodValue|Значение периода. 3254 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3255 - 3256 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3257 - 3258 -(% class="box infomessage" %) 3259 -((( 3260 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3261 -))) 3262 - 3263 -Параметр запроса: **clientId **- идентификатор клиента. 3264 - 3265 -Ответ: 3266 - 3267 -[ 3268 - { 3269 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3270 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3271 - "Name": "string", 3272 - "IsArchived": true, 3273 - "Constraint": { 3274 - "CalculationType": 0, 3275 - "PermissibleBalance": 0, 3276 - "DefermentDays": 0 3277 - }, 3278 - "Features": [ 3279 - { 3280 - "Feature": "string", 3281 - "IsFactual": true, 3282 - "Limit": 0, 3283 - "Price": 0, 3284 - "PeriodValue": 0, 3285 - "PeriodType": 0 3286 - } 3287 - ] 3288 - } 3289 -] 3290 - 3291 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3292 -|ClientId|Идентификатор клиента 3293 -|Id|Идентификатор тарифного плана 3294 -|OwnerId|Идентификатор клиента-владельца 3295 -|Name|Наименование тарифного плана 3296 -|IsArchived|Признак, определяющий архивный тарифный план 3297 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3298 -|PermissibleBalance|Допустимый баланс 3299 -|DefermentDays|Отсрочка, количество дней 3300 -|Feature|Код услуги 3301 -|IsFactual|Признак, определяющий расчёт по факту 3302 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3303 -|Price|Цена за единицу. 3304 -|PeriodValue|Значение периода. 3305 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3306 - 3307 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3308 - 3309 -(% class="box infomessage" %) 3310 -((( 3311 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3312 -))) 3313 - 3314 -Параметр запроса: **clientId **- идентификатор клиента. 3315 - 3316 -Ответ: 3317 - 3318 -[ 3319 - { 3320 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3321 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3322 - "Name": "string", 3323 - "IsArchived": true, 3324 - "Constraint": { 3325 - "CalculationType": 0, 3326 - "PermissibleBalance": 0, 3327 - "DefermentDays": 0 3328 - }, 3329 - "Features": [ 3330 - { 3331 - "Feature": "string", 3332 - "IsFactual": true, 3333 - "Limit": 0, 3334 - "Price": 0, 3335 - "PeriodValue": 0, 3336 - "PeriodType": 0 3337 - } 3338 - ] 3339 - } 3340 -] 3341 - 3342 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3343 -|ClientId|Идентификатор клиента 3344 -|Id|Идентификатор тарифного плана 3345 -|OwnerId|Идентификатор клиента-владельца 3346 -|Name|Наименование тарифного плана 3347 -|IsArchived|Признак, определяющий архивный тарифный план 3348 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3349 -|PermissibleBalance|Допустимый баланс 3350 -|DefermentDays|Отсрочка, количество дней 3351 -|Feature|Код услуги 3352 -|IsFactual|Признак, определяющий расчёт по факту 3353 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3354 -|Price|Цена за единицу. 3355 -|PeriodValue|Значение периода. 3356 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3357 - 3358 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3359 - 3360 -(% class="box warningmessage" %) 3361 -((( 3362 -**PUT /api/v3/Billing/client/balance** 3363 -))) 3364 - 3365 -Тело запроса: 3366 - 3367 -{ 3368 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3369 - "Balance": 0 3370 -} 3371 - 3372 -Ответ: Success 3373 - 3374 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3375 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3376 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3377 - 3378 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3379 - 3380 -(% class="box warningmessage" %) 3381 -((( 3382 -**PUT /api/v3/Billing/client/constraint** 3383 -))) 3384 - 3385 -Тело запроса: 3386 - 3387 -{ 3388 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3389 - "CalculationType": 0, 3390 - "PermissibleBalance": 0, 3391 - "DefermentDays": 0, 3392 - "SendUiNotifications": true, 3393 - "SendEmailNotifications": true, 3394 - "IsPrivate": true, 3395 -} 3396 - 3397 -Ответ: Success 3398 - 3399 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3400 -|ClientId|Идентификатор клиента 3401 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3402 -|PermissibleBalance|Допустимый баланс 3403 -|DefermentDays|((( 3404 -Отсрочка, количество дней 3405 -))) 3406 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3407 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3408 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3409 - 3410 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3411 - 3412 -(% class="box warningmessage" %) 3413 -((( 3414 -**PUT /api/v3/Billing/client/plan** 3415 -))) 3416 - 3417 -Тело запроса: 3418 - 3419 -{ 3420 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3421 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3422 - "Features": [ 3423 - { 3424 - "Feature": "string", 3425 - "IsEnabled": true, 3426 - "IsFactual": true, 3427 - "Limit": 0, 3428 - "Price": 0, 3429 - "DebitDate": "2023-10-18T13:26:58.987Z", 3430 - "PeriodValue": 0, 3431 - "PeriodType": 0 3432 - } 3433 - ] 3434 -} 3435 - 3436 -Ответ: Success 3437 - 3438 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3439 -|ClientId|Идентификатор клиента 3440 -|PlanId|Идентификатор тарифного плана 3441 -|Feature|Код услуги 3442 -|IsEnabled|Признак, определяющий активирована ли услуга 3443 -|IsFactual|Признак, определяющий расчёт по факту 3444 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3445 -|Price|Цена за единицу. 3446 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3447 -|PeriodValue|Значение периода. 3448 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3449 - 3450 -(% class="box" lang="en-US" style="text-align: center;" %) 3451 -((( 3452 -(% 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]] ** 3453 -))) 454 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
-
image-20231020124453-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.krainovim - Size
-
... ... @@ -1,1 +1,0 @@ 1 -268.0 KB -
Content