Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 105.1 >
edited by Илья Крайнов
on 2023/08/09 17:59
To version < 138.1 >
edited by Андрей Калиновский
on 2024/02/28 09:52
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
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,23 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
174 + "agentId": "",(% style="color:#000000" %)   (%%)
175 + "parentId": "",
176 + "name": "string",
177 + "fullName": "string",
178 + "agentInfoType": 0,
179 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
182 +
183 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
186 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
189 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
190 +
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 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
209 + "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  
254 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
255 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
256 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
257 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
258 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
259 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
260 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
261 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
262 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
263 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
264 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
265 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
266 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
267 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
268 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
269 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
270 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
271 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
272 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
273 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
274 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
275 +
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  {
... ... @@ -300,6 +300,21 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
357 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
358 +
359 +(% class="box warningmessage" %)
360 +(((
361 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
362 +)))
363 +
364 +Метод позволяет изменить статус клиента, указанного в запросе.
365 +
366 +В пути указывается GUID клиента и статус клиента.
367 +
368 +**status **- значение 0 - заблокирован, 1 - активен.
369 +
370 +Ответ: Code 204
371 +
303 303  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 305  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -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  
463 +
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  
754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
755 +
756 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
757 +
758 +(% class="box infomessage" %)
759 +(((
760 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
761 +)))
762 +
763 +Метод возвращает полную информацию о модели объекта.
764 +
765 +(% style="color:#000000" %)Метод запроса: **GET**
766 +
767 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
768 +
769 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
770 +
771 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
772 +
773 +(% style="color:#000000" %)Ответ:
774 +
775 +(% style="color:#000000" %){
776 + "parentName": "string",
777 + "name": "string",
778 + "picture": "string",
779 + "minspeed": 0,
780 + "maxspeed": 0,
781 + "width": 0,
782 + "imbeddedtrailer": true,
783 + "hoppercapacity": 0,
784 + "hopperdischargespeed": 0,
785 + "modelType": 0,
786 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
787 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
788 + "deleted": true
789 +}
790 +
791 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
792 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
793 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
794 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
795 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
796 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
797 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
798 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
799 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
800 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
801 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
802 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
803 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
804 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
805 +
806 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
807 +
808 +(% class="box successmessage" %)
809 +(((
810 +(% lang="en-US" %)**POST /api/v3/models/find**
811 +)))
812 +
813 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
814 +
815 +(% style="color:#000000" %)Метод запроса: **POST**
816 +
817 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
818 +
819 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
820 +
821 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
822 +
823 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
824 +}
825 +
826 +(% style="color:#000000" %)Ответ:
827 +
828 +(% style="color:#000000" %)[
829 + {
830 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "parentName": "string",
833 + "name": "string",
834 + "modelType": 0
835 + }
836 +]
837 +
838 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
839 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
840 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
841 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
842 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
844 +
845 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
846 +
847 +(% class="box successmessage" %)
848 +(((
849 +(% lang="en-US" %)**POST /api/v3/models**
850 +)))
851 +
852 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
853 +
854 +(% style="color:#000000" %)Метод запроса: **POST**
855 +
856 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
857 +
858 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
859 +
860 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
861 +
862 +{
863 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
864 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
865 + "deleted": true,
866 + "extId": "string",
867 + "name": "string",
868 + "picture": "string",
869 + "minspeed": 0,
870 + "maxspeed": 0,
871 + "width": 0,
872 + "imbeddedtrailer": true,
873 + "fueloutlay": 0,
874 + "hoppercapacity": 0,
875 + "hopperdischargespeed": 0,
876 + "modelType": 0
877 +}
878 +
879 +Ответ:
880 +
881 +{
882 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
883 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
884 + "deleted": true,
885 + "extId": "string",
886 + "name": "string",
887 + "picture": "string",
888 + "minspeed": 0,
889 + "maxspeed": 0,
890 + "width": 0,
891 + "imbeddedtrailer": true,
892 + "hoppercapacity": 0,
893 + "hopperdischargespeed": 0,
894 + "modelType": 0
895 +}
896 +
897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
898 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
899 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
900 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
901 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
903 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
904 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
905 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
906 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
907 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
908 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
909 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
910 +
911 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
912 +
913 +(% class="box warningmessage" %)
914 +(((
915 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
916 +)))
917 +
918 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
919 +
920 +(% style="color:#000000" %)Метод запроса: **PUT**
921 +
922 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
923 +
924 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
925 +
926 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
927 +
928 +{
929 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
931 + "deleted": true,
932 + "extId": "string",
933 + "name": "string",
934 + "picture": "string",
935 + "minspeed": 0,
936 + "maxspeed": 0,
937 + "width": 0,
938 + "imbeddedtrailer": true,
939 + "fueloutlay": 0,
940 + "hoppercapacity": 0,
941 + "hopperdischargespeed": 0,
942 + "modelType": 0
943 +}
944 +
945 +Ответ:
946 +
947 +{
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
950 + "deleted": true,
951 + "extId": "string",
952 + "name": "string",
953 + "picture": "string",
954 + "minspeed": 0,
955 + "maxspeed": 0,
956 + "width": 0,
957 + "imbeddedtrailer": true,
958 + "fueloutlay": 0,
959 + "hoppercapacity": 0,
960 + "hopperdischargespeed": 0,
961 + "modelType": 0
962 +}
963 +
964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
965 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
966 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
967 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
968 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
970 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
971 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
972 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
973 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
974 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
975 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
976 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
977 +
978 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
979 +
980 +(% class="box errormessage" %)
981 +(((
982 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
983 +)))
984 +
985 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
986 +
987 +(% style="color:#000000" %)Метод запроса: **DELETE**
988 +
989 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
990 +
991 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
992 +
993 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
994 +
995 +Ответ: В случае успеха **Success 200**
996 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1490,7 +1490,7 @@
1490 1490  
1491 1491  (% style="color:#000000" %)Метод запроса: **GET**
1492 1492  
1493 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1805 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1494 1494  
1495 1495  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1496 1496  
... ... @@ -1573,6 +1573,51 @@
1573 1573   }
1574 1574  ]
1575 1575  
1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889 +
1890 +(% class="box infomessage" style="text-align: left;" %)
1891 +(((
1892 +**POST /api/v3/terminalMessages/mapping**
1893 +)))
1894 +
1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896 +
1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898 +
1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900 +
1901 +{
1902 + "protocolType": 0,
1903 + "params": ["string"]
1904 +}
1905 +
1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 +|protocolType|ID типа протокола
1908 +|params|(((
1909 +Массив наименований параметров в сообщении
1910 +)))
1911 +
1912 +Ответ:
1913 +
1914 +{
1915 + "protocolType": 0,
1916 + "mapping": {
1917 + "additionalProp1": {
1918 + "inputType": 0,
1919 + "inputNumber": 0
1920 + },
1921 + "additionalProp2": {
1922 + "inputType": 0,
1923 + "inputNumber": 0
1924 + }
1925 + }
1926 +}
1927 +
1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 +|protocolType|Тип протокола
1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 +|inputNumber|Номер входа
1932 +
1576 1576  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 1577  
1578 1578  (% class="box infomessage" %)
... ... @@ -1597,6 +1597,11 @@
1597 1597   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 1598  }
1599 1599  
1957 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 +|vehicleId|ID объекта
1959 +|from|Дата и время начала периода запроса
1960 +|to|Дата и время окончания периода запроса
1961 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,27 +1603,45 @@
1603 1603   {
1604 1604   "messages": [
1605 1605   {
1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 - "speed": 0, ~/~/ Скорость, км/ч
1609 - "altitude": 0, ~/~/ Высота, м
1610 - "latitude": 0, ~/~/ Широта [-90°;90°]
1611 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 - "satellites": 0, ~/~/ Кол-во спутников
1613 - "voltage": 0, ~/~/ Напряжение
1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1968 + "deviceTime": "2023-11-29T07:40:44.052Z",
1969 + "serverTime": "2023-11-29T07:40:44.052Z",
1970 + "speed": 0,
1971 + "altitude": 0,
1972 + "latitude": 0,
1973 + "longitude": 0,
1974 + "satellites": 0,
1975 + "course": 0,
1976 + "voltage": 0,
1977 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
1982 + "photoCount": 0,
1983 + "lbsCorrectedCoords": true,
1984 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1625 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных о объекте за период**(%%) =
1990 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 +|deviceTime|Время сообщения терминала
1992 +|serverTime|Время когда сообщение поступило на сервер
1993 +|speed|Скорость
1994 +|altitude|Высота над уровнем моря
1995 +|latitude|Широта
1996 +|longitude|Долгота
1997 +|satellites|Кол-во спутников
1998 +|course|Курс
1999 +|voltage|Бортовое напряжение
2000 +|parameters|Список параметров и их значений
2001 +|photoCount|Количество фото
2002 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 +|protocolType|ID типа протокола
1626 1626  
2005 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 +
1627 1627  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
1628 1628  
1629 1629  (% class="box infomessage" %)
... ... @@ -1755,6 +1755,142 @@
1755 1755   }
1756 1756  ]
1757 1757  
2138 +
2139 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2140 +
2141 +(% class="box infomessage" %)
2142 +(((
2143 +**POST /api/v3/vehicles/moveStop**
2144 +)))
2145 +
2146 +Метод запроса: **POST**
2147 +
2148 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2149 +
2150 +В заголовках запроса: X-Auth: Токен авторизации
2151 +
2152 +
2153 +Тело запроса:
2154 +
2155 +{
2156 +
2157 + "vehicleIds": [ ], ~/~/ Список ID объектов
2158 +
2159 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2160 +
2161 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2162 +
2163 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2164 +
2165 +}
2166 +
2167 +Ответ:
2168 +
2169 +[
2170 +
2171 + {
2172 +
2173 + "vehicleId": 0, ~/~/ ID объекта
2174 +
2175 + "vehicleName": "string", ~/~/ Имя объекта
2176 +
2177 + "moves": [ ~/~/ Событие движения
2178 +
2179 + {
2180 +
2181 + "mileage": 0, ~/~/ Пробег, км
2182 +
2183 + "eventId": 0, ~/~/ Идентификатор события
2184 +
2185 + "eventName": "string", ~/~/ Название события
2186 +
2187 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2188 +
2189 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2190 +
2191 + "duration": 0 ~/~/ Продолжительность события, секунд
2192 +
2193 + }
2194 +
2195 + ],
2196 +
2197 + "stops": [ ~/~/ События стоянок
2198 +
2199 + {
2200 +
2201 + "address": "string", ~/~/ Адрес события
2202 +
2203 + "eventId": 0, ~/~/ Идентификатор события
2204 +
2205 + "eventName": "string", ~/~/ Название события
2206 +
2207 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2208 +
2209 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2210 +
2211 + "duration": 0 ~/~/ Продолжительность события, секунд
2212 +
2213 +
2214 + }
2215 +
2216 + ]
2217 +
2218 + }
2219 +
2220 +]
2221 +
2222 +
2223 +
2224 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2225 +
2226 +(% class="box infomessage" %)
2227 +(((
2228 +**POST /api/v3/vehicles/getlastdata**
2229 +)))
2230 +
2231 +Метод запроса: **POST**
2232 +
2233 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2234 +
2235 +В заголовках запроса: X-Auth: Токен авторизации
2236 +
2237 +
2238 +Тело запроса:
2239 +
2240 +{
2241 +
2242 + "vehicleIds": [ ], ~/~/ Список ID машины
2243 +
2244 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2245 +
2246 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на траспортном средстве.
2247 +
2248 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2249 +
2250 +}
2251 +
2252 +
2253 +Ответ:
2254 + {
2255 + "vehicleId": 0, ~/~/Идентификатор объекта.
2256 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2257 + "vehicleNumber": "string",~/~/Номер объекта.
2258 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2259 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на траспортном средстве.
2260 + "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных.
2261 + "speed": 0,~/~/Скорость объекта.
2262 + "course": 0,~/~/Курс движения [0;360]
2263 + "latitude": 0,~/~/Широта [-90°;90°].
2264 + "longitude": 0,~/~/Долгота [-180°;180°].
2265 + "address": "string",~/~/Адрес.
2266 + "geozones": [ ~/~/Сведения по геозонам.
2267 + {
2268 + "id": 0,
2269 + "name": "string"
2270 + }
2271 +
2272 +
2273 +
1758 1758  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1759 1759  
1760 1760  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -1768,7 +1768,7 @@
1768 1768  
1769 1769  (% style="color:#000000" %)Метод запроса: **POST**
1770 1770  
1771 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
2287 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
1772 1772  
1773 1773  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1774 1774  
... ... @@ -2653,6 +2653,83 @@
2653 2653  Success
2654 2654  
2655 2655  
3172 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3173 +
3174 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3175 +
3176 +(% class="box infomessage" %)
3177 +(((
3178 +**POST /api/v3/Trailers**
3179 +)))
3180 +
3181 +Пример запроса:
3182 +
3183 +{
3184 + "startDate": "2023-11-14T10:48:03.671Z",
3185 + "endDate": "2023-11-14T10:48:03.671Z",
3186 + "ids": [ 0 ],
3187 + "timezone": 0
3188 +}
3189 +
3190 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3191 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3192 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3193 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3194 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3195 +
3196 +Пример ответа:
3197 +
3198 +[
3199 + {
3200 + "SD": "2023-11-14T10:48:03.717Z",
3201 + "ED": "2023-11-14T10:48:03.717Z", 
3202 + "id": 0,
3203 + "SLat": 0,
3204 + "SLon": 0,
3205 + "ELat": 0,
3206 + "ELon": 0,
3207 + "mileage": 0
3208 + "Duration": 0
3209 + "Address": "string",
3210 + "Address2": "string",
3211 + "name": "string",
3212 + "rid": "string",
3213 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3214 + "trailer": {
3215 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3216 + "Number": "string",
3217 + "Description": "string",
3218 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3219 + "ExternalID": "string",
3220 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3221 + "CreateTime": "2023-11-14T10:48:03.717Z",
3222 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3223 + "IsDeleted": true
3224 + },
3225 + "filesCount": 0,
3226 + }
3227 +]
3228 +
3229 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3230 +|SD|Дата и время начала события
3231 +|ED|Дата и время окончания события
3232 +|id|ID объекта
3233 +|SLat|Широта начальной координаты
3234 +|SLon|Долгота начальной координаты
3235 +|ELat|Широта конечной координаты
3236 +|ELon|Долгота конечной координаты
3237 +|mileage|Пробег
3238 +|Duration|Продолжительность
3239 +|Address|Адрес начального местоположения
3240 +|Address2|Адрес конечного местоположения
3241 +|name|Имя радиометки
3242 +|rid|Номер радиометки
3243 +|rguid|ID радиометки
3244 +|trailer|Информация об агрегате
3245 +|ModelGuid|ID агрегата
3246 +|Number|Название/номер агрегата
3247 +|Description|Текст примечания агрегата
3248 +
2656 2656  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2657 2657  
2658 2658  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2674,13 +2674,18 @@
2674 2674   {
2675 2675   "name": "string",
2676 2676   "number": 0,
2677 - "period": 0, ~/~/ Частота трансляции радиометки
3270 + "period": 0,
2678 2678   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2679 2679   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 - "deleted": true
2681 2681   }
2682 2682  ]
2683 2683  
3276 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3277 +|parentId|ID клиента
3278 +|name|Название карты-метки
3279 +|number|Номер
3280 +|period|Период запросов в секундах (работает только для агрегатов)
3281 +|id|ID карты-метки
2684 2684  
2685 2685  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2686 2686  
... ... @@ -2697,13 +2697,18 @@
2697 2697   {
2698 2698   "name": "string",
2699 2699   "number": 0,
2700 - "period": 0, ~/~/ Частота трансляции радиометки
3298 + "period": 0,
2701 2701   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2702 2702   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2703 - "deleted": true
2704 2704   }
2705 2705  ]
2706 2706  
3304 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3305 +|name|Название карты-метки
3306 +|number|Номер
3307 +|period|Период запросов в секундах (работает только для агрегатов)
3308 +|id|ID карты-метки
3309 +|parentId|ID клиента
2707 2707  
2708 2708  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2709 2709  
... ... @@ -2719,7 +2719,6 @@
2719 2719   "number": 0,
2720 2720   "period": 0,
2721 2721   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 - "deleted": true
2723 2723  }
2724 2724  
2725 2725  Ответ:
... ... @@ -2730,9 +2730,14 @@
2730 2730   "period": 0,
2731 2731   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2732 2732   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2733 - "deleted": true
2734 2734  }
2735 2735  
3337 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3338 +|name|Название карты-метки
3339 +|number|Номер
3340 +|period|Период запросов в секундах (работает только для агрегатов)
3341 +|id|ID карты-метки
3342 +|parentId|ID клиента
2736 2736  
2737 2737  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2738 2738  
... ... @@ -2749,7 +2749,6 @@
2749 2749   "period": 0,
2750 2750   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2751 2751   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 - "deleted": true
2753 2753  }
2754 2754  
2755 2755  Ответ:
... ... @@ -2760,9 +2760,14 @@
2760 2760   "period": 0,
2761 2761   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2762 2762   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2763 - "deleted": true
2764 2764  }
2765 2765  
3371 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3372 +|name|Название карты-метки
3373 +|number|Номер
3374 +|period|Период запросов в секундах (работает только для агрегатов)
3375 +|id|ID карты-метки
3376 +|parentId|ID клиента
2766 2766  
2767 2767  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2768 2768  
... ... @@ -2771,7 +2771,7 @@
2771 2771  **DELETE /api/v3/Rfids/{rfidGuid}**
2772 2772  )))
2773 2773  
2774 -Передаем параметр rfidGuid - идентификатор карты-метки
3385 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2775 2775  
2776 2776  Ответ:
2777 2777  
... ... @@ -2778,6 +2778,670 @@
2778 2778  Success
2779 2779  
2780 2780  
3392 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3393 +
3394 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3395 +
3396 +(% class="box infomessage" %)
3397 +(((
3398 +**GET /api/v3/Billing/client/balance/{clientId}**
3399 +)))
3400 +
3401 +Параметр запроса: **clientId **- идентификатор клиента.
3402 +
3403 +Ответ:
3404 +
3405 +{
3406 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3407 + "Balance": 0
3408 +}
3409 +
3410 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3411 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3412 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3413 +
3414 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3415 +
3416 +(% class="box infomessage" %)
3417 +(((
3418 +**GET /api/v3/Billing/client/constraint/{clientId}**
3419 +)))
3420 +
3421 +Параметр запроса: **clientId **- идентификатор клиента.
3422 +
3423 +Ответ:
3424 +
3425 +{
3426 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3427 + "CalculationType": 0,
3428 + "PermissibleBalance": 0,
3429 + "DefermentDays": 0,
3430 + "SendUiNotifications": true,
3431 + "SendEmailNotifications": true,
3432 + "IsPrivate": true,
3433 +}
3434 +
3435 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3436 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3437 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3438 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3439 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3440 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3441 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3442 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3443 +
3444 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3445 +
3446 +(% class="box infomessage" %)
3447 +(((
3448 +**GET /api/v3/Billing/client/plan/{clientId}**
3449 +)))
3450 +
3451 +Параметры запроса:
3452 +
3453 +**clientId **- идентификатор клиента.
3454 +
3455 +**planId **- идентификатор тарифного плана.
3456 +
3457 +Ответ:
3458 +
3459 +{
3460 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3461 + "Plan": { **~/~/ Описание тарифного плана**
3462 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3463 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3464 + "Name": "string",
3465 + "IsArchived": true,
3466 + "Constraint": {
3467 + "CalculationType": 0,
3468 + "PermissibleBalance": 0,
3469 + "DefermentDays": 0
3470 + },
3471 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3472 + {
3473 + "Feature": "string",
3474 + "IsFactual": true,
3475 + "Limit": 0,
3476 + "Price": 0,
3477 + "PeriodValue": 0,
3478 + "PeriodType": 0
3479 + }
3480 + ]
3481 + },
3482 + "DebitDate": "2023-10-18T12:46:24.213Z",
3483 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3484 + {
3485 + "Feature": "string",
3486 + "IsEnabled": true,
3487 + "IsPrivate": true,
3488 + "IsFactual": true,
3489 + "Limit": 0,
3490 + "Price": 0,
3491 + "DebitDate": "2023-10-18T12:46:24.213Z",
3492 + "PeriodValue": 0,
3493 + "PeriodType": 0
3494 + }
3495 + ]
3496 +}
3497 +
3498 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3499 +|ClientId|Идентификатор клиента
3500 +|Id|Идентификатор тарифного плана
3501 +|OwnerId|Идентификатор клиента-владельца
3502 +|Name|Наименование тарифного плана
3503 +|IsArchived|Признак, определяющий архивный тарифный план
3504 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3505 +|PermissibleBalance|Допустимый баланс
3506 +|DefermentDays|Отсрочка, количество дней
3507 +|Feature|Код услуги
3508 +|IsEnabled|Признак, определяющий активирована ли услуга
3509 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3510 +|IsFactual|Признак, определяющий расчёт по факту
3511 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3512 +|Price|Цена за единицу.
3513 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3514 +|PeriodValue|Значение периода.
3515 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3516 +
3517 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3518 +
3519 +(% class="box infomessage" %)
3520 +(((
3521 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3522 +)))
3523 +
3524 +Параметр запроса: **clientId **- идентификатор клиента.
3525 +
3526 +Ответ:
3527 +
3528 +[
3529 + {
3530 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3531 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3532 + "Name": "string",
3533 + "IsArchived": true,
3534 + "Constraint": {
3535 + "CalculationType": 0,
3536 + "PermissibleBalance": 0,
3537 + "DefermentDays": 0
3538 + },
3539 + "Features": [
3540 + {
3541 + "Feature": "string",
3542 + "IsFactual": true,
3543 + "Limit": 0,
3544 + "Price": 0,
3545 + "PeriodValue": 0,
3546 + "PeriodType": 0
3547 + }
3548 + ]
3549 + }
3550 +]
3551 +
3552 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3553 +|ClientId|Идентификатор клиента
3554 +|Id|Идентификатор тарифного плана
3555 +|OwnerId|Идентификатор клиента-владельца
3556 +|Name|Наименование тарифного плана
3557 +|IsArchived|Признак, определяющий архивный тарифный план
3558 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3559 +|PermissibleBalance|Допустимый баланс
3560 +|DefermentDays|Отсрочка, количество дней
3561 +|Feature|Код услуги
3562 +|IsFactual|Признак, определяющий расчёт по факту
3563 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3564 +|Price|Цена за единицу.
3565 +|PeriodValue|Значение периода.
3566 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3567 +
3568 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3569 +
3570 +(% class="box infomessage" %)
3571 +(((
3572 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3573 +)))
3574 +
3575 +Параметр запроса: **clientId **- идентификатор клиента.
3576 +
3577 +Ответ:
3578 +
3579 +[
3580 + {
3581 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3582 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3583 + "Name": "string",
3584 + "IsArchived": true,
3585 + "Constraint": {
3586 + "CalculationType": 0,
3587 + "PermissibleBalance": 0,
3588 + "DefermentDays": 0
3589 + },
3590 + "Features": [
3591 + {
3592 + "Feature": "string",
3593 + "IsFactual": true,
3594 + "Limit": 0,
3595 + "Price": 0,
3596 + "PeriodValue": 0,
3597 + "PeriodType": 0
3598 + }
3599 + ]
3600 + }
3601 +]
3602 +
3603 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3604 +|ClientId|Идентификатор клиента
3605 +|Id|Идентификатор тарифного плана
3606 +|OwnerId|Идентификатор клиента-владельца
3607 +|Name|Наименование тарифного плана
3608 +|IsArchived|Признак, определяющий архивный тарифный план
3609 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3610 +|PermissibleBalance|Допустимый баланс
3611 +|DefermentDays|Отсрочка, количество дней
3612 +|Feature|Код услуги
3613 +|IsFactual|Признак, определяющий расчёт по факту
3614 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3615 +|Price|Цена за единицу.
3616 +|PeriodValue|Значение периода.
3617 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3618 +
3619 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3620 +
3621 +(% class="box warningmessage" %)
3622 +(((
3623 +**PUT /api/v3/Billing/client/balance**
3624 +)))
3625 +
3626 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3627 +
3628 +Тело запроса:
3629 +
3630 +{
3631 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3632 + "Balance": 0
3633 +}
3634 +
3635 +Ответ: Success
3636 +
3637 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3638 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3639 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3640 +
3641 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3642 +
3643 +(% class="box warningmessage" %)
3644 +(((
3645 +**PUT /api/v3/billing/client/balance/deposit**
3646 +)))
3647 +
3648 +Создает операцию **Пополнение **с указанной суммой
3649 +
3650 +Тело запроса:
3651 +
3652 +{
3653 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3654 + "Balance": 0
3655 +}
3656 +
3657 +Ответ: Success
3658 +
3659 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3660 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3661 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3662 +
3663 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3664 +
3665 +Создает операцию **Списание **с указанной суммой
3666 +
3667 +(% class="box warningmessage" %)
3668 +(((
3669 +**PUT /api/v3/billing/client/balance/withdraw**
3670 +)))
3671 +
3672 +Тело запроса:
3673 +
3674 +{
3675 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3676 + "Balance": 0
3677 +}
3678 +
3679 +Ответ: Success
3680 +
3681 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3682 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3683 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3684 +
3685 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3686 +
3687 +(% class="box warningmessage" %)
3688 +(((
3689 +**PUT /api/v3/Billing/client/constraint**
3690 +)))
3691 +
3692 +Тело запроса:
3693 +
3694 +{
3695 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3696 + "CalculationType": 0,
3697 + "PermissibleBalance": 0,
3698 + "DefermentDays": 0,
3699 + "SendUiNotifications": true,
3700 + "SendEmailNotifications": true,
3701 + "IsPrivate": true,
3702 +}
3703 +
3704 +Ответ: Success
3705 +
3706 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3707 +|ClientId|Идентификатор клиента
3708 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3709 +|PermissibleBalance|Допустимый баланс
3710 +|DefermentDays|(((
3711 +Отсрочка, количество дней
3712 +)))
3713 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3714 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3715 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3716 +
3717 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3718 +
3719 +(% class="box warningmessage" %)
3720 +(((
3721 +**PUT /api/v3/Billing/client/plan**
3722 +)))
3723 +
3724 +Тело запроса:
3725 +
3726 +{
3727 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3728 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3729 + "Features": [
3730 + {
3731 + "Feature": "string",
3732 + "IsEnabled": true,
3733 + "IsFactual": true,
3734 + "Limit": 0,
3735 + "Price": 0,
3736 + "DebitDate": "2023-10-18T13:26:58.987Z",
3737 + "PeriodValue": 0,
3738 + "PeriodType": 0
3739 + }
3740 + ]
3741 +}
3742 +
3743 +Ответ: Success
3744 +
3745 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3746 +|ClientId|Идентификатор клиента
3747 +|PlanId|Идентификатор тарифного плана
3748 +|Feature|Код услуги
3749 +|IsEnabled|Признак, определяющий активирована ли услуга
3750 +|IsFactual|Признак, определяющий расчёт по факту
3751 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3752 +|Price|Цена за единицу.
3753 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3754 +|PeriodValue|Значение периода.
3755 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3756 +
3757 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3758 +
3759 +(% class="box warningmessage" %)
3760 +(((
3761 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3762 +)))
3763 +
3764 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3765 +
3766 +(% class="box infomessage" %)
3767 +(((
3768 +**POST /api/v3/vehicles/import/{agentId}**
3769 +)))
3770 +
3771 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3772 +
3773 +В пути указывается **agentId** - id клиента.
3774 +
3775 +**Заголовок**
3776 +
3777 +**X-Auth: [токен авторизации]**
3778 +
3779 +**Параметры**
3780 +
3781 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3782 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3783 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3784 +
3785 +В теле использовать тип **form-data,** тип значения** file**
3786 +
3787 +**Ключи**
3788 +
3789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3790 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3791 +|csv|В значении передаем файл датчиков, формат **csv**
3792 +
3793 +Ответ:
3794 +
3795 +{
3796 + "vehicleId": 0,
3797 + "name": "string",
3798 + "errors": ["string"]
3799 +}
3800 +
3801 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3802 +|vehicleId|ID созданного объекта
3803 +|name|Имя созданного объекта
3804 +|errors|Ошибки и их описание
3805 +
3806 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3807 +
3808 +(% class="box infomessage" %)
3809 +(((
3810 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3811 +)))
3812 +
3813 +(% class="wikigeneratedid" %)
3814 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3815 +
3816 +(% class="wikigeneratedid" %)
3817 +В пути указывается **vehicleId **- id объекта.
3818 +
3819 +**Заголовок**
3820 +
3821 +**X-Auth: [токен авторизации]**
3822 +
3823 +В теле использовать тип **form-data.**
3824 +
3825 +Ключи:
3826 +
3827 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3828 +|**history**|В значении передавать файл с историей
3829 +
3830 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3831 +
3832 +Ответ:
3833 +
3834 +{
3835 + "results": [
3836 + {
3837 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3838 + "vehicleId": 0,
3839 + "errors": [
3840 + "string"
3841 + ],
3842 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3843 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3844 + "producedCount": 0,
3845 + "msgCount": 0
3846 + }
3847 + ]
3848 +}
3849 +
3850 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3851 +|results|Результаты импорта в разрезе ТС
3852 +|vehicleGuid|Guid ТС
3853 +|vehicleId|ID ТС
3854 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3855 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3856 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3857 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3858 +|msgCount|Кол-во обработанных сообщений всего
3859 +
3860 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3861 +
3862 +(% class="box infomessage" %)
3863 +(((
3864 +**GET /api/v3/vehicles/import/history/status**
3865 +)))
3866 +
3867 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3868 +
3869 +Ответ:
3870 +
3871 +{
3872 + "activity": true,
3873 + "progress": 0,
3874 + "message": "string"
3875 +}
3876 +
3877 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3878 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3879 +|progress|Guid ТС
3880 +
3881 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3882 +
3883 +(% class="box infomessage" %)
3884 +(((
3885 +**POST /api/v3/vehicles/export**
3886 +)))
3887 +
3888 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3889 +
3890 +Тело запроса:
3891 +
3892 +[
3893 + id
3894 +]
3895 +
3896 +Ответ: Success 200, получаете файлы с настройками.
3897 +
3898 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3899 +
3900 +(% class="box infomessage" %)
3901 +(((
3902 +**POST /api/v3/vehicles/export/history**
3903 +)))
3904 +
3905 +Метод возвращает список сообщений терминала объекта за выбранный период.
3906 +
3907 +Тело запроса:
3908 +
3909 +{
3910 + "vehicleId": 0,
3911 + "asArchive": true,
3912 + "from": "2023-09-27T12:17:45.973Z",
3913 + "to": "2023-09-27T12:17:45.973Z"
3914 +}
3915 +
3916 +Ответ:
3917 +
3918 +Получаете файл. Сообщение: Code 200/Success
3919 +
3920 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3921 +|vehicleId|ID объекта
3922 +|asArchive|true - Архивировать файл, False - не архивировать
3923 +|from|Дата и время начала запроса
3924 +|to|Дата и время окончания запроса
3925 +
3926 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3927 +
3928 +(% class="box infomessage" %)
3929 +(((
3930 +**GET /api/v3/vehicles/export/history/status**
3931 +)))
3932 +
3933 +Метод возвращает список сообщений терминала объекта за выбранный период.
3934 +
3935 +Ответ:
3936 +
3937 +{
3938 + "activity": true,
3939 + "progress": 0,
3940 + "message": "string"
3941 +}
3942 +
3943 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3944 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3945 +|progress|Прогресс экспорта, от 0 до 100%
3946 +|message|Текст описывающий статус
3947 +
3948 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3949 +
3950 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3951 +
3952 +(% class="box infomessage" %)
3953 +(((
3954 +**POST /api/v3/EcoDriving/rating**
3955 +)))
3956 +
3957 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3958 +
3959 +Тело запроса:
3960 +
3961 +{
3962 + "vehicleIds": [vehicleId],
3963 + "from": "2023-11-22T09:29:48.051Z",
3964 + "to": "2023-11-22T09:29:48.051Z"
3965 +}
3966 +
3967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3968 +|vehicleIds|Массив ID объектов
3969 +|from|Дата начала запроса
3970 +|to|Дата окончания запроса
3971 +
3972 +Ответ:
3973 +
3974 +{
3975 + "items": [
3976 + {
3977 + "from": "2023-11-22T09:29:48.052Z",
3978 + "to": "2023-11-22T09:29:48.052Z",
3979 + "vehicleId": 0,
3980 + "vehicleName": "string",
3981 + "vehicleModel": "string",
3982 + "penalty": 0,
3983 + "score": 0,
3984 + "totalViolations": 0,
3985 + "violationsByType": {
3986 + "overspeedingViolations": 0,
3987 + "accelerationViolations": 0,
3988 + "brakingViolations": 0,
3989 + "turningViolations": 0,
3990 + "dangerousDrivingViolations": 0,
3991 + "sensorViolations": 0
3992 + },
3993 + "moveTime": 0,
3994 + "mileage": 0,
3995 + "tripsCount": 0,
3996 + "trips": [
3997 + {
3998 + "penalty": 0,
3999 + "score": 0,
4000 + "violationsCount": 0,
4001 + "violationsByType": {
4002 + "overspeedingViolations": 0,
4003 + "accelerationViolations": 0,
4004 + "brakingViolations": 0,
4005 + "turningViolations": 0,
4006 + "dangerousDrivingViolations": 0,
4007 + "sensorViolations": 0
4008 + },
4009 + "moveTime": 0,
4010 + "mileage": 0,
4011 + "motohours": 0,
4012 + "maxSpeed": 0,
4013 + "startAddress": "string",
4014 + "endAddress": "string",
4015 + "drivers": [
4016 + {
4017 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4018 + "driverName": "string",
4019 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4020 + }
4021 + ]
4022 + }
4023 + ]
4024 + }
4025 + ]
4026 +}
4027 +
4028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4029 +|from|Дата начала запроса
4030 +|to|Дата  окончания
4031 +|vehicleId|ID объекта
4032 +|vehicleName|Имя объекта
4033 +|vehicleModel|Модель объекта
4034 +|penalty|Сумма штрафных баллов
4035 +|score|Оценка
4036 +|totalViolations|Суммарное количество нарушений
4037 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4038 +|overspeedingViolations|Превышение скорости
4039 +|accelerationViolations|Ускорение
4040 +|brakingViolations|Торможение
4041 +|turningViolations|Резкий поворот
4042 +|dangerousDrivingViolations|Резкое вождение
4043 +|sensorViolations|Нарушение по датчику
4044 +|moveTime|Время в движении
4045 +|mileage|Пробег
4046 +|tripsCount|Количество рейсов
4047 +|motohours|Моточасы
4048 +|maxSpeed|Максимальная скорость
4049 +|startAddress|Адрес начала рейса
4050 +|endAddress|Адрес окончания рейса
4051 +|drivers|Список водителей, которые были на объекте в течениии рейса
4052 +|driverGuid|Guid водителя
4053 +|driverName|Имя водителя
4054 +|driverRfid|Номер Карты-метки
4055 +
2781 2781  (% class="box" lang="en-US" style="text-align: center;" %)
2782 2782  (((
2783 2783  (% 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]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

ГЛОНАССSoft wiki - 2024 г.