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,10 +1504,259 @@ 1504 1504 (% style="text-align:left" %) 1505 1505 (% style="color:#000000" %)} 1506 1506 1806 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1507 1507 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 + 1508 1508 (% style="text-align:left" %) 1509 -(% style="color:#000000 ; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**1832 +(% style="color:#000000" %)} 1510 1510 1834 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1835 + 1836 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1837 + 1838 +(% class="box infomessage" style="text-align: left;" %) 1839 +((( 1840 +**POST /api/v3/terminalMessages/count** 1841 +))) 1842 + 1843 +(% style="text-align: left;" %) 1844 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1845 + 1846 +(% style="text-align: left;" %) 1847 +Метод запроса **POST** 1848 + 1849 +(% style="text-align: left;" %) 1850 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1851 + 1852 +(% style="text-align: left;" %) 1853 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1854 + 1855 +(% style="text-align: left;" %) 1856 +{ 1857 + "vehicleIds": [ 1858 + id ~/~/ здесь передается список идентификаторов объектов 1859 + ], 1860 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1861 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1862 +} 1863 + 1864 +(% style="text-align: left;" %) 1865 +Ответ: 1866 + 1867 +(% style="text-align: left;" %) 1868 +[ 1869 + { 1870 + "vehicleId": 0, ~/~/ идентификатор объекта 1871 + "count": 0 ~/~/ количество сообщений за период 1872 + } 1873 +] 1874 + 1875 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1876 + 1877 +(% class="box infomessage" %) 1878 +((( 1879 +**POST /api/v3/terminalMessages** 1880 +))) 1881 + 1882 +Метод возвращает список сообщений терминала объекта за выбранный период. 1883 + 1884 +(% style="text-align: left;" %) 1885 +Метод запроса **POST** 1886 + 1887 +(% style="text-align: left;" %) 1888 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1889 + 1890 +(% style="text-align: left;" %) 1891 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1892 + 1893 +{ 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:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1925 + 1926 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1927 + 1928 +(% class="box infomessage" %) 1929 +((( 1930 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1931 +))) 1932 + 1933 +(% style="color:#000000" %)Метод запроса: **POST** 1934 + 1935 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1936 + 1937 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1938 + 1939 +(% style="text-align:left" %) 1940 +Тело запроса: 1941 + 1942 +{ 1943 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1944 + "vehicleIds": [0], ~/~/ Список ID объектов 1945 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1946 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1947 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1948 +} 1949 + 1950 +Ответ: 1951 + 1952 +[ 1953 + { 1954 + "vehicleId": 0, ~/~/ ID объекта 1955 + "name": "string", ~/~/ Имя ТС 1956 + "periods": [ ~/~/ Периоды 1957 + { 1958 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1959 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1960 + "mileageBegin": 0, ~/~/ Пробег на начало периода 1961 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 1962 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1963 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 1964 + } 1965 + ] 1966 + } 1967 +] 1968 + 1969 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 1970 + 1971 +(% class="box infomessage" %) 1972 +((( 1973 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 1974 +))) 1975 + 1976 +(% style="color:#000000" %)Метод запроса: **POST** 1977 + 1978 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 1979 + 1980 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1981 + 1982 +(% style="text-align:left" %) 1983 +Тело запроса: 1984 + 1985 +{ 1986 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1987 + "vehicleIds": [0], ~/~/ Список ID объектов 1988 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1989 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1990 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1991 +} 1992 + 1993 +Ответ: 1994 + 1995 +[ 1996 + { 1997 + "vehicleId": 0, ~/~/ ID объекта 1998 + "name": "string", ~/~/ Имя ТС 1999 + "periods": [ ~/~/ Периоды 2000 + { 2001 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2002 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2003 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2004 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2005 + "fuelConsumption": 0, ~/~/ Расход топлива 2006 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2007 + } 2008 + ] 2009 + } 2010 +] 2011 + 2012 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2013 + 2014 +(% class="box infomessage" %) 2015 +((( 2016 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2017 +))) 2018 + 2019 +(% style="color:#000000" %)Метод запроса: **POST** 2020 + 2021 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2022 + 2023 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2024 + 2025 +(% style="text-align:left" %) 2026 +Тело запроса: 2027 + 2028 +{ 2029 + "vehicleIds": [0], ~/~/ Список ID объектов 2030 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2031 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2032 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2033 +} 2034 + 2035 +Ответ: 2036 + 2037 +[ 2038 + { 2039 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2040 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2041 + "vehicleId": 0, ~/~/ ID объекта 2042 + "name": "string", ~/~/ Имя объекта 2043 + "model": "string", ~/~/ Модель объекта 2044 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2045 + { 2046 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2047 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2048 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2049 + "valueFuel": 0, ~/~/ Количество 2050 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2051 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2052 + } 2053 + ] 2054 + } 2055 +] 2056 + 2057 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2058 + 1511 1511 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1512 1512 1513 1513 (% class="box infomessage" %) ... ... @@ -1519,7 +1519,7 @@ 1519 1519 1520 1520 (% style="color:#000000" %)Метод запроса: **POST** 1521 1521 1522 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ users/api/v3/gis/find2070 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 1523 1523 1524 1524 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1525 1525 ... ... @@ -1634,124 +1634,6 @@ 1634 1634 } 1635 1635 ] 1636 1636 1637 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1638 - 1639 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1640 - 1641 -(% class="box infomessage" %) 1642 -((( 1643 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1644 -))) 1645 - 1646 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1647 - 1648 -(% style="color:#000000" %)Метод запроса: **GET** 1649 - 1650 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1651 - 1652 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1653 - 1654 -(% style="color:#000000" %)Ответ: 1655 - 1656 -(% style="color:#000000" %){ 1657 - 1658 - "id": "", ~/~/ ID типа датчика 1659 - "name": "", ~/~/ Название 1660 - "description": "", ~/~/ Описание 1661 - 1662 -(% style="text-align:left" %) 1663 -(% style="color:#000000" %)} 1664 - 1665 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1666 - 1667 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1668 - 1669 -(% class="box infomessage" style="text-align: left;" %) 1670 -((( 1671 -**POST /api/v3/terminalMessages/count** 1672 -))) 1673 - 1674 -(% style="text-align: left;" %) 1675 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1676 - 1677 -(% style="text-align: left;" %) 1678 -Метод запроса **POST** 1679 - 1680 -(% style="text-align: left;" %) 1681 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1682 - 1683 -(% style="text-align: left;" %) 1684 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1685 - 1686 -(% style="text-align: left;" %) 1687 -{ 1688 - "vehicleIds": [ 1689 - id ~/~/ здесь передается список идентификаторов объектов 1690 - ], 1691 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1692 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1693 -} 1694 - 1695 -(% style="text-align: left;" %) 1696 -Ответ: 1697 - 1698 -(% style="text-align: left;" %) 1699 -[ 1700 - { 1701 - "vehicleId": 0, ~/~/ идентификатор объекта 1702 - "count": 0 ~/~/ количество сообщений за период 1703 - } 1704 -] 1705 - 1706 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1707 - 1708 -(% class="box infomessage" %) 1709 -((( 1710 -**POST /api/v3/terminalMessages** 1711 -))) 1712 - 1713 -Метод возвращает список сообщений терминала объекта за выбранный период. 1714 - 1715 -(% style="text-align: left;" %) 1716 -Метод запроса **POST** 1717 - 1718 -(% style="text-align: left;" %) 1719 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1720 - 1721 -(% style="text-align: left;" %) 1722 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1723 - 1724 -{ 1725 - "vehicleId": 0, ~/~/ id объекта 1726 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1727 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1728 -} 1729 - 1730 -Ответ: 1731 - 1732 -[ 1733 - { 1734 - "messages": [ 1735 - { 1736 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1737 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1738 - "speed": 0, ~/~/ Скорость, км/ч 1739 - "altitude": 0, ~/~/ Высота, м 1740 - "latitude": 0, ~/~/ Широта [-90°;90°] 1741 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1742 - "satellites": 0, ~/~/ Кол-во спутников 1743 - "voltage": 0, ~/~/ Напряжение 1744 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1745 - "additionalProp1": "string", 1746 - "additionalProp2": "string", 1747 - "additionalProp3": "string" 1748 - }, 1749 - "photoCount": 0 ~/~/ Кол-во фото 1750 - } 1751 - ] 1752 - } 1753 -] 1754 - 1755 1755 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1756 1756 1757 1757 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2522,6 +2522,83 @@ 2522 2522 Success 2523 2523 2524 2524 2955 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 2956 + 2957 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 2958 + 2959 +(% class="box infomessage" %) 2960 +((( 2961 +**POST /api/v3/Trailers** 2962 +))) 2963 + 2964 +Пример запроса: 2965 + 2966 +{ 2967 + "startDate": "2023-11-14T10:48:03.671Z", 2968 + "endDate": "2023-11-14T10:48:03.671Z", 2969 + "ids": [ 0 ], 2970 + "timezone": 0 2971 +} 2972 + 2973 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2974 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 2975 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 2976 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 2977 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 2978 + 2979 +Пример ответа: 2980 + 2981 +[ 2982 + { 2983 + "SD": "2023-11-14T10:48:03.717Z", 2984 + "ED": "2023-11-14T10:48:03.717Z", 2985 + "id": 0, 2986 + "SLat": 0, 2987 + "SLon": 0, 2988 + "ELat": 0, 2989 + "ELon": 0, 2990 + "mileage": 0 2991 + "Duration": 0 2992 + "Address": "string", 2993 + "Address2": "string", 2994 + "name": "string", 2995 + "rid": "string", 2996 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2997 + "trailer": { 2998 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2999 + "Number": "string", 3000 + "Description": "string", 3001 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3002 + "ExternalID": "string", 3003 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3004 + "CreateTime": "2023-11-14T10:48:03.717Z", 3005 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3006 + "IsDeleted": true 3007 + }, 3008 + "filesCount": 0, 3009 + } 3010 +] 3011 + 3012 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3013 +|SD|Дата и время начала события 3014 +|ED|Дата и время окончания события 3015 +|id|ID объекта 3016 +|SLat|Широта начальной координаты 3017 +|SLon|Долгота начальной координаты 3018 +|ELat|Широта конечной координаты 3019 +|ELon|Долгота конечной координаты 3020 +|mileage|Пробег 3021 +|Duration|Продолжительность 3022 +|Address|Адрес начального местоположения 3023 +|Address2|Адрес конечного местоположения 3024 +|name|Имя радиометки 3025 +|rid|Номер радиометки 3026 +|rguid|ID радиометки 3027 +|trailer|Информация об агрегате 3028 +|ModelGuid|ID агрегата 3029 +|Number|Название/номер агрегата 3030 +|Description|Текст примечания агрегата 3031 + 2525 2525 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2526 2526 2527 2527 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2550,7 +2550,6 @@ 2550 2550 } 2551 2551 ] 2552 2552 2553 - 2554 2554 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2555 2555 2556 2556 (% class="box infomessage" %) ... ... @@ -2573,7 +2573,6 @@ 2573 2573 } 2574 2574 ] 2575 2575 2576 - 2577 2577 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2578 2578 2579 2579 (% class="box successmessage" %) ... ... @@ -2602,7 +2602,6 @@ 2602 2602 "deleted": true 2603 2603 } 2604 2604 2605 - 2606 2606 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2607 2607 2608 2608 (% class="box warningmessage" %) ... ... @@ -2632,7 +2632,6 @@ 2632 2632 "deleted": true 2633 2633 } 2634 2634 2635 - 2636 2636 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2637 2637 2638 2638 (% class="box errormessage" %) ... ... @@ -2640,7 +2640,7 @@ 2640 2640 **DELETE /api/v3/Rfids/{rfidGuid}** 2641 2641 ))) 2642 2642 2643 -Передаем параметр rfidGuid - идентификатор карты-метки 3146 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2644 2644 2645 2645 Ответ: 2646 2646 ... ... @@ -2647,6 +2647,395 @@ 2647 2647 Success 2648 2648 2649 2649 3153 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3154 + 3155 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3156 + 3157 +(% class="box infomessage" %) 3158 +((( 3159 +**GET /api/v3/Billing/client/balance/{clientId}** 3160 +))) 3161 + 3162 +Параметр запроса: **clientId **- идентификатор клиента. 3163 + 3164 +Ответ: 3165 + 3166 +{ 3167 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3168 + "Balance": 0 3169 +} 3170 + 3171 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3172 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3173 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3174 + 3175 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3176 + 3177 +(% class="box infomessage" %) 3178 +((( 3179 +**GET /api/v3/Billing/client/constraint/{clientId}** 3180 +))) 3181 + 3182 +Параметр запроса: **clientId **- идентификатор клиента. 3183 + 3184 +Ответ: 3185 + 3186 +{ 3187 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3188 + "CalculationType": 0, 3189 + "PermissibleBalance": 0, 3190 + "DefermentDays": 0, 3191 + "SendUiNotifications": true, 3192 + "SendEmailNotifications": true, 3193 + "IsPrivate": true, 3194 +} 3195 + 3196 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3197 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3198 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3199 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3200 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3201 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3202 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3203 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3204 + 3205 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3206 + 3207 +(% class="box infomessage" %) 3208 +((( 3209 +**GET /api/v3/Billing/client/plan/{clientId}** 3210 +))) 3211 + 3212 +Параметры запроса: 3213 + 3214 +**clientId **- идентификатор клиента. 3215 + 3216 +**planId **- идентификатор тарифного плана. 3217 + 3218 +Ответ: 3219 + 3220 +{ 3221 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3222 + "Plan": { **~/~/ Описание тарифного плана** 3223 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3224 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3225 + "Name": "string", 3226 + "IsArchived": true, 3227 + "Constraint": { 3228 + "CalculationType": 0, 3229 + "PermissibleBalance": 0, 3230 + "DefermentDays": 0 3231 + }, 3232 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3233 + { 3234 + "Feature": "string", 3235 + "IsFactual": true, 3236 + "Limit": 0, 3237 + "Price": 0, 3238 + "PeriodValue": 0, 3239 + "PeriodType": 0 3240 + } 3241 + ] 3242 + }, 3243 + "DebitDate": "2023-10-18T12:46:24.213Z", 3244 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3245 + { 3246 + "Feature": "string", 3247 + "IsEnabled": true, 3248 + "IsPrivate": true, 3249 + "IsFactual": true, 3250 + "Limit": 0, 3251 + "Price": 0, 3252 + "DebitDate": "2023-10-18T12:46:24.213Z", 3253 + "PeriodValue": 0, 3254 + "PeriodType": 0 3255 + } 3256 + ] 3257 +} 3258 + 3259 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3260 +|ClientId|Идентификатор клиента 3261 +|Id|Идентификатор тарифного плана 3262 +|OwnerId|Идентификатор клиента-владельца 3263 +|Name|Наименование тарифного плана 3264 +|IsArchived|Признак, определяющий архивный тарифный план 3265 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3266 +|PermissibleBalance|Допустимый баланс 3267 +|DefermentDays|Отсрочка, количество дней 3268 +|Feature|Код услуги 3269 +|IsEnabled|Признак, определяющий активирована ли услуга 3270 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3271 +|IsFactual|Признак, определяющий расчёт по факту 3272 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3273 +|Price|Цена за единицу. 3274 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3275 +|PeriodValue|Значение периода. 3276 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3277 + 3278 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3279 + 3280 +(% class="box infomessage" %) 3281 +((( 3282 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3283 +))) 3284 + 3285 +Параметр запроса: **clientId **- идентификатор клиента. 3286 + 3287 +Ответ: 3288 + 3289 +[ 3290 + { 3291 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3292 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3293 + "Name": "string", 3294 + "IsArchived": true, 3295 + "Constraint": { 3296 + "CalculationType": 0, 3297 + "PermissibleBalance": 0, 3298 + "DefermentDays": 0 3299 + }, 3300 + "Features": [ 3301 + { 3302 + "Feature": "string", 3303 + "IsFactual": true, 3304 + "Limit": 0, 3305 + "Price": 0, 3306 + "PeriodValue": 0, 3307 + "PeriodType": 0 3308 + } 3309 + ] 3310 + } 3311 +] 3312 + 3313 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3314 +|ClientId|Идентификатор клиента 3315 +|Id|Идентификатор тарифного плана 3316 +|OwnerId|Идентификатор клиента-владельца 3317 +|Name|Наименование тарифного плана 3318 +|IsArchived|Признак, определяющий архивный тарифный план 3319 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3320 +|PermissibleBalance|Допустимый баланс 3321 +|DefermentDays|Отсрочка, количество дней 3322 +|Feature|Код услуги 3323 +|IsFactual|Признак, определяющий расчёт по факту 3324 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3325 +|Price|Цена за единицу. 3326 +|PeriodValue|Значение периода. 3327 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3328 + 3329 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3330 + 3331 +(% class="box infomessage" %) 3332 +((( 3333 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3334 +))) 3335 + 3336 +Параметр запроса: **clientId **- идентификатор клиента. 3337 + 3338 +Ответ: 3339 + 3340 +[ 3341 + { 3342 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3343 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3344 + "Name": "string", 3345 + "IsArchived": true, 3346 + "Constraint": { 3347 + "CalculationType": 0, 3348 + "PermissibleBalance": 0, 3349 + "DefermentDays": 0 3350 + }, 3351 + "Features": [ 3352 + { 3353 + "Feature": "string", 3354 + "IsFactual": true, 3355 + "Limit": 0, 3356 + "Price": 0, 3357 + "PeriodValue": 0, 3358 + "PeriodType": 0 3359 + } 3360 + ] 3361 + } 3362 +] 3363 + 3364 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3365 +|ClientId|Идентификатор клиента 3366 +|Id|Идентификатор тарифного плана 3367 +|OwnerId|Идентификатор клиента-владельца 3368 +|Name|Наименование тарифного плана 3369 +|IsArchived|Признак, определяющий архивный тарифный план 3370 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3371 +|PermissibleBalance|Допустимый баланс 3372 +|DefermentDays|Отсрочка, количество дней 3373 +|Feature|Код услуги 3374 +|IsFactual|Признак, определяющий расчёт по факту 3375 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3376 +|Price|Цена за единицу. 3377 +|PeriodValue|Значение периода. 3378 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3379 + 3380 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3381 + 3382 +(% class="box warningmessage" %) 3383 +((( 3384 +**PUT /api/v3/Billing/client/balance** 3385 +))) 3386 + 3387 +Тело запроса: 3388 + 3389 +{ 3390 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3391 + "Balance": 0 3392 +} 3393 + 3394 +Ответ: Success 3395 + 3396 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3397 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3398 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3399 + 3400 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3401 + 3402 +(% class="box warningmessage" %) 3403 +((( 3404 +**PUT /api/v3/Billing/client/constraint** 3405 +))) 3406 + 3407 +Тело запроса: 3408 + 3409 +{ 3410 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3411 + "CalculationType": 0, 3412 + "PermissibleBalance": 0, 3413 + "DefermentDays": 0, 3414 + "SendUiNotifications": true, 3415 + "SendEmailNotifications": true, 3416 + "IsPrivate": true, 3417 +} 3418 + 3419 +Ответ: Success 3420 + 3421 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3422 +|ClientId|Идентификатор клиента 3423 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3424 +|PermissibleBalance|Допустимый баланс 3425 +|DefermentDays|((( 3426 +Отсрочка, количество дней 3427 +))) 3428 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3429 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3430 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3431 + 3432 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3433 + 3434 +(% class="box warningmessage" %) 3435 +((( 3436 +**PUT /api/v3/Billing/client/plan** 3437 +))) 3438 + 3439 +Тело запроса: 3440 + 3441 +{ 3442 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3443 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3444 + "Features": [ 3445 + { 3446 + "Feature": "string", 3447 + "IsEnabled": true, 3448 + "IsFactual": true, 3449 + "Limit": 0, 3450 + "Price": 0, 3451 + "DebitDate": "2023-10-18T13:26:58.987Z", 3452 + "PeriodValue": 0, 3453 + "PeriodType": 0 3454 + } 3455 + ] 3456 +} 3457 + 3458 +Ответ: Success 3459 + 3460 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3461 +|ClientId|Идентификатор клиента 3462 +|PlanId|Идентификатор тарифного плана 3463 +|Feature|Код услуги 3464 +|IsEnabled|Признак, определяющий активирована ли услуга 3465 +|IsFactual|Признак, определяющий расчёт по факту 3466 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3467 +|Price|Цена за единицу. 3468 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3469 +|PeriodValue|Значение периода. 3470 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3471 + 3472 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3473 + 3474 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3475 + 3476 +(% class="box infomessage" %) 3477 +((( 3478 +**POST /api/v3/vehicles/export/history** 3479 +))) 3480 + 3481 +Метод возвращает список сообщений терминала объекта за выбранный период. 3482 + 3483 +Тело запроса: 3484 + 3485 +{ 3486 + "vehicleId": 0, 3487 + "asArchive": true, 3488 + "from": "2023-09-27T12:17:45.973Z", 3489 + "to": "2023-09-27T12:17:45.973Z" 3490 +} 3491 + 3492 +Ответ: 3493 + 3494 +Получаете файл. Сообщение: Code 200/Success 3495 + 3496 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3497 +|vehicleId|ID объекта 3498 +|asArchive|true - Архивировать файл, False - не архивировать 3499 +|from|Дата и время начала запроса 3500 +|to|Дата и время окончания запроса 3501 + 3502 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3503 + 3504 +(% class="box infomessage" %) 3505 +((( 3506 +**GET /api/v3/vehicles/export/history/status** 3507 +))) 3508 + 3509 +Метод возвращает список сообщений терминала объекта за выбранный период. 3510 + 3511 +Ответ: 3512 + 3513 +{ 3514 + "activity": true, 3515 + "progress": 0, 3516 + "message": "string" 3517 +} 3518 + 3519 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3520 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3521 +|progress|Прогресс экспорта, от 0 до 100% 3522 +|message|Текст описывающий статус 3523 + 3524 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3525 + 3526 +(% class="box infomessage" %) 3527 +((( 3528 +**POST /api/v3/vehicles/export** 3529 +))) 3530 + 3531 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3532 + 3533 +Тело запроса: 3534 + 3535 +[ 3536 + id 3537 +] 3538 + 3539 +Ответ: Success 200, получаете файлы с настройками. 3540 + 3541 + 2650 2650 (% class="box" lang="en-US" style="text-align: center;" %) 2651 2651 ((( 2652 2652 (% 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