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