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