Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 92.1 >
edited by Илья Крайнов
on 2023/05/22 15:40
To version < 136.1 >
edited by Андрей Калиновский
on 2024/02/27 18:05
>
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" %)**Получение информации об объекте**(%%) ==
... ... @@ -788,25 +788,25 @@
788 788   "sensors": [ ~/~/ Датчики
789 789   {
790 790   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
791 - "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный
1103 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
792 792   "type": 0, ~/~/ Тип датчика
793 793   "name": "string", ~/~/ Имя датчика
794 - "inputType": 0, ~/~/ Тип входа
1106 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
795 795   "inputNumber": 0, ~/~/ Номер входа
796 796   "pseudonym": "string", ~/~/ Псевдоним
797 797   "medianDegree": 0, ~/~/ Медианная фильтрация
798 798   "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 799   "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 - "gradeType": 0, ~/~/ Тип тарировки
801 - "gradesTables": [ ~/~/ Тип тарировки Таблица
1112 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1113 + "gradesTables": [ ~/~/ Массив таблиц тарировки
802 802   {
803 - "grades": [ ~/~/ Тарировка
1115 + "grades": [ ~/~/ Таблица тарировки 1
804 804   {
805 805   "input": 0, ~/~/ Входящее значение
806 806   "output": 0 ~/~/ Выходящее значение
807 807   }
808 808   ],
809 - "relevanceTime": "2023-05-22T09:57:39.562Z"
1121 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
810 810   }
811 811   ],
812 812   "showInTooltip": true, ~/~/ Отображать в подсказке
... ... @@ -813,25 +813,49 @@
813 813   "showLastValid": true, ~/~/ Отображать последнее валидное значение
814 814   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
815 815   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
816 - "agrFunction": 0,
817 - "expr": "string",
818 - "children": [
1128 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1129 + "expr": "string", ~/~/ Формула
1130 + "children": [ ~/~/ массив дочерних датчиков
819 819   "string"
820 820   ],
821 - "customParams": {
1133 + "customParams": { ~/~/ прочие произвольные параметры
822 822   "additionalProp1": "string",
823 823   "additionalProp2": "string",
824 824   "additionalProp3": "string"
825 825   },
826 - "summaryMaxValue": 0
1138 +
1139 +~/~/ Характерные для произвольного:
1140 +
1141 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1142 +
1143 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1144 +
1145 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1146 +
1147 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148 +
1149 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1150 +
1151 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1152 +
1153 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1154 +
1155 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1156 +
1157 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1158 +
1159 +~/~/ "ValueOn": "Вкл.",
1160 +
1161 +~/~/ "ValueOff": "Выкл."
1162 + "summaryMaxValue": 0 ~/~/ Макс. значение
827 827   }
828 828  
829 829   "drivers": [ ~/~/ Водители
830 830   {
831 831   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 - "name": "string",
1168 + "name": "string", ~/~/ Наименование
833 833   "description": "string",
834 - "isDefault": true
1170 + "isDefault": true ~/~/ По умолчанию
835 835   }
836 836   ],
837 837  
... ... @@ -957,45 +957,70 @@
957 957   "retries": 0
958 958   }
959 959   ],
960 - "sensors": [ ~/~/ Датчики
1296 +
1297 + "sensors": [ ~/~/ Датчики
961 961   {
962 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
963 - "kind": 0,
964 - "type": 0,
965 - "name": "string",
966 - "inputType": 0,
967 - "inputNumber": 0,
968 - "pseudonym": "string",
969 - "medianDegree": 0,
970 - "isInverted": true,
971 - "disabled": true,
972 - "gradeType": 0,
973 - "gradesTables": [
1299 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1300 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1301 + "type": 0, ~/~/ Тип датчика
1302 + "name": "string", ~/~/ Имя датчика
1303 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1304 + "inputNumber": 0, ~/~/ Номер входа
1305 + "pseudonym": "string", ~/~/ Псевдоним
1306 + "medianDegree": 0, ~/~/ Медианная фильтрация
1307 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1308 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1309 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1310 + "gradesTables": [ ~/~/ Массив таблиц тарировки
974 974   {
975 - "grades": [
1312 + "grades": [ ~/~/ Таблица тарировки 1
976 976   {
977 - "input": 0,
978 - "output": 0
1314 + "input": 0, ~/~/ Входящее значение
1315 + "output": 0 ~/~/ Выходящее значение
979 979   }
980 980   ],
981 - "relevanceTime": "2023-05-22T12:19:59.728Z"
1318 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
982 982   }
983 983   ],
984 - "showInTooltip": true,
985 - "showLastValid": true,
986 - "showAsDutOnGraph": true,
987 - "showWithoutIgn": true,
988 - "agrFunction": 0,
989 - "expr": "string",
990 - "children": [
1321 + "showInTooltip": true, ~/~/ Отображать в подсказке
1322 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1323 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1324 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1325 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1326 + "expr": "string", ~/~/ Формула
1327 + "children": [ ~/~/ массив дочерних датчиков
991 991   "string"
992 992   ],
993 - "customParams": {
1330 + "customParams": { ~/~/ прочие произвольные параметры
994 994   "additionalProp1": "string",
995 995   "additionalProp2": "string",
996 996   "additionalProp3": "string"
997 997   },
998 - "summaryMaxValue": 0
1335 +
1336 +~/~/ Характерные для произвольного:
1337 +
1338 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1339 +
1340 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1341 +
1342 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1343 +
1344 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1345 +
1346 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1347 +
1348 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1349 +
1350 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1351 +
1352 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1353 +
1354 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1355 +
1356 +~/~/ "ValueOn": "Вкл.",
1357 +
1358 +~/~/ "ValueOff": "Выкл."
1359 + "summaryMaxValue": 0 ~/~/ Макс. значение
999 999   }
1000 1000   ],
1001 1001   "customFields": [ ~/~/ Произвольные поля
... ... @@ -1206,7 +1206,7 @@
1206 1206  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1207 1207  
1208 1208  (% style="color:#000000" %){
1209 -
1570 + "vehicleId": , ~/~/ ID объекта
1210 1210   "parentId": "" , ~/~/ ID клиента
1211 1211   "name": "" , ~/~/ имя ТС
1212 1212   "imei": "" , ~/~/ IMEI
... ... @@ -1275,45 +1275,70 @@
1275 1275   "retries": 0
1276 1276   }
1277 1277   ],
1278 - "sensors": [ ~/~/ Датчики
1639 +
1640 + "sensors": [ ~/~/ Датчики
1279 1279   {
1280 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1281 - "kind": 0,
1282 - "type": 0,
1283 - "name": "string",
1284 - "inputType": 0,
1285 - "inputNumber": 0,
1286 - "pseudonym": "string",
1287 - "medianDegree": 0,
1288 - "isInverted": true,
1289 - "disabled": true,
1290 - "gradeType": 0,
1291 - "gradesTables": [
1642 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1643 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1644 + "type": 0, ~/~/ Тип датчика
1645 + "name": "string", ~/~/ Имя датчика
1646 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1647 + "inputNumber": 0, ~/~/ Номер входа
1648 + "pseudonym": "string", ~/~/ Псевдоним
1649 + "medianDegree": 0, ~/~/ Медианная фильтрация
1650 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1651 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1652 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1653 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1292 1292   {
1293 - "grades": [
1655 + "grades": [ ~/~/ Таблица тарировки 1
1294 1294   {
1295 - "input": 0,
1296 - "output": 0
1657 + "input": 0, ~/~/ Входящее значение
1658 + "output": 0 ~/~/ Выходящее значение
1297 1297   }
1298 1298   ],
1299 - "relevanceTime": "2023-05-22T12:19:59.728Z"
1661 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1300 1300   }
1301 1301   ],
1302 - "showInTooltip": true,
1303 - "showLastValid": true,
1304 - "showAsDutOnGraph": true,
1305 - "showWithoutIgn": true,
1306 - "agrFunction": 0,
1307 - "expr": "string",
1308 - "children": [
1664 + "showInTooltip": true, ~/~/ Отображать в подсказке
1665 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1666 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1667 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1668 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1669 + "expr": "string", ~/~/ Формула
1670 + "children": [ ~/~/ массив дочерних датчиков
1309 1309   "string"
1310 1310   ],
1311 - "customParams": {
1673 + "customParams": { ~/~/ прочие произвольные параметры
1312 1312   "additionalProp1": "string",
1313 1313   "additionalProp2": "string",
1314 1314   "additionalProp3": "string"
1315 1315   },
1316 - "summaryMaxValue": 0
1678 +
1679 +~/~/ Характерные для произвольного:
1680 +
1681 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1682 +
1683 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1684 +
1685 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1686 +
1687 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1688 +
1689 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1690 +
1691 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1692 +
1693 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1694 +
1695 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1696 +
1697 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1698 +
1699 +~/~/ "ValueOn": "Вкл.",
1700 +
1701 +~/~/ "ValueOff": "Выкл."
1702 + "summaryMaxValue": 0 ~/~/ Макс. значение
1317 1317   }
1318 1318   ],
1319 1319   "customFields": [ ~/~/ Произвольные поля
... ... @@ -1416,7 +1416,7 @@
1416 1416  
1417 1417  (% style="color:#000000" %)Метод запроса: **GET**
1418 1418  
1419 -(% 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]]
1420 1420  
1421 1421  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1422 1422  
... ... @@ -1499,6 +1499,51 @@
1499 1499   }
1500 1500  ]
1501 1501  
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 +
1502 1502  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1503 1503  
1504 1504  (% class="box infomessage" %)
... ... @@ -1523,6 +1523,11 @@
1523 1523   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1524 1524  }
1525 1525  
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 +
1526 1526  Ответ:
1527 1527  
1528 1528  [
... ... @@ -1529,25 +1529,444 @@
1529 1529   {
1530 1530   "messages": [
1531 1531   {
1532 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1533 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1534 - "speed": 0, ~/~/ Скорость, км/ч
1535 - "altitude": 0, ~/~/ Высота, м
1536 - "latitude": 0, ~/~/ Широта [-90°;90°]
1537 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1538 - "satellites": 0, ~/~/ Кол-во спутников
1539 - "voltage": 0, ~/~/ Напряжение
1540 - "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": {
1541 1541   "additionalProp1": "string",
1542 1542   "additionalProp2": "string",
1543 1543   "additionalProp3": "string"
1544 1544   },
1545 - "photoCount": 0 ~/~/ Кол-во фото
1982 + "photoCount": 0,
1983 + "lbsCorrectedCoords": true,
1984 + "protocolType": 0
1546 1546   }
1547 1547   ]
1548 1548   }
1549 1549  ]
1550 1550  
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 типа протокола
2004 +
2005 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 +
2007 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2008 +
2009 +(% class="box infomessage" %)
2010 +(((
2011 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2012 +)))
2013 +
2014 +(% style="color:#000000" %)Метод запроса: **POST**
2015 +
2016 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2017 +
2018 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2019 +
2020 +(% style="text-align:left" %)
2021 +Тело запроса:
2022 +
2023 +{
2024 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2025 + "vehicleIds": [0], ~/~/ Список ID объектов
2026 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2027 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2028 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2029 +}
2030 +
2031 +Ответ:
2032 +
2033 +[
2034 + {
2035 + "vehicleId": 0, ~/~/ ID объекта
2036 + "name": "string", ~/~/ Имя ТС
2037 + "periods": [ ~/~/ Периоды
2038 + {
2039 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2040 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2041 + "mileageBegin": 0, ~/~/ Пробег на начало периода
2042 + "mileageEnd": 0, ~/~/ Пробег на окончание периода
2043 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода
2044 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2045 + }
2046 + ]
2047 + }
2048 +]
2049 +
2050 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2051 +
2052 +(% class="box infomessage" %)
2053 +(((
2054 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2055 +)))
2056 +
2057 +(% style="color:#000000" %)Метод запроса: **POST**
2058 +
2059 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2060 +
2061 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2062 +
2063 +(% style="text-align:left" %)
2064 +Тело запроса:
2065 +
2066 +{
2067 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2068 + "vehicleIds": [0], ~/~/ Список ID объектов
2069 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2070 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2071 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2072 +}
2073 +
2074 +Ответ:
2075 +
2076 +[
2077 + {
2078 + "vehicleId": 0, ~/~/ ID объекта
2079 + "name": "string", ~/~/ Имя ТС
2080 + "periods": [ ~/~/ Периоды
2081 + {
2082 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2083 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2084 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2085 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2086 + "fuelConsumption": 0, ~/~/ Расход топлива
2087 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2088 + }
2089 + ]
2090 + }
2091 +]
2092 +
2093 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2094 +
2095 +(% class="box infomessage" %)
2096 +(((
2097 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2098 +)))
2099 +
2100 +(% style="color:#000000" %)Метод запроса: **POST**
2101 +
2102 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2103 +
2104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2105 +
2106 +(% style="text-align:left" %)
2107 +Тело запроса:
2108 +
2109 +{
2110 + "vehicleIds": [0], ~/~/ Список ID объектов
2111 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2112 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2113 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2114 +}
2115 +
2116 +Ответ:
2117 +
2118 +[
2119 + {
2120 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2121 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2122 + "vehicleId": 0, ~/~/ ID объекта
2123 + "name": "string", ~/~/ Имя объекта
2124 + "model": "string", ~/~/ Модель объекта
2125 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2126 + {
2127 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2128 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2129 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2130 + "valueFuel": 0, ~/~/ Количество
2131 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2132 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2133 + }
2134 + ]
2135 + }
2136 +]
2137 +
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 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2245 +
2246 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2247 +
2248 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2249 +
2250 +}
2251 +
2252 +
2253 +Ответ:
2254 +
2255 +[
2256 + {
2257 + "vehicleId": 0, ~/~/Идентификатор объекта.
2258 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2259 + "vehicleNumber": "string",~/~/Номер объекта.
2260 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2261 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на траспортном средстве.
2262 + "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных.
2263 + "speed": 0,~/~/Скорость объекта.
2264 + "course": 0,~/~/Курс движения [0;360]
2265 + "latitude": 0,~/~/Широта [-90°;90°].
2266 + "longitude": 0,~/~/Долгота [-180°;180°].
2267 + "address": "string",~/~/Адрес.
2268 + "geozones": [ ~/~/Сведения по геозонам.
2269 + {
2270 + "id": 0,
2271 + "name": "string"
2272 + }
2273 + ]
2274 + }
2275 +]
2276 +
2277 +
2278 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2279 +
2280 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2281 +
2282 +(% class="box infomessage" %)
2283 +(((
2284 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2285 +)))
2286 +
2287 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2288 +
2289 +(% style="color:#000000" %)Метод запроса: **POST**
2290 +
2291 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2292 +
2293 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2294 +
2295 +(% style="text-align:left" %)
2296 +Тело запроса:
2297 +
2298 +(% style="text-align:left" %)
2299 +{
2300 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2301 +}
2302 +
2303 +(% style="text-align:left" %)
2304 +Ответ:
2305 +
2306 +[
2307 + {
2308 + "id": 0, ~/~/ Идентификатор объекта геозоны
2309 + "name": "string", ~/~/ Название объекта геозоны
2310 + "type": 0, ~/~/ Тип объекта геозоны
2311 + "fname": "string", ~/~/ Имя файла
2312 + "parentId": "string", ~/~/ Идентификатор клиента
2313 + "radius": 0, ~/~/ Радиус геообъекта
2314 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2315 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2316 + "description": "string", ~/~/ Описание
2317 + "area": 0, ~/~/ Площадь, м^^2^^
2318 + "perimetr": 0, ~/~/ Периметр, м
2319 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2320 + }
2321 +]
2322 +
2323 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2324 +
2325 +(% class="box infomessage" %)
2326 +(((
2327 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2328 +)))
2329 +
2330 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2331 +
2332 +(% style="color:#000000" %)Метод запроса: **POST**
2333 +
2334 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2335 +
2336 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2337 +
2338 +(% style="text-align:left" %)
2339 +Тело запроса:
2340 +
2341 +{
2342 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2343 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2344 + "ids": [ ], ~/~/ Массив id объектов
2345 + "byTime": 0, ~/~/ Объединение событий по времени 
2346 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2347 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2348 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2349 +}
2350 +
2351 +Ответ:
2352 +[
2353 + {
2354 + "geozoneId": 0, ~/~/ ID геообъекта
2355 + "geozoneName": "string", ~/~/ Название геообъекта
2356 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2357 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2358 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2359 + "vehicleId": 0, ~/~/ ID объекта
2360 + "vehicleName": "string" ~/~/ Имя объекта
2361 + }
2362 +]
2363 +
2364 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2365 +
2366 +(% class="box infomessage" %)
2367 +(((
2368 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2369 +)))
2370 +
2371 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2372 +
2373 +(% style="color:#000000" %)Метод запроса: **POST**
2374 +
2375 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2376 +
2377 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2378 +
2379 +(% style="text-align:left" %)
2380 +Тело запроса:
2381 +
2382 +{
2383 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2384 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2385 + "ids": [ ], ~/~/ Массив id геообъектов
2386 + "byTime": 0, ~/~/ Объединение событий по времени 
2387 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2388 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2389 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2390 +}
2391 +
2392 +Ответ:
2393 +
2394 +[
2395 + {
2396 + "geozoneId": 0, ~/~/ ID геообъекта
2397 + "geozoneName": "string", ~/~/ Название геообъекта
2398 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2399 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2400 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2401 + "vehicleId": 0, ~/~/ ID объекта
2402 + "vehicleName": "string" ~/~/ Имя объекта
2403 + }
2404 +]
2405 +
1551 1551  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1552 1552  
1553 1553  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -1748,6 +1748,1460 @@
1748 1748  
1749 1749  Success
1750 1750  
2606 +
2607 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2608 +
2609 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2610 +
2611 +(% class="box infomessage" %)
2612 +(((
2613 +**POST /api/v3/Drivers/find**
2614 +)))
2615 +
2616 +Передается параметр: parentId - ID клиента-родителя
2617 +
2618 +Ответ:
2619 +
2620 +[
2621 + {
2622 + "name": "string", ~/~/ Определяет наименование
2623 + "description": "string", ~/~/ Определяет описание
2624 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2625 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2626 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2627 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2628 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2629 + "deleted": true ~/~/ Признак удаления
2630 + }
2631 +]
2632 +
2633 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2634 +
2635 +(% class="box infomessage" %)
2636 +(((
2637 +**GET /api/v3/Drivers/{driverGuid}**
2638 +)))
2639 +
2640 +Передается параметр: ID водителя
2641 +
2642 +Ответ:
2643 +
2644 +{
2645 + "name": "string", ~/~/ Определяет наименование
2646 + "description": "string", ~/~/ Определяет описание
2647 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2648 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2649 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2650 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2651 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2652 + "deleted": true ~/~/ Признак удаления
2653 +}
2654 +
2655 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2656 +
2657 +(% class="box successmessage" %)
2658 +(((
2659 +**POST /api/v3/Drivers**
2660 +)))
2661 +
2662 +Запрос:
2663 +
2664 +{
2665 + "name": "string",
2666 + "description": "string",
2667 + "hiredate": "2023-06-30T12:50:54.020Z",
2668 + "chopdate": "2023-06-30T12:50:54.020Z",
2669 + "exclusive": true,
2670 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2671 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2672 + "deleted": true
2673 +}
2674 +
2675 +Ответ:
2676 +
2677 +{
2678 + "name": "string",
2679 + "description": "string",
2680 + "hiredate": "2023-06-30T12:50:54.051Z",
2681 + "chopdate": "2023-06-30T12:50:54.051Z",
2682 + "exclusive": true,
2683 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2684 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2685 + "deleted": true
2686 +}
2687 +
2688 +
2689 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2690 +
2691 +(% class="box warningmessage" %)
2692 +(((
2693 +**PUT /api/v3/Drivers**
2694 +)))
2695 +
2696 +Запрос:
2697 +
2698 +{
2699 + "name": "string",
2700 + "description": "string",
2701 + "hiredate": "2023-06-30T12:50:27.910Z",
2702 + "chopdate": "2023-06-30T12:50:27.910Z",
2703 + "exclusive": true,
2704 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2705 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2706 + "deleted": true
2707 +}
2708 +
2709 +Ответ:
2710 +
2711 +{
2712 + "name": "string",
2713 + "description": "string",
2714 + "hiredate": "2023-06-30T12:50:27.929Z",
2715 + "chopdate": "2023-06-30T12:50:27.929Z",
2716 + "exclusive": true,
2717 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2718 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2719 + "deleted": true
2720 +}
2721 +
2722 +
2723 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2724 +
2725 +(% class="box errormessage" %)
2726 +(((
2727 +**DELETE /api/v3/Drivers/{driverGuid}**
2728 +)))
2729 +
2730 +Передается параметр: ID водителя
2731 +
2732 +Ответ:
2733 +
2734 +Success
2735 +
2736 +
2737 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2738 +
2739 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2740 +
2741 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2742 +
2743 +(% class="box infomessage" %)
2744 +(((
2745 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2746 +)))
2747 +
2748 +Запрос:
2749 +
2750 +{
2751 + "Ids": [
2752 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2753 + ],
2754 + "BeginTime": "2023-06-30T12:49:04.365Z",
2755 + "EndTime": "2023-06-30T12:49:04.365Z"
2756 +}
2757 +
2758 +Ответ:
2759 +
2760 +[
2761 + {
2762 + "VehicleId": 0,
2763 + "CreateTime": "2023-06-30T09:52:31.240Z",
2764 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2765 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2766 + "BeginTime": "2023-06-30T09:52:31.240Z",
2767 + "EndTime": "2023-06-30T09:52:31.240Z"
2768 + }
2769 +]
2770 +
2771 +
2772 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2773 +
2774 +(% class="box infomessage" %)
2775 +(((
2776 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2777 +)))
2778 +
2779 +Запрос:
2780 +
2781 +{
2782 + "Ids": [
2783 + 0
2784 + ],
2785 + "BeginTime": "2023-06-30T12:48:39.419Z",
2786 + "EndTime": "2023-06-30T12:48:39.419Z"
2787 +}
2788 +
2789 +Ответ:
2790 +
2791 +[
2792 + {
2793 + "VehicleId": 0,
2794 + "CreateTime": "2023-06-30T09:54:01.631Z",
2795 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2796 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2797 + "BeginTime": "2023-06-30T09:54:01.631Z",
2798 + "EndTime": "2023-06-30T09:54:01.631Z"
2799 + }
2800 +]
2801 +
2802 +
2803 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2804 +
2805 +(% class="box successmessage" %)
2806 +(((
2807 +**POST /api/v3/DriversVehiclesAssignments**
2808 +)))
2809 +
2810 +Передается массив назначений
2811 +
2812 +Запрос:
2813 +
2814 +[
2815 + {
2816 + "VehicleId": 0, ~/~/ Идентификатор объекта
2817 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2818 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2819 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2820 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2821 + }
2822 +]
2823 +
2824 +Ответ:
2825 +
2826 +[
2827 + {
2828 + "VehicleId": 0,
2829 + "CreateTime": "2023-06-30T11:04:46.903Z",
2830 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2831 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2832 + "BeginTime": "2023-06-30T11:04:46.903Z",
2833 + "EndTime": "2023-06-30T11:04:46.903Z"
2834 + }
2835 +]
2836 +
2837 +
2838 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2839 +
2840 +(% class="box warningmessage" %)
2841 +(((
2842 +**PUT /api/v3/DriversVehiclesAssignments**
2843 +)))
2844 +
2845 +Запрос:
2846 +
2847 +[
2848 + {
2849 + "VehicleId": 0,
2850 + "CreateTime": "2023-06-30T11:14:08.117Z",
2851 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2852 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2853 + "BeginTime": "2023-06-30T11:14:08.117Z",
2854 + "EndTime": "2023-06-30T11:14:08.117Z"
2855 + }
2856 +]
2857 +
2858 +Ответ:
2859 +
2860 +[
2861 + {
2862 + "VehicleId": 0,
2863 + "CreateTime": "2023-06-30T11:14:53.349Z",
2864 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2865 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2866 + "BeginTime": "2023-06-30T11:14:53.349Z",
2867 + "EndTime": "2023-06-30T11:14:53.349Z"
2868 + }
2869 +]
2870 +
2871 +
2872 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2873 +
2874 +(% class="box errormessage" %)
2875 +(((
2876 +**DELETE /api/v3/DriversVehiclesAssignments**
2877 +)))
2878 +
2879 +Запрос:
2880 +
2881 +[
2882 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2883 +]
2884 +
2885 +Ответ:
2886 +
2887 +Success
2888 +
2889 +
2890 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2891 +
2892 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2893 +
2894 +(% class="box infomessage" %)
2895 +(((
2896 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2897 +)))
2898 +
2899 +Запрос:
2900 +
2901 +{
2902 + "Ids": [
2903 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2904 + ],
2905 + "BeginTime": "2023-06-30T12:47:12.162Z",
2906 + "EndTime": "2023-06-30T12:47:12.162Z"
2907 +}
2908 +
2909 +Ответ:
2910 +
2911 +[
2912 + {
2913 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2914 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2915 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2916 + "BeginTime": "2023-06-30T11:19:40.703Z",
2917 + "EndTime": "2023-06-30T11:19:40.703Z"
2918 + }
2919 +]
2920 +
2921 +
2922 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2923 +
2924 +(% class="box infomessage" %)
2925 +(((
2926 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2927 +)))
2928 +
2929 +Запрос:
2930 +
2931 +{
2932 + "Ids": [
2933 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2934 + ],
2935 + "BeginTime": "2023-06-30T12:47:12.162Z",
2936 + "EndTime": "2023-06-30T12:47:12.162Z"
2937 +}
2938 +
2939 +Ответ:
2940 +
2941 +[
2942 + {
2943 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2944 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2945 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2946 + "BeginTime": "2023-06-30T11:19:40.703Z",
2947 + "EndTime": "2023-06-30T11:19:40.703Z"
2948 + }
2949 +]
2950 +
2951 +
2952 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2953 +
2954 +(% class="box successmessage" %)
2955 +(((
2956 +**POST /api/v3/DriversRfidsAssignments**
2957 +)))
2958 +
2959 +Запрос:
2960 +
2961 +[
2962 + {
2963 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2964 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2965 + "BeginTime": "2023-06-30T11:27:08.635Z",
2966 + "EndTime": "2023-06-30T11:27:08.635Z"
2967 + }
2968 +]
2969 +
2970 +Ответ:
2971 +
2972 +[
2973 + {
2974 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2975 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2977 + "BeginTime": "2023-06-30T11:27:08.677Z",
2978 + "EndTime": "2023-06-30T11:27:08.677Z"
2979 + }
2980 +]
2981 +
2982 +
2983 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2984 +
2985 +(% class="box warningmessage" %)
2986 +(((
2987 +**PUT /api/v3/DriversRfidsAssignments**
2988 +)))
2989 +
2990 +Запрос:
2991 +
2992 +[
2993 + {
2994 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2996 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2997 + "BeginTime": "2023-06-30T11:28:43.330Z",
2998 + "EndTime": "2023-06-30T11:28:43.330Z"
2999 + }
3000 +]
3001 +
3002 +Ответ:
3003 +
3004 +[
3005 + {
3006 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3007 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3008 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3009 + "BeginTime": "2023-06-30T11:28:43.331Z",
3010 + "EndTime": "2023-06-30T11:28:43.331Z"
3011 + }
3012 +]
3013 +
3014 +
3015 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3016 +
3017 +(% class="box errormessage" %)
3018 +(((
3019 +**DELETE /api/v3/DriversRfidsAssignments**
3020 +)))
3021 +
3022 +Запрос:
3023 +
3024 +[
3025 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3026 +]
3027 +
3028 +Ответ:
3029 +
3030 +Success
3031 +
3032 +
3033 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3034 +
3035 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3036 +
3037 +(% class="box infomessage" %)
3038 +(((
3039 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3040 +)))
3041 +
3042 +Запрос:
3043 +
3044 +{
3045 + "Ids": [
3046 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3047 + ],
3048 + "BeginTime": "2023-06-30T12:45:10.852Z",
3049 + "EndTime": "2023-06-30T12:45:10.852Z"
3050 +}
3051 +
3052 +Ответ:
3053 +
3054 +[
3055 + {
3056 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3057 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3058 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3059 + "BeginTime": "2023-06-30T11:58:04.695Z",
3060 + "EndTime": "2023-06-30T11:58:04.695Z"
3061 + }
3062 +]
3063 +
3064 +
3065 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3066 +
3067 +(% class="box infomessage" %)
3068 +(((
3069 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3070 +)))
3071 +
3072 +Запрос:
3073 +
3074 +{
3075 + "Ids": [
3076 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3077 + ],
3078 + "BeginTime": "2023-06-30T12:45:10.852Z",
3079 + "EndTime": "2023-06-30T12:45:10.852Z"
3080 +}
3081 +
3082 +Ответ:
3083 +
3084 +[
3085 + {
3086 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3087 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3088 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3089 + "BeginTime": "2023-06-30T11:58:04.695Z",
3090 + "EndTime": "2023-06-30T11:58:04.695Z"
3091 + }
3092 +]
3093 +
3094 +
3095 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3096 +
3097 +(% class="box successmessage" %)
3098 +(((
3099 +**POST /api/v3/DriversFuelCardsAssignments**
3100 +)))
3101 +
3102 +Запрос:
3103 +
3104 +[
3105 + {
3106 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3107 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3108 + "BeginTime": "2023-06-30T12:09:53.175Z",
3109 + "EndTime": "2023-06-30T12:09:53.175Z"
3110 + }
3111 +]
3112 +
3113 +Ответ:
3114 +
3115 +[
3116 + {
3117 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3118 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3119 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3120 + "BeginTime": "2023-06-30T12:09:53.201Z",
3121 + "EndTime": "2023-06-30T12:09:53.201Z"
3122 + }
3123 +]
3124 +
3125 +
3126 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3127 +
3128 +(% class="box warningmessage" %)
3129 +(((
3130 +**PUT /api/v3/DriversFuelCardsAssignments**
3131 +)))
3132 +
3133 +Запрос:
3134 +
3135 +[
3136 + {
3137 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3138 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3139 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3140 + "BeginTime": "2023-06-30T12:09:53.201Z",
3141 + "EndTime": "2023-06-30T12:09:53.201Z"
3142 + }
3143 +]
3144 +
3145 +Ответ:
3146 +
3147 +[
3148 + {
3149 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3150 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3152 + "BeginTime": "2023-06-30T12:09:53.201Z",
3153 + "EndTime": "2023-06-30T12:09:53.201Z"
3154 + }
3155 +]
3156 +
3157 +
3158 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3159 +
3160 +(% class="box errormessage" %)
3161 +(((
3162 +**DELETE /api/v3/DriversFuelCardsAssignments**
3163 +)))
3164 +
3165 +Запрос:
3166 +
3167 +[
3168 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3169 +]
3170 +
3171 +Ответ:
3172 +
3173 +Success
3174 +
3175 +
3176 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3177 +
3178 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3179 +
3180 +(% class="box infomessage" %)
3181 +(((
3182 +**POST /api/v3/Trailers**
3183 +)))
3184 +
3185 +Пример запроса:
3186 +
3187 +{
3188 + "startDate": "2023-11-14T10:48:03.671Z",
3189 + "endDate": "2023-11-14T10:48:03.671Z",
3190 + "ids": [ 0 ],
3191 + "timezone": 0
3192 +}
3193 +
3194 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3195 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3196 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3197 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3198 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3199 +
3200 +Пример ответа:
3201 +
3202 +[
3203 + {
3204 + "SD": "2023-11-14T10:48:03.717Z",
3205 + "ED": "2023-11-14T10:48:03.717Z", 
3206 + "id": 0,
3207 + "SLat": 0,
3208 + "SLon": 0,
3209 + "ELat": 0,
3210 + "ELon": 0,
3211 + "mileage": 0
3212 + "Duration": 0
3213 + "Address": "string",
3214 + "Address2": "string",
3215 + "name": "string",
3216 + "rid": "string",
3217 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3218 + "trailer": {
3219 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3220 + "Number": "string",
3221 + "Description": "string",
3222 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3223 + "ExternalID": "string",
3224 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3225 + "CreateTime": "2023-11-14T10:48:03.717Z",
3226 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3227 + "IsDeleted": true
3228 + },
3229 + "filesCount": 0,
3230 + }
3231 +]
3232 +
3233 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3234 +|SD|Дата и время начала события
3235 +|ED|Дата и время окончания события
3236 +|id|ID объекта
3237 +|SLat|Широта начальной координаты
3238 +|SLon|Долгота начальной координаты
3239 +|ELat|Широта конечной координаты
3240 +|ELon|Долгота конечной координаты
3241 +|mileage|Пробег
3242 +|Duration|Продолжительность
3243 +|Address|Адрес начального местоположения
3244 +|Address2|Адрес конечного местоположения
3245 +|name|Имя радиометки
3246 +|rid|Номер радиометки
3247 +|rguid|ID радиометки
3248 +|trailer|Информация об агрегате
3249 +|ModelGuid|ID агрегата
3250 +|Number|Название/номер агрегата
3251 +|Description|Текст примечания агрегата
3252 +
3253 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3254 +
3255 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3256 +
3257 +(% class="box infomessage" %)
3258 +(((
3259 +**POST /api/v3/Rfids/find**
3260 +)))
3261 +
3262 +Запрос:
3263 +
3264 +{
3265 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3266 +}
3267 +
3268 +Ответ:
3269 +
3270 +[
3271 + {
3272 + "name": "string",
3273 + "number": 0,
3274 + "period": 0,
3275 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3276 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3277 + }
3278 +]
3279 +
3280 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3281 +|parentId|ID клиента
3282 +|name|Название карты-метки
3283 +|number|Номер
3284 +|period|Период запросов в секундах (работает только для агрегатов)
3285 +|id|ID карты-метки
3286 +
3287 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3288 +
3289 +(% class="box infomessage" %)
3290 +(((
3291 +**GET /api/v3/Rfids/{rfidGuid}**
3292 +)))
3293 +
3294 +Передаем параметр rfidGuid - идентификатор карты-метки
3295 +
3296 +Ответ:
3297 +
3298 +[
3299 + {
3300 + "name": "string",
3301 + "number": 0,
3302 + "period": 0,
3303 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3304 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3305 + }
3306 +]
3307 +
3308 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3309 +|name|Название карты-метки
3310 +|number|Номер
3311 +|period|Период запросов в секундах (работает только для агрегатов)
3312 +|id|ID карты-метки
3313 +|parentId|ID клиента
3314 +
3315 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3316 +
3317 +(% class="box successmessage" %)
3318 +(((
3319 +**POST /api/v3/Rfids**
3320 +)))
3321 +
3322 +Запрос:
3323 +
3324 +{
3325 + "name": "string",
3326 + "number": 0,
3327 + "period": 0,
3328 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3329 +}
3330 +
3331 +Ответ:
3332 +
3333 +{
3334 + "name": "string",
3335 + "number": 0,
3336 + "period": 0,
3337 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3338 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3339 +}
3340 +
3341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3342 +|name|Название карты-метки
3343 +|number|Номер
3344 +|period|Период запросов в секундах (работает только для агрегатов)
3345 +|id|ID карты-метки
3346 +|parentId|ID клиента
3347 +
3348 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3349 +
3350 +(% class="box warningmessage" %)
3351 +(((
3352 +**PUT /api/v3/Rfids**
3353 +)))
3354 +
3355 +Запрос:
3356 +
3357 +{
3358 + "name": "string",
3359 + "number": 0,
3360 + "period": 0,
3361 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3362 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3363 +}
3364 +
3365 +Ответ:
3366 +
3367 +{
3368 + "name": "string",
3369 + "number": 0,
3370 + "period": 0,
3371 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3372 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3373 +}
3374 +
3375 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3376 +|name|Название карты-метки
3377 +|number|Номер
3378 +|period|Период запросов в секундах (работает только для агрегатов)
3379 +|id|ID карты-метки
3380 +|parentId|ID клиента
3381 +
3382 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3383 +
3384 +(% class="box errormessage" %)
3385 +(((
3386 +**DELETE /api/v3/Rfids/{rfidGuid}**
3387 +)))
3388 +
3389 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3390 +
3391 +Ответ:
3392 +
3393 +Success
3394 +
3395 +
3396 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3397 +
3398 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3399 +
3400 +(% class="box infomessage" %)
3401 +(((
3402 +**GET /api/v3/Billing/client/balance/{clientId}**
3403 +)))
3404 +
3405 +Параметр запроса: **clientId **- идентификатор клиента.
3406 +
3407 +Ответ:
3408 +
3409 +{
3410 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3411 + "Balance": 0
3412 +}
3413 +
3414 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3415 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3416 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3417 +
3418 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3419 +
3420 +(% class="box infomessage" %)
3421 +(((
3422 +**GET /api/v3/Billing/client/constraint/{clientId}**
3423 +)))
3424 +
3425 +Параметр запроса: **clientId **- идентификатор клиента.
3426 +
3427 +Ответ:
3428 +
3429 +{
3430 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3431 + "CalculationType": 0,
3432 + "PermissibleBalance": 0,
3433 + "DefermentDays": 0,
3434 + "SendUiNotifications": true,
3435 + "SendEmailNotifications": true,
3436 + "IsPrivate": true,
3437 +}
3438 +
3439 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3440 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3441 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3442 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3443 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3444 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3445 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3446 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3447 +
3448 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3449 +
3450 +(% class="box infomessage" %)
3451 +(((
3452 +**GET /api/v3/Billing/client/plan/{clientId}**
3453 +)))
3454 +
3455 +Параметры запроса:
3456 +
3457 +**clientId **- идентификатор клиента.
3458 +
3459 +**planId **- идентификатор тарифного плана.
3460 +
3461 +Ответ:
3462 +
3463 +{
3464 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 + "Plan": { **~/~/ Описание тарифного плана**
3466 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3467 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3468 + "Name": "string",
3469 + "IsArchived": true,
3470 + "Constraint": {
3471 + "CalculationType": 0,
3472 + "PermissibleBalance": 0,
3473 + "DefermentDays": 0
3474 + },
3475 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3476 + {
3477 + "Feature": "string",
3478 + "IsFactual": true,
3479 + "Limit": 0,
3480 + "Price": 0,
3481 + "PeriodValue": 0,
3482 + "PeriodType": 0
3483 + }
3484 + ]
3485 + },
3486 + "DebitDate": "2023-10-18T12:46:24.213Z",
3487 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3488 + {
3489 + "Feature": "string",
3490 + "IsEnabled": true,
3491 + "IsPrivate": true,
3492 + "IsFactual": true,
3493 + "Limit": 0,
3494 + "Price": 0,
3495 + "DebitDate": "2023-10-18T12:46:24.213Z",
3496 + "PeriodValue": 0,
3497 + "PeriodType": 0
3498 + }
3499 + ]
3500 +}
3501 +
3502 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3503 +|ClientId|Идентификатор клиента
3504 +|Id|Идентификатор тарифного плана
3505 +|OwnerId|Идентификатор клиента-владельца
3506 +|Name|Наименование тарифного плана
3507 +|IsArchived|Признак, определяющий архивный тарифный план
3508 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3509 +|PermissibleBalance|Допустимый баланс
3510 +|DefermentDays|Отсрочка, количество дней
3511 +|Feature|Код услуги
3512 +|IsEnabled|Признак, определяющий активирована ли услуга
3513 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3514 +|IsFactual|Признак, определяющий расчёт по факту
3515 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3516 +|Price|Цена за единицу.
3517 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3518 +|PeriodValue|Значение периода.
3519 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3520 +
3521 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3522 +
3523 +(% class="box infomessage" %)
3524 +(((
3525 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3526 +)))
3527 +
3528 +Параметр запроса: **clientId **- идентификатор клиента.
3529 +
3530 +Ответ:
3531 +
3532 +[
3533 + {
3534 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3535 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3536 + "Name": "string",
3537 + "IsArchived": true,
3538 + "Constraint": {
3539 + "CalculationType": 0,
3540 + "PermissibleBalance": 0,
3541 + "DefermentDays": 0
3542 + },
3543 + "Features": [
3544 + {
3545 + "Feature": "string",
3546 + "IsFactual": true,
3547 + "Limit": 0,
3548 + "Price": 0,
3549 + "PeriodValue": 0,
3550 + "PeriodType": 0
3551 + }
3552 + ]
3553 + }
3554 +]
3555 +
3556 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3557 +|ClientId|Идентификатор клиента
3558 +|Id|Идентификатор тарифного плана
3559 +|OwnerId|Идентификатор клиента-владельца
3560 +|Name|Наименование тарифного плана
3561 +|IsArchived|Признак, определяющий архивный тарифный план
3562 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3563 +|PermissibleBalance|Допустимый баланс
3564 +|DefermentDays|Отсрочка, количество дней
3565 +|Feature|Код услуги
3566 +|IsFactual|Признак, определяющий расчёт по факту
3567 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3568 +|Price|Цена за единицу.
3569 +|PeriodValue|Значение периода.
3570 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3571 +
3572 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3573 +
3574 +(% class="box infomessage" %)
3575 +(((
3576 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3577 +)))
3578 +
3579 +Параметр запроса: **clientId **- идентификатор клиента.
3580 +
3581 +Ответ:
3582 +
3583 +[
3584 + {
3585 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3586 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3587 + "Name": "string",
3588 + "IsArchived": true,
3589 + "Constraint": {
3590 + "CalculationType": 0,
3591 + "PermissibleBalance": 0,
3592 + "DefermentDays": 0
3593 + },
3594 + "Features": [
3595 + {
3596 + "Feature": "string",
3597 + "IsFactual": true,
3598 + "Limit": 0,
3599 + "Price": 0,
3600 + "PeriodValue": 0,
3601 + "PeriodType": 0
3602 + }
3603 + ]
3604 + }
3605 +]
3606 +
3607 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3608 +|ClientId|Идентификатор клиента
3609 +|Id|Идентификатор тарифного плана
3610 +|OwnerId|Идентификатор клиента-владельца
3611 +|Name|Наименование тарифного плана
3612 +|IsArchived|Признак, определяющий архивный тарифный план
3613 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3614 +|PermissibleBalance|Допустимый баланс
3615 +|DefermentDays|Отсрочка, количество дней
3616 +|Feature|Код услуги
3617 +|IsFactual|Признак, определяющий расчёт по факту
3618 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3619 +|Price|Цена за единицу.
3620 +|PeriodValue|Значение периода.
3621 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3622 +
3623 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3624 +
3625 +(% class="box warningmessage" %)
3626 +(((
3627 +**PUT /api/v3/Billing/client/balance**
3628 +)))
3629 +
3630 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3631 +
3632 +Тело запроса:
3633 +
3634 +{
3635 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3636 + "Balance": 0
3637 +}
3638 +
3639 +Ответ: Success
3640 +
3641 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3642 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3643 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3644 +
3645 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3646 +
3647 +(% class="box warningmessage" %)
3648 +(((
3649 +**PUT /api/v3/billing/client/balance/deposit**
3650 +)))
3651 +
3652 +Создает операцию **Пополнение **с указанной суммой
3653 +
3654 +Тело запроса:
3655 +
3656 +{
3657 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3658 + "Balance": 0
3659 +}
3660 +
3661 +Ответ: Success
3662 +
3663 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3664 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3665 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3666 +
3667 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3668 +
3669 +Создает операцию **Списание **с указанной суммой
3670 +
3671 +(% class="box warningmessage" %)
3672 +(((
3673 +**PUT /api/v3/billing/client/balance/withdraw**
3674 +)))
3675 +
3676 +Тело запроса:
3677 +
3678 +{
3679 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3680 + "Balance": 0
3681 +}
3682 +
3683 +Ответ: Success
3684 +
3685 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3686 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3687 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3688 +
3689 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3690 +
3691 +(% class="box warningmessage" %)
3692 +(((
3693 +**PUT /api/v3/Billing/client/constraint**
3694 +)))
3695 +
3696 +Тело запроса:
3697 +
3698 +{
3699 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3700 + "CalculationType": 0,
3701 + "PermissibleBalance": 0,
3702 + "DefermentDays": 0,
3703 + "SendUiNotifications": true,
3704 + "SendEmailNotifications": true,
3705 + "IsPrivate": true,
3706 +}
3707 +
3708 +Ответ: Success
3709 +
3710 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3711 +|ClientId|Идентификатор клиента
3712 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3713 +|PermissibleBalance|Допустимый баланс
3714 +|DefermentDays|(((
3715 +Отсрочка, количество дней
3716 +)))
3717 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3718 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3719 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3720 +
3721 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3722 +
3723 +(% class="box warningmessage" %)
3724 +(((
3725 +**PUT /api/v3/Billing/client/plan**
3726 +)))
3727 +
3728 +Тело запроса:
3729 +
3730 +{
3731 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3732 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3733 + "Features": [
3734 + {
3735 + "Feature": "string",
3736 + "IsEnabled": true,
3737 + "IsFactual": true,
3738 + "Limit": 0,
3739 + "Price": 0,
3740 + "DebitDate": "2023-10-18T13:26:58.987Z",
3741 + "PeriodValue": 0,
3742 + "PeriodType": 0
3743 + }
3744 + ]
3745 +}
3746 +
3747 +Ответ: Success
3748 +
3749 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3750 +|ClientId|Идентификатор клиента
3751 +|PlanId|Идентификатор тарифного плана
3752 +|Feature|Код услуги
3753 +|IsEnabled|Признак, определяющий активирована ли услуга
3754 +|IsFactual|Признак, определяющий расчёт по факту
3755 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3756 +|Price|Цена за единицу.
3757 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3758 +|PeriodValue|Значение периода.
3759 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3760 +
3761 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3762 +
3763 +(% class="box warningmessage" %)
3764 +(((
3765 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3766 +)))
3767 +
3768 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3769 +
3770 +(% class="box infomessage" %)
3771 +(((
3772 +**POST /api/v3/vehicles/import/{agentId}**
3773 +)))
3774 +
3775 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3776 +
3777 +В пути указывается **agentId** - id клиента.
3778 +
3779 +**Заголовок**
3780 +
3781 +**X-Auth: [токен авторизации]**
3782 +
3783 +**Параметры**
3784 +
3785 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3786 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3787 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3788 +
3789 +В теле использовать тип **form-data,** тип значения** file**
3790 +
3791 +**Ключи**
3792 +
3793 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3794 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3795 +|csv|В значении передаем файл датчиков, формат **csv**
3796 +
3797 +Ответ:
3798 +
3799 +{
3800 + "vehicleId": 0,
3801 + "name": "string",
3802 + "errors": ["string"]
3803 +}
3804 +
3805 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3806 +|vehicleId|ID созданного объекта
3807 +|name|Имя созданного объекта
3808 +|errors|Ошибки и их описание
3809 +
3810 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3811 +
3812 +(% class="box infomessage" %)
3813 +(((
3814 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3815 +)))
3816 +
3817 +(% class="wikigeneratedid" %)
3818 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3819 +
3820 +(% class="wikigeneratedid" %)
3821 +В пути указывается **vehicleId **- id объекта.
3822 +
3823 +**Заголовок**
3824 +
3825 +**X-Auth: [токен авторизации]**
3826 +
3827 +В теле использовать тип **form-data.**
3828 +
3829 +Ключи:
3830 +
3831 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3832 +|**history**|В значении передавать файл с историей
3833 +
3834 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3835 +
3836 +Ответ:
3837 +
3838 +{
3839 + "results": [
3840 + {
3841 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3842 + "vehicleId": 0,
3843 + "errors": [
3844 + "string"
3845 + ],
3846 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3847 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3848 + "producedCount": 0,
3849 + "msgCount": 0
3850 + }
3851 + ]
3852 +}
3853 +
3854 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3855 +|results|Результаты импорта в разрезе ТС
3856 +|vehicleGuid|Guid ТС
3857 +|vehicleId|ID ТС
3858 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3859 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3860 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3861 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3862 +|msgCount|Кол-во обработанных сообщений всего
3863 +
3864 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3865 +
3866 +(% class="box infomessage" %)
3867 +(((
3868 +**GET /api/v3/vehicles/import/history/status**
3869 +)))
3870 +
3871 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3872 +
3873 +Ответ:
3874 +
3875 +{
3876 + "activity": true,
3877 + "progress": 0,
3878 + "message": "string"
3879 +}
3880 +
3881 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3882 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3883 +|progress|Guid ТС
3884 +
3885 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3886 +
3887 +(% class="box infomessage" %)
3888 +(((
3889 +**POST /api/v3/vehicles/export**
3890 +)))
3891 +
3892 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3893 +
3894 +Тело запроса:
3895 +
3896 +[
3897 + id
3898 +]
3899 +
3900 +Ответ: Success 200, получаете файлы с настройками.
3901 +
3902 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3903 +
3904 +(% class="box infomessage" %)
3905 +(((
3906 +**POST /api/v3/vehicles/export/history**
3907 +)))
3908 +
3909 +Метод возвращает список сообщений терминала объекта за выбранный период.
3910 +
3911 +Тело запроса:
3912 +
3913 +{
3914 + "vehicleId": 0,
3915 + "asArchive": true,
3916 + "from": "2023-09-27T12:17:45.973Z",
3917 + "to": "2023-09-27T12:17:45.973Z"
3918 +}
3919 +
3920 +Ответ:
3921 +
3922 +Получаете файл. Сообщение: Code 200/Success
3923 +
3924 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3925 +|vehicleId|ID объекта
3926 +|asArchive|true - Архивировать файл, False - не архивировать
3927 +|from|Дата и время начала запроса
3928 +|to|Дата и время окончания запроса
3929 +
3930 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3931 +
3932 +(% class="box infomessage" %)
3933 +(((
3934 +**GET /api/v3/vehicles/export/history/status**
3935 +)))
3936 +
3937 +Метод возвращает список сообщений терминала объекта за выбранный период.
3938 +
3939 +Ответ:
3940 +
3941 +{
3942 + "activity": true,
3943 + "progress": 0,
3944 + "message": "string"
3945 +}
3946 +
3947 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3948 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3949 +|progress|Прогресс экспорта, от 0 до 100%
3950 +|message|Текст описывающий статус
3951 +
3952 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3953 +
3954 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3955 +
3956 +(% class="box infomessage" %)
3957 +(((
3958 +**POST /api/v3/EcoDriving/rating**
3959 +)))
3960 +
3961 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3962 +
3963 +Тело запроса:
3964 +
3965 +{
3966 + "vehicleIds": [vehicleId],
3967 + "from": "2023-11-22T09:29:48.051Z",
3968 + "to": "2023-11-22T09:29:48.051Z"
3969 +}
3970 +
3971 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3972 +|vehicleIds|Массив ID объектов
3973 +|from|Дата начала запроса
3974 +|to|Дата окончания запроса
3975 +
3976 +Ответ:
3977 +
3978 +{
3979 + "items": [
3980 + {
3981 + "from": "2023-11-22T09:29:48.052Z",
3982 + "to": "2023-11-22T09:29:48.052Z",
3983 + "vehicleId": 0,
3984 + "vehicleName": "string",
3985 + "vehicleModel": "string",
3986 + "penalty": 0,
3987 + "score": 0,
3988 + "totalViolations": 0,
3989 + "violationsByType": {
3990 + "overspeedingViolations": 0,
3991 + "accelerationViolations": 0,
3992 + "brakingViolations": 0,
3993 + "turningViolations": 0,
3994 + "dangerousDrivingViolations": 0,
3995 + "sensorViolations": 0
3996 + },
3997 + "moveTime": 0,
3998 + "mileage": 0,
3999 + "tripsCount": 0,
4000 + "trips": [
4001 + {
4002 + "penalty": 0,
4003 + "score": 0,
4004 + "violationsCount": 0,
4005 + "violationsByType": {
4006 + "overspeedingViolations": 0,
4007 + "accelerationViolations": 0,
4008 + "brakingViolations": 0,
4009 + "turningViolations": 0,
4010 + "dangerousDrivingViolations": 0,
4011 + "sensorViolations": 0
4012 + },
4013 + "moveTime": 0,
4014 + "mileage": 0,
4015 + "motohours": 0,
4016 + "maxSpeed": 0,
4017 + "startAddress": "string",
4018 + "endAddress": "string",
4019 + "drivers": [
4020 + {
4021 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4022 + "driverName": "string",
4023 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4024 + }
4025 + ]
4026 + }
4027 + ]
4028 + }
4029 + ]
4030 +}
4031 +
4032 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4033 +|from|Дата начала запроса
4034 +|to|Дата  окончания
4035 +|vehicleId|ID объекта
4036 +|vehicleName|Имя объекта
4037 +|vehicleModel|Модель объекта
4038 +|penalty|Сумма штрафных баллов
4039 +|score|Оценка
4040 +|totalViolations|Суммарное количество нарушений
4041 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4042 +|overspeedingViolations|Превышение скорости
4043 +|accelerationViolations|Ускорение
4044 +|brakingViolations|Торможение
4045 +|turningViolations|Резкий поворот
4046 +|dangerousDrivingViolations|Резкое вождение
4047 +|sensorViolations|Нарушение по датчику
4048 +|moveTime|Время в движении
4049 +|mileage|Пробег
4050 +|tripsCount|Количество рейсов
4051 +|motohours|Моточасы
4052 +|maxSpeed|Максимальная скорость
4053 +|startAddress|Адрес начала рейса
4054 +|endAddress|Адрес окончания рейса
4055 +|drivers|Список водителей, которые были на объекте в течениии рейса
4056 +|driverGuid|Guid водителя
4057 +|driverName|Имя водителя
4058 +|driverRfid|Номер Карты-метки
4059 +
1751 1751  (% class="box" lang="en-US" style="text-align: center;" %)
1752 1752  (((
1753 1753  (% 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 г.