Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 119.2 >
edited by Илья Крайнов
on 2023/11/24 15:58
To version < 109.1 >
edited by Илья Крайнов
on 2023/10/17 11:01
>
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,
... ... @@ -775,7 +775,7 @@
775 775   "deleted": true
776 776  }
777 777  
778 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
723 +|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание
779 779  |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
780 780  |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
781 781  |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
... ... @@ -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 клиента, которому принадлежит модель объекта
... ... @@ -805,9 +805,10 @@
805 805  
806 806  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
807 807  
808 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
754 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
809 809  
810 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
756 +(% style="color:#000000" %){
757 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
811 811  }
812 812  
813 813  (% style="color:#000000" %)Ответ:
... ... @@ -822,13 +822,6 @@
822 822   }
823 823  ]
824 824  
825 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
826 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
827 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
828 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
829 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
830 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
831 -
832 832  == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
833 833  
834 834  (% class="box successmessage" %)
... ... @@ -876,25 +876,12 @@
876 876   "maxspeed": 0,
877 877   "width": 0,
878 878   "imbeddedtrailer": true,
819 + "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 -
898 898  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
899 899  
900 900  (% class="box warningmessage" %)
... ... @@ -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  
1837 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1838 +
1839 +(% class="box infomessage" %)
1840 +(((
1841 +**POST /api/v3/vehicles/export/history**
1842 +)))
1843 +
1844 +Метод возвращает список сообщений терминала объекта за выбранный период.
1845 +
1846 +(% style="text-align: left;" %)
1847 +Метод запроса **POST**
1848 +
1849 +(% style="text-align: left;" %)
1850 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1851 +
1852 +(% style="text-align: left;" %)
1853 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1854 +
1855 +{
1856 + "vehicleId": 0, ~/~/ ID объекта
1857 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1858 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1859 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1860 +}
1861 +
1862 +Ответ:
1863 +
1864 +Получаете файл. Сообщение: Code 200/Success
1865 +
1866 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1867 +
1868 +(% class="box infomessage" %)
1869 +(((
1870 +**GET /api/v3/vehicles/export/history/status**
1871 +)))
1872 +
1873 +Метод возвращает список сообщений терминала объекта за выбранный период.
1874 +
1875 +(% style="text-align: left;" %)
1876 +Метод запроса **GET**
1877 +
1878 +(% style="text-align: left;" %)
1879 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1880 +
1881 +(% style="text-align: left;" %)
1882 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1883 +
1884 +Ответ:
1885 +
1886 +{
1887 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1888 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1889 + "message": "string" ~/~/ текст описывающий статус.
1890 +}
1891 +
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" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3050,18 +3050,13 @@
3050 3050   {
3051 3051   "name": "string",
3052 3052   "number": 0,
3053 - "period": 0,
2944 + "period": 0, ~/~/ Частота трансляции радиометки
3054 3054   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3055 3055   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2947 + "deleted": true
3056 3056   }
3057 3057  ]
3058 3058  
3059 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3060 -|parentId|ID клиента
3061 -|name|Название карты-метки
3062 -|number|Номер
3063 -|period|Период запросов в секундах (работает только для агрегатов)
3064 -|id|ID карты-метки
3065 3065  
3066 3066  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3067 3067  
... ... @@ -3078,18 +3078,13 @@
3078 3078   {
3079 3079   "name": "string",
3080 3080   "number": 0,
3081 - "period": 0,
2967 + "period": 0, ~/~/ Частота трансляции радиометки
3082 3082   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 3083   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2970 + "deleted": true
3084 3084   }
3085 3085  ]
3086 3086  
3087 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3088 -|name|Название карты-метки
3089 -|number|Номер
3090 -|period|Период запросов в секундах (работает только для агрегатов)
3091 -|id|ID карты-метки
3092 -|parentId|ID клиента
3093 3093  
3094 3094  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3095 3095  
... ... @@ -3105,6 +3105,7 @@
3105 3105   "number": 0,
3106 3106   "period": 0,
3107 3107   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2989 + "deleted": true
3108 3108  }
3109 3109  
3110 3110  Ответ:
... ... @@ -3115,14 +3115,9 @@
3115 3115   "period": 0,
3116 3116   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3117 3117   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3000 + "deleted": true
3118 3118  }
3119 3119  
3120 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3121 -|name|Название карты-метки
3122 -|number|Номер
3123 -|period|Период запросов в секундах (работает только для агрегатов)
3124 -|id|ID карты-метки
3125 -|parentId|ID клиента
3126 3126  
3127 3127  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3128 3128  
... ... @@ -3139,6 +3139,7 @@
3139 3139   "period": 0,
3140 3140   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3141 3141   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3019 + "deleted": true
3142 3142  }
3143 3143  
3144 3144  Ответ:
... ... @@ -3149,14 +3149,9 @@
3149 3149   "period": 0,
3150 3150   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 3151   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3030 + "deleted": true
3152 3152  }
3153 3153  
3154 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3155 -|name|Название карты-метки
3156 -|number|Номер
3157 -|period|Период запросов в секундах (работает только для агрегатов)
3158 -|id|ID карты-метки
3159 -|parentId|ID клиента
3160 3160  
3161 3161  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3162 3162  
... ... @@ -3165,7 +3165,7 @@
3165 3165  **DELETE /api/v3/Rfids/{rfidGuid}**
3166 3166  )))
3167 3167  
3168 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3041 +Передаем параметр rfidGuid - идентификатор карты-метки
3169 3169  
3170 3170  Ответ:
3171 3171  
... ... @@ -3172,537 +3172,6 @@
3172 3172  Success
3173 3173  
3174 3174  
3175 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3176 -
3177 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3178 -
3179 -(% class="box infomessage" %)
3180 -(((
3181 -**GET /api/v3/Billing/client/balance/{clientId}**
3182 -)))
3183 -
3184 -Параметр запроса: **clientId **- идентификатор клиента.
3185 -
3186 -Ответ:
3187 -
3188 -{
3189 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3190 - "Balance": 0
3191 -}
3192 -
3193 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3194 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3195 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3196 -
3197 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3198 -
3199 -(% class="box infomessage" %)
3200 -(((
3201 -**GET /api/v3/Billing/client/constraint/{clientId}**
3202 -)))
3203 -
3204 -Параметр запроса: **clientId **- идентификатор клиента.
3205 -
3206 -Ответ:
3207 -
3208 -{
3209 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3210 - "CalculationType": 0,
3211 - "PermissibleBalance": 0,
3212 - "DefermentDays": 0,
3213 - "SendUiNotifications": true,
3214 - "SendEmailNotifications": true,
3215 - "IsPrivate": true,
3216 -}
3217 -
3218 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3219 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3220 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3221 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3222 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3223 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3224 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3225 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3226 -
3227 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3228 -
3229 -(% class="box infomessage" %)
3230 -(((
3231 -**GET /api/v3/Billing/client/plan/{clientId}**
3232 -)))
3233 -
3234 -Параметры запроса:
3235 -
3236 -**clientId **- идентификатор клиента.
3237 -
3238 -**planId **- идентификатор тарифного плана.
3239 -
3240 -Ответ:
3241 -
3242 -{
3243 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3244 - "Plan": { **~/~/ Описание тарифного плана**
3245 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3246 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3247 - "Name": "string",
3248 - "IsArchived": true,
3249 - "Constraint": {
3250 - "CalculationType": 0,
3251 - "PermissibleBalance": 0,
3252 - "DefermentDays": 0
3253 - },
3254 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3255 - {
3256 - "Feature": "string",
3257 - "IsFactual": true,
3258 - "Limit": 0,
3259 - "Price": 0,
3260 - "PeriodValue": 0,
3261 - "PeriodType": 0
3262 - }
3263 - ]
3264 - },
3265 - "DebitDate": "2023-10-18T12:46:24.213Z",
3266 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3267 - {
3268 - "Feature": "string",
3269 - "IsEnabled": true,
3270 - "IsPrivate": true,
3271 - "IsFactual": true,
3272 - "Limit": 0,
3273 - "Price": 0,
3274 - "DebitDate": "2023-10-18T12:46:24.213Z",
3275 - "PeriodValue": 0,
3276 - "PeriodType": 0
3277 - }
3278 - ]
3279 -}
3280 -
3281 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3282 -|ClientId|Идентификатор клиента
3283 -|Id|Идентификатор тарифного плана
3284 -|OwnerId|Идентификатор клиента-владельца
3285 -|Name|Наименование тарифного плана
3286 -|IsArchived|Признак, определяющий архивный тарифный план
3287 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3288 -|PermissibleBalance|Допустимый баланс
3289 -|DefermentDays|Отсрочка, количество дней
3290 -|Feature|Код услуги
3291 -|IsEnabled|Признак, определяющий активирована ли услуга
3292 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3293 -|IsFactual|Признак, определяющий расчёт по факту
3294 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3295 -|Price|Цена за единицу.
3296 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3297 -|PeriodValue|Значение периода.
3298 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3299 -
3300 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3301 -
3302 -(% class="box infomessage" %)
3303 -(((
3304 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3305 -)))
3306 -
3307 -Параметр запроса: **clientId **- идентификатор клиента.
3308 -
3309 -Ответ:
3310 -
3311 -[
3312 - {
3313 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3314 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3315 - "Name": "string",
3316 - "IsArchived": true,
3317 - "Constraint": {
3318 - "CalculationType": 0,
3319 - "PermissibleBalance": 0,
3320 - "DefermentDays": 0
3321 - },
3322 - "Features": [
3323 - {
3324 - "Feature": "string",
3325 - "IsFactual": true,
3326 - "Limit": 0,
3327 - "Price": 0,
3328 - "PeriodValue": 0,
3329 - "PeriodType": 0
3330 - }
3331 - ]
3332 - }
3333 -]
3334 -
3335 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3336 -|ClientId|Идентификатор клиента
3337 -|Id|Идентификатор тарифного плана
3338 -|OwnerId|Идентификатор клиента-владельца
3339 -|Name|Наименование тарифного плана
3340 -|IsArchived|Признак, определяющий архивный тарифный план
3341 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3342 -|PermissibleBalance|Допустимый баланс
3343 -|DefermentDays|Отсрочка, количество дней
3344 -|Feature|Код услуги
3345 -|IsFactual|Признак, определяющий расчёт по факту
3346 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3347 -|Price|Цена за единицу.
3348 -|PeriodValue|Значение периода.
3349 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3350 -
3351 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3352 -
3353 -(% class="box infomessage" %)
3354 -(((
3355 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3356 -)))
3357 -
3358 -Параметр запроса: **clientId **- идентификатор клиента.
3359 -
3360 -Ответ:
3361 -
3362 -[
3363 - {
3364 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3365 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3366 - "Name": "string",
3367 - "IsArchived": true,
3368 - "Constraint": {
3369 - "CalculationType": 0,
3370 - "PermissibleBalance": 0,
3371 - "DefermentDays": 0
3372 - },
3373 - "Features": [
3374 - {
3375 - "Feature": "string",
3376 - "IsFactual": true,
3377 - "Limit": 0,
3378 - "Price": 0,
3379 - "PeriodValue": 0,
3380 - "PeriodType": 0
3381 - }
3382 - ]
3383 - }
3384 -]
3385 -
3386 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3387 -|ClientId|Идентификатор клиента
3388 -|Id|Идентификатор тарифного плана
3389 -|OwnerId|Идентификатор клиента-владельца
3390 -|Name|Наименование тарифного плана
3391 -|IsArchived|Признак, определяющий архивный тарифный план
3392 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3393 -|PermissibleBalance|Допустимый баланс
3394 -|DefermentDays|Отсрочка, количество дней
3395 -|Feature|Код услуги
3396 -|IsFactual|Признак, определяющий расчёт по факту
3397 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3398 -|Price|Цена за единицу.
3399 -|PeriodValue|Значение периода.
3400 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3401 -
3402 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3403 -
3404 -(% class="box warningmessage" %)
3405 -(((
3406 -**PUT /api/v3/Billing/client/balance**
3407 -)))
3408 -
3409 -Тело запроса:
3410 -
3411 -{
3412 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 - "Balance": 0
3414 -}
3415 -
3416 -Ответ: Success
3417 -
3418 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3419 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3420 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3421 -
3422 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3423 -
3424 -(% class="box warningmessage" %)
3425 -(((
3426 -**PUT /api/v3/Billing/client/constraint**
3427 -)))
3428 -
3429 -Тело запроса:
3430 -
3431 -{
3432 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3433 - "CalculationType": 0,
3434 - "PermissibleBalance": 0,
3435 - "DefermentDays": 0,
3436 - "SendUiNotifications": true,
3437 - "SendEmailNotifications": true,
3438 - "IsPrivate": true,
3439 -}
3440 -
3441 -Ответ: Success
3442 -
3443 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3444 -|ClientId|Идентификатор клиента
3445 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3446 -|PermissibleBalance|Допустимый баланс
3447 -|DefermentDays|(((
3448 -Отсрочка, количество дней
3449 -)))
3450 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3451 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3452 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3453 -
3454 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3455 -
3456 -(% class="box warningmessage" %)
3457 -(((
3458 -**PUT /api/v3/Billing/client/plan**
3459 -)))
3460 -
3461 -Тело запроса:
3462 -
3463 -{
3464 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3466 - "Features": [
3467 - {
3468 - "Feature": "string",
3469 - "IsEnabled": true,
3470 - "IsFactual": true,
3471 - "Limit": 0,
3472 - "Price": 0,
3473 - "DebitDate": "2023-10-18T13:26:58.987Z",
3474 - "PeriodValue": 0,
3475 - "PeriodType": 0
3476 - }
3477 - ]
3478 -}
3479 -
3480 -Ответ: Success
3481 -
3482 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3483 -|ClientId|Идентификатор клиента
3484 -|PlanId|Идентификатор тарифного плана
3485 -|Feature|Код услуги
3486 -|IsEnabled|Признак, определяющий активирована ли услуга
3487 -|IsFactual|Признак, определяющий расчёт по факту
3488 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3489 -|Price|Цена за единицу.
3490 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3491 -|PeriodValue|Значение периода.
3492 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3493 -
3494 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3495 -
3496 -(% class="box warningmessage" %)
3497 -(((
3498 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3499 -)))
3500 -
3501 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3502 -
3503 -(% class="box infomessage" %)
3504 -(((
3505 -**POST /api/v3/vehicles/import/{agentId}**
3506 -)))
3507 -
3508 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp **. В формате **xml **экспортируются объекты из нашей системы.
3509 -
3510 -**agentId** - id клиента, указывается в пути запроса. (обязательный)
3511 -
3512 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3513 -
3514 -(% class="box infomessage" %)
3515 -(((
3516 -**POST /api/v3/vehicles/import/history/{vehicleId}**
3517 -)))
3518 -
3519 -(% class="wikigeneratedid" %)
3520 -**vehicleId **- id объекта.
3521 -
3522 -
3523 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3524 -
3525 -(% class="box infomessage" %)
3526 -(((
3527 -**GET /api/v3/vehicles/import/history/status**
3528 -)))
3529 -
3530 -
3531 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3532 -
3533 -(% class="box infomessage" %)
3534 -(((
3535 -**POST /api/v3/vehicles/export**
3536 -)))
3537 -
3538 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3539 -
3540 -Тело запроса:
3541 -
3542 -[
3543 - id
3544 -]
3545 -
3546 -Ответ: Success 200, получаете файлы с настройками.
3547 -
3548 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3549 -
3550 -(% class="box infomessage" %)
3551 -(((
3552 -**POST /api/v3/vehicles/export/history**
3553 -)))
3554 -
3555 -Метод возвращает список сообщений терминала объекта за выбранный период.
3556 -
3557 -Тело запроса:
3558 -
3559 -{
3560 - "vehicleId": 0,
3561 - "asArchive": true,
3562 - "from": "2023-09-27T12:17:45.973Z",
3563 - "to": "2023-09-27T12:17:45.973Z"
3564 -}
3565 -
3566 -Ответ:
3567 -
3568 -Получаете файл. Сообщение: Code 200/Success
3569 -
3570 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3571 -|vehicleId|ID объекта
3572 -|asArchive|true - Архивировать файл, False - не архивировать
3573 -|from|Дата и время начала запроса
3574 -|to|Дата и время окончания запроса
3575 -
3576 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3577 -
3578 -(% class="box infomessage" %)
3579 -(((
3580 -**GET /api/v3/vehicles/export/history/status**
3581 -)))
3582 -
3583 -Метод возвращает список сообщений терминала объекта за выбранный период.
3584 -
3585 -Ответ:
3586 -
3587 -{
3588 - "activity": true,
3589 - "progress": 0,
3590 - "message": "string"
3591 -}
3592 -
3593 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3594 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3595 -|progress|Прогресс экспорта, от 0 до 100%
3596 -|message|Текст описывающий статус
3597 -
3598 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3599 -
3600 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3601 -
3602 -(% class="box infomessage" %)
3603 -(((
3604 -**POST /api/v3/EcoDriving/rating**
3605 -)))
3606 -
3607 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3608 -
3609 -Тело запроса:
3610 -
3611 -{
3612 - "vehicleIds": [vehicleId],
3613 - "from": "2023-11-22T09:29:48.051Z",
3614 - "to": "2023-11-22T09:29:48.051Z"
3615 -}
3616 -
3617 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3618 -|vehicleIds|Массив ID объектов
3619 -|from|Дата начала запроса
3620 -|to|Дата окончания запроса
3621 -
3622 -Ответ:
3623 -
3624 -{
3625 - "items": [
3626 - {
3627 - "from": "2023-11-22T09:29:48.052Z",
3628 - "to": "2023-11-22T09:29:48.052Z",
3629 - "vehicleId": 0,
3630 - "vehicleName": "string",
3631 - "vehicleModel": "string",
3632 - "penalty": 0,
3633 - "score": 0,
3634 - "totalViolations": 0,
3635 - "violationsByType": {
3636 - "overspeedingViolations": 0,
3637 - "accelerationViolations": 0,
3638 - "brakingViolations": 0,
3639 - "turningViolations": 0,
3640 - "dangerousDrivingViolations": 0,
3641 - "sensorViolations": 0
3642 - },
3643 - "moveTime": 0,
3644 - "mileage": 0,
3645 - "tripsCount": 0,
3646 - "trips": [
3647 - {
3648 - "penalty": 0,
3649 - "score": 0,
3650 - "violationsCount": 0,
3651 - "violationsByType": {
3652 - "overspeedingViolations": 0,
3653 - "accelerationViolations": 0,
3654 - "brakingViolations": 0,
3655 - "turningViolations": 0,
3656 - "dangerousDrivingViolations": 0,
3657 - "sensorViolations": 0
3658 - },
3659 - "moveTime": 0,
3660 - "mileage": 0,
3661 - "motohours": 0,
3662 - "maxSpeed": 0,
3663 - "startAddress": "string",
3664 - "endAddress": "string",
3665 - "drivers": [
3666 - {
3667 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3668 - "driverName": "string",
3669 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3670 - }
3671 - ]
3672 - }
3673 - ]
3674 - }
3675 - ]
3676 -}
3677 -
3678 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3679 -|from|Дата начала запроса
3680 -|to|Дата  окончания
3681 -|vehicleId|ID объекта
3682 -|vehicleName|Имя объекта
3683 -|vehicleModel|Модель объекта
3684 -|penalty|Сумма штрафных баллов
3685 -|score|Оценка
3686 -|totalViolations|Суммарное количество нарушений
3687 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3688 -|overspeedingViolations|Превышение скорости
3689 -|accelerationViolations|Ускорение
3690 -|brakingViolations|Торможение
3691 -|turningViolations|Резкий поворот
3692 -|dangerousDrivingViolations|Резкое вождение
3693 -|sensorViolations|Нарушение по датчику
3694 -|moveTime|Время в движении
3695 -|mileage|Пробег
3696 -|tripsCount|Количество рейсов
3697 -|motohours|Моточасы
3698 -|maxSpeed|Максимальная скорость
3699 -|startAddress|Адрес начала рейса
3700 -|endAddress|Адрес окончания рейса
3701 -|drivers|Список водителей, которые были на объекте в течениии рейса
3702 -|driverGuid|Guid водителя
3703 -|driverName|Имя водителя
3704 -|driverRfid|Номер Карты-метки
3705 -
3706 3706  (% class="box" lang="en-US" style="text-align: center;" %)
3707 3707  (((
3708 3708  (% 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 г.