Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 92.1 >
edited by Илья Крайнов
on 2023/05/22 15:40
To version < 131.1 >
edited by Андрей Калиновский
on 2024/01/30 15:09
>
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,390 @@
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 +
2142 +(% class="box infomessage" %)
2143 +(((
2144 +**POST/api/v3/vehicles/moveStop**
2145 +)))
2146 +
2147 +Метод запроса: **POST**
2148 +
2149 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/moveStop]]
2150 +
2151 +В заголовках запроса: X-Auth: Токен авторизации
2152 +
2153 +
2154 +Тело запроса:
2155 +
2156 +{
2157 +
2158 + "vehicleIds": [ ], ~/~/ Список ID объектов
2159 +
2160 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2161 +
2162 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2163 +
2164 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2165 +
2166 +}
2167 +
2168 +
2169 +Ответ:
2170 +
2171 +[
2172 +
2173 + {
2174 +
2175 + "vehicleId": 0, ~/~/ ID объекта
2176 +
2177 + "vehicleName": "string", ~/~/ Имя объекта
2178 +
2179 + "moves": [ ~/~/ Событие движения
2180 +
2181 + {
2182 +
2183 + "mileage": 0, ~/~/ Пробег, км
2184 +
2185 + "eventId": 0, ~/~/ Идентификатор события
2186 +
2187 + "eventName": "string", ~/~/ Название события
2188 +
2189 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2190 +
2191 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2192 +
2193 + "duration": 0 ~/~/ Продолжительность события, секунд
2194 +
2195 + }
2196 +
2197 + ],
2198 +
2199 + "stops": [ ~/~/ События стоянок
2200 +
2201 + {
2202 +
2203 + "address": "string", ~/~/ Адрес события
2204 +
2205 + "eventId": 0, ~/~/ Идентификатор события
2206 +
2207 + "eventName": "string", ~/~/ Название события
2208 +
2209 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2210 +
2211 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2212 +
2213 + "duration": 0 ~/~/ Продолжительность события, секунд
2214 +
2215 +
2216 + }
2217 +
2218 + ]
2219 +
2220 + }
2221 +
2222 +]
2223 +
2224 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2225 +
2226 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2227 +
2228 +(% class="box infomessage" %)
2229 +(((
2230 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2231 +)))
2232 +
2233 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2234 +
2235 +(% style="color:#000000" %)Метод запроса: **POST**
2236 +
2237 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2238 +
2239 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2240 +
2241 +(% style="text-align:left" %)
2242 +Тело запроса:
2243 +
2244 +(% style="text-align:left" %)
2245 +{
2246 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2247 +}
2248 +
2249 +(% style="text-align:left" %)
2250 +Ответ:
2251 +
2252 +[
2253 + {
2254 + "id": 0, ~/~/ Идентификатор объекта геозоны
2255 + "name": "string", ~/~/ Название объекта геозоны
2256 + "type": 0, ~/~/ Тип объекта геозоны
2257 + "fname": "string", ~/~/ Имя файла
2258 + "parentId": "string", ~/~/ Идентификатор клиента
2259 + "radius": 0, ~/~/ Радиус геообъекта
2260 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2261 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2262 + "description": "string", ~/~/ Описание
2263 + "area": 0, ~/~/ Площадь, м^^2^^
2264 + "perimetr": 0, ~/~/ Периметр, м
2265 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2266 + }
2267 +]
2268 +
2269 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2270 +
2271 +(% class="box infomessage" %)
2272 +(((
2273 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2274 +)))
2275 +
2276 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2277 +
2278 +(% style="color:#000000" %)Метод запроса: **POST**
2279 +
2280 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2281 +
2282 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2283 +
2284 +(% style="text-align:left" %)
2285 +Тело запроса:
2286 +
2287 +{
2288 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2289 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2290 + "ids": [ ], ~/~/ Массив id объектов
2291 + "byTime": 0, ~/~/ Объединение событий по времени 
2292 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2293 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2294 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2295 +}
2296 +
2297 +Ответ:
2298 +[
2299 + {
2300 + "geozoneId": 0, ~/~/ ID геообъекта
2301 + "geozoneName": "string", ~/~/ Название геообъекта
2302 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2303 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2304 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2305 + "vehicleId": 0, ~/~/ ID объекта
2306 + "vehicleName": "string" ~/~/ Имя объекта
2307 + }
2308 +]
2309 +
2310 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2311 +
2312 +(% class="box infomessage" %)
2313 +(((
2314 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2315 +)))
2316 +
2317 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2318 +
2319 +(% style="color:#000000" %)Метод запроса: **POST**
2320 +
2321 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2322 +
2323 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2324 +
2325 +(% style="text-align:left" %)
2326 +Тело запроса:
2327 +
2328 +{
2329 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2330 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2331 + "ids": [ ], ~/~/ Массив id геообъектов
2332 + "byTime": 0, ~/~/ Объединение событий по времени 
2333 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2334 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2335 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2336 +}
2337 +
2338 +Ответ:
2339 +
2340 +[
2341 + {
2342 + "geozoneId": 0, ~/~/ ID геообъекта
2343 + "geozoneName": "string", ~/~/ Название геообъекта
2344 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2345 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2346 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2347 + "vehicleId": 0, ~/~/ ID объекта
2348 + "vehicleName": "string" ~/~/ Имя объекта
2349 + }
2350 +]
2351 +
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  
2552 +
2553 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2554 +
2555 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2556 +
2557 +(% class="box infomessage" %)
2558 +(((
2559 +**POST /api/v3/Drivers/find**
2560 +)))
2561 +
2562 +Передается параметр: parentId - ID клиента-родителя
2563 +
2564 +Ответ:
2565 +
2566 +[
2567 + {
2568 + "name": "string", ~/~/ Определяет наименование
2569 + "description": "string", ~/~/ Определяет описание
2570 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2571 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2572 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2573 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2574 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2575 + "deleted": true ~/~/ Признак удаления
2576 + }
2577 +]
2578 +
2579 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2580 +
2581 +(% class="box infomessage" %)
2582 +(((
2583 +**GET /api/v3/Drivers/{driverGuid}**
2584 +)))
2585 +
2586 +Передается параметр: ID водителя
2587 +
2588 +Ответ:
2589 +
2590 +{
2591 + "name": "string", ~/~/ Определяет наименование
2592 + "description": "string", ~/~/ Определяет описание
2593 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2594 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2595 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
2596 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2597 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2598 + "deleted": true ~/~/ Признак удаления
2599 +}
2600 +
2601 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2602 +
2603 +(% class="box successmessage" %)
2604 +(((
2605 +**POST /api/v3/Drivers**
2606 +)))
2607 +
2608 +Запрос:
2609 +
2610 +{
2611 + "name": "string",
2612 + "description": "string",
2613 + "hiredate": "2023-06-30T12:50:54.020Z",
2614 + "chopdate": "2023-06-30T12:50:54.020Z",
2615 + "exclusive": true,
2616 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2617 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2618 + "deleted": true
2619 +}
2620 +
2621 +Ответ:
2622 +
2623 +{
2624 + "name": "string",
2625 + "description": "string",
2626 + "hiredate": "2023-06-30T12:50:54.051Z",
2627 + "chopdate": "2023-06-30T12:50:54.051Z",
2628 + "exclusive": true,
2629 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2630 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2631 + "deleted": true
2632 +}
2633 +
2634 +
2635 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
2636 +
2637 +(% class="box warningmessage" %)
2638 +(((
2639 +**PUT /api/v3/Drivers**
2640 +)))
2641 +
2642 +Запрос:
2643 +
2644 +{
2645 + "name": "string",
2646 + "description": "string",
2647 + "hiredate": "2023-06-30T12:50:27.910Z",
2648 + "chopdate": "2023-06-30T12:50:27.910Z",
2649 + "exclusive": true,
2650 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2651 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2652 + "deleted": true
2653 +}
2654 +
2655 +Ответ:
2656 +
2657 +{
2658 + "name": "string",
2659 + "description": "string",
2660 + "hiredate": "2023-06-30T12:50:27.929Z",
2661 + "chopdate": "2023-06-30T12:50:27.929Z",
2662 + "exclusive": true,
2663 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2664 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2665 + "deleted": true
2666 +}
2667 +
2668 +
2669 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
2670 +
2671 +(% class="box errormessage" %)
2672 +(((
2673 +**DELETE /api/v3/Drivers/{driverGuid}**
2674 +)))
2675 +
2676 +Передается параметр: ID водителя
2677 +
2678 +Ответ:
2679 +
2680 +Success
2681 +
2682 +
2683 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
2684 +
2685 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
2686 +
2687 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
2688 +
2689 +(% class="box infomessage" %)
2690 +(((
2691 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2692 +)))
2693 +
2694 +Запрос:
2695 +
2696 +{
2697 + "Ids": [
2698 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2699 + ],
2700 + "BeginTime": "2023-06-30T12:49:04.365Z",
2701 + "EndTime": "2023-06-30T12:49:04.365Z"
2702 +}
2703 +
2704 +Ответ:
2705 +
2706 +[
2707 + {
2708 + "VehicleId": 0,
2709 + "CreateTime": "2023-06-30T09:52:31.240Z",
2710 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2711 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2712 + "BeginTime": "2023-06-30T09:52:31.240Z",
2713 + "EndTime": "2023-06-30T09:52:31.240Z"
2714 + }
2715 +]
2716 +
2717 +
2718 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
2719 +
2720 +(% class="box infomessage" %)
2721 +(((
2722 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2723 +)))
2724 +
2725 +Запрос:
2726 +
2727 +{
2728 + "Ids": [
2729 + 0
2730 + ],
2731 + "BeginTime": "2023-06-30T12:48:39.419Z",
2732 + "EndTime": "2023-06-30T12:48:39.419Z"
2733 +}
2734 +
2735 +Ответ:
2736 +
2737 +[
2738 + {
2739 + "VehicleId": 0,
2740 + "CreateTime": "2023-06-30T09:54:01.631Z",
2741 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2742 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2743 + "BeginTime": "2023-06-30T09:54:01.631Z",
2744 + "EndTime": "2023-06-30T09:54:01.631Z"
2745 + }
2746 +]
2747 +
2748 +
2749 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2750 +
2751 +(% class="box successmessage" %)
2752 +(((
2753 +**POST /api/v3/DriversVehiclesAssignments**
2754 +)))
2755 +
2756 +Передается массив назначений
2757 +
2758 +Запрос:
2759 +
2760 +[
2761 + {
2762 + "VehicleId": 0, ~/~/ Идентификатор объекта
2763 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
2764 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2765 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
2766 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
2767 + }
2768 +]
2769 +
2770 +Ответ:
2771 +
2772 +[
2773 + {
2774 + "VehicleId": 0,
2775 + "CreateTime": "2023-06-30T11:04:46.903Z",
2776 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2777 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2778 + "BeginTime": "2023-06-30T11:04:46.903Z",
2779 + "EndTime": "2023-06-30T11:04:46.903Z"
2780 + }
2781 +]
2782 +
2783 +
2784 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2785 +
2786 +(% class="box warningmessage" %)
2787 +(((
2788 +**PUT /api/v3/DriversVehiclesAssignments**
2789 +)))
2790 +
2791 +Запрос:
2792 +
2793 +[
2794 + {
2795 + "VehicleId": 0,
2796 + "CreateTime": "2023-06-30T11:14:08.117Z",
2797 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2798 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2799 + "BeginTime": "2023-06-30T11:14:08.117Z",
2800 + "EndTime": "2023-06-30T11:14:08.117Z"
2801 + }
2802 +]
2803 +
2804 +Ответ:
2805 +
2806 +[
2807 + {
2808 + "VehicleId": 0,
2809 + "CreateTime": "2023-06-30T11:14:53.349Z",
2810 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2811 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2812 + "BeginTime": "2023-06-30T11:14:53.349Z",
2813 + "EndTime": "2023-06-30T11:14:53.349Z"
2814 + }
2815 +]
2816 +
2817 +
2818 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2819 +
2820 +(% class="box errormessage" %)
2821 +(((
2822 +**DELETE /api/v3/DriversVehiclesAssignments**
2823 +)))
2824 +
2825 +Запрос:
2826 +
2827 +[
2828 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2829 +]
2830 +
2831 +Ответ:
2832 +
2833 +Success
2834 +
2835 +
2836 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2837 +
2838 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2839 +
2840 +(% class="box infomessage" %)
2841 +(((
2842 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2843 +)))
2844 +
2845 +Запрос:
2846 +
2847 +{
2848 + "Ids": [
2849 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2850 + ],
2851 + "BeginTime": "2023-06-30T12:47:12.162Z",
2852 + "EndTime": "2023-06-30T12:47:12.162Z"
2853 +}
2854 +
2855 +Ответ:
2856 +
2857 +[
2858 + {
2859 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2860 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2861 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2862 + "BeginTime": "2023-06-30T11:19:40.703Z",
2863 + "EndTime": "2023-06-30T11:19:40.703Z"
2864 + }
2865 +]
2866 +
2867 +
2868 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2869 +
2870 +(% class="box infomessage" %)
2871 +(((
2872 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2873 +)))
2874 +
2875 +Запрос:
2876 +
2877 +{
2878 + "Ids": [
2879 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2880 + ],
2881 + "BeginTime": "2023-06-30T12:47:12.162Z",
2882 + "EndTime": "2023-06-30T12:47:12.162Z"
2883 +}
2884 +
2885 +Ответ:
2886 +
2887 +[
2888 + {
2889 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2890 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2891 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2892 + "BeginTime": "2023-06-30T11:19:40.703Z",
2893 + "EndTime": "2023-06-30T11:19:40.703Z"
2894 + }
2895 +]
2896 +
2897 +
2898 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2899 +
2900 +(% class="box successmessage" %)
2901 +(((
2902 +**POST /api/v3/DriversRfidsAssignments**
2903 +)))
2904 +
2905 +Запрос:
2906 +
2907 +[
2908 + {
2909 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2910 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2911 + "BeginTime": "2023-06-30T11:27:08.635Z",
2912 + "EndTime": "2023-06-30T11:27:08.635Z"
2913 + }
2914 +]
2915 +
2916 +Ответ:
2917 +
2918 +[
2919 + {
2920 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2921 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2922 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2923 + "BeginTime": "2023-06-30T11:27:08.677Z",
2924 + "EndTime": "2023-06-30T11:27:08.677Z"
2925 + }
2926 +]
2927 +
2928 +
2929 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2930 +
2931 +(% class="box warningmessage" %)
2932 +(((
2933 +**PUT /api/v3/DriversRfidsAssignments**
2934 +)))
2935 +
2936 +Запрос:
2937 +
2938 +[
2939 + {
2940 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2941 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2942 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2943 + "BeginTime": "2023-06-30T11:28:43.330Z",
2944 + "EndTime": "2023-06-30T11:28:43.330Z"
2945 + }
2946 +]
2947 +
2948 +Ответ:
2949 +
2950 +[
2951 + {
2952 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2953 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2955 + "BeginTime": "2023-06-30T11:28:43.331Z",
2956 + "EndTime": "2023-06-30T11:28:43.331Z"
2957 + }
2958 +]
2959 +
2960 +
2961 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2962 +
2963 +(% class="box errormessage" %)
2964 +(((
2965 +**DELETE /api/v3/DriversRfidsAssignments**
2966 +)))
2967 +
2968 +Запрос:
2969 +
2970 +[
2971 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2972 +]
2973 +
2974 +Ответ:
2975 +
2976 +Success
2977 +
2978 +
2979 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2980 +
2981 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2982 +
2983 +(% class="box infomessage" %)
2984 +(((
2985 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2986 +)))
2987 +
2988 +Запрос:
2989 +
2990 +{
2991 + "Ids": [
2992 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2993 + ],
2994 + "BeginTime": "2023-06-30T12:45:10.852Z",
2995 + "EndTime": "2023-06-30T12:45:10.852Z"
2996 +}
2997 +
2998 +Ответ:
2999 +
3000 +[
3001 + {
3002 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3003 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3004 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3005 + "BeginTime": "2023-06-30T11:58:04.695Z",
3006 + "EndTime": "2023-06-30T11:58:04.695Z"
3007 + }
3008 +]
3009 +
3010 +
3011 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3012 +
3013 +(% class="box infomessage" %)
3014 +(((
3015 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3016 +)))
3017 +
3018 +Запрос:
3019 +
3020 +{
3021 + "Ids": [
3022 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3023 + ],
3024 + "BeginTime": "2023-06-30T12:45:10.852Z",
3025 + "EndTime": "2023-06-30T12:45:10.852Z"
3026 +}
3027 +
3028 +Ответ:
3029 +
3030 +[
3031 + {
3032 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3033 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3034 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 + "BeginTime": "2023-06-30T11:58:04.695Z",
3036 + "EndTime": "2023-06-30T11:58:04.695Z"
3037 + }
3038 +]
3039 +
3040 +
3041 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3042 +
3043 +(% class="box successmessage" %)
3044 +(((
3045 +**POST /api/v3/DriversFuelCardsAssignments**
3046 +)))
3047 +
3048 +Запрос:
3049 +
3050 +[
3051 + {
3052 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3053 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3054 + "BeginTime": "2023-06-30T12:09:53.175Z",
3055 + "EndTime": "2023-06-30T12:09:53.175Z"
3056 + }
3057 +]
3058 +
3059 +Ответ:
3060 +
3061 +[
3062 + {
3063 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3064 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3065 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3066 + "BeginTime": "2023-06-30T12:09:53.201Z",
3067 + "EndTime": "2023-06-30T12:09:53.201Z"
3068 + }
3069 +]
3070 +
3071 +
3072 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3073 +
3074 +(% class="box warningmessage" %)
3075 +(((
3076 +**PUT /api/v3/DriversFuelCardsAssignments**
3077 +)))
3078 +
3079 +Запрос:
3080 +
3081 +[
3082 + {
3083 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3084 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3086 + "BeginTime": "2023-06-30T12:09:53.201Z",
3087 + "EndTime": "2023-06-30T12:09:53.201Z"
3088 + }
3089 +]
3090 +
3091 +Ответ:
3092 +
3093 +[
3094 + {
3095 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3096 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3097 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3098 + "BeginTime": "2023-06-30T12:09:53.201Z",
3099 + "EndTime": "2023-06-30T12:09:53.201Z"
3100 + }
3101 +]
3102 +
3103 +
3104 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3105 +
3106 +(% class="box errormessage" %)
3107 +(((
3108 +**DELETE /api/v3/DriversFuelCardsAssignments**
3109 +)))
3110 +
3111 +Запрос:
3112 +
3113 +[
3114 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3115 +]
3116 +
3117 +Ответ:
3118 +
3119 +Success
3120 +
3121 +
3122 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3123 +
3124 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3125 +
3126 +(% class="box infomessage" %)
3127 +(((
3128 +**POST /api/v3/Trailers**
3129 +)))
3130 +
3131 +Пример запроса:
3132 +
3133 +{
3134 + "startDate": "2023-11-14T10:48:03.671Z",
3135 + "endDate": "2023-11-14T10:48:03.671Z",
3136 + "ids": [ 0 ],
3137 + "timezone": 0
3138 +}
3139 +
3140 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3141 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3142 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3143 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3144 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3145 +
3146 +Пример ответа:
3147 +
3148 +[
3149 + {
3150 + "SD": "2023-11-14T10:48:03.717Z",
3151 + "ED": "2023-11-14T10:48:03.717Z", 
3152 + "id": 0,
3153 + "SLat": 0,
3154 + "SLon": 0,
3155 + "ELat": 0,
3156 + "ELon": 0,
3157 + "mileage": 0
3158 + "Duration": 0
3159 + "Address": "string",
3160 + "Address2": "string",
3161 + "name": "string",
3162 + "rid": "string",
3163 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3164 + "trailer": {
3165 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3166 + "Number": "string",
3167 + "Description": "string",
3168 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3169 + "ExternalID": "string",
3170 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3171 + "CreateTime": "2023-11-14T10:48:03.717Z",
3172 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3173 + "IsDeleted": true
3174 + },
3175 + "filesCount": 0,
3176 + }
3177 +]
3178 +
3179 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3180 +|SD|Дата и время начала события
3181 +|ED|Дата и время окончания события
3182 +|id|ID объекта
3183 +|SLat|Широта начальной координаты
3184 +|SLon|Долгота начальной координаты
3185 +|ELat|Широта конечной координаты
3186 +|ELon|Долгота конечной координаты
3187 +|mileage|Пробег
3188 +|Duration|Продолжительность
3189 +|Address|Адрес начального местоположения
3190 +|Address2|Адрес конечного местоположения
3191 +|name|Имя радиометки
3192 +|rid|Номер радиометки
3193 +|rguid|ID радиометки
3194 +|trailer|Информация об агрегате
3195 +|ModelGuid|ID агрегата
3196 +|Number|Название/номер агрегата
3197 +|Description|Текст примечания агрегата
3198 +
3199 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3200 +
3201 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3202 +
3203 +(% class="box infomessage" %)
3204 +(((
3205 +**POST /api/v3/Rfids/find**
3206 +)))
3207 +
3208 +Запрос:
3209 +
3210 +{
3211 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3212 +}
3213 +
3214 +Ответ:
3215 +
3216 +[
3217 + {
3218 + "name": "string",
3219 + "number": 0,
3220 + "period": 0,
3221 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3222 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3223 + }
3224 +]
3225 +
3226 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3227 +|parentId|ID клиента
3228 +|name|Название карты-метки
3229 +|number|Номер
3230 +|period|Период запросов в секундах (работает только для агрегатов)
3231 +|id|ID карты-метки
3232 +
3233 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3234 +
3235 +(% class="box infomessage" %)
3236 +(((
3237 +**GET /api/v3/Rfids/{rfidGuid}**
3238 +)))
3239 +
3240 +Передаем параметр rfidGuid - идентификатор карты-метки
3241 +
3242 +Ответ:
3243 +
3244 +[
3245 + {
3246 + "name": "string",
3247 + "number": 0,
3248 + "period": 0,
3249 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3250 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3251 + }
3252 +]
3253 +
3254 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3255 +|name|Название карты-метки
3256 +|number|Номер
3257 +|period|Период запросов в секундах (работает только для агрегатов)
3258 +|id|ID карты-метки
3259 +|parentId|ID клиента
3260 +
3261 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3262 +
3263 +(% class="box successmessage" %)
3264 +(((
3265 +**POST /api/v3/Rfids**
3266 +)))
3267 +
3268 +Запрос:
3269 +
3270 +{
3271 + "name": "string",
3272 + "number": 0,
3273 + "period": 0,
3274 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3275 +}
3276 +
3277 +Ответ:
3278 +
3279 +{
3280 + "name": "string",
3281 + "number": 0,
3282 + "period": 0,
3283 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3284 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3285 +}
3286 +
3287 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3288 +|name|Название карты-метки
3289 +|number|Номер
3290 +|period|Период запросов в секундах (работает только для агрегатов)
3291 +|id|ID карты-метки
3292 +|parentId|ID клиента
3293 +
3294 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3295 +
3296 +(% class="box warningmessage" %)
3297 +(((
3298 +**PUT /api/v3/Rfids**
3299 +)))
3300 +
3301 +Запрос:
3302 +
3303 +{
3304 + "name": "string",
3305 + "number": 0,
3306 + "period": 0,
3307 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3308 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3309 +}
3310 +
3311 +Ответ:
3312 +
3313 +{
3314 + "name": "string",
3315 + "number": 0,
3316 + "period": 0,
3317 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3318 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3319 +}
3320 +
3321 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3322 +|name|Название карты-метки
3323 +|number|Номер
3324 +|period|Период запросов в секундах (работает только для агрегатов)
3325 +|id|ID карты-метки
3326 +|parentId|ID клиента
3327 +
3328 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3329 +
3330 +(% class="box errormessage" %)
3331 +(((
3332 +**DELETE /api/v3/Rfids/{rfidGuid}**
3333 +)))
3334 +
3335 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3336 +
3337 +Ответ:
3338 +
3339 +Success
3340 +
3341 +
3342 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3343 +
3344 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3345 +
3346 +(% class="box infomessage" %)
3347 +(((
3348 +**GET /api/v3/Billing/client/balance/{clientId}**
3349 +)))
3350 +
3351 +Параметр запроса: **clientId **- идентификатор клиента.
3352 +
3353 +Ответ:
3354 +
3355 +{
3356 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3357 + "Balance": 0
3358 +}
3359 +
3360 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3361 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3362 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3363 +
3364 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3365 +
3366 +(% class="box infomessage" %)
3367 +(((
3368 +**GET /api/v3/Billing/client/constraint/{clientId}**
3369 +)))
3370 +
3371 +Параметр запроса: **clientId **- идентификатор клиента.
3372 +
3373 +Ответ:
3374 +
3375 +{
3376 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3377 + "CalculationType": 0,
3378 + "PermissibleBalance": 0,
3379 + "DefermentDays": 0,
3380 + "SendUiNotifications": true,
3381 + "SendEmailNotifications": true,
3382 + "IsPrivate": true,
3383 +}
3384 +
3385 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3386 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3387 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3388 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3389 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3390 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3391 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3392 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3393 +
3394 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3395 +
3396 +(% class="box infomessage" %)
3397 +(((
3398 +**GET /api/v3/Billing/client/plan/{clientId}**
3399 +)))
3400 +
3401 +Параметры запроса:
3402 +
3403 +**clientId **- идентификатор клиента.
3404 +
3405 +**planId **- идентификатор тарифного плана.
3406 +
3407 +Ответ:
3408 +
3409 +{
3410 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3411 + "Plan": { **~/~/ Описание тарифного плана**
3412 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3414 + "Name": "string",
3415 + "IsArchived": true,
3416 + "Constraint": {
3417 + "CalculationType": 0,
3418 + "PermissibleBalance": 0,
3419 + "DefermentDays": 0
3420 + },
3421 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3422 + {
3423 + "Feature": "string",
3424 + "IsFactual": true,
3425 + "Limit": 0,
3426 + "Price": 0,
3427 + "PeriodValue": 0,
3428 + "PeriodType": 0
3429 + }
3430 + ]
3431 + },
3432 + "DebitDate": "2023-10-18T12:46:24.213Z",
3433 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3434 + {
3435 + "Feature": "string",
3436 + "IsEnabled": true,
3437 + "IsPrivate": true,
3438 + "IsFactual": true,
3439 + "Limit": 0,
3440 + "Price": 0,
3441 + "DebitDate": "2023-10-18T12:46:24.213Z",
3442 + "PeriodValue": 0,
3443 + "PeriodType": 0
3444 + }
3445 + ]
3446 +}
3447 +
3448 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3449 +|ClientId|Идентификатор клиента
3450 +|Id|Идентификатор тарифного плана
3451 +|OwnerId|Идентификатор клиента-владельца
3452 +|Name|Наименование тарифного плана
3453 +|IsArchived|Признак, определяющий архивный тарифный план
3454 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3455 +|PermissibleBalance|Допустимый баланс
3456 +|DefermentDays|Отсрочка, количество дней
3457 +|Feature|Код услуги
3458 +|IsEnabled|Признак, определяющий активирована ли услуга
3459 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3460 +|IsFactual|Признак, определяющий расчёт по факту
3461 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3462 +|Price|Цена за единицу.
3463 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3464 +|PeriodValue|Значение периода.
3465 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3466 +
3467 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3468 +
3469 +(% class="box infomessage" %)
3470 +(((
3471 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3472 +)))
3473 +
3474 +Параметр запроса: **clientId **- идентификатор клиента.
3475 +
3476 +Ответ:
3477 +
3478 +[
3479 + {
3480 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3481 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3482 + "Name": "string",
3483 + "IsArchived": true,
3484 + "Constraint": {
3485 + "CalculationType": 0,
3486 + "PermissibleBalance": 0,
3487 + "DefermentDays": 0
3488 + },
3489 + "Features": [
3490 + {
3491 + "Feature": "string",
3492 + "IsFactual": true,
3493 + "Limit": 0,
3494 + "Price": 0,
3495 + "PeriodValue": 0,
3496 + "PeriodType": 0
3497 + }
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 +|IsFactual|Признак, определяющий расчёт по факту
3513 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3514 +|Price|Цена за единицу.
3515 +|PeriodValue|Значение периода.
3516 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3517 +
3518 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3519 +
3520 +(% class="box infomessage" %)
3521 +(((
3522 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3523 +)))
3524 +
3525 +Параметр запроса: **clientId **- идентификатор клиента.
3526 +
3527 +Ответ:
3528 +
3529 +[
3530 + {
3531 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3532 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3533 + "Name": "string",
3534 + "IsArchived": true,
3535 + "Constraint": {
3536 + "CalculationType": 0,
3537 + "PermissibleBalance": 0,
3538 + "DefermentDays": 0
3539 + },
3540 + "Features": [
3541 + {
3542 + "Feature": "string",
3543 + "IsFactual": true,
3544 + "Limit": 0,
3545 + "Price": 0,
3546 + "PeriodValue": 0,
3547 + "PeriodType": 0
3548 + }
3549 + ]
3550 + }
3551 +]
3552 +
3553 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3554 +|ClientId|Идентификатор клиента
3555 +|Id|Идентификатор тарифного плана
3556 +|OwnerId|Идентификатор клиента-владельца
3557 +|Name|Наименование тарифного плана
3558 +|IsArchived|Признак, определяющий архивный тарифный план
3559 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3560 +|PermissibleBalance|Допустимый баланс
3561 +|DefermentDays|Отсрочка, количество дней
3562 +|Feature|Код услуги
3563 +|IsFactual|Признак, определяющий расчёт по факту
3564 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3565 +|Price|Цена за единицу.
3566 +|PeriodValue|Значение периода.
3567 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3568 +
3569 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3570 +
3571 +(% class="box warningmessage" %)
3572 +(((
3573 +**PUT /api/v3/Billing/client/balance**
3574 +)))
3575 +
3576 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3577 +
3578 +Тело запроса:
3579 +
3580 +{
3581 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3582 + "Balance": 0
3583 +}
3584 +
3585 +Ответ: Success
3586 +
3587 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3588 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3589 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3590 +
3591 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3592 +
3593 +(% class="box warningmessage" %)
3594 +(((
3595 +**PUT /api/v3/billing/client/balance/deposit**
3596 +)))
3597 +
3598 +Создает операцию **Пополнение **с указанной суммой
3599 +
3600 +Тело запроса:
3601 +
3602 +{
3603 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3604 + "Balance": 0
3605 +}
3606 +
3607 +Ответ: Success
3608 +
3609 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3610 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3611 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3612 +
3613 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3614 +
3615 +Создает операцию **Списание **с указанной суммой
3616 +
3617 +(% class="box warningmessage" %)
3618 +(((
3619 +**PUT /api/v3/billing/client/balance/withdraw**
3620 +)))
3621 +
3622 +Тело запроса:
3623 +
3624 +{
3625 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3626 + "Balance": 0
3627 +}
3628 +
3629 +Ответ: Success
3630 +
3631 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3632 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3633 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3634 +
3635 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3636 +
3637 +(% class="box warningmessage" %)
3638 +(((
3639 +**PUT /api/v3/Billing/client/constraint**
3640 +)))
3641 +
3642 +Тело запроса:
3643 +
3644 +{
3645 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3646 + "CalculationType": 0,
3647 + "PermissibleBalance": 0,
3648 + "DefermentDays": 0,
3649 + "SendUiNotifications": true,
3650 + "SendEmailNotifications": true,
3651 + "IsPrivate": true,
3652 +}
3653 +
3654 +Ответ: Success
3655 +
3656 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3657 +|ClientId|Идентификатор клиента
3658 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3659 +|PermissibleBalance|Допустимый баланс
3660 +|DefermentDays|(((
3661 +Отсрочка, количество дней
3662 +)))
3663 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3664 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3665 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3666 +
3667 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3668 +
3669 +(% class="box warningmessage" %)
3670 +(((
3671 +**PUT /api/v3/Billing/client/plan**
3672 +)))
3673 +
3674 +Тело запроса:
3675 +
3676 +{
3677 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3678 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3679 + "Features": [
3680 + {
3681 + "Feature": "string",
3682 + "IsEnabled": true,
3683 + "IsFactual": true,
3684 + "Limit": 0,
3685 + "Price": 0,
3686 + "DebitDate": "2023-10-18T13:26:58.987Z",
3687 + "PeriodValue": 0,
3688 + "PeriodType": 0
3689 + }
3690 + ]
3691 +}
3692 +
3693 +Ответ: Success
3694 +
3695 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3696 +|ClientId|Идентификатор клиента
3697 +|PlanId|Идентификатор тарифного плана
3698 +|Feature|Код услуги
3699 +|IsEnabled|Признак, определяющий активирована ли услуга
3700 +|IsFactual|Признак, определяющий расчёт по факту
3701 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3702 +|Price|Цена за единицу.
3703 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3704 +|PeriodValue|Значение периода.
3705 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3706 +
3707 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3708 +
3709 +(% class="box warningmessage" %)
3710 +(((
3711 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3712 +)))
3713 +
3714 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3715 +
3716 +(% class="box infomessage" %)
3717 +(((
3718 +**POST /api/v3/vehicles/import/{agentId}**
3719 +)))
3720 +
3721 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3722 +
3723 +В пути указывается **agentId** - id клиента.
3724 +
3725 +**Заголовок**
3726 +
3727 +**X-Auth: [токен авторизации]**
3728 +
3729 +**Параметры**
3730 +
3731 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3732 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3733 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3734 +
3735 +В теле использовать тип **form-data,** тип значения** file**
3736 +
3737 +**Ключи**
3738 +
3739 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3740 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3741 +|csv|В значении передаем файл датчиков, формат **csv**
3742 +
3743 +Ответ:
3744 +
3745 +{
3746 + "vehicleId": 0,
3747 + "name": "string",
3748 + "errors": ["string"]
3749 +}
3750 +
3751 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3752 +|vehicleId|ID созданного объекта
3753 +|name|Имя созданного объекта
3754 +|errors|Ошибки и их описание
3755 +
3756 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3757 +
3758 +(% class="box infomessage" %)
3759 +(((
3760 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3761 +)))
3762 +
3763 +(% class="wikigeneratedid" %)
3764 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3765 +
3766 +(% class="wikigeneratedid" %)
3767 +В пути указывается **vehicleId **- id объекта.
3768 +
3769 +**Заголовок**
3770 +
3771 +**X-Auth: [токен авторизации]**
3772 +
3773 +В теле использовать тип **form-data.**
3774 +
3775 +Ключи:
3776 +
3777 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3778 +|**history**|В значении передавать файл с историей
3779 +
3780 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3781 +
3782 +Ответ:
3783 +
3784 +{
3785 + "results": [
3786 + {
3787 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3788 + "vehicleId": 0,
3789 + "errors": [
3790 + "string"
3791 + ],
3792 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3793 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3794 + "producedCount": 0,
3795 + "msgCount": 0
3796 + }
3797 + ]
3798 +}
3799 +
3800 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3801 +|results|Результаты импорта в разрезе ТС
3802 +|vehicleGuid|Guid ТС
3803 +|vehicleId|ID ТС
3804 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3805 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3806 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3807 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3808 +|msgCount|Кол-во обработанных сообщений всего
3809 +
3810 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3811 +
3812 +(% class="box infomessage" %)
3813 +(((
3814 +**GET /api/v3/vehicles/import/history/status**
3815 +)))
3816 +
3817 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3818 +
3819 +Ответ:
3820 +
3821 +{
3822 + "activity": true,
3823 + "progress": 0,
3824 + "message": "string"
3825 +}
3826 +
3827 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3828 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3829 +|progress|Guid ТС
3830 +
3831 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3832 +
3833 +(% class="box infomessage" %)
3834 +(((
3835 +**POST /api/v3/vehicles/export**
3836 +)))
3837 +
3838 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3839 +
3840 +Тело запроса:
3841 +
3842 +[
3843 + id
3844 +]
3845 +
3846 +Ответ: Success 200, получаете файлы с настройками.
3847 +
3848 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3849 +
3850 +(% class="box infomessage" %)
3851 +(((
3852 +**POST /api/v3/vehicles/export/history**
3853 +)))
3854 +
3855 +Метод возвращает список сообщений терминала объекта за выбранный период.
3856 +
3857 +Тело запроса:
3858 +
3859 +{
3860 + "vehicleId": 0,
3861 + "asArchive": true,
3862 + "from": "2023-09-27T12:17:45.973Z",
3863 + "to": "2023-09-27T12:17:45.973Z"
3864 +}
3865 +
3866 +Ответ:
3867 +
3868 +Получаете файл. Сообщение: Code 200/Success
3869 +
3870 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3871 +|vehicleId|ID объекта
3872 +|asArchive|true - Архивировать файл, False - не архивировать
3873 +|from|Дата и время начала запроса
3874 +|to|Дата и время окончания запроса
3875 +
3876 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3877 +
3878 +(% class="box infomessage" %)
3879 +(((
3880 +**GET /api/v3/vehicles/export/history/status**
3881 +)))
3882 +
3883 +Метод возвращает список сообщений терминала объекта за выбранный период.
3884 +
3885 +Ответ:
3886 +
3887 +{
3888 + "activity": true,
3889 + "progress": 0,
3890 + "message": "string"
3891 +}
3892 +
3893 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3894 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3895 +|progress|Прогресс экспорта, от 0 до 100%
3896 +|message|Текст описывающий статус
3897 +
3898 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3899 +
3900 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3901 +
3902 +(% class="box infomessage" %)
3903 +(((
3904 +**POST /api/v3/EcoDriving/rating**
3905 +)))
3906 +
3907 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3908 +
3909 +Тело запроса:
3910 +
3911 +{
3912 + "vehicleIds": [vehicleId],
3913 + "from": "2023-11-22T09:29:48.051Z",
3914 + "to": "2023-11-22T09:29:48.051Z"
3915 +}
3916 +
3917 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3918 +|vehicleIds|Массив ID объектов
3919 +|from|Дата начала запроса
3920 +|to|Дата окончания запроса
3921 +
3922 +Ответ:
3923 +
3924 +{
3925 + "items": [
3926 + {
3927 + "from": "2023-11-22T09:29:48.052Z",
3928 + "to": "2023-11-22T09:29:48.052Z",
3929 + "vehicleId": 0,
3930 + "vehicleName": "string",
3931 + "vehicleModel": "string",
3932 + "penalty": 0,
3933 + "score": 0,
3934 + "totalViolations": 0,
3935 + "violationsByType": {
3936 + "overspeedingViolations": 0,
3937 + "accelerationViolations": 0,
3938 + "brakingViolations": 0,
3939 + "turningViolations": 0,
3940 + "dangerousDrivingViolations": 0,
3941 + "sensorViolations": 0
3942 + },
3943 + "moveTime": 0,
3944 + "mileage": 0,
3945 + "tripsCount": 0,
3946 + "trips": [
3947 + {
3948 + "penalty": 0,
3949 + "score": 0,
3950 + "violationsCount": 0,
3951 + "violationsByType": {
3952 + "overspeedingViolations": 0,
3953 + "accelerationViolations": 0,
3954 + "brakingViolations": 0,
3955 + "turningViolations": 0,
3956 + "dangerousDrivingViolations": 0,
3957 + "sensorViolations": 0
3958 + },
3959 + "moveTime": 0,
3960 + "mileage": 0,
3961 + "motohours": 0,
3962 + "maxSpeed": 0,
3963 + "startAddress": "string",
3964 + "endAddress": "string",
3965 + "drivers": [
3966 + {
3967 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3968 + "driverName": "string",
3969 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3970 + }
3971 + ]
3972 + }
3973 + ]
3974 + }
3975 + ]
3976 +}
3977 +
3978 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3979 +|from|Дата начала запроса
3980 +|to|Дата  окончания
3981 +|vehicleId|ID объекта
3982 +|vehicleName|Имя объекта
3983 +|vehicleModel|Модель объекта
3984 +|penalty|Сумма штрафных баллов
3985 +|score|Оценка
3986 +|totalViolations|Суммарное количество нарушений
3987 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3988 +|overspeedingViolations|Превышение скорости
3989 +|accelerationViolations|Ускорение
3990 +|brakingViolations|Торможение
3991 +|turningViolations|Резкий поворот
3992 +|dangerousDrivingViolations|Резкое вождение
3993 +|sensorViolations|Нарушение по датчику
3994 +|moveTime|Время в движении
3995 +|mileage|Пробег
3996 +|tripsCount|Количество рейсов
3997 +|motohours|Моточасы
3998 +|maxSpeed|Максимальная скорость
3999 +|startAddress|Адрес начала рейса
4000 +|endAddress|Адрес окончания рейса
4001 +|drivers|Список водителей, которые были на объекте в течениии рейса
4002 +|driverGuid|Guid водителя
4003 +|driverName|Имя водителя
4004 +|driverRfid|Номер Карты-метки
4005 +
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 г.