Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 117.1 >
edited by Илья Крайнов
on 2023/11/22 12:53
To version < 111.1 >
edited by Илья Крайнов
on 2023/10/18 17:09
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
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 successmessage" %)
23 +(% class="box infomessage" %)
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,6 +40,7 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -54,12 +54,6 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
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 -
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -98,51 +98,30 @@
98 98  Запрос должен содержать данные параметра "**agentId**"
99 99  
100 100  (% style="color:#000000" %)Ответ:
96 +А
101 101  {
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"
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" ~/~/ Корр. счет
122 122   }
123 123  
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 -
146 146  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147 147  
148 148  (% class="box infomessage" %)
... ... @@ -156,7 +156,7 @@
156 156  
157 157  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
158 158  
159 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
160 160  
161 161  (% style="color:#000000" %)Метод запроса: **POST**
162 162  
... ... @@ -171,25 +171,15 @@
171 171  (% style="color:#000000" %)Ответ:
172 172  
173 173  {
174 - "agentId": "",(% style="color:#000000" %)   (%%)
175 - "parentId": "",
176 - "parentName": "string",
177 - "name": "string",
178 - "fullName": "string",
179 - "agentInfoType": 0,
180 -(% style="color:#000000" %) "status": "",
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 - Отказ)
181 181  }
182 182  
183 -
184 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
185 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
186 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
188 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
189 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
190 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
191 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
192 -
193 193  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
194 194  
195 195  (% class="box successmessage" %)
... ... @@ -208,7 +208,7 @@
208 208  Параметры в теле запроса (JSON):
209 209  
210 210  {
211 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
212 212   "name": "string", ~/~/ имя
213 213   "fullName": "string", ~/~/ полное наименование
214 214   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -253,28 +253,6 @@
253 253   "bankKS": "string" ~/~/ корр. счёт
254 254  }
255 255  
256 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
257 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
258 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
259 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
260 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
261 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
262 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
263 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
264 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
265 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
266 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
267 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
268 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
269 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
270 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
271 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
272 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
273 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
274 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
275 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
276 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
277 -
278 278  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
279 279  
280 280  (% class="box warningmessage" %)
... ... @@ -290,6 +290,7 @@
290 290  
291 291  В заголовках запроса: X-Auth: Токен авторизации
292 292  
235 +
293 293  Параметры в теле запроса (JSON):
294 294  
295 295  {
... ... @@ -314,6 +314,7 @@
314 314   "bankKS": "string" ~/~/ корр. счёт
315 315  }
316 316  
260 +
317 317  Ответ:
318 318  
319 319  {
... ... @@ -419,6 +419,7 @@
419 419   "password": "string",
420 420   "email": "string",
421 421  
366 +
422 422  (% style="text-align:left" %)
423 423  (% style="color:#000000; font-weight:normal" %)Ответ:
424 424  
... ... @@ -447,7 +447,6 @@
447 447  (% style="text-align:left" %)
448 448  (% style="color:#000000; font-weight:normal" %)}
449 449  
450 -
451 451  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
452 452  
453 453  (% class="box infomessage" %)
... ... @@ -767,6 +767,7 @@
767 767   "maxspeed": 0,
768 768   "width": 0,
769 769   "imbeddedtrailer": true,
714 + "fueloutlay": 0,
770 770   "hoppercapacity": 0,
771 771   "hopperdischargespeed": 0,
772 772   "modelType": 0,
... ... @@ -783,8 +783,9 @@
783 783  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
784 784  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
785 785  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
786 786  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
787 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
788 788  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
789 789  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
790 790  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -876,24 +876,12 @@
876 876   "maxspeed": 0,
877 877   "width": 0,
878 878   "imbeddedtrailer": true,
825 + "fueloutlay": 0,
879 879   "hoppercapacity": 0,
880 880   "hopperdischargespeed": 0,
881 881   "modelType": 0
882 882  }
883 883  
884 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
885 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
886 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
887 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
888 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
889 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
890 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
891 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
892 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
893 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
894 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
895 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
896 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
897 897  
898 898  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
899 899  
... ... @@ -948,20 +948,6 @@
948 948   "modelType": 0
949 949  }
950 950  
951 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
952 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
953 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
954 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
955 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
956 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
957 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
958 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
959 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
960 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
961 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
962 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
963 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
964 -
965 965  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
966 966  
967 967  (% class="box errormessage" %)
... ... @@ -1921,6 +1921,61 @@
1921 1921   }
1922 1922  ]
1923 1923  
1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1845 +
1846 +(% class="box infomessage" %)
1847 +(((
1848 +**POST /api/v3/vehicles/export/history**
1849 +)))
1850 +
1851 +Метод возвращает список сообщений терминала объекта за выбранный период.
1852 +
1853 +(% style="text-align: left;" %)
1854 +Метод запроса **POST**
1855 +
1856 +(% style="text-align: left;" %)
1857 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1858 +
1859 +(% style="text-align: left;" %)
1860 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1861 +
1862 +{
1863 + "vehicleId": 0, ~/~/ ID объекта
1864 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1865 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1866 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1867 +}
1868 +
1869 +Ответ:
1870 +
1871 +Получаете файл. Сообщение: Code 200/Success
1872 +
1873 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1874 +
1875 +(% class="box infomessage" %)
1876 +(((
1877 +**GET /api/v3/vehicles/export/history/status**
1878 +)))
1879 +
1880 +Метод возвращает список сообщений терминала объекта за выбранный период.
1881 +
1882 +(% style="text-align: left;" %)
1883 +Метод запроса **GET**
1884 +
1885 +(% style="text-align: left;" %)
1886 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1887 +
1888 +(% style="text-align: left;" %)
1889 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1890 +
1891 +Ответ:
1892 +
1893 +{
1894 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1895 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1896 + "message": "string" ~/~/ текст описывающий статус.
1897 +}
1898 +
1924 1924  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1925 1925  
1926 1926  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2952,83 +2952,6 @@
2952 2952  Success
2953 2953  
2954 2954  
2955 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
2956 -
2957 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
2958 -
2959 -(% class="box infomessage" %)
2960 -(((
2961 -**POST /api/v3/Trailers**
2962 -)))
2963 -
2964 -Пример запроса:
2965 -
2966 -{
2967 - "startDate": "2023-11-14T10:48:03.671Z",
2968 - "endDate": "2023-11-14T10:48:03.671Z",
2969 - "ids": [ 0 ],
2970 - "timezone": 0
2971 -}
2972 -
2973 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2974 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
2975 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
2976 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
2977 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
2978 -
2979 -Пример ответа:
2980 -
2981 -[
2982 - {
2983 - "SD": "2023-11-14T10:48:03.717Z",
2984 - "ED": "2023-11-14T10:48:03.717Z", 
2985 - "id": 0,
2986 - "SLat": 0,
2987 - "SLon": 0,
2988 - "ELat": 0,
2989 - "ELon": 0,
2990 - "mileage": 0
2991 - "Duration": 0
2992 - "Address": "string",
2993 - "Address2": "string",
2994 - "name": "string",
2995 - "rid": "string",
2996 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2997 - "trailer": {
2998 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2999 - "Number": "string",
3000 - "Description": "string",
3001 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3002 - "ExternalID": "string",
3003 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3004 - "CreateTime": "2023-11-14T10:48:03.717Z",
3005 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3006 - "IsDeleted": true
3007 - },
3008 - "filesCount": 0,
3009 - }
3010 -]
3011 -
3012 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3013 -|SD|Дата и время начала события
3014 -|ED|Дата и время окончания события
3015 -|id|ID объекта
3016 -|SLat|Широта начальной координаты
3017 -|SLon|Долгота начальной координаты
3018 -|ELat|Широта конечной координаты
3019 -|ELon|Долгота конечной координаты
3020 -|mileage|Пробег
3021 -|Duration|Продолжительность
3022 -|Address|Адрес начального местоположения
3023 -|Address2|Адрес конечного местоположения
3024 -|name|Имя радиометки
3025 -|rid|Номер радиометки
3026 -|rguid|ID радиометки
3027 -|trailer|Информация об агрегате
3028 -|ModelGuid|ID агрегата
3029 -|Number|Название/номер агрегата
3030 -|Description|Текст примечания агрегата
3031 -
3032 3032  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3033 3033  
3034 3034  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3079,6 +3079,7 @@
3079 3079   }
3080 3080  ]
3081 3081  
2980 +
3082 3082  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3083 3083  
3084 3084  (% class="box successmessage" %)
... ... @@ -3143,7 +3143,7 @@
3143 3143  **DELETE /api/v3/Rfids/{rfidGuid}**
3144 3144  )))
3145 3145  
3146 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3045 +Передаем параметр rfidGuid - идентификатор карты-метки
3147 3147  
3148 3148  Ответ:
3149 3149  
... ... @@ -3459,7 +3459,6 @@
3459 3459  
3460 3460  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3461 3461  |ClientId|Идентификатор клиента
3462 -|PlanId|Идентификатор тарифного плана
3463 3463  |Feature|Код услуги
3464 3464  |IsEnabled|Признак, определяющий активирована ли услуга
3465 3465  |IsFactual|Признак, определяющий расчёт по факту
... ... @@ -3469,217 +3469,6 @@
3469 3469  |PeriodValue|Значение периода.
3470 3470  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3471 3471  
3472 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3473 -
3474 -(% class="wikigeneratedid" %)
3475 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3476 -
3477 -(% class="box infomessage" %)
3478 -(((
3479 -**POST /api/v3/vehicles/import/{agentId}**
3480 -)))
3481 -
3482 -**agentId** - id клиента.
3483 -
3484 -
3485 -(% class="wikigeneratedid" %)
3486 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3487 -
3488 -(% class="box infomessage" %)
3489 -(((
3490 -**POST /api/v3/vehicles/import/history/{vehicleId}**
3491 -)))
3492 -
3493 -(% class="wikigeneratedid" %)
3494 -**vehicleId **- id объекта.
3495 -
3496 -
3497 -(% class="wikigeneratedid" %)
3498 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3499 -
3500 -(% class="box infomessage" %)
3501 -(((
3502 -**GET /api/v3/vehicles/import/history/status**
3503 -)))
3504 -
3505 -
3506 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3507 -
3508 -(% class="box infomessage" %)
3509 -(((
3510 -**POST /api/v3/vehicles/export**
3511 -)))
3512 -
3513 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3514 -
3515 -Тело запроса:
3516 -
3517 -[
3518 - id
3519 -]
3520 -
3521 -Ответ: Success 200, получаете файлы с настройками.
3522 -
3523 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3524 -
3525 -(% class="box infomessage" %)
3526 -(((
3527 -**POST /api/v3/vehicles/export/history**
3528 -)))
3529 -
3530 -Метод возвращает список сообщений терминала объекта за выбранный период.
3531 -
3532 -Тело запроса:
3533 -
3534 -{
3535 - "vehicleId": 0,
3536 - "asArchive": true,
3537 - "from": "2023-09-27T12:17:45.973Z",
3538 - "to": "2023-09-27T12:17:45.973Z"
3539 -}
3540 -
3541 -Ответ:
3542 -
3543 -Получаете файл. Сообщение: Code 200/Success
3544 -
3545 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3546 -|vehicleId|ID объекта
3547 -|asArchive|true - Архивировать файл, False - не архивировать
3548 -|from|Дата и время начала запроса
3549 -|to|Дата и время окончания запроса
3550 -
3551 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3552 -
3553 -(% class="box infomessage" %)
3554 -(((
3555 -**GET /api/v3/vehicles/export/history/status**
3556 -)))
3557 -
3558 -Метод возвращает список сообщений терминала объекта за выбранный период.
3559 -
3560 -Ответ:
3561 -
3562 -{
3563 - "activity": true,
3564 - "progress": 0,
3565 - "message": "string"
3566 -}
3567 -
3568 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3569 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3570 -|progress|Прогресс экспорта, от 0 до 100%
3571 -|message|Текст описывающий статус
3572 -
3573 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3574 -
3575 -(% class="wikigeneratedid" %)
3576 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3577 -
3578 -(% class="box infomessage" %)
3579 -(((
3580 -**POST /api/v3/EcoDriving/rating**
3581 -)))
3582 -
3583 -Позволяет получить список нарушений массива объектов объектов за выбранный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3584 -
3585 -Тело запроса:
3586 -
3587 -{
3588 - "vehicleIds": [vehicleId],
3589 - "from": "2023-11-22T09:29:48.051Z",
3590 - "to": "2023-11-22T09:29:48.051Z"
3591 -}
3592 -
3593 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3594 -|vehicleIds|Массив ID объектов
3595 -|from|Дата начала запроса
3596 -|to|Дата окончания запроса
3597 -
3598 -Ответ:
3599 -
3600 -{
3601 - "items": [
3602 - {
3603 - "from": "2023-11-22T09:29:48.052Z",
3604 - "to": "2023-11-22T09:29:48.052Z",
3605 - "vehicleId": 0,
3606 - "vehicleName": "string",
3607 - "vehicleModel": "string",
3608 - "penalty": 0,
3609 - "score": 0,
3610 - "totalViolations": 0,
3611 - "violationsByType": {
3612 - "overspeedingViolations": 0,
3613 - "accelerationViolations": 0,
3614 - "brakingViolations": 0,
3615 - "turningViolations": 0,
3616 - "dangerousDrivingViolations": 0,
3617 - "sensorViolations": 0
3618 - },
3619 - "moveTime": 0,
3620 - "mileage": 0,
3621 - "tripsCount": 0,
3622 - "trips": [
3623 - {
3624 - "penalty": 0,
3625 - "score": 0,
3626 - "violationsCount": 0,
3627 - "violationsByType": {
3628 - "overspeedingViolations": 0,
3629 - "accelerationViolations": 0,
3630 - "brakingViolations": 0,
3631 - "turningViolations": 0,
3632 - "dangerousDrivingViolations": 0,
3633 - "sensorViolations": 0
3634 - },
3635 - "moveTime": 0,
3636 - "mileage": 0,
3637 - "motohours": 0,
3638 - "maxSpeed": 0,
3639 - "startAddress": "string",
3640 - "endAddress": "string",
3641 - "drivers": [
3642 - {
3643 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3644 - "driverName": "string",
3645 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3646 - }
3647 - ]
3648 - }
3649 - ]
3650 - }
3651 - ]
3652 -}
3653 -
3654 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3655 -|from|Дата начала запроса
3656 -|to|Дата  окончания
3657 -|vehicleId|ID объекта
3658 -|vehicleName|Имя объекта
3659 -|vehicleModel|Модель объекта
3660 -|penalty|Сумма штрафных баллов
3661 -|score|Оценка
3662 -|totalViolations|Суммарное количество нарушений
3663 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3664 -|overspeedingViolations|Превышение скорости
3665 -|accelerationViolations|Ускорение
3666 -|brakingViolations|Торможение
3667 -|turningViolations|Резкий поворот
3668 -|dangerousDrivingViolations|Резкое вождение
3669 -|sensorViolations|Нарушение по датчику
3670 -|moveTime|Время в движении
3671 -|mileage|Пробег
3672 -|tripsCount|Количество рейсов
3673 -|motohours|Моточасы
3674 -|maxSpeed|Максимальная скорость
3675 -|startAddress|Адрес начала рейса
3676 -|endAddress|Адрес окончания рейса
3677 -|drivers|Список водителей, которые были на объекте в течениии рейса
3678 -|driverGuid|Guid водителя
3679 -|driverName|Имя водителя
3680 -|driverRfid|Номер Карты-метки
3681 -
3682 -
3683 3683  (% class="box" lang="en-US" style="text-align: center;" %)
3684 3684  (((
3685 3685  (% 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,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

ГЛОНАССSoft wiki - 2024 г.