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 infomessage" %)23 +(% class="box successmessage" %) 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,7 +40,6 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) ... ... @@ -55,6 +55,12 @@ 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 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 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 97 97 { 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" ~/~/ Корр. счет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" 118 118 } 119 119 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 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,25 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", ~/~/ идентификатор клиента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 - Отказ)174 + "agentId": "",(% style="color:#000000" %) (%%) 175 + "parentId": "", 176 + "parentName": "string", 177 + "name": "string", 178 + "fullName": "string", 179 + "agentInfoType": 0, 180 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 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 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 211 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 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 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -363,7 +363,6 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 369 ... ... @@ -392,6 +392,7 @@ 392 392 (% style="text-align:left" %) 393 393 (% style="color:#000000; font-weight:normal" %)} 394 394 450 + 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 397 397 (% class="box infomessage" %) ... ... @@ -682,6 +682,249 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 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 + 685 685 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 686 686 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == ... ... @@ -1504,65 +1504,191 @@ 1504 1504 (% style="text-align:left" %) 1505 1505 (% style="color:#000000" %)} 1506 1506 1806 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1507 1507 1508 -(% style="text-align:left" %) 1509 -(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов** 1808 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1510 1510 1511 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1512 - 1513 1513 (% class="box infomessage" %) 1514 1514 ((( 1515 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)** POST**(%%)**/api/v3/gis/find**1812 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1516 1516 ))) 1517 1517 1518 -(% style="color:#000000" %)Метод позволяет получить список геообъектовклиента.Возвращает массивгеообъектов совсейинформациейоних.1815 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1519 1519 1520 -(% style="color:#000000" %)Метод запроса: ** POST**1817 +(% style="color:#000000" %)Метод запроса: **GET** 1521 1521 1522 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ users/api/v3/gis/find1819 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1523 1523 1524 1524 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1525 1525 1526 -(% style="text-align:left" %) 1527 -Тело запроса: 1823 +(% style="color:#000000" %)Ответ: 1528 1528 1825 +(% style="color:#000000" %){ 1826 + 1827 + "id": "", ~/~/ ID типа датчика 1828 + "name": "", ~/~/ Название 1829 + "description": "", ~/~/ Описание 1830 + 1529 1529 (% 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;" %) 1530 1530 { 1531 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 1857 + "vehicleIds": [ 1858 + id ~/~/ здесь передается список идентификаторов объектов 1859 + ], 1860 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1861 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1532 1532 } 1533 1533 1534 -(% style="text-align:left" %) 1864 +(% style="text-align: left;" %) 1535 1535 Ответ: 1536 1536 1867 +(% style="text-align: left;" %) 1537 1537 [ 1538 1538 { 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", ~/~/ Дата создания 1870 + "vehicleId": 0, ~/~/ идентификатор объекта 1871 + "count": 0 ~/~/ количество сообщений за период 1551 1551 } 1552 1552 ] 1553 1553 1554 -== (% style="color:#000000; font-size:16px" %)**Запрос пересеченийпоъектам**(%%) ==1875 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1555 1555 1556 1556 (% class="box infomessage" %) 1557 1557 ((( 1558 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/vehicles**1879 +**POST /api/v3/terminalMessages** 1559 1559 ))) 1560 1560 1561 - (% style="color:#000000" %)Методпозволяетполучитьсписокпересеченийвыбранных объектов со всемигеообъектамиза выбранный период.1882 +Метод возвращает список сообщений терминала объекта за выбранный период. 1562 1562 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 + 1563 1563 (% style="color:#000000" %)Метод запроса: **POST** 1564 1564 1565 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ gis/intersections/vehicles1990 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1566 1566 1567 1567 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1568 1568 ... ... @@ -1570,40 +1570,42 @@ 1570 1570 Тело запроса: 1571 1571 1572 1572 { 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 ~/~/ 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 1580 1580 } 1581 1581 1582 1582 Ответ: 2006 + 1583 1583 [ 1584 1584 { 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" 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 ~/~/ Моточасы на окончание периода 2019 + } 2020 + ] 1592 1592 } 1593 1593 ] 1594 1594 1595 -== (% style="color:#000000; font-size:16px" %)** Запрос пересеченийпогеообъектам**(%%) ==2024 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 1596 1596 1597 1597 (% class="box infomessage" %) 1598 1598 ((( 1599 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/ gis/intersections/geozones**2028 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 1600 1600 ))) 1601 1601 1602 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 1603 - 1604 1604 (% style="color:#000000" %)Метод запроса: **POST** 1605 1605 1606 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ gis/intersections/geozones2033 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 1607 1607 1608 1608 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1609 1609 ... ... @@ -1611,15 +1611,11 @@ 1611 1611 Тело запроса: 1612 1612 1613 1613 { 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 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 1623 1623 } 1624 1624 1625 1625 Ответ: ... ... @@ -1626,110 +1626,178 @@ 1626 1626 1627 1627 [ 1628 1628 { 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" 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 + ] 1636 1636 } 1637 1637 ] 1638 1638 2067 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1639 1639 2069 +(% class="box infomessage" %) 2070 +((( 2071 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2072 +))) 1640 1640 2074 +(% style="color:#000000" %)Метод запроса: **POST** 1641 1641 1642 - =(% style="color:#000000; font-size:18.6667px" %)Раздел:**Датчики**(%%)=2076 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 1643 1643 1644 - ==(% style="color:#000000; font-size:16px" %)**Получениеспискатиповдатчиков**(%%) ==2078 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1645 1645 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 + 1646 1646 (% class="box infomessage" %) 1647 1647 ((( 1648 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)** GETensors/types**2118 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 1649 1649 ))) 1650 1650 1651 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков.Методвозвращаетинформациюотипах датчиков сучетомнастроекавторизованного пользователя,указанногов запросе.2121 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 1652 1652 1653 -(% style="color:#000000" %)Метод запроса: ** GET**2123 +(% style="color:#000000" %)Метод запроса: **POST** 1654 1654 1655 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]2125 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 1656 1656 1657 1657 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1658 1658 1659 -(% style="color:#000000" %)Ответ: 2129 +(% style="text-align:left" %) 2130 +Тело запроса: 1660 1660 1661 -(% style="color:#000000" %){ 2132 +(% style="text-align:left" %) 2133 +{ 2134 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2135 +} 1662 1662 1663 - "id": "", ~/~/ ID типа датчика 1664 - "name": "", ~/~/ Название 1665 - "description": "", ~/~/ Описание 1666 - 1667 1667 (% style="text-align:left" %) 1668 - (% style="color:#000000" %)}2138 +Ответ: 1669 1669 1670 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 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 +] 1671 1671 1672 -== (% style="color:#000000; font-size:16px" %)** Данныеобактивности объекта**(%%) ==2157 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 1673 1673 1674 -(% class="box infomessage" style="text-align: left;"%)2159 +(% class="box infomessage" %) 1675 1675 ((( 1676 -**POST /api/v3/ terminalMessages/count**2161 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 1677 1677 ))) 1678 1678 1679 -(% style="text-align: left;" %) 1680 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 2164 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1681 1681 1682 -(% style="text-align: left;" %) 1683 -Метод запроса **POST** 2166 +(% style="color:#000000" %)Метод запроса: **POST** 1684 1684 1685 -(% style="text-align: left;" %) 1686 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 2168 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1687 1687 1688 -(% style="text-align: left;" %) 1689 1689 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1690 1690 1691 -(% style="text-align: left;" %) 2172 +(% style="text-align:left" %) 2173 +Тело запроса: 2174 + 1692 1692 { 1693 - "vehicleIds": [ 1694 - id ~/~/ здесь передается список идентификаторов объектов 1695 - ], 1696 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1697 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 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 ~/~/ Фильтрация событий по пробегу половины периметра 1698 1698 } 1699 1699 1700 -(% style="text-align: left;" %) 1701 1701 Ответ: 1702 - 1703 -(% style="text-align: left;" %) 1704 1704 [ 1705 1705 { 1706 - "vehicleId": 0, ~/~/ идентификатор объекта 1707 - "count": 0 ~/~/ количество сообщений за период 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" ~/~/ Имя объекта 1708 1708 } 1709 1709 ] 1710 1710 1711 -== (% style="color:#000000; font-size:16px" %)**Запрос спискасообщений**(%%) ==2198 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 1712 1712 1713 1713 (% class="box infomessage" %) 1714 1714 ((( 1715 -**POST /api/v3/ter minalMessages**2202 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 1716 1716 ))) 1717 1717 1718 -Метод возвращает список сообщений терминалаобъекта за выбранный период.2205 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 1719 1719 1720 -(% style="text-align: left;" %) 1721 -Метод запроса **POST** 2207 +(% style="color:#000000" %)Метод запроса: **POST** 1722 1722 1723 -(% style="text-align: left;" %) 1724 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2209 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 1725 1725 1726 -(% style="text-align: left;" %) 1727 1727 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1728 1728 2213 +(% style="text-align:left" %) 2214 +Тело запроса: 2215 + 1729 1729 { 1730 - "vehicleId": 0, ~/~/ id объекта 1731 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1732 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 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 ~/~/ Фильтрация событий по пробегу половины периметра 1733 1733 } 1734 1734 1735 1735 Ответ: ... ... @@ -1736,24 +1736,13 @@ 1736 1736 1737 1737 [ 1738 1738 { 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 - ] 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" ~/~/ Имя объекта 1757 1757 } 1758 1758 ] 1759 1759 ... ... @@ -2555,7 +2555,6 @@ 2555 2555 } 2556 2556 ] 2557 2557 2558 - 2559 2559 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2560 2560 2561 2561 (% class="box infomessage" %) ... ... @@ -2578,7 +2578,6 @@ 2578 2578 } 2579 2579 ] 2580 2580 2581 - 2582 2582 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2583 2583 2584 2584 (% class="box successmessage" %) ... ... @@ -2607,7 +2607,6 @@ 2607 2607 "deleted": true 2608 2608 } 2609 2609 2610 - 2611 2611 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2612 2612 2613 2613 (% class="box warningmessage" %) ... ... @@ -2637,7 +2637,6 @@ 2637 2637 "deleted": true 2638 2638 } 2639 2639 2640 - 2641 2641 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2642 2642 2643 2643 (% class="box errormessage" %) ... ... @@ -2645,7 +2645,7 @@ 2645 2645 **DELETE /api/v3/Rfids/{rfidGuid}** 2646 2646 ))) 2647 2647 2648 -Передаем параметр rfidGuid - идентификатор карты-метки 3124 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2649 2649 2650 2650 Ответ: 2651 2651 ... ... @@ -2652,6 +2652,325 @@ 2652 2652 Success 2653 2653 2654 2654 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 + 2655 2655 (% class="box" lang="en-US" style="text-align: center;" %) 2656 2656 ((( 2657 2657 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
-
image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB -
Content