Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 109.1 >
edited by Илья Крайнов
on 2023/10/17 11:01
To version < 127.1 >
edited by Илья Крайнов
on 2023/11/29 10:51
>
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 infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,7 +40,6 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,6 +55,12 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,51 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -А
97 97  {
98 - "agentId": "", ~/~/ идентификатор клиента    (%%)
99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 - "isForeign": true/false, ~/~/ Иностранный контрагент
105 - "district": "string", ~/~/ округ
106 - "region": "string", ~/~/ регион
107 - "city": "string", ~/~/ город
108 - "inn": "string", ~/~/ ИНН клиента
109 - "kpp": "string", ~/~/ КПП клиента
110 - "address": "string", ~/~/ юридический адрес
111 - "addressFact": "string", ~/~/ фактический адрес
112 - "email": "string", ~/~/ почта
113 - "director": "string", ~/~/ ФИО руководителя
114 - "bankName": "string", ~/~/ Банк
115 - "bankBIK": "string", ~/~/ БИК
116 - "bankRS": "string", ~/~/ Номер счета
117 - "bankKS": "string" ~/~/ Корр. счет
102 + "agentId": "",  (%%)
103 + "parentId": "",
104 + "parentName": "string",
105 + "name": "string",
106 + "fullName": "string",
107 + "agentInfoType": 0,
108 + "isForeign": true/false,
109 + "district": "string", 
110 + "region": "string",
111 + "city": "string",
112 + "inn": "string",
113 + "kpp": "string",
114 + "address": "string",
115 + "addressFact": "string",
116 + "email": "string",
117 + "director": "string",
118 + "bankName": "string",
119 + "bankBIK": "string",
120 + "bankRS": "string",
121 + "bankKS": "string"
118 118   }
119 119  
124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145 +
120 120  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
122 122  (% class="box infomessage" %)
... ... @@ -130,7 +130,7 @@
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,25 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
174 + "agentId": "",(% style="color:#000000" %)   (%%)
175 + "parentId": "",
176 + "parentName": "string",
177 + "name": "string",
178 + "fullName": "string",
179 + "agentInfoType": 0,
180 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
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 +
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", ~/~/ идентификатор клиента-родителя 
211 + "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  
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 +
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  
359 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
360 +
361 +(% class="box warningmessage" %)
362 +(((
363 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
364 +)))
365 +
366 +Метод позволяет изменить статус клиента, указанного в запросе.
367 +
368 +В пути указывается GUID клиента и статус клиента.
369 +
370 +**status **- значение 0 - заблокирован, 1 - активен.
371 +
372 +Ответ: Code 204
373 +
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  
465 +
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,
... ... @@ -720,7 +720,7 @@
720 720   "deleted": true
721 721  }
722 722  
723 -|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание
793 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
724 724  |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
725 725  |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
726 726  |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
... ... @@ -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" %)Скорость выгрузки из бункера, л/сек
802 +|(% 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 клиента, которому принадлежит модель объекта
... ... @@ -751,10 +751,9 @@
751 751  
752 752  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
753 753  
754 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
823 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
755 755  
756 -(% style="color:#000000" %){
757 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
825 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
758 758  }
759 759  
760 760  (% style="color:#000000" %)Ответ:
... ... @@ -769,6 +769,13 @@
769 769   }
770 770  ]
771 771  
840 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
841 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
842 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
843 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
844 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
845 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
846 +
772 772  == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
773 773  
774 774  (% class="box successmessage" %)
... ... @@ -816,12 +816,25 @@
816 816   "maxspeed": 0,
817 817   "width": 0,
818 818   "imbeddedtrailer": true,
819 - "fueloutlay": 0,
820 820   "hoppercapacity": 0,
821 821   "hopperdischargespeed": 0,
822 822   "modelType": 0
823 823  }
824 824  
899 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
900 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
901 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
902 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
903 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
904 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
905 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
906 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
907 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
908 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
909 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
910 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
911 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
912 +
825 825  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
826 826  
827 827  (% class="box warningmessage" %)
... ... @@ -875,6 +875,20 @@
875 875   "modelType": 0
876 876  }
877 877  
966 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
967 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
968 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
969 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
970 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
971 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
972 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
973 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
974 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
975 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
976 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
977 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
978 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
979 +
878 878  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
879 879  
880 880  (% class="box errormessage" %)
... ... @@ -1785,6 +1785,51 @@
1785 1785   }
1786 1786  ]
1787 1787  
1890 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1891 +
1892 +(% class="box infomessage" style="text-align: left;" %)
1893 +(((
1894 +**POST /api/v3/terminalMessages/mapping**
1895 +)))
1896 +
1897 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1898 +
1899 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1900 +
1901 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1902 +
1903 +{
1904 + "protocolType": 0,
1905 + "params": ["string"]
1906 +}
1907 +
1908 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1909 +|protocolType|ID типа протокола
1910 +|params|(((
1911 +Массив наименований параметров в сообщении
1912 +)))
1913 +
1914 +Ответ:
1915 +
1916 +{
1917 + "protocolType": 0,
1918 + "mapping": {
1919 + "additionalProp1": {
1920 + "inputType": 0,
1921 + "inputNumber": 0
1922 + },
1923 + "additionalProp2": {
1924 + "inputType": 0,
1925 + "inputNumber": 0
1926 + }
1927 + }
1928 +}
1929 +
1930 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1931 +|protocolType|Тип протокола
1932 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1933 +|inputNumber|Номер входа
1934 +
1788 1788  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1789 1789  
1790 1790  (% class="box infomessage" %)
... ... @@ -1809,6 +1809,11 @@
1809 1809   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1810 1810  }
1811 1811  
1959 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1960 +|vehicleId|ID объекта
1961 +|from|Дата и время начала периода запроса
1962 +|to|Дата и время окончания периода запроса
1963 +
1812 1812  Ответ:
1813 1813  
1814 1814  [
... ... @@ -1815,80 +1815,43 @@
1815 1815   {
1816 1816   "messages": [
1817 1817   {
1818 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1819 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1820 - "speed": 0, ~/~/ Скорость, км/ч
1821 - "altitude": 0, ~/~/ Высота, м
1822 - "latitude": 0, ~/~/ Широта [-90°;90°]
1823 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1824 - "satellites": 0, ~/~/ Кол-во спутников
1825 - "voltage": 0, ~/~/ Напряжение
1826 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1970 + "deviceTime": "2023-11-29T07:40:44.052Z",
1971 + "serverTime": "2023-11-29T07:40:44.052Z",
1972 + "speed": 0,
1973 + "altitude": 0,
1974 + "latitude": 0,
1975 + "longitude": 0,
1976 + "satellites": 0,
1977 + "course": 0,
1978 + "voltage": 0,
1979 + "parameters": {
1827 1827   "additionalProp1": "string",
1828 1828   "additionalProp2": "string",
1829 1829   "additionalProp3": "string"
1830 1830   },
1831 - "photoCount": 0 ~/~/ Кол-во фото
1984 + "photoCount": 0,
1985 + "lbsCorrectedCoords": true,
1986 + "protocolType": 0
1832 1832   }
1833 1833   ]
1834 1834   }
1835 1835  ]
1836 1836  
1837 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1992 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1993 +|deviceTime|Время сообщения терминала
1994 +|serverTime|Время когда сообщение поступило на сервер
1995 +|speed|Скорость
1996 +|altitude|Высота над уровнем моря
1997 +|latitude|Широта
1998 +|longitude|Долгота
1999 +|satellites|Кол-во спутников
2000 +|course|Курс
2001 +|voltage|Бортовое напряжение
2002 +|parameters|Список параметров и их значений
2003 +|photoCount|Количество фото
2004 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2005 +|protocolType|ID типа протокола
1838 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 -
1892 1892  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1893 1893  
1894 1894  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2920,6 +2920,83 @@
2920 2920  Success
2921 2921  
2922 2922  
3038 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3039 +
3040 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3041 +
3042 +(% class="box infomessage" %)
3043 +(((
3044 +**POST /api/v3/Trailers**
3045 +)))
3046 +
3047 +Пример запроса:
3048 +
3049 +{
3050 + "startDate": "2023-11-14T10:48:03.671Z",
3051 + "endDate": "2023-11-14T10:48:03.671Z",
3052 + "ids": [ 0 ],
3053 + "timezone": 0
3054 +}
3055 +
3056 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3057 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3058 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3059 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3060 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3061 +
3062 +Пример ответа:
3063 +
3064 +[
3065 + {
3066 + "SD": "2023-11-14T10:48:03.717Z",
3067 + "ED": "2023-11-14T10:48:03.717Z", 
3068 + "id": 0,
3069 + "SLat": 0,
3070 + "SLon": 0,
3071 + "ELat": 0,
3072 + "ELon": 0,
3073 + "mileage": 0
3074 + "Duration": 0
3075 + "Address": "string",
3076 + "Address2": "string",
3077 + "name": "string",
3078 + "rid": "string",
3079 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3080 + "trailer": {
3081 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3082 + "Number": "string",
3083 + "Description": "string",
3084 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 + "ExternalID": "string",
3086 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3087 + "CreateTime": "2023-11-14T10:48:03.717Z",
3088 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3089 + "IsDeleted": true
3090 + },
3091 + "filesCount": 0,
3092 + }
3093 +]
3094 +
3095 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3096 +|SD|Дата и время начала события
3097 +|ED|Дата и время окончания события
3098 +|id|ID объекта
3099 +|SLat|Широта начальной координаты
3100 +|SLon|Долгота начальной координаты
3101 +|ELat|Широта конечной координаты
3102 +|ELon|Долгота конечной координаты
3103 +|mileage|Пробег
3104 +|Duration|Продолжительность
3105 +|Address|Адрес начального местоположения
3106 +|Address2|Адрес конечного местоположения
3107 +|name|Имя радиометки
3108 +|rid|Номер радиометки
3109 +|rguid|ID радиометки
3110 +|trailer|Информация об агрегате
3111 +|ModelGuid|ID агрегата
3112 +|Number|Название/номер агрегата
3113 +|Description|Текст примечания агрегата
3114 +
2923 2923  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2924 2924  
2925 2925  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2941,13 +2941,18 @@
2941 2941   {
2942 2942   "name": "string",
2943 2943   "number": 0,
2944 - "period": 0, ~/~/ Частота трансляции радиометки
3136 + "period": 0,
2945 2945   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2946 2946   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2947 - "deleted": true
2948 2948   }
2949 2949  ]
2950 2950  
3142 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3143 +|parentId|ID клиента
3144 +|name|Название карты-метки
3145 +|number|Номер
3146 +|period|Период запросов в секундах (работает только для агрегатов)
3147 +|id|ID карты-метки
2951 2951  
2952 2952  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2953 2953  
... ... @@ -2964,13 +2964,18 @@
2964 2964   {
2965 2965   "name": "string",
2966 2966   "number": 0,
2967 - "period": 0, ~/~/ Частота трансляции радиометки
3164 + "period": 0,
2968 2968   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2969 2969   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2970 - "deleted": true
2971 2971   }
2972 2972  ]
2973 2973  
3170 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3171 +|name|Название карты-метки
3172 +|number|Номер
3173 +|period|Период запросов в секундах (работает только для агрегатов)
3174 +|id|ID карты-метки
3175 +|parentId|ID клиента
2974 2974  
2975 2975  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2976 2976  
... ... @@ -2986,7 +2986,6 @@
2986 2986   "number": 0,
2987 2987   "period": 0,
2988 2988   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2989 - "deleted": true
2990 2990  }
2991 2991  
2992 2992  Ответ:
... ... @@ -2997,9 +2997,14 @@
2997 2997   "period": 0,
2998 2998   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2999 2999   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3000 - "deleted": true
3001 3001  }
3002 3002  
3203 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3204 +|name|Название карты-метки
3205 +|number|Номер
3206 +|period|Период запросов в секундах (работает только для агрегатов)
3207 +|id|ID карты-метки
3208 +|parentId|ID клиента
3003 3003  
3004 3004  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3005 3005  
... ... @@ -3016,7 +3016,6 @@
3016 3016   "period": 0,
3017 3017   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3018 3018   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3019 - "deleted": true
3020 3020  }
3021 3021  
3022 3022  Ответ:
... ... @@ -3027,9 +3027,14 @@
3027 3027   "period": 0,
3028 3028   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3029 3029   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3030 - "deleted": true
3031 3031  }
3032 3032  
3237 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3238 +|name|Название карты-метки
3239 +|number|Номер
3240 +|period|Период запросов в секундах (работает только для агрегатов)
3241 +|id|ID карты-метки
3242 +|parentId|ID клиента
3033 3033  
3034 3034  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3035 3035  
... ... @@ -3038,7 +3038,7 @@
3038 3038  **DELETE /api/v3/Rfids/{rfidGuid}**
3039 3039  )))
3040 3040  
3041 -Передаем параметр rfidGuid - идентификатор карты-метки
3251 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3042 3042  
3043 3043  Ответ:
3044 3044  
... ... @@ -3045,6 +3045,670 @@
3045 3045  Success
3046 3046  
3047 3047  
3258 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3259 +
3260 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3261 +
3262 +(% class="box infomessage" %)
3263 +(((
3264 +**GET /api/v3/Billing/client/balance/{clientId}**
3265 +)))
3266 +
3267 +Параметр запроса: **clientId **- идентификатор клиента.
3268 +
3269 +Ответ:
3270 +
3271 +{
3272 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3273 + "Balance": 0
3274 +}
3275 +
3276 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3277 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3278 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3279 +
3280 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3281 +
3282 +(% class="box infomessage" %)
3283 +(((
3284 +**GET /api/v3/Billing/client/constraint/{clientId}**
3285 +)))
3286 +
3287 +Параметр запроса: **clientId **- идентификатор клиента.
3288 +
3289 +Ответ:
3290 +
3291 +{
3292 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3293 + "CalculationType": 0,
3294 + "PermissibleBalance": 0,
3295 + "DefermentDays": 0,
3296 + "SendUiNotifications": true,
3297 + "SendEmailNotifications": true,
3298 + "IsPrivate": true,
3299 +}
3300 +
3301 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3302 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3303 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3304 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3305 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3306 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3307 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3308 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3309 +
3310 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3311 +
3312 +(% class="box infomessage" %)
3313 +(((
3314 +**GET /api/v3/Billing/client/plan/{clientId}**
3315 +)))
3316 +
3317 +Параметры запроса:
3318 +
3319 +**clientId **- идентификатор клиента.
3320 +
3321 +**planId **- идентификатор тарифного плана.
3322 +
3323 +Ответ:
3324 +
3325 +{
3326 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3327 + "Plan": { **~/~/ Описание тарифного плана**
3328 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3329 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3330 + "Name": "string",
3331 + "IsArchived": true,
3332 + "Constraint": {
3333 + "CalculationType": 0,
3334 + "PermissibleBalance": 0,
3335 + "DefermentDays": 0
3336 + },
3337 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3338 + {
3339 + "Feature": "string",
3340 + "IsFactual": true,
3341 + "Limit": 0,
3342 + "Price": 0,
3343 + "PeriodValue": 0,
3344 + "PeriodType": 0
3345 + }
3346 + ]
3347 + },
3348 + "DebitDate": "2023-10-18T12:46:24.213Z",
3349 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3350 + {
3351 + "Feature": "string",
3352 + "IsEnabled": true,
3353 + "IsPrivate": true,
3354 + "IsFactual": true,
3355 + "Limit": 0,
3356 + "Price": 0,
3357 + "DebitDate": "2023-10-18T12:46:24.213Z",
3358 + "PeriodValue": 0,
3359 + "PeriodType": 0
3360 + }
3361 + ]
3362 +}
3363 +
3364 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3365 +|ClientId|Идентификатор клиента
3366 +|Id|Идентификатор тарифного плана
3367 +|OwnerId|Идентификатор клиента-владельца
3368 +|Name|Наименование тарифного плана
3369 +|IsArchived|Признак, определяющий архивный тарифный план
3370 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3371 +|PermissibleBalance|Допустимый баланс
3372 +|DefermentDays|Отсрочка, количество дней
3373 +|Feature|Код услуги
3374 +|IsEnabled|Признак, определяющий активирована ли услуга
3375 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3376 +|IsFactual|Признак, определяющий расчёт по факту
3377 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3378 +|Price|Цена за единицу.
3379 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3380 +|PeriodValue|Значение периода.
3381 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3382 +
3383 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3384 +
3385 +(% class="box infomessage" %)
3386 +(((
3387 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3388 +)))
3389 +
3390 +Параметр запроса: **clientId **- идентификатор клиента.
3391 +
3392 +Ответ:
3393 +
3394 +[
3395 + {
3396 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3397 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3398 + "Name": "string",
3399 + "IsArchived": true,
3400 + "Constraint": {
3401 + "CalculationType": 0,
3402 + "PermissibleBalance": 0,
3403 + "DefermentDays": 0
3404 + },
3405 + "Features": [
3406 + {
3407 + "Feature": "string",
3408 + "IsFactual": true,
3409 + "Limit": 0,
3410 + "Price": 0,
3411 + "PeriodValue": 0,
3412 + "PeriodType": 0
3413 + }
3414 + ]
3415 + }
3416 +]
3417 +
3418 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3419 +|ClientId|Идентификатор клиента
3420 +|Id|Идентификатор тарифного плана
3421 +|OwnerId|Идентификатор клиента-владельца
3422 +|Name|Наименование тарифного плана
3423 +|IsArchived|Признак, определяющий архивный тарифный план
3424 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3425 +|PermissibleBalance|Допустимый баланс
3426 +|DefermentDays|Отсрочка, количество дней
3427 +|Feature|Код услуги
3428 +|IsFactual|Признак, определяющий расчёт по факту
3429 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3430 +|Price|Цена за единицу.
3431 +|PeriodValue|Значение периода.
3432 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3433 +
3434 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3435 +
3436 +(% class="box infomessage" %)
3437 +(((
3438 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3439 +)))
3440 +
3441 +Параметр запроса: **clientId **- идентификатор клиента.
3442 +
3443 +Ответ:
3444 +
3445 +[
3446 + {
3447 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3448 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3449 + "Name": "string",
3450 + "IsArchived": true,
3451 + "Constraint": {
3452 + "CalculationType": 0,
3453 + "PermissibleBalance": 0,
3454 + "DefermentDays": 0
3455 + },
3456 + "Features": [
3457 + {
3458 + "Feature": "string",
3459 + "IsFactual": true,
3460 + "Limit": 0,
3461 + "Price": 0,
3462 + "PeriodValue": 0,
3463 + "PeriodType": 0
3464 + }
3465 + ]
3466 + }
3467 +]
3468 +
3469 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3470 +|ClientId|Идентификатор клиента
3471 +|Id|Идентификатор тарифного плана
3472 +|OwnerId|Идентификатор клиента-владельца
3473 +|Name|Наименование тарифного плана
3474 +|IsArchived|Признак, определяющий архивный тарифный план
3475 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3476 +|PermissibleBalance|Допустимый баланс
3477 +|DefermentDays|Отсрочка, количество дней
3478 +|Feature|Код услуги
3479 +|IsFactual|Признак, определяющий расчёт по факту
3480 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3481 +|Price|Цена за единицу.
3482 +|PeriodValue|Значение периода.
3483 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3484 +
3485 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3486 +
3487 +(% class="box warningmessage" %)
3488 +(((
3489 +**PUT /api/v3/Billing/client/balance**
3490 +)))
3491 +
3492 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3493 +
3494 +Тело запроса:
3495 +
3496 +{
3497 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3498 + "Balance": 0
3499 +}
3500 +
3501 +Ответ: Success
3502 +
3503 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3504 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3505 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3506 +
3507 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3508 +
3509 +(% class="box warningmessage" %)
3510 +(((
3511 +**PUT /api/v3/billing/client/balance/deposit**
3512 +)))
3513 +
3514 +Создает операцию **Пополнение **с указанной суммой
3515 +
3516 +Тело запроса:
3517 +
3518 +{
3519 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3520 + "Balance": 0
3521 +}
3522 +
3523 +Ответ: Success
3524 +
3525 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3526 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3527 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3528 +
3529 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3530 +
3531 +Создает операцию **Списание **с указанной суммой
3532 +
3533 +(% class="box warningmessage" %)
3534 +(((
3535 +**PUT /api/v3/billing/client/balance/withdraw**
3536 +)))
3537 +
3538 +Тело запроса:
3539 +
3540 +{
3541 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3542 + "Balance": 0
3543 +}
3544 +
3545 +Ответ: Success
3546 +
3547 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3548 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3549 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3550 +
3551 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3552 +
3553 +(% class="box warningmessage" %)
3554 +(((
3555 +**PUT /api/v3/Billing/client/constraint**
3556 +)))
3557 +
3558 +Тело запроса:
3559 +
3560 +{
3561 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3562 + "CalculationType": 0,
3563 + "PermissibleBalance": 0,
3564 + "DefermentDays": 0,
3565 + "SendUiNotifications": true,
3566 + "SendEmailNotifications": true,
3567 + "IsPrivate": true,
3568 +}
3569 +
3570 +Ответ: Success
3571 +
3572 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3573 +|ClientId|Идентификатор клиента
3574 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3575 +|PermissibleBalance|Допустимый баланс
3576 +|DefermentDays|(((
3577 +Отсрочка, количество дней
3578 +)))
3579 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3580 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3581 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3582 +
3583 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3584 +
3585 +(% class="box warningmessage" %)
3586 +(((
3587 +**PUT /api/v3/Billing/client/plan**
3588 +)))
3589 +
3590 +Тело запроса:
3591 +
3592 +{
3593 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3594 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3595 + "Features": [
3596 + {
3597 + "Feature": "string",
3598 + "IsEnabled": true,
3599 + "IsFactual": true,
3600 + "Limit": 0,
3601 + "Price": 0,
3602 + "DebitDate": "2023-10-18T13:26:58.987Z",
3603 + "PeriodValue": 0,
3604 + "PeriodType": 0
3605 + }
3606 + ]
3607 +}
3608 +
3609 +Ответ: Success
3610 +
3611 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3612 +|ClientId|Идентификатор клиента
3613 +|PlanId|Идентификатор тарифного плана
3614 +|Feature|Код услуги
3615 +|IsEnabled|Признак, определяющий активирована ли услуга
3616 +|IsFactual|Признак, определяющий расчёт по факту
3617 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3618 +|Price|Цена за единицу.
3619 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3620 +|PeriodValue|Значение периода.
3621 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3622 +
3623 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3624 +
3625 +(% class="box warningmessage" %)
3626 +(((
3627 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3628 +)))
3629 +
3630 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3631 +
3632 +(% class="box infomessage" %)
3633 +(((
3634 +**POST /api/v3/vehicles/import/{agentId}**
3635 +)))
3636 +
3637 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3638 +
3639 +В пути указывается **agentId** - id клиента.
3640 +
3641 +**Заголовок**
3642 +
3643 +**X-Auth: [токен авторизации]**
3644 +
3645 +**Параметры**
3646 +
3647 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3648 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3649 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3650 +
3651 +В теле использовать тип **form-data,** тип значения** file**
3652 +
3653 +**Ключи**
3654 +
3655 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3656 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3657 +|csv|В значении передаем файл датчиков, формат **csv**
3658 +
3659 +Ответ:
3660 +
3661 +{
3662 + "vehicleId": 0,
3663 + "name": "string",
3664 + "errors": ["string"]
3665 +}
3666 +
3667 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3668 +|vehicleId|ID созданного объекта
3669 +|name|Имя созданного объекта
3670 +|errors|Ошибки и их описание
3671 +
3672 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3673 +
3674 +(% class="box infomessage" %)
3675 +(((
3676 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3677 +)))
3678 +
3679 +(% class="wikigeneratedid" %)
3680 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3681 +
3682 +(% class="wikigeneratedid" %)
3683 +В пути указывается **vehicleId **- id объекта.
3684 +
3685 +**Заголовок**
3686 +
3687 +**X-Auth: [токен авторизации]**
3688 +
3689 +В теле использовать тип **form-data.**
3690 +
3691 +Ключи:
3692 +
3693 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3694 +|**history**|В значении передавать файл с историей
3695 +
3696 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3697 +
3698 +Ответ:
3699 +
3700 +{
3701 + "results": [
3702 + {
3703 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3704 + "vehicleId": 0,
3705 + "errors": [
3706 + "string"
3707 + ],
3708 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3709 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3710 + "producedCount": 0,
3711 + "msgCount": 0
3712 + }
3713 + ]
3714 +}
3715 +
3716 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3717 +|results|Результаты импорта в разрезе ТС
3718 +|vehicleGuid|Guid ТС
3719 +|vehicleId|ID ТС
3720 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3721 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3722 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3723 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3724 +|msgCount|Кол-во обработанных сообщений всего
3725 +
3726 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3727 +
3728 +(% class="box infomessage" %)
3729 +(((
3730 +**GET /api/v3/vehicles/import/history/status**
3731 +)))
3732 +
3733 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3734 +
3735 +Ответ:
3736 +
3737 +{
3738 + "activity": true,
3739 + "progress": 0,
3740 + "message": "string"
3741 +}
3742 +
3743 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3744 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3745 +|progress|Guid ТС
3746 +
3747 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3748 +
3749 +(% class="box infomessage" %)
3750 +(((
3751 +**POST /api/v3/vehicles/export**
3752 +)))
3753 +
3754 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3755 +
3756 +Тело запроса:
3757 +
3758 +[
3759 + id
3760 +]
3761 +
3762 +Ответ: Success 200, получаете файлы с настройками.
3763 +
3764 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3765 +
3766 +(% class="box infomessage" %)
3767 +(((
3768 +**POST /api/v3/vehicles/export/history**
3769 +)))
3770 +
3771 +Метод возвращает список сообщений терминала объекта за выбранный период.
3772 +
3773 +Тело запроса:
3774 +
3775 +{
3776 + "vehicleId": 0,
3777 + "asArchive": true,
3778 + "from": "2023-09-27T12:17:45.973Z",
3779 + "to": "2023-09-27T12:17:45.973Z"
3780 +}
3781 +
3782 +Ответ:
3783 +
3784 +Получаете файл. Сообщение: Code 200/Success
3785 +
3786 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3787 +|vehicleId|ID объекта
3788 +|asArchive|true - Архивировать файл, False - не архивировать
3789 +|from|Дата и время начала запроса
3790 +|to|Дата и время окончания запроса
3791 +
3792 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3793 +
3794 +(% class="box infomessage" %)
3795 +(((
3796 +**GET /api/v3/vehicles/export/history/status**
3797 +)))
3798 +
3799 +Метод возвращает список сообщений терминала объекта за выбранный период.
3800 +
3801 +Ответ:
3802 +
3803 +{
3804 + "activity": true,
3805 + "progress": 0,
3806 + "message": "string"
3807 +}
3808 +
3809 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3810 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3811 +|progress|Прогресс экспорта, от 0 до 100%
3812 +|message|Текст описывающий статус
3813 +
3814 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3815 +
3816 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3817 +
3818 +(% class="box infomessage" %)
3819 +(((
3820 +**POST /api/v3/EcoDriving/rating**
3821 +)))
3822 +
3823 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3824 +
3825 +Тело запроса:
3826 +
3827 +{
3828 + "vehicleIds": [vehicleId],
3829 + "from": "2023-11-22T09:29:48.051Z",
3830 + "to": "2023-11-22T09:29:48.051Z"
3831 +}
3832 +
3833 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3834 +|vehicleIds|Массив ID объектов
3835 +|from|Дата начала запроса
3836 +|to|Дата окончания запроса
3837 +
3838 +Ответ:
3839 +
3840 +{
3841 + "items": [
3842 + {
3843 + "from": "2023-11-22T09:29:48.052Z",
3844 + "to": "2023-11-22T09:29:48.052Z",
3845 + "vehicleId": 0,
3846 + "vehicleName": "string",
3847 + "vehicleModel": "string",
3848 + "penalty": 0,
3849 + "score": 0,
3850 + "totalViolations": 0,
3851 + "violationsByType": {
3852 + "overspeedingViolations": 0,
3853 + "accelerationViolations": 0,
3854 + "brakingViolations": 0,
3855 + "turningViolations": 0,
3856 + "dangerousDrivingViolations": 0,
3857 + "sensorViolations": 0
3858 + },
3859 + "moveTime": 0,
3860 + "mileage": 0,
3861 + "tripsCount": 0,
3862 + "trips": [
3863 + {
3864 + "penalty": 0,
3865 + "score": 0,
3866 + "violationsCount": 0,
3867 + "violationsByType": {
3868 + "overspeedingViolations": 0,
3869 + "accelerationViolations": 0,
3870 + "brakingViolations": 0,
3871 + "turningViolations": 0,
3872 + "dangerousDrivingViolations": 0,
3873 + "sensorViolations": 0
3874 + },
3875 + "moveTime": 0,
3876 + "mileage": 0,
3877 + "motohours": 0,
3878 + "maxSpeed": 0,
3879 + "startAddress": "string",
3880 + "endAddress": "string",
3881 + "drivers": [
3882 + {
3883 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3884 + "driverName": "string",
3885 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3886 + }
3887 + ]
3888 + }
3889 + ]
3890 + }
3891 + ]
3892 +}
3893 +
3894 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3895 +|from|Дата начала запроса
3896 +|to|Дата  окончания
3897 +|vehicleId|ID объекта
3898 +|vehicleName|Имя объекта
3899 +|vehicleModel|Модель объекта
3900 +|penalty|Сумма штрафных баллов
3901 +|score|Оценка
3902 +|totalViolations|Суммарное количество нарушений
3903 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3904 +|overspeedingViolations|Превышение скорости
3905 +|accelerationViolations|Ускорение
3906 +|brakingViolations|Торможение
3907 +|turningViolations|Резкий поворот
3908 +|dangerousDrivingViolations|Резкое вождение
3909 +|sensorViolations|Нарушение по датчику
3910 +|moveTime|Время в движении
3911 +|mileage|Пробег
3912 +|tripsCount|Количество рейсов
3913 +|motohours|Моточасы
3914 +|maxSpeed|Максимальная скорость
3915 +|startAddress|Адрес начала рейса
3916 +|endAddress|Адрес окончания рейса
3917 +|drivers|Список водителей, которые были на объекте в течениии рейса
3918 +|driverGuid|Guid водителя
3919 +|driverName|Имя водителя
3920 +|driverRfid|Номер Карты-метки
3921 +
3048 3048  (% class="box" lang="en-US" style="text-align: center;" %)
3049 3049  (((
3050 3050  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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