Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
- 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
-
- Content
-
... ... @@ -14,13 +14,13 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При **редактировании**необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 21 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 22 23 -(% class="box successmessage" %)23 +(% class="box infomessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,6 +40,7 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 + 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) ... ... @@ -54,12 +54,6 @@ 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 56 56 57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 - 63 63 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 64 64 65 65 (% class="box infomessage" %) ... ... @@ -98,51 +98,30 @@ 98 98 Запрос должен содержать данные параметра "**agentId**" 99 99 100 100 (% style="color:#000000" %)Ответ: 96 +А 101 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" 98 + "agentId": "", ~/~/ идентификатор клиента (%%) 99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 + "isForeign": true/false, ~/~/ Иностранный контрагент 105 + "district": "string", ~/~/ округ 106 + "region": "string", ~/~/ регион 107 + "city": "string", ~/~/ город 108 + "inn": "string", ~/~/ ИНН клиента 109 + "kpp": "string", ~/~/ КПП клиента 110 + "address": "string", ~/~/ юридический адрес 111 + "addressFact": "string", ~/~/ фактический адрес 112 + "email": "string", ~/~/ почта 113 + "director": "string", ~/~/ ФИО руководителя 114 + "bankName": "string", ~/~/ Банк 115 + "bankBIK": "string", ~/~/ БИК 116 + "bankRS": "string", ~/~/ Номер счета 117 + "bankKS": "string" ~/~/ Корр. счет 122 122 } 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" %)Корр. счет 145 - 146 146 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 147 147 148 148 (% class="box infomessage" %) ... ... @@ -156,7 +156,7 @@ 156 156 157 157 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 158 158 159 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 160 160 161 161 (% style="color:#000000" %)Метод запроса: **POST** 162 162 ... ... @@ -171,25 +171,15 @@ 171 171 (% style="color:#000000" %)Ответ: 172 172 173 173 { 174 - "agentId": "",(% style="color:#000000" %) (%%) 175 - "parentId": "", 176 - "parentName": "string", 177 - "name": "string", 178 - "fullName": "string", 179 - "agentInfoType": 0, 180 - (%style="color:#000000"%)148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 181 181 } 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 193 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 194 194 195 195 (% class="box successmessage" %) ... ... @@ -208,7 +208,7 @@ 208 208 Параметры в теле запроса (JSON): 209 209 210 210 { 211 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 212 212 "name": "string", ~/~/ имя 213 213 "fullName": "string", ~/~/ полное наименование 214 214 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -253,28 +253,6 @@ 253 253 "bankKS": "string" ~/~/ корр. счёт 254 254 } 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" %)Корр. счет 277 - 278 278 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 279 279 280 280 (% class="box warningmessage" %) ... ... @@ -290,6 +290,7 @@ 290 290 291 291 В заголовках запроса: X-Auth: Токен авторизации 292 292 235 + 293 293 Параметры в теле запроса (JSON): 294 294 295 295 { ... ... @@ -314,6 +314,7 @@ 314 314 "bankKS": "string" ~/~/ корр. счёт 315 315 } 316 316 260 + 317 317 Ответ: 318 318 319 319 { ... ... @@ -419,6 +419,7 @@ 419 419 "password": "string", 420 420 "email": "string", 421 421 366 + 422 422 (% style="text-align:left" %) 423 423 (% style="color:#000000; font-weight:normal" %)Ответ: 424 424 ... ... @@ -447,7 +447,6 @@ 447 447 (% style="text-align:left" %) 448 448 (% style="color:#000000; font-weight:normal" %)} 449 449 450 - 451 451 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 452 452 453 453 (% class="box infomessage" %) ... ... @@ -738,249 +738,6 @@ 738 738 (% style="text-align:left" %) 739 739 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 740 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 -Ответ: 867 - 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 - 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 984 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 985 985 986 986 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == ... ... @@ -1803,191 +1803,22 @@ 1803 1803 (% style="text-align:left" %) 1804 1804 (% style="color:#000000" %)} 1805 1805 1806 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1807 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 1831 (% style="text-align:left" %) 1832 -(% style="color:#000000" %) }1509 +(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов** 1833 1833 1834 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел:**Сообщения**(%%) =1511 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1835 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 -Ответ: 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 1877 (% class="box infomessage" %) 1878 1878 ((( 1879 -**POST /api/v3/ terminalMessages**1515 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 1880 1880 ))) 1881 1881 1882 -Метод возвращает списоксообщенийтерминала объектазавыбранныйпериод.1518 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 1883 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 -{ 1894 - "vehicleId": 0, ~/~/ id объекта 1895 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1896 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1897 -} 1898 - 1899 -Ответ: 1900 - 1901 -[ 1902 - { 1903 - "messages": [ 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 -] 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 1988 (% style="color:#000000" %)Метод запроса: **POST** 1989 1989 1990 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/mileageAndMotohours1522 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find 1991 1991 1992 1992 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1993 1993 ... ... @@ -1994,43 +1994,43 @@ 1994 1994 (% style="text-align:left" %) 1995 1995 Тело запроса: 1996 1996 1529 +(% style="text-align:left" %) 1997 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 1531 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2003 2003 } 2004 2004 1534 +(% style="text-align:left" %) 2005 2005 Ответ: 2006 2006 2007 2007 [ 2008 2008 { 2009 - " vehicleId": 0, ~/~/IDобъекта2010 - "name": "string", ~/~/ ИмяТС2011 - "pe riods":[~/~/Периоды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 ~/~/Моточасы на окончание периода2019 - }2020 - ]1539 + "id": 0, ~/~/ Идентификатор объекта геозоны 1540 + "name": "string", ~/~/ Название объекта геозоны 1541 + "type": 0, ~/~/ Тип объекта геозоны 1542 + "fname": "string", ~/~/ Имя файла 1543 + "parentId": "string", ~/~/ Идентификатор клиента 1544 + "radius": 0, ~/~/ Радиус геообъекта 1545 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 1546 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 1547 + "description": "string", ~/~/ Описание 1548 + "area": 0, ~/~/ Площадь, м^^2^^ 1549 + "perimetr": 0, ~/~/ Периметр, м 1550 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2021 2021 } 2022 2022 ] 2023 2023 2024 -== (% style="color:#000000; font-size:16px" %)** Получение данныхо расходетранспортногосредства**(%%) ==1554 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2025 2025 2026 2026 (% class="box infomessage" %) 2027 2027 ((( 2028 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/ vehicles/fuelConsumption**1558 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2029 2029 ))) 2030 2030 1561 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1562 + 2031 2031 (% style="color:#000000" %)Метод запроса: **POST** 2032 2032 2033 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/fuelConsumption1565 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2034 2034 2035 2035 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2036 2036 ... ... @@ -2038,42 +2038,40 @@ 2038 2038 Тело запроса: 2039 2039 2040 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 1573 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1574 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1575 + "ids": [ ], ~/~/ Массив id объектов 1576 + "byTime": 0, ~/~/ Настройки фильтрации по времени 1577 + "byDist": 0, ~/~/ 1578 + "filterByTime": 0, ~/~/ 1579 + "filterByHalfPerimeter": true ~/~/ 2046 2046 } 2047 2047 2048 2048 Ответ: 2049 - 2050 2050 [ 2051 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 - ] 1585 + "geozoneId": 0, 1586 + "geozoneName": "string", 1587 + "startDate": "2023-08-02T06:13:18.554Z", 1588 + "endDate": "2023-08-02T06:13:18.554Z", 1589 + "duration": 0, 1590 + "vehicleId": 0, 1591 + "vehicleName": "string" 2064 2064 } 2065 2065 ] 2066 2066 2067 -== (% style="color:#000000; font-size:16px" %)** Получение данныхозаправках исливахтранспортногосредства**(%%) ==1595 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2068 2068 2069 2069 (% class="box infomessage" %) 2070 2070 ((( 2071 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/ vehicles/fuelInOut**1599 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2072 2072 ))) 2073 2073 1602 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 1603 + 2074 2074 (% style="color:#000000" %)Метод запроса: **POST** 2075 2075 2076 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/fuelInOut1606 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2077 2077 2078 2078 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2079 2079 ... ... @@ -2081,10 +2081,15 @@ 2081 2081 Тело запроса: 2082 2082 2083 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 1614 + "startDate": "2023-08-03T14:20:03.439Z", 1615 + "endDate": "2023-08-03T14:20:03.439Z", 1616 + "ids": [ 1617 + 0 1618 + ], 1619 + "byTime": 0, 1620 + "byDist": 0, 1621 + "filterByTime": 0, 1622 + "filterByHalfPerimeter": true 2088 2088 } 2089 2089 2090 2090 Ответ: ... ... @@ -2091,136 +2091,110 @@ 2091 2091 2092 2092 [ 2093 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 - ] 1629 + "geozoneId": 0, 1630 + "geozoneName": "string", 1631 + "startDate": "2023-08-02T06:13:18.554Z", 1632 + "endDate": "2023-08-02T06:13:18.554Z", 1633 + "duration": 0, 1634 + "vehicleId": 0, 1635 + "vehicleName": "string" 2109 2109 } 2110 2110 ] 2111 2111 2112 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2113 2113 2114 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2115 2115 1641 + 1642 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1643 + 1644 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1645 + 2116 2116 (% class="box infomessage" %) 2117 2117 ((( 2118 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)** POST**(%%)**/api/v3/gis/find**1648 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 2119 2119 ))) 2120 2120 2121 -(% style="color:#000000" %)Метод позволяет получить список геообъектовклиента.Возвращает массивгеообъектов совсейинформациейоних.1651 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 2122 2122 2123 -(% style="color:#000000" %)Метод запроса: ** POST**1653 +(% style="color:#000000" %)Метод запроса: **GET** 2124 2124 2125 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ gis/find1655 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 2126 2126 2127 2127 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2128 2128 2129 -(% style="text-align:left" %) 2130 -Тело запроса: 1659 +(% style="color:#000000" %)Ответ: 2131 2131 2132 -(% style="text-align:left" %) 2133 -{ 2134 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2135 -} 1661 +(% style="color:#000000" %){ 2136 2136 1663 + "id": "", ~/~/ ID типа датчика 1664 + "name": "", ~/~/ Название 1665 + "description": "", ~/~/ Описание 1666 + 2137 2137 (% style="text-align:left" %) 2138 - Ответ:1668 +(% style="color:#000000" %)} 2139 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 -] 1670 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 2156 2156 2157 -== (% style="color:#000000; font-size:16px" %)** Запроспересеченийпообъектам**(%%) ==1672 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 2158 2158 2159 -(% class="box infomessage" %) 1674 +(% class="box infomessage" style="text-align: left;" %) 2160 2160 ((( 2161 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/vehicles**1676 +**POST /api/v3/terminalMessages/count** 2162 2162 ))) 2163 2163 2164 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1679 +(% style="text-align: left;" %) 1680 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 2165 2165 2166 -(% style="color:#000000" %)Метод запроса: **POST** 1682 +(% style="text-align: left;" %) 1683 +Метод запроса **POST** 2167 2167 2168 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1685 +(% style="text-align: left;" %) 1686 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 2169 2169 1688 +(% style="text-align: left;" %) 2170 2170 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2171 2171 2172 -(% style="text-align:left" %) 2173 -Тело запроса: 2174 - 1691 +(% style="text-align: left;" %) 2175 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 ~/~/ Фильтрация событий по пробегу половины периметра 1693 + "vehicleIds": [ 1694 + id ~/~/ здесь передается список идентификаторов объектов 1695 + ], 1696 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1697 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 2183 2183 } 2184 2184 1700 +(% style="text-align: left;" %) 2185 2185 Ответ: 1702 + 1703 +(% style="text-align: left;" %) 2186 2186 [ 2187 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" ~/~/ Имя объекта 1706 + "vehicleId": 0, ~/~/ идентификатор объекта 1707 + "count": 0 ~/~/ количество сообщений за период 2195 2195 } 2196 2196 ] 2197 2197 2198 -== (% style="color:#000000; font-size:16px" %)**Запрос пересеченийпогеообъектам**(%%) ==1711 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 2199 2199 2200 2200 (% class="box infomessage" %) 2201 2201 ((( 2202 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/geozones**1715 +**POST /api/v3/terminalMessages** 2203 2203 ))) 2204 2204 2205 - (% style="color:#000000" %)Методпозволяетполучитьсписокпересеченийвыбранных геообъектов со всеми объектамиза выбранный период.1718 +Метод возвращает список сообщений терминала объекта за выбранный период. 2206 2206 2207 -(% style="color:#000000" %)Метод запроса: **POST** 1720 +(% style="text-align: left;" %) 1721 +Метод запроса **POST** 2208 2208 2209 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 1723 +(% style="text-align: left;" %) 1724 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2210 2210 1726 +(% style="text-align: left;" %) 2211 2211 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2212 2212 2213 -(% style="text-align:left" %) 2214 -Тело запроса: 2215 - 2216 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 ~/~/ Фильтрация событий по пробегу половины периметра 1730 + "vehicleId": 0, ~/~/ id объекта 1731 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1732 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 2224 2224 } 2225 2225 2226 2226 Ответ: ... ... @@ -2227,13 +2227,24 @@ 2227 2227 2228 2228 [ 2229 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" ~/~/ Имя объекта 1739 + "messages": [ 1740 + { 1741 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1742 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1743 + "speed": 0, ~/~/ Скорость, км/ч 1744 + "altitude": 0, ~/~/ Высота, м 1745 + "latitude": 0, ~/~/ Широта [-90°;90°] 1746 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1747 + "satellites": 0, ~/~/ Кол-во спутников 1748 + "voltage": 0, ~/~/ Напряжение 1749 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1750 + "additionalProp1": "string", 1751 + "additionalProp2": "string", 1752 + "additionalProp3": "string" 1753 + }, 1754 + "photoCount": 0 ~/~/ Кол-во фото 1755 + } 1756 + ] 2237 2237 } 2238 2238 ] 2239 2239 ... ... @@ -3007,84 +3007,6 @@ 3007 3007 Success 3008 3008 3009 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/Trailers** 3017 -))) 3018 - 3019 -Пример запроса: 3020 - 3021 -{ 3022 - "startDate": "2023-11-14T10:48:03.671Z", 3023 - "endDate": "2023-11-14T10:48:03.671Z", 3024 - "ids": [ 0 ], 3025 - "timezone": 0 3026 -} 3027 - 3028 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3029 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3030 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3031 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3032 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3033 - 3034 -Пример ответа: 3035 - 3036 -[ 3037 - { 3038 - "SD": "2023-11-14T10:48:03.717Z", 3039 - "ED": "2023-11-14T10:48:03.717Z", 3040 - "id": 0, 3041 - "SLat": 0, 3042 - "SLon": 0, 3043 - "ELat": 0, 3044 - "ELon": 0, 3045 - "mileage": 0 3046 - "Duration": 0 3047 - "Address": "string", 3048 - "Address2": "string", 3049 - "name": "string", 3050 - "rid": "string", 3051 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3052 - "trailer": { 3053 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3054 - "Number": "string", 3055 - "Description": "string", 3056 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3057 - "ExternalID": "string", 3058 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3059 - "CreateTime": "2023-11-14T10:48:03.717Z", 3060 - "UpdateTime": "2023-11-14T10:48:03.717Z", 3061 - "IsDeleted": true 3062 - }, 3063 - "filesCount": 0, 3064 - } 3065 -] 3066 - 3067 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3068 -|SD|Дата и время начала события 3069 -|ED|Дата и время окончания события 3070 -|id|ID объекта 3071 -|SLat|Широта начальной координаты 3072 -|SLon|Долгота начальной координаты 3073 -|ELat|Широта конечной координаты 3074 -|ELon|Долгота конечной координаты 3075 -|mileage|Пробег 3076 -|Duration|Продолжительность 3077 -|Address|Адрес начального местоположения 3078 -|Address2|Адрес конечного местоположения 3079 -|name|Имя радиометки 3080 -|rid|Номер радиометки 3081 -|rguid|ID радиометки 3082 -|trailer|Информация об агрегате 3083 -|ModelGuid|ID агрегата 3084 -|Number|Название/номер агрегата 3085 -|Description|Текст примечания агрегата 3086 - 3087 - 3088 3088 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3089 3089 3090 3090 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -3113,6 +3113,7 @@ 3113 3113 } 3114 3114 ] 3115 3115 2558 + 3116 3116 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3117 3117 3118 3118 (% class="box infomessage" %) ... ... @@ -3135,6 +3135,7 @@ 3135 3135 } 3136 3136 ] 3137 3137 2581 + 3138 3138 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3139 3139 3140 3140 (% class="box successmessage" %) ... ... @@ -3163,6 +3163,7 @@ 3163 3163 "deleted": true 3164 3164 } 3165 3165 2610 + 3166 3166 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3167 3167 3168 3168 (% class="box warningmessage" %) ... ... @@ -3192,6 +3192,7 @@ 3192 3192 "deleted": true 3193 3193 } 3194 3194 2640 + 3195 3195 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3196 3196 3197 3197 (% class="box errormessage" %) ... ... @@ -3199,7 +3199,7 @@ 3199 3199 **DELETE /api/v3/Rfids/{rfidGuid}** 3200 3200 ))) 3201 3201 3202 -Передаем параметр **rfidGuid**- идентификатор карты-метки2648 +Передаем параметр rfidGuid - идентификатор карты-метки 3203 3203 3204 3204 Ответ: 3205 3205 ... ... @@ -3206,325 +3206,6 @@ 3206 3206 Success 3207 3207 3208 3208 3209 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3210 - 3211 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3212 - 3213 -(% class="box infomessage" %) 3214 -((( 3215 -**GET /api/v3/Billing/client/balance/{clientId}** 3216 -))) 3217 - 3218 -Параметр запроса: **clientId **- идентификатор клиента. 3219 - 3220 -Ответ: 3221 - 3222 -{ 3223 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3224 - "Balance": 0 3225 -} 3226 - 3227 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3228 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3229 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3230 - 3231 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3232 - 3233 -(% class="box infomessage" %) 3234 -((( 3235 -**GET /api/v3/Billing/client/constraint/{clientId}** 3236 -))) 3237 - 3238 -Параметр запроса: **clientId **- идентификатор клиента. 3239 - 3240 -Ответ: 3241 - 3242 -{ 3243 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3244 - "CalculationType": 0, 3245 - "PermissibleBalance": 0, 3246 - "DefermentDays": 0, 3247 - "SendUiNotifications": true, 3248 - "SendEmailNotifications": true, 3249 - "IsPrivate": true, 3250 -} 3251 - 3252 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3253 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3254 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3255 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3256 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3257 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3258 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3259 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3260 - 3261 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3262 - 3263 -(% class="box infomessage" %) 3264 -((( 3265 -**GET /api/v3/Billing/client/plan/{clientId}** 3266 -))) 3267 - 3268 -Параметры запроса: 3269 - 3270 -**clientId **- идентификатор клиента. 3271 - 3272 -**planId **- идентификатор тарифного плана. 3273 - 3274 -Ответ: 3275 - 3276 -{ 3277 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3278 - "Plan": { **~/~/ Описание тарифного плана** 3279 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3280 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3281 - "Name": "string", 3282 - "IsArchived": true, 3283 - "Constraint": { 3284 - "CalculationType": 0, 3285 - "PermissibleBalance": 0, 3286 - "DefermentDays": 0 3287 - }, 3288 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3289 - { 3290 - "Feature": "string", 3291 - "IsFactual": true, 3292 - "Limit": 0, 3293 - "Price": 0, 3294 - "PeriodValue": 0, 3295 - "PeriodType": 0 3296 - } 3297 - ] 3298 - }, 3299 - "DebitDate": "2023-10-18T12:46:24.213Z", 3300 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3301 - { 3302 - "Feature": "string", 3303 - "IsEnabled": true, 3304 - "IsPrivate": true, 3305 - "IsFactual": true, 3306 - "Limit": 0, 3307 - "Price": 0, 3308 - "DebitDate": "2023-10-18T12:46:24.213Z", 3309 - "PeriodValue": 0, 3310 - "PeriodType": 0 3311 - } 3312 - ] 3313 -} 3314 - 3315 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3316 -|ClientId|Идентификатор клиента 3317 -|Id|Идентификатор тарифного плана 3318 -|OwnerId|Идентификатор клиента-владельца 3319 -|Name|Наименование тарифного плана 3320 -|IsArchived|Признак, определяющий архивный тарифный план 3321 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3322 -|PermissibleBalance|Допустимый баланс 3323 -|DefermentDays|Отсрочка, количество дней 3324 -|Feature|Код услуги 3325 -|IsEnabled|Признак, определяющий активирована ли услуга 3326 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3327 -|IsFactual|Признак, определяющий расчёт по факту 3328 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3329 -|Price|Цена за единицу. 3330 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3331 -|PeriodValue|Значение периода. 3332 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3333 - 3334 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3335 - 3336 -(% class="box infomessage" %) 3337 -((( 3338 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3339 -))) 3340 - 3341 -Параметр запроса: **clientId **- идентификатор клиента. 3342 - 3343 -Ответ: 3344 - 3345 -[ 3346 - { 3347 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3348 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3349 - "Name": "string", 3350 - "IsArchived": true, 3351 - "Constraint": { 3352 - "CalculationType": 0, 3353 - "PermissibleBalance": 0, 3354 - "DefermentDays": 0 3355 - }, 3356 - "Features": [ 3357 - { 3358 - "Feature": "string", 3359 - "IsFactual": true, 3360 - "Limit": 0, 3361 - "Price": 0, 3362 - "PeriodValue": 0, 3363 - "PeriodType": 0 3364 - } 3365 - ] 3366 - } 3367 -] 3368 - 3369 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3370 -|ClientId|Идентификатор клиента 3371 -|Id|Идентификатор тарифного плана 3372 -|OwnerId|Идентификатор клиента-владельца 3373 -|Name|Наименование тарифного плана 3374 -|IsArchived|Признак, определяющий архивный тарифный план 3375 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3376 -|PermissibleBalance|Допустимый баланс 3377 -|DefermentDays|Отсрочка, количество дней 3378 -|Feature|Код услуги 3379 -|IsFactual|Признак, определяющий расчёт по факту 3380 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3381 -|Price|Цена за единицу. 3382 -|PeriodValue|Значение периода. 3383 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3384 - 3385 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3386 - 3387 -(% class="box infomessage" %) 3388 -((( 3389 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3390 -))) 3391 - 3392 -Параметр запроса: **clientId **- идентификатор клиента. 3393 - 3394 -Ответ: 3395 - 3396 -[ 3397 - { 3398 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3399 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3400 - "Name": "string", 3401 - "IsArchived": true, 3402 - "Constraint": { 3403 - "CalculationType": 0, 3404 - "PermissibleBalance": 0, 3405 - "DefermentDays": 0 3406 - }, 3407 - "Features": [ 3408 - { 3409 - "Feature": "string", 3410 - "IsFactual": true, 3411 - "Limit": 0, 3412 - "Price": 0, 3413 - "PeriodValue": 0, 3414 - "PeriodType": 0 3415 - } 3416 - ] 3417 - } 3418 -] 3419 - 3420 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3421 -|ClientId|Идентификатор клиента 3422 -|Id|Идентификатор тарифного плана 3423 -|OwnerId|Идентификатор клиента-владельца 3424 -|Name|Наименование тарифного плана 3425 -|IsArchived|Признак, определяющий архивный тарифный план 3426 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3427 -|PermissibleBalance|Допустимый баланс 3428 -|DefermentDays|Отсрочка, количество дней 3429 -|Feature|Код услуги 3430 -|IsFactual|Признак, определяющий расчёт по факту 3431 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3432 -|Price|Цена за единицу. 3433 -|PeriodValue|Значение периода. 3434 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3435 - 3436 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3437 - 3438 -(% class="box warningmessage" %) 3439 -((( 3440 -**PUT /api/v3/Billing/client/balance** 3441 -))) 3442 - 3443 -Тело запроса: 3444 - 3445 -{ 3446 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3447 - "Balance": 0 3448 -} 3449 - 3450 -Ответ: Success 3451 - 3452 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3453 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3454 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3455 - 3456 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3457 - 3458 -(% class="box warningmessage" %) 3459 -((( 3460 -**PUT /api/v3/Billing/client/constraint** 3461 -))) 3462 - 3463 -Тело запроса: 3464 - 3465 -{ 3466 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3467 - "CalculationType": 0, 3468 - "PermissibleBalance": 0, 3469 - "DefermentDays": 0, 3470 - "SendUiNotifications": true, 3471 - "SendEmailNotifications": true, 3472 - "IsPrivate": true, 3473 -} 3474 - 3475 -Ответ: Success 3476 - 3477 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3478 -|ClientId|Идентификатор клиента 3479 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3480 -|PermissibleBalance|Допустимый баланс 3481 -|DefermentDays|((( 3482 -Отсрочка, количество дней 3483 -))) 3484 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3485 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3486 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3487 - 3488 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3489 - 3490 -(% class="box warningmessage" %) 3491 -((( 3492 -**PUT /api/v3/Billing/client/plan** 3493 -))) 3494 - 3495 -Тело запроса: 3496 - 3497 -{ 3498 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3499 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3500 - "Features": [ 3501 - { 3502 - "Feature": "string", 3503 - "IsEnabled": true, 3504 - "IsFactual": true, 3505 - "Limit": 0, 3506 - "Price": 0, 3507 - "DebitDate": "2023-10-18T13:26:58.987Z", 3508 - "PeriodValue": 0, 3509 - "PeriodType": 0 3510 - } 3511 - ] 3512 -} 3513 - 3514 -Ответ: Success 3515 - 3516 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3517 -|ClientId|Идентификатор клиента 3518 -|PlanId|Идентификатор тарифного плана 3519 -|Feature|Код услуги 3520 -|IsEnabled|Признак, определяющий активирована ли услуга 3521 -|IsFactual|Признак, определяющий расчёт по факту 3522 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3523 -|Price|Цена за единицу. 3524 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3525 -|PeriodValue|Значение периода. 3526 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3527 - 3528 3528 (% class="box" lang="en-US" style="text-align: center;" %) 3529 3529 ((( 3530 3530 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
-
image-20231020124453-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.krainovim - Size
-
... ... @@ -1,1 +1,0 @@ 1 -268.0 KB -
Content