Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 108.1 >
edited by Илья Крайнов
on 2023/09/27 15:57
To version < 141.1 >
edited by Андрей Калиновский
on 2024/02/28 10:46
>
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,80 +1603,43 @@
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: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) ==
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  
1627 -(% class="box infomessage" %)
1628 -(((
1629 -**POST /api/v3/vehicles/export/history**
1630 -)))
1631 -
1632 -Метод возвращает список сообщений терминала объекта за выбранный период.
1633 -
1634 -(% style="text-align: left;" %)
1635 -Метод запроса **POST**
1636 -
1637 -(% style="text-align: left;" %)
1638 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1639 -
1640 -(% style="text-align: left;" %)
1641 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1642 -
1643 -{
1644 - "vehicleId": 0, ~/~/ ID объекта
1645 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1646 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1647 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1648 -}
1649 -
1650 -Ответ:
1651 -
1652 -Получаете файл. Сообщение: Code 200/Success
1653 -
1654 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1655 -
1656 -(% class="box infomessage" %)
1657 -(((
1658 -**GET /api/v3/vehicles/export/history/status**
1659 -)))
1660 -
1661 -Метод возвращает список сообщений терминала объекта за выбранный период.
1662 -
1663 -(% style="text-align: left;" %)
1664 -Метод запроса **GET**
1665 -
1666 -(% style="text-align: left;" %)
1667 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1668 -
1669 -(% style="text-align: left;" %)
1670 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1671 -
1672 -Ответ:
1673 -
1674 -{
1675 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1676 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1677 - "message": "string" ~/~/ текст описывающий статус.
1678 -}
1679 -
1680 1680  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1681 1681  
1682 1682  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1810,6 +1810,129 @@
1810 1810   }
1811 1811  ]
1812 1812  
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 +В теле запроса перечисляете массив id объектов
2238 +
2239 +
2240 +Ответ:
2241 + {
2242 + "vehicleId": 0, ~/~/Идентификатор объекта.
2243 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2244 + "vehicleNumber": "string",~/~/Номер объекта.
2245 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2246 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2247 + "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных.
2248 + "speed": 0,~/~/Скорость объекта.
2249 + "course": 0,~/~/Курс движения [0;360]
2250 + "latitude": 0,~/~/Широта [-90°;90°].
2251 + "longitude": 0,~/~/Долгота [-180°;180°].
2252 + "address": "string",~/~/Адрес.
2253 + "geozones": [ ~/~/Сведения по геозонам.
2254 + {
2255 + "id": 0,
2256 + "name": "string"
2257 + }
2258 +
2259 +
2260 +
1813 1813  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1814 1814  
1815 1815  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2708,6 +2708,83 @@
2708 2708  Success
2709 2709  
2710 2710  
3159 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3160 +
3161 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3162 +
3163 +(% class="box infomessage" %)
3164 +(((
3165 +**POST /api/v3/Trailers**
3166 +)))
3167 +
3168 +Пример запроса:
3169 +
3170 +{
3171 + "startDate": "2023-11-14T10:48:03.671Z",
3172 + "endDate": "2023-11-14T10:48:03.671Z",
3173 + "ids": [ 0 ],
3174 + "timezone": 0
3175 +}
3176 +
3177 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3178 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3179 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3180 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3181 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3182 +
3183 +Пример ответа:
3184 +
3185 +[
3186 + {
3187 + "SD": "2023-11-14T10:48:03.717Z",
3188 + "ED": "2023-11-14T10:48:03.717Z", 
3189 + "id": 0,
3190 + "SLat": 0,
3191 + "SLon": 0,
3192 + "ELat": 0,
3193 + "ELon": 0,
3194 + "mileage": 0
3195 + "Duration": 0
3196 + "Address": "string",
3197 + "Address2": "string",
3198 + "name": "string",
3199 + "rid": "string",
3200 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3201 + "trailer": {
3202 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3203 + "Number": "string",
3204 + "Description": "string",
3205 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3206 + "ExternalID": "string",
3207 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3208 + "CreateTime": "2023-11-14T10:48:03.717Z",
3209 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3210 + "IsDeleted": true
3211 + },
3212 + "filesCount": 0,
3213 + }
3214 +]
3215 +
3216 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3217 +|SD|Дата и время начала события
3218 +|ED|Дата и время окончания события
3219 +|id|ID объекта
3220 +|SLat|Широта начальной координаты
3221 +|SLon|Долгота начальной координаты
3222 +|ELat|Широта конечной координаты
3223 +|ELon|Долгота конечной координаты
3224 +|mileage|Пробег
3225 +|Duration|Продолжительность
3226 +|Address|Адрес начального местоположения
3227 +|Address2|Адрес конечного местоположения
3228 +|name|Имя радиометки
3229 +|rid|Номер радиометки
3230 +|rguid|ID радиометки
3231 +|trailer|Информация об агрегате
3232 +|ModelGuid|ID агрегата
3233 +|Number|Название/номер агрегата
3234 +|Description|Текст примечания агрегата
3235 +
2711 2711  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2712 2712  
2713 2713  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2729,13 +2729,18 @@
2729 2729   {
2730 2730   "name": "string",
2731 2731   "number": 0,
2732 - "period": 0, ~/~/ Частота трансляции радиометки
3257 + "period": 0,
2733 2733   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2734 2734   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2735 - "deleted": true
2736 2736   }
2737 2737  ]
2738 2738  
3263 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3264 +|parentId|ID клиента
3265 +|name|Название карты-метки
3266 +|number|Номер
3267 +|period|Период запросов в секундах (работает только для агрегатов)
3268 +|id|ID карты-метки
2739 2739  
2740 2740  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2741 2741  
... ... @@ -2752,13 +2752,18 @@
2752 2752   {
2753 2753   "name": "string",
2754 2754   "number": 0,
2755 - "period": 0, ~/~/ Частота трансляции радиометки
3285 + "period": 0,
2756 2756   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2757 2757   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2758 - "deleted": true
2759 2759   }
2760 2760  ]
2761 2761  
3291 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3292 +|name|Название карты-метки
3293 +|number|Номер
3294 +|period|Период запросов в секундах (работает только для агрегатов)
3295 +|id|ID карты-метки
3296 +|parentId|ID клиента
2762 2762  
2763 2763  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2764 2764  
... ... @@ -2774,7 +2774,6 @@
2774 2774   "number": 0,
2775 2775   "period": 0,
2776 2776   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2777 - "deleted": true
2778 2778  }
2779 2779  
2780 2780  Ответ:
... ... @@ -2785,9 +2785,14 @@
2785 2785   "period": 0,
2786 2786   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2787 2787   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2788 - "deleted": true
2789 2789  }
2790 2790  
3324 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3325 +|name|Название карты-метки
3326 +|number|Номер
3327 +|period|Период запросов в секундах (работает только для агрегатов)
3328 +|id|ID карты-метки
3329 +|parentId|ID клиента
2791 2791  
2792 2792  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2793 2793  
... ... @@ -2804,7 +2804,6 @@
2804 2804   "period": 0,
2805 2805   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2806 2806   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2807 - "deleted": true
2808 2808  }
2809 2809  
2810 2810  Ответ:
... ... @@ -2815,9 +2815,14 @@
2815 2815   "period": 0,
2816 2816   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2817 2817   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2818 - "deleted": true
2819 2819  }
2820 2820  
3358 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3359 +|name|Название карты-метки
3360 +|number|Номер
3361 +|period|Период запросов в секундах (работает только для агрегатов)
3362 +|id|ID карты-метки
3363 +|parentId|ID клиента
2821 2821  
2822 2822  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2823 2823  
... ... @@ -2826,7 +2826,7 @@
2826 2826  **DELETE /api/v3/Rfids/{rfidGuid}**
2827 2827  )))
2828 2828  
2829 -Передаем параметр rfidGuid - идентификатор карты-метки
3372 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2830 2830  
2831 2831  Ответ:
2832 2832  
... ... @@ -2833,6 +2833,670 @@
2833 2833  Success
2834 2834  
2835 2835  
3379 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3380 +
3381 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3382 +
3383 +(% class="box infomessage" %)
3384 +(((
3385 +**GET /api/v3/Billing/client/balance/{clientId}**
3386 +)))
3387 +
3388 +Параметр запроса: **clientId **- идентификатор клиента.
3389 +
3390 +Ответ:
3391 +
3392 +{
3393 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3394 + "Balance": 0
3395 +}
3396 +
3397 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3398 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3399 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3400 +
3401 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3402 +
3403 +(% class="box infomessage" %)
3404 +(((
3405 +**GET /api/v3/Billing/client/constraint/{clientId}**
3406 +)))
3407 +
3408 +Параметр запроса: **clientId **- идентификатор клиента.
3409 +
3410 +Ответ:
3411 +
3412 +{
3413 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3414 + "CalculationType": 0,
3415 + "PermissibleBalance": 0,
3416 + "DefermentDays": 0,
3417 + "SendUiNotifications": true,
3418 + "SendEmailNotifications": true,
3419 + "IsPrivate": true,
3420 +}
3421 +
3422 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3423 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3424 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3425 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3426 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3427 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3428 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3429 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3430 +
3431 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3432 +
3433 +(% class="box infomessage" %)
3434 +(((
3435 +**GET /api/v3/Billing/client/plan/{clientId}**
3436 +)))
3437 +
3438 +Параметры запроса:
3439 +
3440 +**clientId **- идентификатор клиента.
3441 +
3442 +**planId **- идентификатор тарифного плана.
3443 +
3444 +Ответ:
3445 +
3446 +{
3447 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3448 + "Plan": { **~/~/ Описание тарифного плана**
3449 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3450 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3451 + "Name": "string",
3452 + "IsArchived": true,
3453 + "Constraint": {
3454 + "CalculationType": 0,
3455 + "PermissibleBalance": 0,
3456 + "DefermentDays": 0
3457 + },
3458 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3459 + {
3460 + "Feature": "string",
3461 + "IsFactual": true,
3462 + "Limit": 0,
3463 + "Price": 0,
3464 + "PeriodValue": 0,
3465 + "PeriodType": 0
3466 + }
3467 + ]
3468 + },
3469 + "DebitDate": "2023-10-18T12:46:24.213Z",
3470 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3471 + {
3472 + "Feature": "string",
3473 + "IsEnabled": true,
3474 + "IsPrivate": true,
3475 + "IsFactual": true,
3476 + "Limit": 0,
3477 + "Price": 0,
3478 + "DebitDate": "2023-10-18T12:46:24.213Z",
3479 + "PeriodValue": 0,
3480 + "PeriodType": 0
3481 + }
3482 + ]
3483 +}
3484 +
3485 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3486 +|ClientId|Идентификатор клиента
3487 +|Id|Идентификатор тарифного плана
3488 +|OwnerId|Идентификатор клиента-владельца
3489 +|Name|Наименование тарифного плана
3490 +|IsArchived|Признак, определяющий архивный тарифный план
3491 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3492 +|PermissibleBalance|Допустимый баланс
3493 +|DefermentDays|Отсрочка, количество дней
3494 +|Feature|Код услуги
3495 +|IsEnabled|Признак, определяющий активирована ли услуга
3496 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3497 +|IsFactual|Признак, определяющий расчёт по факту
3498 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3499 +|Price|Цена за единицу.
3500 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3501 +|PeriodValue|Значение периода.
3502 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3503 +
3504 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3505 +
3506 +(% class="box infomessage" %)
3507 +(((
3508 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3509 +)))
3510 +
3511 +Параметр запроса: **clientId **- идентификатор клиента.
3512 +
3513 +Ответ:
3514 +
3515 +[
3516 + {
3517 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3518 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 + "Name": "string",
3520 + "IsArchived": true,
3521 + "Constraint": {
3522 + "CalculationType": 0,
3523 + "PermissibleBalance": 0,
3524 + "DefermentDays": 0
3525 + },
3526 + "Features": [
3527 + {
3528 + "Feature": "string",
3529 + "IsFactual": true,
3530 + "Limit": 0,
3531 + "Price": 0,
3532 + "PeriodValue": 0,
3533 + "PeriodType": 0
3534 + }
3535 + ]
3536 + }
3537 +]
3538 +
3539 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3540 +|ClientId|Идентификатор клиента
3541 +|Id|Идентификатор тарифного плана
3542 +|OwnerId|Идентификатор клиента-владельца
3543 +|Name|Наименование тарифного плана
3544 +|IsArchived|Признак, определяющий архивный тарифный план
3545 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3546 +|PermissibleBalance|Допустимый баланс
3547 +|DefermentDays|Отсрочка, количество дней
3548 +|Feature|Код услуги
3549 +|IsFactual|Признак, определяющий расчёт по факту
3550 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3551 +|Price|Цена за единицу.
3552 +|PeriodValue|Значение периода.
3553 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3554 +
3555 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3556 +
3557 +(% class="box infomessage" %)
3558 +(((
3559 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3560 +)))
3561 +
3562 +Параметр запроса: **clientId **- идентификатор клиента.
3563 +
3564 +Ответ:
3565 +
3566 +[
3567 + {
3568 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3569 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3570 + "Name": "string",
3571 + "IsArchived": true,
3572 + "Constraint": {
3573 + "CalculationType": 0,
3574 + "PermissibleBalance": 0,
3575 + "DefermentDays": 0
3576 + },
3577 + "Features": [
3578 + {
3579 + "Feature": "string",
3580 + "IsFactual": true,
3581 + "Limit": 0,
3582 + "Price": 0,
3583 + "PeriodValue": 0,
3584 + "PeriodType": 0
3585 + }
3586 + ]
3587 + }
3588 +]
3589 +
3590 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3591 +|ClientId|Идентификатор клиента
3592 +|Id|Идентификатор тарифного плана
3593 +|OwnerId|Идентификатор клиента-владельца
3594 +|Name|Наименование тарифного плана
3595 +|IsArchived|Признак, определяющий архивный тарифный план
3596 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3597 +|PermissibleBalance|Допустимый баланс
3598 +|DefermentDays|Отсрочка, количество дней
3599 +|Feature|Код услуги
3600 +|IsFactual|Признак, определяющий расчёт по факту
3601 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3602 +|Price|Цена за единицу.
3603 +|PeriodValue|Значение периода.
3604 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3605 +
3606 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3607 +
3608 +(% class="box warningmessage" %)
3609 +(((
3610 +**PUT /api/v3/Billing/client/balance**
3611 +)))
3612 +
3613 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3614 +
3615 +Тело запроса:
3616 +
3617 +{
3618 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3619 + "Balance": 0
3620 +}
3621 +
3622 +Ответ: Success
3623 +
3624 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3625 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3626 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3627 +
3628 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3629 +
3630 +(% class="box warningmessage" %)
3631 +(((
3632 +**PUT /api/v3/billing/client/balance/deposit**
3633 +)))
3634 +
3635 +Создает операцию **Пополнение **с указанной суммой
3636 +
3637 +Тело запроса:
3638 +
3639 +{
3640 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3641 + "Balance": 0
3642 +}
3643 +
3644 +Ответ: Success
3645 +
3646 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3647 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3648 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3649 +
3650 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3651 +
3652 +Создает операцию **Списание **с указанной суммой
3653 +
3654 +(% class="box warningmessage" %)
3655 +(((
3656 +**PUT /api/v3/billing/client/balance/withdraw**
3657 +)))
3658 +
3659 +Тело запроса:
3660 +
3661 +{
3662 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3663 + "Balance": 0
3664 +}
3665 +
3666 +Ответ: Success
3667 +
3668 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3669 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3670 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3671 +
3672 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3673 +
3674 +(% class="box warningmessage" %)
3675 +(((
3676 +**PUT /api/v3/Billing/client/constraint**
3677 +)))
3678 +
3679 +Тело запроса:
3680 +
3681 +{
3682 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3683 + "CalculationType": 0,
3684 + "PermissibleBalance": 0,
3685 + "DefermentDays": 0,
3686 + "SendUiNotifications": true,
3687 + "SendEmailNotifications": true,
3688 + "IsPrivate": true,
3689 +}
3690 +
3691 +Ответ: Success
3692 +
3693 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3694 +|ClientId|Идентификатор клиента
3695 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3696 +|PermissibleBalance|Допустимый баланс
3697 +|DefermentDays|(((
3698 +Отсрочка, количество дней
3699 +)))
3700 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3701 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3702 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3703 +
3704 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3705 +
3706 +(% class="box warningmessage" %)
3707 +(((
3708 +**PUT /api/v3/Billing/client/plan**
3709 +)))
3710 +
3711 +Тело запроса:
3712 +
3713 +{
3714 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3715 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3716 + "Features": [
3717 + {
3718 + "Feature": "string",
3719 + "IsEnabled": true,
3720 + "IsFactual": true,
3721 + "Limit": 0,
3722 + "Price": 0,
3723 + "DebitDate": "2023-10-18T13:26:58.987Z",
3724 + "PeriodValue": 0,
3725 + "PeriodType": 0
3726 + }
3727 + ]
3728 +}
3729 +
3730 +Ответ: Success
3731 +
3732 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3733 +|ClientId|Идентификатор клиента
3734 +|PlanId|Идентификатор тарифного плана
3735 +|Feature|Код услуги
3736 +|IsEnabled|Признак, определяющий активирована ли услуга
3737 +|IsFactual|Признак, определяющий расчёт по факту
3738 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3739 +|Price|Цена за единицу.
3740 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3741 +|PeriodValue|Значение периода.
3742 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3743 +
3744 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3745 +
3746 +(% class="box warningmessage" %)
3747 +(((
3748 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3749 +)))
3750 +
3751 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3752 +
3753 +(% class="box infomessage" %)
3754 +(((
3755 +**POST /api/v3/vehicles/import/{agentId}**
3756 +)))
3757 +
3758 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3759 +
3760 +В пути указывается **agentId** - id клиента.
3761 +
3762 +**Заголовок**
3763 +
3764 +**X-Auth: [токен авторизации]**
3765 +
3766 +**Параметры**
3767 +
3768 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3769 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3770 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3771 +
3772 +В теле использовать тип **form-data,** тип значения** file**
3773 +
3774 +**Ключи**
3775 +
3776 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3777 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3778 +|csv|В значении передаем файл датчиков, формат **csv**
3779 +
3780 +Ответ:
3781 +
3782 +{
3783 + "vehicleId": 0,
3784 + "name": "string",
3785 + "errors": ["string"]
3786 +}
3787 +
3788 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3789 +|vehicleId|ID созданного объекта
3790 +|name|Имя созданного объекта
3791 +|errors|Ошибки и их описание
3792 +
3793 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3794 +
3795 +(% class="box infomessage" %)
3796 +(((
3797 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3798 +)))
3799 +
3800 +(% class="wikigeneratedid" %)
3801 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3802 +
3803 +(% class="wikigeneratedid" %)
3804 +В пути указывается **vehicleId **- id объекта.
3805 +
3806 +**Заголовок**
3807 +
3808 +**X-Auth: [токен авторизации]**
3809 +
3810 +В теле использовать тип **form-data.**
3811 +
3812 +Ключи:
3813 +
3814 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3815 +|**history**|В значении передавать файл с историей
3816 +
3817 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3818 +
3819 +Ответ:
3820 +
3821 +{
3822 + "results": [
3823 + {
3824 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3825 + "vehicleId": 0,
3826 + "errors": [
3827 + "string"
3828 + ],
3829 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3830 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3831 + "producedCount": 0,
3832 + "msgCount": 0
3833 + }
3834 + ]
3835 +}
3836 +
3837 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3838 +|results|Результаты импорта в разрезе ТС
3839 +|vehicleGuid|Guid ТС
3840 +|vehicleId|ID ТС
3841 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3842 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3843 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3844 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3845 +|msgCount|Кол-во обработанных сообщений всего
3846 +
3847 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3848 +
3849 +(% class="box infomessage" %)
3850 +(((
3851 +**GET /api/v3/vehicles/import/history/status**
3852 +)))
3853 +
3854 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3855 +
3856 +Ответ:
3857 +
3858 +{
3859 + "activity": true,
3860 + "progress": 0,
3861 + "message": "string"
3862 +}
3863 +
3864 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3865 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3866 +|progress|Guid ТС
3867 +
3868 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3869 +
3870 +(% class="box infomessage" %)
3871 +(((
3872 +**POST /api/v3/vehicles/export**
3873 +)))
3874 +
3875 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3876 +
3877 +Тело запроса:
3878 +
3879 +[
3880 + id
3881 +]
3882 +
3883 +Ответ: Success 200, получаете файлы с настройками.
3884 +
3885 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3886 +
3887 +(% class="box infomessage" %)
3888 +(((
3889 +**POST /api/v3/vehicles/export/history**
3890 +)))
3891 +
3892 +Метод возвращает список сообщений терминала объекта за выбранный период.
3893 +
3894 +Тело запроса:
3895 +
3896 +{
3897 + "vehicleId": 0,
3898 + "asArchive": true,
3899 + "from": "2023-09-27T12:17:45.973Z",
3900 + "to": "2023-09-27T12:17:45.973Z"
3901 +}
3902 +
3903 +Ответ:
3904 +
3905 +Получаете файл. Сообщение: Code 200/Success
3906 +
3907 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3908 +|vehicleId|ID объекта
3909 +|asArchive|true - Архивировать файл, False - не архивировать
3910 +|from|Дата и время начала запроса
3911 +|to|Дата и время окончания запроса
3912 +
3913 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3914 +
3915 +(% class="box infomessage" %)
3916 +(((
3917 +**GET /api/v3/vehicles/export/history/status**
3918 +)))
3919 +
3920 +Метод возвращает список сообщений терминала объекта за выбранный период.
3921 +
3922 +Ответ:
3923 +
3924 +{
3925 + "activity": true,
3926 + "progress": 0,
3927 + "message": "string"
3928 +}
3929 +
3930 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3931 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3932 +|progress|Прогресс экспорта, от 0 до 100%
3933 +|message|Текст описывающий статус
3934 +
3935 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3936 +
3937 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3938 +
3939 +(% class="box infomessage" %)
3940 +(((
3941 +**POST /api/v3/EcoDriving/rating**
3942 +)))
3943 +
3944 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3945 +
3946 +Тело запроса:
3947 +
3948 +{
3949 + "vehicleIds": [vehicleId],
3950 + "from": "2023-11-22T09:29:48.051Z",
3951 + "to": "2023-11-22T09:29:48.051Z"
3952 +}
3953 +
3954 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3955 +|vehicleIds|Массив ID объектов
3956 +|from|Дата начала запроса
3957 +|to|Дата окончания запроса
3958 +
3959 +Ответ:
3960 +
3961 +{
3962 + "items": [
3963 + {
3964 + "from": "2023-11-22T09:29:48.052Z",
3965 + "to": "2023-11-22T09:29:48.052Z",
3966 + "vehicleId": 0,
3967 + "vehicleName": "string",
3968 + "vehicleModel": "string",
3969 + "penalty": 0,
3970 + "score": 0,
3971 + "totalViolations": 0,
3972 + "violationsByType": {
3973 + "overspeedingViolations": 0,
3974 + "accelerationViolations": 0,
3975 + "brakingViolations": 0,
3976 + "turningViolations": 0,
3977 + "dangerousDrivingViolations": 0,
3978 + "sensorViolations": 0
3979 + },
3980 + "moveTime": 0,
3981 + "mileage": 0,
3982 + "tripsCount": 0,
3983 + "trips": [
3984 + {
3985 + "penalty": 0,
3986 + "score": 0,
3987 + "violationsCount": 0,
3988 + "violationsByType": {
3989 + "overspeedingViolations": 0,
3990 + "accelerationViolations": 0,
3991 + "brakingViolations": 0,
3992 + "turningViolations": 0,
3993 + "dangerousDrivingViolations": 0,
3994 + "sensorViolations": 0
3995 + },
3996 + "moveTime": 0,
3997 + "mileage": 0,
3998 + "motohours": 0,
3999 + "maxSpeed": 0,
4000 + "startAddress": "string",
4001 + "endAddress": "string",
4002 + "drivers": [
4003 + {
4004 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4005 + "driverName": "string",
4006 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4007 + }
4008 + ]
4009 + }
4010 + ]
4011 + }
4012 + ]
4013 +}
4014 +
4015 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4016 +|from|Дата начала запроса
4017 +|to|Дата  окончания
4018 +|vehicleId|ID объекта
4019 +|vehicleName|Имя объекта
4020 +|vehicleModel|Модель объекта
4021 +|penalty|Сумма штрафных баллов
4022 +|score|Оценка
4023 +|totalViolations|Суммарное количество нарушений
4024 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4025 +|overspeedingViolations|Превышение скорости
4026 +|accelerationViolations|Ускорение
4027 +|brakingViolations|Торможение
4028 +|turningViolations|Резкий поворот
4029 +|dangerousDrivingViolations|Резкое вождение
4030 +|sensorViolations|Нарушение по датчику
4031 +|moveTime|Время в движении
4032 +|mileage|Пробег
4033 +|tripsCount|Количество рейсов
4034 +|motohours|Моточасы
4035 +|maxSpeed|Максимальная скорость
4036 +|startAddress|Адрес начала рейса
4037 +|endAddress|Адрес окончания рейса
4038 +|drivers|Список водителей, которые были на объекте в течениии рейса
4039 +|driverGuid|Guid водителя
4040 +|driverName|Имя водителя
4041 +|driverRfid|Номер Карты-метки
4042 +
2836 2836  (% class="box" lang="en-US" style="text-align: center;" %)
2837 2837  (((
2838 2838  (% 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 г.