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,7 +1504,312 @@ 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 + 1831 +(% style="text-align:left" %) 1832 +(% style="color:#000000" %)} 1833 + 1834 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1835 + 1836 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1837 + 1838 +(% class="box infomessage" style="text-align: left;" %) 1839 +((( 1840 +**POST /api/v3/terminalMessages/count** 1841 +))) 1842 + 1843 +(% style="text-align: left;" %) 1844 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1845 + 1846 +(% style="text-align: left;" %) 1847 +Метод запроса **POST** 1848 + 1849 +(% style="text-align: left;" %) 1850 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1851 + 1852 +(% style="text-align: left;" %) 1853 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1854 + 1855 +(% style="text-align: left;" %) 1856 +{ 1857 + "vehicleIds": [ 1858 + id ~/~/ здесь передается список идентификаторов объектов 1859 + ], 1860 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1861 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1862 +} 1863 + 1864 +(% style="text-align: left;" %) 1865 +Ответ: 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:16px" %)**Экспорт сообщений**(%%) == 1925 + 1926 +(% class="box infomessage" %) 1927 +((( 1928 +**POST /api/v3/vehicles/export/history** 1929 +))) 1930 + 1931 +Метод возвращает список сообщений терминала объекта за выбранный период. 1932 + 1933 +(% style="text-align: left;" %) 1934 +Метод запроса **POST** 1935 + 1936 +(% style="text-align: left;" %) 1937 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1938 + 1939 +(% style="text-align: left;" %) 1940 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1941 + 1942 +{ 1943 + "vehicleId": 0, ~/~/ ID объекта 1944 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1945 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1946 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1947 +} 1948 + 1949 +Ответ: 1950 + 1951 +Получаете файл. Сообщение: Code 200/Success 1952 + 1953 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1954 + 1955 +(% class="box infomessage" %) 1956 +((( 1957 +**GET /api/v3/vehicles/export/history/status** 1958 +))) 1959 + 1960 +Метод возвращает список сообщений терминала объекта за выбранный период. 1961 + 1962 +(% style="text-align: left;" %) 1963 +Метод запроса **GET** 1964 + 1965 +(% style="text-align: left;" %) 1966 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1967 + 1968 +(% style="text-align: left;" %) 1969 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1970 + 1971 +Ответ: 1972 + 1973 +{ 1974 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1975 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1976 + "message": "string" ~/~/ текст описывающий статус. 1977 +} 1978 + 1979 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1980 + 1981 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1982 + 1983 +(% class="box infomessage" %) 1984 +((( 1985 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1986 +))) 1987 + 1988 +(% style="color:#000000" %)Метод запроса: **POST** 1989 + 1990 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1991 + 1992 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1993 + 1994 +(% style="text-align:left" %) 1995 +Тело запроса: 1996 + 1997 +{ 1998 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1999 + "vehicleIds": [0], ~/~/ Список ID объектов 2000 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2001 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2002 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2003 +} 2004 + 2005 +Ответ: 2006 + 2007 +[ 2008 + { 2009 + "vehicleId": 0, ~/~/ ID объекта 2010 + "name": "string", ~/~/ Имя ТС 2011 + "periods": [ ~/~/ Периоды 2012 + { 2013 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2014 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2015 + "mileageBegin": 0, ~/~/ Пробег на начало периода 2016 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 2017 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2018 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2019 + } 2020 + ] 2021 + } 2022 +] 2023 + 2024 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2025 + 2026 +(% class="box infomessage" %) 2027 +((( 2028 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2029 +))) 2030 + 2031 +(% style="color:#000000" %)Метод запроса: **POST** 2032 + 2033 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2034 + 2035 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2036 + 2037 +(% style="text-align:left" %) 2038 +Тело запроса: 2039 + 2040 +{ 2041 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2042 + "vehicleIds": [0], ~/~/ Список ID объектов 2043 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2044 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2045 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2046 +} 2047 + 2048 +Ответ: 2049 + 2050 +[ 2051 + { 2052 + "vehicleId": 0, ~/~/ ID объекта 2053 + "name": "string", ~/~/ Имя ТС 2054 + "periods": [ ~/~/ Периоды 2055 + { 2056 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2057 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2058 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2059 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2060 + "fuelConsumption": 0, ~/~/ Расход топлива 2061 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2062 + } 2063 + ] 2064 + } 2065 +] 2066 + 2067 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2068 + 2069 +(% class="box infomessage" %) 2070 +((( 2071 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2072 +))) 2073 + 2074 +(% style="color:#000000" %)Метод запроса: **POST** 2075 + 2076 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2077 + 2078 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2079 + 2080 +(% style="text-align:left" %) 2081 +Тело запроса: 2082 + 2083 +{ 2084 + "vehicleIds": [0], ~/~/ Список ID объектов 2085 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2086 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2087 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2088 +} 2089 + 2090 +Ответ: 2091 + 2092 +[ 2093 + { 2094 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2095 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2096 + "vehicleId": 0, ~/~/ ID объекта 2097 + "name": "string", ~/~/ Имя объекта 2098 + "model": "string", ~/~/ Модель объекта 2099 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2100 + { 2101 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2102 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2103 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2104 + "valueFuel": 0, ~/~/ Количество 2105 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2106 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2107 + } 2108 + ] 2109 + } 2110 +] 2111 + 1508 1508 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 1509 1509 1510 1510 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -1518,7 +1518,7 @@ 1518 1518 1519 1519 (% style="color:#000000" %)Метод запроса: **POST** 1520 1520 1521 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ users/api/v3/gis/find2125 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 1522 1522 1523 1523 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1524 1524 ... ... @@ -1633,124 +1633,6 @@ 1633 1633 } 1634 1634 ] 1635 1635 1636 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1637 - 1638 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1639 - 1640 -(% class="box infomessage" %) 1641 -((( 1642 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1643 -))) 1644 - 1645 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1646 - 1647 -(% style="color:#000000" %)Метод запроса: **GET** 1648 - 1649 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1650 - 1651 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1652 - 1653 -(% style="color:#000000" %)Ответ: 1654 - 1655 -(% style="color:#000000" %){ 1656 - 1657 - "id": "", ~/~/ ID типа датчика 1658 - "name": "", ~/~/ Название 1659 - "description": "", ~/~/ Описание 1660 - 1661 -(% style="text-align:left" %) 1662 -(% style="color:#000000" %)} 1663 - 1664 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1665 - 1666 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1667 - 1668 -(% class="box infomessage" style="text-align: left;" %) 1669 -((( 1670 -**POST /api/v3/terminalMessages/count** 1671 -))) 1672 - 1673 -(% style="text-align: left;" %) 1674 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1675 - 1676 -(% style="text-align: left;" %) 1677 -Метод запроса **POST** 1678 - 1679 -(% style="text-align: left;" %) 1680 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1681 - 1682 -(% style="text-align: left;" %) 1683 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1684 - 1685 -(% style="text-align: left;" %) 1686 -{ 1687 - "vehicleIds": [ 1688 - id ~/~/ здесь передается список идентификаторов объектов 1689 - ], 1690 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1691 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1692 -} 1693 - 1694 -(% style="text-align: left;" %) 1695 -Ответ: 1696 - 1697 -(% style="text-align: left;" %) 1698 -[ 1699 - { 1700 - "vehicleId": 0, ~/~/ идентификатор объекта 1701 - "count": 0 ~/~/ количество сообщений за период 1702 - } 1703 -] 1704 - 1705 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1706 - 1707 -(% class="box infomessage" %) 1708 -((( 1709 -**POST /api/v3/terminalMessages** 1710 -))) 1711 - 1712 -Метод возвращает список сообщений терминала объекта за выбранный период. 1713 - 1714 -(% style="text-align: left;" %) 1715 -Метод запроса **POST** 1716 - 1717 -(% style="text-align: left;" %) 1718 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1719 - 1720 -(% style="text-align: left;" %) 1721 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1722 - 1723 -{ 1724 - "vehicleId": 0, ~/~/ id объекта 1725 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1726 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1727 -} 1728 - 1729 -Ответ: 1730 - 1731 -[ 1732 - { 1733 - "messages": [ 1734 - { 1735 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1736 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1737 - "speed": 0, ~/~/ Скорость, км/ч 1738 - "altitude": 0, ~/~/ Высота, м 1739 - "latitude": 0, ~/~/ Широта [-90°;90°] 1740 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1741 - "satellites": 0, ~/~/ Кол-во спутников 1742 - "voltage": 0, ~/~/ Напряжение 1743 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1744 - "additionalProp1": "string", 1745 - "additionalProp2": "string", 1746 - "additionalProp3": "string" 1747 - }, 1748 - "photoCount": 0 ~/~/ Кол-во фото 1749 - } 1750 - ] 1751 - } 1752 -] 1753 - 1754 1754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1755 1755 1756 1756 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2521,6 +2521,84 @@ 2521 2521 Success 2522 2522 2523 2523 3010 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3011 + 3012 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3013 + 3014 +(% class="box infomessage" %) 3015 +((( 3016 +**POST /api/v3/Trailers** 3017 +))) 3018 + 3019 +Пример запроса: 3020 + 3021 +{ 3022 + "startDate": "2023-11-14T10:48:03.671Z", 3023 + "endDate": "2023-11-14T10:48:03.671Z", 3024 + "ids": [ 0 ], 3025 + "timezone": 0 3026 +} 3027 + 3028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3029 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3030 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3031 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3032 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3033 + 3034 +Пример ответа: 3035 + 3036 +[ 3037 + { 3038 + "SD": "2023-11-14T10:48:03.717Z", 3039 + "ED": "2023-11-14T10:48:03.717Z", 3040 + "id": 0, 3041 + "SLat": 0, 3042 + "SLon": 0, 3043 + "ELat": 0, 3044 + "ELon": 0, 3045 + "mileage": 0 3046 + "Duration": 0 3047 + "Address": "string", 3048 + "Address2": "string", 3049 + "name": "string", 3050 + "rid": "string", 3051 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3052 + "trailer": { 3053 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3054 + "Number": "string", 3055 + "Description": "string", 3056 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3057 + "ExternalID": "string", 3058 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3059 + "CreateTime": "2023-11-14T10:48:03.717Z", 3060 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3061 + "IsDeleted": true 3062 + }, 3063 + "filesCount": 0, 3064 + } 3065 +] 3066 + 3067 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3068 +|SD|Дата и время начала события 3069 +|ED|Дата и время окончания события 3070 +|id|ID объекта 3071 +|SLat|Широта начальной координаты 3072 +|SLon|Долгота начальной координаты 3073 +|ELat|Широта конечной координаты 3074 +|ELon|Долгота конечной координаты 3075 +|mileage|Пробег 3076 +|Duration|Продолжительность 3077 +|Address|Адрес начального местоположения 3078 +|Address2|Адрес конечного местоположения 3079 +|name|Имя радиометки 3080 +|rid|Номер радиометки 3081 +|rguid|ID радиометки 3082 +|trailer|Информация об агрегате 3083 +|ModelGuid|ID агрегата 3084 +|Number|Название/номер агрегата 3085 +|Description|Текст примечания агрегата 3086 + 3087 + 2524 2524 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2525 2525 2526 2526 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2549,7 +2549,6 @@ 2549 2549 } 2550 2550 ] 2551 2551 2552 - 2553 2553 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2554 2554 2555 2555 (% class="box infomessage" %) ... ... @@ -2572,7 +2572,6 @@ 2572 2572 } 2573 2573 ] 2574 2574 2575 - 2576 2576 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2577 2577 2578 2578 (% class="box successmessage" %) ... ... @@ -2601,7 +2601,6 @@ 2601 2601 "deleted": true 2602 2602 } 2603 2603 2604 - 2605 2605 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2606 2606 2607 2607 (% class="box warningmessage" %) ... ... @@ -2631,7 +2631,6 @@ 2631 2631 "deleted": true 2632 2632 } 2633 2633 2634 - 2635 2635 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2636 2636 2637 2637 (% class="box errormessage" %) ... ... @@ -2639,7 +2639,7 @@ 2639 2639 **DELETE /api/v3/Rfids/{rfidGuid}** 2640 2640 ))) 2641 2641 2642 -Передаем параметр rfidGuid - идентификатор карты-метки 3202 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2643 2643 2644 2644 Ответ: 2645 2645 ... ... @@ -2646,6 +2646,325 @@ 2646 2646 Success 2647 2647 2648 2648 3209 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3210 + 3211 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3212 + 3213 +(% class="box infomessage" %) 3214 +((( 3215 +**GET /api/v3/Billing/client/balance/{clientId}** 3216 +))) 3217 + 3218 +Параметр запроса: **clientId **- идентификатор клиента. 3219 + 3220 +Ответ: 3221 + 3222 +{ 3223 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3224 + "Balance": 0 3225 +} 3226 + 3227 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3228 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3229 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3230 + 3231 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3232 + 3233 +(% class="box infomessage" %) 3234 +((( 3235 +**GET /api/v3/Billing/client/constraint/{clientId}** 3236 +))) 3237 + 3238 +Параметр запроса: **clientId **- идентификатор клиента. 3239 + 3240 +Ответ: 3241 + 3242 +{ 3243 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3244 + "CalculationType": 0, 3245 + "PermissibleBalance": 0, 3246 + "DefermentDays": 0, 3247 + "SendUiNotifications": true, 3248 + "SendEmailNotifications": true, 3249 + "IsPrivate": true, 3250 +} 3251 + 3252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3253 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3254 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3255 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3256 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3257 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3258 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3259 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3260 + 3261 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3262 + 3263 +(% class="box infomessage" %) 3264 +((( 3265 +**GET /api/v3/Billing/client/plan/{clientId}** 3266 +))) 3267 + 3268 +Параметры запроса: 3269 + 3270 +**clientId **- идентификатор клиента. 3271 + 3272 +**planId **- идентификатор тарифного плана. 3273 + 3274 +Ответ: 3275 + 3276 +{ 3277 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3278 + "Plan": { **~/~/ Описание тарифного плана** 3279 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3280 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3281 + "Name": "string", 3282 + "IsArchived": true, 3283 + "Constraint": { 3284 + "CalculationType": 0, 3285 + "PermissibleBalance": 0, 3286 + "DefermentDays": 0 3287 + }, 3288 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3289 + { 3290 + "Feature": "string", 3291 + "IsFactual": true, 3292 + "Limit": 0, 3293 + "Price": 0, 3294 + "PeriodValue": 0, 3295 + "PeriodType": 0 3296 + } 3297 + ] 3298 + }, 3299 + "DebitDate": "2023-10-18T12:46:24.213Z", 3300 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3301 + { 3302 + "Feature": "string", 3303 + "IsEnabled": true, 3304 + "IsPrivate": true, 3305 + "IsFactual": true, 3306 + "Limit": 0, 3307 + "Price": 0, 3308 + "DebitDate": "2023-10-18T12:46:24.213Z", 3309 + "PeriodValue": 0, 3310 + "PeriodType": 0 3311 + } 3312 + ] 3313 +} 3314 + 3315 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3316 +|ClientId|Идентификатор клиента 3317 +|Id|Идентификатор тарифного плана 3318 +|OwnerId|Идентификатор клиента-владельца 3319 +|Name|Наименование тарифного плана 3320 +|IsArchived|Признак, определяющий архивный тарифный план 3321 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3322 +|PermissibleBalance|Допустимый баланс 3323 +|DefermentDays|Отсрочка, количество дней 3324 +|Feature|Код услуги 3325 +|IsEnabled|Признак, определяющий активирована ли услуга 3326 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3327 +|IsFactual|Признак, определяющий расчёт по факту 3328 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3329 +|Price|Цена за единицу. 3330 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3331 +|PeriodValue|Значение периода. 3332 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3333 + 3334 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3335 + 3336 +(% class="box infomessage" %) 3337 +((( 3338 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3339 +))) 3340 + 3341 +Параметр запроса: **clientId **- идентификатор клиента. 3342 + 3343 +Ответ: 3344 + 3345 +[ 3346 + { 3347 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3348 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3349 + "Name": "string", 3350 + "IsArchived": true, 3351 + "Constraint": { 3352 + "CalculationType": 0, 3353 + "PermissibleBalance": 0, 3354 + "DefermentDays": 0 3355 + }, 3356 + "Features": [ 3357 + { 3358 + "Feature": "string", 3359 + "IsFactual": true, 3360 + "Limit": 0, 3361 + "Price": 0, 3362 + "PeriodValue": 0, 3363 + "PeriodType": 0 3364 + } 3365 + ] 3366 + } 3367 +] 3368 + 3369 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3370 +|ClientId|Идентификатор клиента 3371 +|Id|Идентификатор тарифного плана 3372 +|OwnerId|Идентификатор клиента-владельца 3373 +|Name|Наименование тарифного плана 3374 +|IsArchived|Признак, определяющий архивный тарифный план 3375 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3376 +|PermissibleBalance|Допустимый баланс 3377 +|DefermentDays|Отсрочка, количество дней 3378 +|Feature|Код услуги 3379 +|IsFactual|Признак, определяющий расчёт по факту 3380 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3381 +|Price|Цена за единицу. 3382 +|PeriodValue|Значение периода. 3383 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3384 + 3385 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3386 + 3387 +(% class="box infomessage" %) 3388 +((( 3389 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3390 +))) 3391 + 3392 +Параметр запроса: **clientId **- идентификатор клиента. 3393 + 3394 +Ответ: 3395 + 3396 +[ 3397 + { 3398 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3399 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3400 + "Name": "string", 3401 + "IsArchived": true, 3402 + "Constraint": { 3403 + "CalculationType": 0, 3404 + "PermissibleBalance": 0, 3405 + "DefermentDays": 0 3406 + }, 3407 + "Features": [ 3408 + { 3409 + "Feature": "string", 3410 + "IsFactual": true, 3411 + "Limit": 0, 3412 + "Price": 0, 3413 + "PeriodValue": 0, 3414 + "PeriodType": 0 3415 + } 3416 + ] 3417 + } 3418 +] 3419 + 3420 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3421 +|ClientId|Идентификатор клиента 3422 +|Id|Идентификатор тарифного плана 3423 +|OwnerId|Идентификатор клиента-владельца 3424 +|Name|Наименование тарифного плана 3425 +|IsArchived|Признак, определяющий архивный тарифный план 3426 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3427 +|PermissibleBalance|Допустимый баланс 3428 +|DefermentDays|Отсрочка, количество дней 3429 +|Feature|Код услуги 3430 +|IsFactual|Признак, определяющий расчёт по факту 3431 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3432 +|Price|Цена за единицу. 3433 +|PeriodValue|Значение периода. 3434 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3435 + 3436 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3437 + 3438 +(% class="box warningmessage" %) 3439 +((( 3440 +**PUT /api/v3/Billing/client/balance** 3441 +))) 3442 + 3443 +Тело запроса: 3444 + 3445 +{ 3446 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3447 + "Balance": 0 3448 +} 3449 + 3450 +Ответ: Success 3451 + 3452 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3453 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3454 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3455 + 3456 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3457 + 3458 +(% class="box warningmessage" %) 3459 +((( 3460 +**PUT /api/v3/Billing/client/constraint** 3461 +))) 3462 + 3463 +Тело запроса: 3464 + 3465 +{ 3466 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3467 + "CalculationType": 0, 3468 + "PermissibleBalance": 0, 3469 + "DefermentDays": 0, 3470 + "SendUiNotifications": true, 3471 + "SendEmailNotifications": true, 3472 + "IsPrivate": true, 3473 +} 3474 + 3475 +Ответ: Success 3476 + 3477 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3478 +|ClientId|Идентификатор клиента 3479 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3480 +|PermissibleBalance|Допустимый баланс 3481 +|DefermentDays|((( 3482 +Отсрочка, количество дней 3483 +))) 3484 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3485 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3486 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3487 + 3488 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3489 + 3490 +(% class="box warningmessage" %) 3491 +((( 3492 +**PUT /api/v3/Billing/client/plan** 3493 +))) 3494 + 3495 +Тело запроса: 3496 + 3497 +{ 3498 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3499 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3500 + "Features": [ 3501 + { 3502 + "Feature": "string", 3503 + "IsEnabled": true, 3504 + "IsFactual": true, 3505 + "Limit": 0, 3506 + "Price": 0, 3507 + "DebitDate": "2023-10-18T13:26:58.987Z", 3508 + "PeriodValue": 0, 3509 + "PeriodType": 0 3510 + } 3511 + ] 3512 +} 3513 + 3514 +Ответ: Success 3515 + 3516 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3517 +|ClientId|Идентификатор клиента 3518 +|PlanId|Идентификатор тарифного плана 3519 +|Feature|Код услуги 3520 +|IsEnabled|Признак, определяющий активирована ли услуга 3521 +|IsFactual|Признак, определяющий расчёт по факту 3522 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3523 +|Price|Цена за единицу. 3524 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3525 +|PeriodValue|Значение периода. 3526 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3527 + 2649 2649 (% class="box" lang="en-US" style="text-align: center;" %) 2650 2650 ((( 2651 2651 (% 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