Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 113.1 >
edited by Илья Крайнов
on 2023/10/20 12:44
To version < 151.1 >
edited by Андрей Калиновский
on 2024/03/26 10:45
>
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,15 @@
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 +
63 +(% class="wikigeneratedid" %)
64 +Для сквозной (/бесшовной) авторизации добавьте токен в ссылку, чтобы попасть сразу в клиент: [[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]
65 +
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" ~/~/ Корр. счет
105 + "agentId": "",  (%%)
106 + "parentId": "",
107 + "parentName": "string",
108 + "name": "string",
109 + "fullName": "string",
110 + "agentInfoType": 0,
111 + "isForeign": true/false,
112 + "district": "string", 
113 + "region": "string",
114 + "city": "string",
115 + "inn": "string",
116 + "kpp": "string",
117 + "address": "string",
118 + "addressFact": "string",
119 + "email": "string",
120 + "director": "string",
121 + "bankName": "string",
122 + "bankBIK": "string",
123 + "bankRS": "string",
124 + "bankKS": "string"
118 118   }
119 119  
127 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
128 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
129 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
130 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
131 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
132 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
133 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
134 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
135 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
136 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
137 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
138 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
139 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
140 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
141 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
142 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
143 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
144 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
145 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
146 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
147 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
148 +
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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
162 +(% 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 - Отказ)
177 + "agentId": "",(% style="color:#000000" %)   (%%)
178 + "parentId": "",
179 + "name": "string",
180 + "fullName": "string",
181 + "agentInfoType": 0,
182 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
185 +
186 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
187 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
188 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
189 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
190 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
191 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
192 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
193 +
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", ~/~/ идентификатор клиента-родителя 
212 + "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  
257 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
258 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
259 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
260 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
261 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
262 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
263 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
264 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
265 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
266 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
267 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
268 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
269 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
270 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
271 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
272 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
273 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
274 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
275 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
276 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
277 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
278 +
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  
360 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
361 +
362 +(% class="box warningmessage" %)
363 +(((
364 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 +)))
366 +
367 +Метод позволяет изменить статус клиента, указанного в запросе.
368 +
369 +В пути указывается GUID клиента и статус клиента.
370 +
371 +**status **- значение 0 - заблокирован, 1 - активен.
372 +
373 +Ответ: Code 204
374 +
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  
466 +
395 395  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 396  
397 397  (% class="box infomessage" %)
... ... @@ -711,7 +711,6 @@
711 711   "maxspeed": 0,
712 712   "width": 0,
713 713   "imbeddedtrailer": true,
714 - "fueloutlay": 0,
715 715   "hoppercapacity": 0,
716 716   "hopperdischargespeed": 0,
717 717   "modelType": 0,
... ... @@ -728,9 +728,8 @@
728 728  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
729 729  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
730 730  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
732 732  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
803 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
734 734  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
735 735  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
736 736  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -822,12 +822,24 @@
822 822   "maxspeed": 0,
823 823   "width": 0,
824 824   "imbeddedtrailer": true,
825 - "fueloutlay": 0,
826 826   "hoppercapacity": 0,
827 827   "hopperdischargespeed": 0,
828 828   "modelType": 0
829 829  }
830 830  
900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
901 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
903 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
904 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
905 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
906 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
907 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
908 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
909 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
910 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
911 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
912 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
831 831  
832 832  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
833 833  
... ... @@ -882,6 +882,20 @@
882 882   "modelType": 0
883 883  }
884 884  
967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
968 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
970 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
971 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
972 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
973 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
974 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
975 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
976 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
977 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
978 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
979 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
980 +
885 885  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
886 886  
887 887  (% class="box errormessage" %)
... ... @@ -1709,7 +1709,7 @@
1709 1709  
1710 1710  (% style="color:#000000" %)Метод запроса: **GET**
1711 1711  
1712 -(% 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]]
1808 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1713 1713  
1714 1714  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1715 1715  
... ... @@ -1792,6 +1792,56 @@
1792 1792   }
1793 1793  ]
1794 1794  
1891 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1892 +
1893 +(% class="box infomessage" style="text-align: left;" %)
1894 +(((
1895 +**POST /api/v3/terminalMessages/mapping**
1896 +)))
1897 +
1898 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1899 +
1900 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1901 +
1902 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1903 +
1904 +{
1905 + "protocolType": 0,
1906 + "params": ["string"]
1907 +}
1908 +
1909 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1910 +|protocolType|ID типа протокола
1911 +|params|(((
1912 +Массив наименований параметров в сообщении
1913 +)))
1914 +
1915 +Ответ:
1916 +
1917 +{
1918 + "protocolType": 0,
1919 + "mapping": {
1920 + "additionalProp1": {
1921 + "inputType": 0,
1922 + "inputNumber": 0
1923 + },
1924 + "additionalProp2": {
1925 + "inputType": 0,
1926 + "inputNumber": 0
1927 + }
1928 + }
1929 +}
1930 +
1931 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1932 +|protocolType|Тип протокола
1933 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1934 +|inputNumber|(((
1935 +Номер входа
1936 +)))
1937 +
1938 +(% class="wikigeneratedid" %)
1939 +Перечень 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/]]
1940 +
1795 1795  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1796 1796  
1797 1797  (% class="box infomessage" %)
... ... @@ -1816,6 +1816,11 @@
1816 1816   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1817 1817  }
1818 1818  
1965 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1966 +|vehicleId|ID объекта
1967 +|from|Дата и время начала периода запроса
1968 +|to|Дата и время окончания периода запроса
1969 +
1819 1819  Ответ:
1820 1820  
1821 1821  [
... ... @@ -1822,80 +1822,43 @@
1822 1822   {
1823 1823   "messages": [
1824 1824   {
1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1827 - "speed": 0, ~/~/ Скорость, км/ч
1828 - "altitude": 0, ~/~/ Высота, м
1829 - "latitude": 0, ~/~/ Широта [-90°;90°]
1830 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1831 - "satellites": 0, ~/~/ Кол-во спутников
1832 - "voltage": 0, ~/~/ Напряжение
1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1976 + "deviceTime": "2023-11-29T07:40:44.052Z",
1977 + "serverTime": "2023-11-29T07:40:44.052Z",
1978 + "speed": 0,
1979 + "altitude": 0,
1980 + "latitude": 0,
1981 + "longitude": 0,
1982 + "satellites": 0,
1983 + "course": 0,
1984 + "voltage": 0,
1985 + "parameters": {
1834 1834   "additionalProp1": "string",
1835 1835   "additionalProp2": "string",
1836 1836   "additionalProp3": "string"
1837 1837   },
1838 - "photoCount": 0 ~/~/ Кол-во фото
1990 + "photoCount": 0,
1991 + "lbsCorrectedCoords": true,
1992 + "protocolType": 0
1839 1839   }
1840 1840   ]
1841 1841   }
1842 1842  ]
1843 1843  
1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1998 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1999 +|deviceTime|Время сообщения терминала
2000 +|serverTime|Время когда сообщение поступило на сервер
2001 +|speed|Скорость
2002 +|altitude|Высота над уровнем моря
2003 +|latitude|Широта
2004 +|longitude|Долгота
2005 +|satellites|Кол-во спутников
2006 +|course|Курс
2007 +|voltage|Бортовое напряжение
2008 +|parameters|Список параметров и их значений
2009 +|photoCount|Количество фото
2010 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2011 +|protocolType|ID типа протокола
1845 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 -
1899 1899  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1900 1900  
1901 1901  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2029,6 +2029,129 @@
2029 2029   }
2030 2030  ]
2031 2031  
2146 +
2147 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2148 +
2149 +(% class="box infomessage" %)
2150 +(((
2151 +**POST /api/v3/vehicles/moveStop**
2152 +)))
2153 +
2154 +Метод запроса: **POST**
2155 +
2156 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2157 +
2158 +В заголовках запроса: X-Auth: Токен авторизации
2159 +
2160 +
2161 +Тело запроса:
2162 +
2163 +{
2164 +
2165 + "vehicleIds": [ ], ~/~/ Список ID объектов
2166 +
2167 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2168 +
2169 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2170 +
2171 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2172 +
2173 +}
2174 +
2175 +Ответ:
2176 +
2177 +[
2178 +
2179 + {
2180 +
2181 + "vehicleId": 0, ~/~/ ID объекта
2182 +
2183 + "vehicleName": "string", ~/~/ Имя объекта
2184 +
2185 + "moves": [ ~/~/ Событие движения
2186 +
2187 + {
2188 +
2189 + "mileage": 0, ~/~/ Пробег, км
2190 +
2191 + "eventId": 0, ~/~/ Идентификатор события
2192 +
2193 + "eventName": "string", ~/~/ Название события
2194 +
2195 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2196 +
2197 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2198 +
2199 + "duration": 0 ~/~/ Продолжительность события, секунд
2200 +
2201 + }
2202 +
2203 + ],
2204 +
2205 + "stops": [ ~/~/ События стоянок
2206 +
2207 + {
2208 +
2209 + "address": "string", ~/~/ Адрес события
2210 +
2211 + "eventId": 0, ~/~/ Идентификатор события
2212 +
2213 + "eventName": "string", ~/~/ Название события
2214 +
2215 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2216 +
2217 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2218 +
2219 + "duration": 0 ~/~/ Продолжительность события, секунд
2220 +
2221 +
2222 + }
2223 +
2224 + ]
2225 +
2226 + }
2227 +
2228 +]
2229 +
2230 +
2231 +
2232 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2233 +
2234 +(% class="box infomessage" %)
2235 +(((
2236 +**POST /api/v3/vehicles/getlastdata**
2237 +)))
2238 +
2239 +Метод запроса: **POST**
2240 +
2241 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2242 +
2243 +В заголовках запроса: X-Auth: Токен авторизации
2244 +
2245 +
2246 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2247 +
2248 +Ответ:
2249 + {
2250 + "vehicleId": 0, ~/~/Идентификатор объекта.
2251 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2252 + "vehicleNumber": "string",~/~/Номер объекта.
2253 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2254 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2255 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2256 + "speed": 0,~/~/Скорость объекта.
2257 + "course": 0,~/~/Курс движения [0;360]
2258 + "latitude": 0,~/~/Широта [-90°;90°].
2259 + "longitude": 0,~/~/Долгота [-180°;180°].
2260 + "address": "string",~/~/Адрес.
2261 + "geozones": [ ~/~/Сведения по геозонам.
2262 + {
2263 + "id": 0,
2264 + "name": "string"
2265 + }
2266 +
2267 +
2268 +
2032 2032  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2033 2033  
2034 2034  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2927,6 +2927,83 @@
2927 2927  Success
2928 2928  
2929 2929  
3167 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3168 +
3169 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3170 +
3171 +(% class="box infomessage" %)
3172 +(((
3173 +**POST /api/v3/Trailers**
3174 +)))
3175 +
3176 +Пример запроса:
3177 +
3178 +{
3179 + "startDate": "2023-11-14T10:48:03.671Z",
3180 + "endDate": "2023-11-14T10:48:03.671Z",
3181 + "ids": [ 0 ],
3182 + "timezone": 0
3183 +}
3184 +
3185 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3186 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3187 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3188 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3189 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3190 +
3191 +Пример ответа:
3192 +
3193 +[
3194 + {
3195 + "SD": "2023-11-14T10:48:03.717Z",
3196 + "ED": "2023-11-14T10:48:03.717Z", 
3197 + "id": 0,
3198 + "SLat": 0,
3199 + "SLon": 0,
3200 + "ELat": 0,
3201 + "ELon": 0,
3202 + "mileage": 0
3203 + "Duration": 0
3204 + "Address": "string",
3205 + "Address2": "string",
3206 + "name": "string",
3207 + "rid": "string",
3208 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3209 + "trailer": {
3210 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 + "Number": "string",
3212 + "Description": "string",
3213 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3214 + "ExternalID": "string",
3215 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3216 + "CreateTime": "2023-11-14T10:48:03.717Z",
3217 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3218 + "IsDeleted": true
3219 + },
3220 + "filesCount": 0,
3221 + }
3222 +]
3223 +
3224 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3225 +|SD|Дата и время начала события
3226 +|ED|Дата и время окончания события
3227 +|id|ID объекта
3228 +|SLat|Широта начальной координаты
3229 +|SLon|Долгота начальной координаты
3230 +|ELat|Широта конечной координаты
3231 +|ELon|Долгота конечной координаты
3232 +|mileage|Пробег
3233 +|Duration|Продолжительность
3234 +|Address|Адрес начального местоположения
3235 +|Address2|Адрес конечного местоположения
3236 +|name|Имя радиометки
3237 +|rid|Номер радиометки
3238 +|rguid|ID радиометки
3239 +|trailer|Информация об агрегате
3240 +|ModelGuid|ID агрегата
3241 +|Number|Название/номер агрегата
3242 +|Description|Текст примечания агрегата
3243 +
2930 2930  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2931 2931  
2932 2932  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2948,13 +2948,19 @@
2948 2948   {
2949 2949   "name": "string",
2950 2950   "number": 0,
2951 - "period": 0, ~/~/ Частота трансляции радиометки
3265 + "period": 0,
2952 2952   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2953 2953   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2954 - "deleted": true
2955 2955   }
2956 2956  ]
2957 2957  
3271 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3272 +|parentId|ID клиента
3273 +|name|Название карты-метки
3274 +|number|Номер
3275 +|period|Период запросов в секундах (работает только для агрегатов)
3276 +|id|ID карты-метки
3277 +
2958 2958  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2959 2959  
2960 2960  (% class="box infomessage" %)
... ... @@ -2970,13 +2970,18 @@
2970 2970   {
2971 2971   "name": "string",
2972 2972   "number": 0,
2973 - "period": 0, ~/~/ Частота трансляции радиометки
3293 + "period": 0,
2974 2974   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2975 2975   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 - "deleted": true
2977 2977   }
2978 2978  ]
2979 2979  
3299 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3300 +|name|Название карты-метки
3301 +|number|Номер
3302 +|period|Период запросов в секундах (работает только для агрегатов)
3303 +|id|ID карты-метки
3304 +|parentId|ID клиента
2980 2980  
2981 2981  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2982 2982  
... ... @@ -2992,7 +2992,6 @@
2992 2992   "number": 0,
2993 2993   "period": 0,
2994 2994   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2995 - "deleted": true
2996 2996  }
2997 2997  
2998 2998  Ответ:
... ... @@ -3003,9 +3003,15 @@
3003 3003   "period": 0,
3004 3004   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3005 3005   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3006 - "deleted": true
3007 3007  }
3008 3008  
3332 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3333 +|name|Название карты-метки
3334 +|number|Номер
3335 +|period|Период запросов в секундах (работает только для агрегатов)
3336 +|id|ID карты-метки
3337 +|parentId|ID клиента
3338 +
3009 3009  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3010 3010  
3011 3011  (% class="box warningmessage" %)
... ... @@ -3021,7 +3021,6 @@
3021 3021   "period": 0,
3022 3022   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3023 3023   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3024 - "deleted": true
3025 3025  }
3026 3026  
3027 3027  Ответ:
... ... @@ -3032,9 +3032,15 @@
3032 3032   "period": 0,
3033 3033   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3034 3034   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3035 - "deleted": true
3036 3036  }
3037 3037  
3366 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3367 +|name|Название карты-метки
3368 +|number|Номер
3369 +|period|Период запросов в секундах (работает только для агрегатов)
3370 +|id|ID карты-метки
3371 +|parentId|ID клиента
3372 +
3038 3038  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3039 3039  
3040 3040  (% class="box errormessage" %)
... ... @@ -3042,7 +3042,7 @@
3042 3042  **DELETE /api/v3/Rfids/{rfidGuid}**
3043 3043  )))
3044 3044  
3045 -Передаем параметр rfidGuid - идентификатор карты-метки
3380 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3046 3046  
3047 3047  Ответ:
3048 3048  
... ... @@ -3283,6 +3283,8 @@
3283 3283  **PUT /api/v3/Billing/client/balance**
3284 3284  )))
3285 3285  
3621 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3622 +
3286 3286  Тело запроса:
3287 3287  
3288 3288  {
... ... @@ -3296,6 +3296,50 @@
3296 3296  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3297 3297  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3298 3298  
3636 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3637 +
3638 +(% class="box warningmessage" %)
3639 +(((
3640 +**PUT /api/v3/billing/client/balance/deposit**
3641 +)))
3642 +
3643 +Создает операцию **Пополнение **с указанной суммой
3644 +
3645 +Тело запроса:
3646 +
3647 +{
3648 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3649 + "Balance": 0
3650 +}
3651 +
3652 +Ответ: Success
3653 +
3654 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3655 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3656 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3657 +
3658 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3659 +
3660 +Создает операцию **Списание **с указанной суммой
3661 +
3662 +(% class="box warningmessage" %)
3663 +(((
3664 +**PUT /api/v3/billing/client/balance/withdraw**
3665 +)))
3666 +
3667 +Тело запроса:
3668 +
3669 +{
3670 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3671 + "Balance": 0
3672 +}
3673 +
3674 +Ответ: Success
3675 +
3676 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3677 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3678 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3679 +
3299 3299  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3300 3300  
3301 3301  (% class="box warningmessage" %)
... ... @@ -3368,6 +3368,451 @@
3368 3368  |PeriodValue|Значение периода.
3369 3369  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3370 3370  
3752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3753 +
3754 +(% class="box warningmessage" %)
3755 +(((
3756 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3757 +)))
3758 +
3759 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3760 +
3761 +(% class="box infomessage" %)
3762 +(((
3763 +**POST /api/v3/vehicles/import/{agentId}**
3764 +)))
3765 +
3766 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3767 +
3768 +В пути указывается **agentId** - id клиента.
3769 +
3770 +**Заголовок**
3771 +
3772 +**X-Auth: [токен авторизации]**
3773 +
3774 +**Параметры**
3775 +
3776 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3777 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3778 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3779 +
3780 +В теле использовать тип **form-data,** тип значения** file**
3781 +
3782 +**Ключи**
3783 +
3784 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3785 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3786 +|csv|В значении передаем файл датчиков, формат **csv**
3787 +
3788 +Ответ:
3789 +
3790 +{
3791 + "vehicleId": 0,
3792 + "name": "string",
3793 + "errors": ["string"]
3794 +}
3795 +
3796 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3797 +|vehicleId|ID созданного объекта
3798 +|name|Имя созданного объекта
3799 +|errors|Ошибки и их описание
3800 +
3801 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3802 +
3803 +(% class="box infomessage" %)
3804 +(((
3805 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3806 +)))
3807 +
3808 +(% class="wikigeneratedid" %)
3809 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3810 +
3811 +(% class="wikigeneratedid" %)
3812 +В пути указывается **vehicleId **- id объекта.
3813 +
3814 +**Заголовок**
3815 +
3816 +**X-Auth: [токен авторизации]**
3817 +
3818 +В теле использовать тип **form-data.**
3819 +
3820 +Ключи:
3821 +
3822 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3823 +|**history**|В значении передавать файл с историей
3824 +
3825 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3826 +
3827 +Ответ:
3828 +
3829 +{
3830 + "results": [
3831 + {
3832 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3833 + "vehicleId": 0,
3834 + "errors": [
3835 + "string"
3836 + ],
3837 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3838 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3839 + "producedCount": 0,
3840 + "msgCount": 0
3841 + }
3842 + ]
3843 +}
3844 +
3845 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3846 +|results|Результаты импорта в разрезе ТС
3847 +|vehicleGuid|Guid ТС
3848 +|vehicleId|ID ТС
3849 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3850 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3851 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3852 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3853 +|msgCount|Кол-во обработанных сообщений всего
3854 +
3855 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3856 +
3857 +(% class="box infomessage" %)
3858 +(((
3859 +**GET /api/v3/vehicles/import/history/status**
3860 +)))
3861 +
3862 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3863 +
3864 +Ответ:
3865 +
3866 +{
3867 + "activity": true,
3868 + "progress": 0,
3869 + "message": "string"
3870 +}
3871 +
3872 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3873 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3874 +|progress|Guid ТС
3875 +
3876 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3877 +
3878 +(% class="box infomessage" %)
3879 +(((
3880 +**POST /api/v3/vehicles/export**
3881 +)))
3882 +
3883 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3884 +
3885 +Тело запроса:
3886 +
3887 +[
3888 + id
3889 +]
3890 +
3891 +Ответ: Success 200, получаете файлы с настройками.
3892 +
3893 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3894 +
3895 +(% class="box infomessage" %)
3896 +(((
3897 +**POST /api/v3/vehicles/export/history**
3898 +)))
3899 +
3900 +Метод возвращает список сообщений терминала объекта за выбранный период.
3901 +
3902 +Тело запроса:
3903 +
3904 +{
3905 + "vehicleId": 0,
3906 + "asArchive": true,
3907 + "from": "2023-09-27T12:17:45.973Z",
3908 + "to": "2023-09-27T12:17:45.973Z"
3909 +}
3910 +
3911 +Ответ:
3912 +
3913 +Получаете файл. Сообщение: Code 200/Success
3914 +
3915 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3916 +|vehicleId|ID объекта
3917 +|asArchive|true - Архивировать файл, False - не архивировать
3918 +|from|Дата и время начала запроса
3919 +|to|Дата и время окончания запроса
3920 +
3921 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3922 +
3923 +(% class="box infomessage" %)
3924 +(((
3925 +**GET /api/v3/vehicles/export/history/status**
3926 +)))
3927 +
3928 +Метод возвращает список сообщений терминала объекта за выбранный период.
3929 +
3930 +Ответ:
3931 +
3932 +{
3933 + "activity": true,
3934 + "progress": 0,
3935 + "message": "string"
3936 +}
3937 +
3938 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3939 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3940 +|progress|Прогресс экспорта, от 0 до 100%
3941 +|message|Текст описывающий статус
3942 +
3943 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3944 +
3945 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3946 +
3947 +(% class="box infomessage" %)
3948 +(((
3949 +**POST /api/v3/EcoDriving/rating**
3950 +)))
3951 +
3952 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3953 +
3954 +Тело запроса:
3955 +
3956 +{
3957 + "vehicleIds": [vehicleId],
3958 + "from": "2023-11-22T09:29:48.051Z",
3959 + "to": "2023-11-22T09:29:48.051Z"
3960 +}
3961 +
3962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3963 +|vehicleIds|Массив ID объектов
3964 +|from|Дата начала запроса
3965 +|to|Дата окончания запроса
3966 +
3967 +Ответ:
3968 +
3969 +{
3970 + "items": [
3971 + {
3972 + "from": "2023-11-22T09:29:48.052Z",
3973 + "to": "2023-11-22T09:29:48.052Z",
3974 + "vehicleId": 0,
3975 + "vehicleName": "string",
3976 + "vehicleModel": "string",
3977 + "penalty": 0,
3978 + "score": 0,
3979 + "totalViolations": 0,
3980 + "violationsByType": {
3981 + "overspeedingViolations": 0,
3982 + "accelerationViolations": 0,
3983 + "brakingViolations": 0,
3984 + "turningViolations": 0,
3985 + "dangerousDrivingViolations": 0,
3986 + "sensorViolations": 0
3987 + },
3988 + "moveTime": 0,
3989 + "mileage": 0,
3990 + "tripsCount": 0,
3991 + "trips": [
3992 + {
3993 + "penalty": 0,
3994 + "score": 0,
3995 + "violationsCount": 0,
3996 + "violationsByType": {
3997 + "overspeedingViolations": 0,
3998 + "accelerationViolations": 0,
3999 + "brakingViolations": 0,
4000 + "turningViolations": 0,
4001 + "dangerousDrivingViolations": 0,
4002 + "sensorViolations": 0
4003 + },
4004 + "moveTime": 0,
4005 + "mileage": 0,
4006 + "motohours": 0,
4007 + "maxSpeed": 0,
4008 + "startAddress": "string",
4009 + "endAddress": "string",
4010 + "drivers": [
4011 + {
4012 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4013 + "driverName": "string",
4014 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4015 + }
4016 + ]
4017 + }
4018 + ]
4019 + }
4020 + ]
4021 +}
4022 +
4023 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4024 +|from|Дата начала запроса
4025 +|to|Дата  окончания
4026 +|vehicleId|ID объекта
4027 +|vehicleName|Имя объекта
4028 +|vehicleModel|Модель объекта
4029 +|penalty|Сумма штрафных баллов
4030 +|score|Оценка
4031 +|totalViolations|Суммарное количество нарушений
4032 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4033 +|overspeedingViolations|Превышение скорости
4034 +|accelerationViolations|Ускорение
4035 +|brakingViolations|Торможение
4036 +|turningViolations|Резкий поворот
4037 +|dangerousDrivingViolations|Резкое вождение
4038 +|sensorViolations|Нарушение по датчику
4039 +|moveTime|Время в движении
4040 +|mileage|Пробег
4041 +|tripsCount|Количество рейсов
4042 +|motohours|Моточасы
4043 +|maxSpeed|Максимальная скорость
4044 +|startAddress|Адрес начала рейса
4045 +|endAddress|Адрес окончания рейса
4046 +|drivers|Список водителей, которые были на объекте в течениии рейса
4047 +|driverGuid|Guid водителя
4048 +|driverName|Имя водителя
4049 +|driverRfid|Номер Карты-метки
4050 +
4051 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4052 +
4053 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4054 +
4055 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
4056 +
4057 +(% class="box infomessage" %)
4058 +(((
4059 +**POST**/api/v3/fuelcards/transactions
4060 +)))
4061 +
4062 +Запрос должен содержать параметры:
4063 +
4064 +{
4065 +
4066 + "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
4067 +
4068 + "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
4069 +
4070 + "ids": [
4071 +
4072 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
4073 +
4074 + ],
4075 +
4076 + "timezone": 0, ~/~/ Часовой пояс
4077 +
4078 + "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
4079 +
4080 +}
4081 +
4082 +Ответ:
4083 +
4084 + {
4085 +
4086 + "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
4087 +
4088 + " driver ": "string", ~/~/ Имя водителя
4089 +
4090 + "amount": 0, ~/~/ Количество топлива
4091 +
4092 + "amountDut": 0, ~/~/ Количество топлива по ДУТ
4093 +
4094 + "amountDiff": 0, ~/~/ Разница в литрах
4095 +
4096 + "amountDiffPerc": 0, ~/~/ Разница в %
4097 +
4098 + "summa": 0, ~/~/  Стоимость в руб.
4099 +
4100 + "serviceName": "string", ~/~/ Тип топлива
4101 +
4102 + "price": 0, ~/~/ Цена за литр в руб.
4103 +
4104 + "cardName": "string", ~/~/ Наименование ТК
4105 +
4106 + "cardNum": "string", ~/~/ Номер ТК
4107 +
4108 + "operator": "string", ~/~/ Оператор ТК
4109 +
4110 + "address": "string", ~/~/ Адрес АЗС
4111 +
4112 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
4113 +
4114 + }
4115 +
4116 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4117 +
4118 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4119 +
4120 +
4121 +(% class="box infomessage" %)
4122 +(((
4123 +GET api/v3/Vehicles/recyclebin/all
4124 +)))
4125 +
4126 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4127 +
4128 +Параметр запроса: {parentId} - идентификатор агента
4129 +
4130 +В заголовках запроса: X-Auth: Токен авторизации
4131 +
4132 +Ответ:
4133 +
4134 +"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
4135 +"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
4136 +"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
4137 +"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
4138 +"objectType": "Vehicle", - Тип объекта
4139 +"details": {
4140 +"items": [ {
4141 +"name": "ObjectName", - наименование столбца
4142 +"value": "01" - содержание столбца
4143 +},
4144 +
4145 +{
4146 +"parentName": "string",
4147 +"name": "string",
4148 +"picture": "string",
4149 +"minspeed": 0,
4150 +"maxspeed": 0,
4151 +"width": 0,
4152 +"imbeddedtrailer": true,
4153 +"hoppercapacity": 0,
4154 +"hopperdischargespeed": 0,
4155 +"modelType": 0,
4156 +"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4157 +"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4158 +"deleted": true
4159 +}
4160 +
4161 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4162 +
4163 +(% class="box infomessage" %)
4164 +(((
4165 +POST/api/v3/Vehicles/recyclebin/erase
4166 +)))
4167 +
4168 +В заголовках запроса: X-Auth: Токен авторизации
4169 +
4170 +Параметры в теле запроса (JSON):
4171 +[
4172 +"eb737fdf-c422-4df7-8727-bd61439b8460",
4173 +"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4174 +]
4175 +
4176 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4177 +
4178 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4179 +
4180 +(% class="box infomessage" %)
4181 +(((
4182 +POST/api/v3/Vehicles/recyclebin/restore
4183 +)))
4184 +
4185 +В заголовках запроса: X-Auth: Токен авторизации
4186 +
4187 +Параметры в теле запроса (JSON):
4188 +[
4189 +"eb737fdf-c422-4df7-8727-bd61439b8460",
4190 +"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4191 +]
4192 +
4193 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4194 +
4195 +
4196 +
3371 3371  (% class="box" lang="en-US" style="text-align: center;" %)
3372 3372  (((
3373 3373  (% 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]] **

Меню

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