Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 125.1 >
edited by Илья Крайнов
on 2023/11/28 16:04
To version < 107.1 >
edited by Илья Крайнов
on 2023/08/30 15:15
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -14,13 +14,13 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 21  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,6 +40,7 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 +
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -54,12 +54,6 @@
54 54  
55 55  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
56 56  
57 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
58 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
59 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
60 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 -
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -98,51 +98,30 @@
98 98  Запрос должен содержать данные параметра "**agentId**"
99 99  
100 100  (% style="color:#000000" %)Ответ:
96 +А
101 101  {
102 - "agentId": "",  (%%)
103 - "parentId": "",
104 - "parentName": "string",
105 - "name": "string",
106 - "fullName": "string",
107 - "agentInfoType": 0,
108 - "isForeign": true/false,
109 - "district": "string", 
110 - "region": "string",
111 - "city": "string",
112 - "inn": "string",
113 - "kpp": "string",
114 - "address": "string",
115 - "addressFact": "string",
116 - "email": "string",
117 - "director": "string",
118 - "bankName": "string",
119 - "bankBIK": "string",
120 - "bankRS": "string",
121 - "bankKS": "string"
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
122 122   }
123 123  
124 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
125 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
126 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
127 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
128 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
129 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
130 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
131 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
132 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
133 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
134 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
135 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
136 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
137 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
138 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
139 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
140 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
141 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
142 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
143 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
144 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
145 -
146 146  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
147 147  
148 148  (% class="box infomessage" %)
... ... @@ -156,7 +156,7 @@
156 156  
157 157  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
158 158  
159 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
160 160  
161 161  (% style="color:#000000" %)Метод запроса: **POST**
162 162  
... ... @@ -171,25 +171,15 @@
171 171  (% style="color:#000000" %)Ответ:
172 172  
173 173  {
174 - "agentId": "",(% style="color:#000000" %)   (%%)
175 - "parentId": "",
176 - "parentName": "string",
177 - "name": "string",
178 - "fullName": "string",
179 - "agentInfoType": 0,
180 -(% style="color:#000000" %) "status": "",
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
181 181  }
182 182  
183 -
184 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
185 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
186 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
188 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
189 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
190 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
191 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
192 -
193 193  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
194 194  
195 195  (% class="box successmessage" %)
... ... @@ -208,7 +208,7 @@
208 208  Параметры в теле запроса (JSON):
209 209  
210 210  {
211 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
212 212   "name": "string", ~/~/ имя
213 213   "fullName": "string", ~/~/ полное наименование
214 214   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -253,28 +253,6 @@
253 253   "bankKS": "string" ~/~/ корр. счёт
254 254  }
255 255  
256 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
257 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
258 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
259 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
260 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
261 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
262 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
263 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
264 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
265 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
266 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
267 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
268 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
269 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
270 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
271 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
272 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
273 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
274 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
275 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
276 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
277 -
278 278  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
279 279  
280 280  (% class="box warningmessage" %)
... ... @@ -290,6 +290,7 @@
290 290  
291 291  В заголовках запроса: X-Auth: Токен авторизации
292 292  
235 +
293 293  Параметры в теле запроса (JSON):
294 294  
295 295  {
... ... @@ -314,6 +314,7 @@
314 314   "bankKS": "string" ~/~/ корр. счёт
315 315  }
316 316  
260 +
317 317  Ответ:
318 318  
319 319  {
... ... @@ -356,23 +356,8 @@
356 356  
357 357  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
358 358  
359 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
360 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 -
374 -== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) ==
375 -
376 376  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
377 377  
378 378  (% class="box successmessage" %)
... ... @@ -434,6 +434,7 @@
434 434   "password": "string",
435 435   "email": "string",
436 436  
366 +
437 437  (% style="text-align:left" %)
438 438  (% style="color:#000000; font-weight:normal" %)Ответ:
439 439  
... ... @@ -462,7 +462,6 @@
462 462  (% style="text-align:left" %)
463 463  (% style="color:#000000; font-weight:normal" %)}
464 464  
465 -
466 466  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
467 467  
468 468  (% class="box infomessage" %)
... ... @@ -753,249 +753,6 @@
753 753  (% style="text-align:left" %)
754 754  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
755 755  
756 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
757 -
758 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
759 -
760 -(% class="box infomessage" %)
761 -(((
762 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
763 -)))
764 -
765 -Метод возвращает полную информацию о модели объекта.
766 -
767 -(% style="color:#000000" %)Метод запроса: **GET**
768 -
769 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
770 -
771 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
772 -
773 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
774 -
775 -(% style="color:#000000" %)Ответ:
776 -
777 -(% style="color:#000000" %){
778 - "parentName": "string",
779 - "name": "string",
780 - "picture": "string",
781 - "minspeed": 0,
782 - "maxspeed": 0,
783 - "width": 0,
784 - "imbeddedtrailer": true,
785 - "hoppercapacity": 0,
786 - "hopperdischargespeed": 0,
787 - "modelType": 0,
788 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
789 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
790 - "deleted": true
791 -}
792 -
793 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
794 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
795 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
796 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
797 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
798 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
799 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
800 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
801 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
802 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
803 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
804 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
805 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
806 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
807 -
808 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
809 -
810 -(% class="box successmessage" %)
811 -(((
812 -(% lang="en-US" %)**POST /api/v3/models/find**
813 -)))
814 -
815 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
816 -
817 -(% style="color:#000000" %)Метод запроса: **POST**
818 -
819 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
820 -
821 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
822 -
823 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
824 -
825 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
826 -}
827 -
828 -(% style="color:#000000" %)Ответ:
829 -
830 -(% style="color:#000000" %)[
831 - {
832 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
833 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
834 - "parentName": "string",
835 - "name": "string",
836 - "modelType": 0
837 - }
838 -]
839 -
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 -
847 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
848 -
849 -(% class="box successmessage" %)
850 -(((
851 -(% lang="en-US" %)**POST /api/v3/models**
852 -)))
853 -
854 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
855 -
856 -(% style="color:#000000" %)Метод запроса: **POST**
857 -
858 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
859 -
860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
861 -
862 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
863 -
864 -{
865 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
866 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
867 - "deleted": true,
868 - "extId": "string",
869 - "name": "string",
870 - "picture": "string",
871 - "minspeed": 0,
872 - "maxspeed": 0,
873 - "width": 0,
874 - "imbeddedtrailer": true,
875 - "fueloutlay": 0,
876 - "hoppercapacity": 0,
877 - "hopperdischargespeed": 0,
878 - "modelType": 0
879 -}
880 -
881 -Ответ:
882 -
883 -{
884 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
885 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
886 - "deleted": true,
887 - "extId": "string",
888 - "name": "string",
889 - "picture": "string",
890 - "minspeed": 0,
891 - "maxspeed": 0,
892 - "width": 0,
893 - "imbeddedtrailer": true,
894 - "hoppercapacity": 0,
895 - "hopperdischargespeed": 0,
896 - "modelType": 0
897 -}
898 -
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 -
913 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
914 -
915 -(% class="box warningmessage" %)
916 -(((
917 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
918 -)))
919 -
920 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
921 -
922 -(% style="color:#000000" %)Метод запроса: **PUT**
923 -
924 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
925 -
926 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
927 -
928 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
929 -
930 -{
931 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
932 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
933 - "deleted": true,
934 - "extId": "string",
935 - "name": "string",
936 - "picture": "string",
937 - "minspeed": 0,
938 - "maxspeed": 0,
939 - "width": 0,
940 - "imbeddedtrailer": true,
941 - "fueloutlay": 0,
942 - "hoppercapacity": 0,
943 - "hopperdischargespeed": 0,
944 - "modelType": 0
945 -}
946 -
947 -Ответ:
948 -
949 -{
950 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
951 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
952 - "deleted": true,
953 - "extId": "string",
954 - "name": "string",
955 - "picture": "string",
956 - "minspeed": 0,
957 - "maxspeed": 0,
958 - "width": 0,
959 - "imbeddedtrailer": true,
960 - "fueloutlay": 0,
961 - "hoppercapacity": 0,
962 - "hopperdischargespeed": 0,
963 - "modelType": 0
964 -}
965 -
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 -
980 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
981 -
982 -(% class="box errormessage" %)
983 -(((
984 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
985 -)))
986 -
987 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
988 -
989 -(% style="color:#000000" %)Метод запроса: **DELETE**
990 -
991 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
992 -
993 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
994 -
995 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
996 -
997 -Ответ: В случае успеха **Success 200**
998 -
999 999  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
1000 1000  
1001 1001  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -2967,83 +2967,6 @@
2967 2967  Success
2968 2968  
2969 2969  
2970 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
2971 -
2972 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
2973 -
2974 -(% class="box infomessage" %)
2975 -(((
2976 -**POST /api/v3/Trailers**
2977 -)))
2978 -
2979 -Пример запроса:
2980 -
2981 -{
2982 - "startDate": "2023-11-14T10:48:03.671Z",
2983 - "endDate": "2023-11-14T10:48:03.671Z",
2984 - "ids": [ 0 ],
2985 - "timezone": 0
2986 -}
2987 -
2988 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2989 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
2990 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
2991 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
2992 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
2993 -
2994 -Пример ответа:
2995 -
2996 -[
2997 - {
2998 - "SD": "2023-11-14T10:48:03.717Z",
2999 - "ED": "2023-11-14T10:48:03.717Z", 
3000 - "id": 0,
3001 - "SLat": 0,
3002 - "SLon": 0,
3003 - "ELat": 0,
3004 - "ELon": 0,
3005 - "mileage": 0
3006 - "Duration": 0
3007 - "Address": "string",
3008 - "Address2": "string",
3009 - "name": "string",
3010 - "rid": "string",
3011 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3012 - "trailer": {
3013 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3014 - "Number": "string",
3015 - "Description": "string",
3016 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3017 - "ExternalID": "string",
3018 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3019 - "CreateTime": "2023-11-14T10:48:03.717Z",
3020 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3021 - "IsDeleted": true
3022 - },
3023 - "filesCount": 0,
3024 - }
3025 -]
3026 -
3027 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3028 -|SD|Дата и время начала события
3029 -|ED|Дата и время окончания события
3030 -|id|ID объекта
3031 -|SLat|Широта начальной координаты
3032 -|SLon|Долгота начальной координаты
3033 -|ELat|Широта конечной координаты
3034 -|ELon|Долгота конечной координаты
3035 -|mileage|Пробег
3036 -|Duration|Продолжительность
3037 -|Address|Адрес начального местоположения
3038 -|Address2|Адрес конечного местоположения
3039 -|name|Имя радиометки
3040 -|rid|Номер радиометки
3041 -|rguid|ID радиометки
3042 -|trailer|Информация об агрегате
3043 -|ModelGuid|ID агрегата
3044 -|Number|Название/номер агрегата
3045 -|Description|Текст примечания агрегата
3046 -
3047 3047  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3048 3048  
3049 3049  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3065,18 +3065,13 @@
3065 3065   {
3066 3066   "name": "string",
3067 3067   "number": 0,
3068 - "period": 0,
2677 + "period": 0, ~/~/ Частота трансляции радиометки
3069 3069   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3070 3070   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 + "deleted": true
3071 3071   }
3072 3072  ]
3073 3073  
3074 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3075 -|parentId|ID клиента
3076 -|name|Название карты-метки
3077 -|number|Номер
3078 -|period|Период запросов в секундах (работает только для агрегатов)
3079 -|id|ID карты-метки
3080 3080  
3081 3081  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3082 3082  
... ... @@ -3093,18 +3093,13 @@
3093 3093   {
3094 3094   "name": "string",
3095 3095   "number": 0,
3096 - "period": 0,
2700 + "period": 0, ~/~/ Частота трансляции радиометки
3097 3097   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3098 3098   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2703 + "deleted": true
3099 3099   }
3100 3100  ]
3101 3101  
3102 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3103 -|name|Название карты-метки
3104 -|number|Номер
3105 -|period|Период запросов в секундах (работает только для агрегатов)
3106 -|id|ID карты-метки
3107 -|parentId|ID клиента
3108 3108  
3109 3109  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3110 3110  
... ... @@ -3120,6 +3120,7 @@
3120 3120   "number": 0,
3121 3121   "period": 0,
3122 3122   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 + "deleted": true
3123 3123  }
3124 3124  
3125 3125  Ответ:
... ... @@ -3130,14 +3130,9 @@
3130 3130   "period": 0,
3131 3131   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3132 3132   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2733 + "deleted": true
3133 3133  }
3134 3134  
3135 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3136 -|name|Название карты-метки
3137 -|number|Номер
3138 -|period|Период запросов в секундах (работает только для агрегатов)
3139 -|id|ID карты-метки
3140 -|parentId|ID клиента
3141 3141  
3142 3142  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3143 3143  
... ... @@ -3154,6 +3154,7 @@
3154 3154   "period": 0,
3155 3155   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3156 3156   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 + "deleted": true
3157 3157  }
3158 3158  
3159 3159  Ответ:
... ... @@ -3164,14 +3164,9 @@
3164 3164   "period": 0,
3165 3165   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3166 3166   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2763 + "deleted": true
3167 3167  }
3168 3168  
3169 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3170 -|name|Название карты-метки
3171 -|number|Номер
3172 -|period|Период запросов в секундах (работает только для агрегатов)
3173 -|id|ID карты-метки
3174 -|parentId|ID клиента
3175 3175  
3176 3176  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3177 3177  
... ... @@ -3180,7 +3180,7 @@
3180 3180  **DELETE /api/v3/Rfids/{rfidGuid}**
3181 3181  )))
3182 3182  
3183 -Передаем параметр **rfidGuid** - идентификатор карты-метки
2774 +Передаем параметр rfidGuid - идентификатор карты-метки
3184 3184  
3185 3185  Ответ:
3186 3186  
... ... @@ -3187,670 +3187,6 @@
3187 3187  Success
3188 3188  
3189 3189  
3190 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3191 -
3192 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3193 -
3194 -(% class="box infomessage" %)
3195 -(((
3196 -**GET /api/v3/Billing/client/balance/{clientId}**
3197 -)))
3198 -
3199 -Параметр запроса: **clientId **- идентификатор клиента.
3200 -
3201 -Ответ:
3202 -
3203 -{
3204 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3205 - "Balance": 0
3206 -}
3207 -
3208 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3209 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3210 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3211 -
3212 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3213 -
3214 -(% class="box infomessage" %)
3215 -(((
3216 -**GET /api/v3/Billing/client/constraint/{clientId}**
3217 -)))
3218 -
3219 -Параметр запроса: **clientId **- идентификатор клиента.
3220 -
3221 -Ответ:
3222 -
3223 -{
3224 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3225 - "CalculationType": 0,
3226 - "PermissibleBalance": 0,
3227 - "DefermentDays": 0,
3228 - "SendUiNotifications": true,
3229 - "SendEmailNotifications": true,
3230 - "IsPrivate": true,
3231 -}
3232 -
3233 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3234 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3235 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3236 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3237 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3238 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3239 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3240 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3241 -
3242 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3243 -
3244 -(% class="box infomessage" %)
3245 -(((
3246 -**GET /api/v3/Billing/client/plan/{clientId}**
3247 -)))
3248 -
3249 -Параметры запроса:
3250 -
3251 -**clientId **- идентификатор клиента.
3252 -
3253 -**planId **- идентификатор тарифного плана.
3254 -
3255 -Ответ:
3256 -
3257 -{
3258 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3259 - "Plan": { **~/~/ Описание тарифного плана**
3260 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3261 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3262 - "Name": "string",
3263 - "IsArchived": true,
3264 - "Constraint": {
3265 - "CalculationType": 0,
3266 - "PermissibleBalance": 0,
3267 - "DefermentDays": 0
3268 - },
3269 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3270 - {
3271 - "Feature": "string",
3272 - "IsFactual": true,
3273 - "Limit": 0,
3274 - "Price": 0,
3275 - "PeriodValue": 0,
3276 - "PeriodType": 0
3277 - }
3278 - ]
3279 - },
3280 - "DebitDate": "2023-10-18T12:46:24.213Z",
3281 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3282 - {
3283 - "Feature": "string",
3284 - "IsEnabled": true,
3285 - "IsPrivate": true,
3286 - "IsFactual": true,
3287 - "Limit": 0,
3288 - "Price": 0,
3289 - "DebitDate": "2023-10-18T12:46:24.213Z",
3290 - "PeriodValue": 0,
3291 - "PeriodType": 0
3292 - }
3293 - ]
3294 -}
3295 -
3296 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3297 -|ClientId|Идентификатор клиента
3298 -|Id|Идентификатор тарифного плана
3299 -|OwnerId|Идентификатор клиента-владельца
3300 -|Name|Наименование тарифного плана
3301 -|IsArchived|Признак, определяющий архивный тарифный план
3302 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3303 -|PermissibleBalance|Допустимый баланс
3304 -|DefermentDays|Отсрочка, количество дней
3305 -|Feature|Код услуги
3306 -|IsEnabled|Признак, определяющий активирована ли услуга
3307 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3308 -|IsFactual|Признак, определяющий расчёт по факту
3309 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3310 -|Price|Цена за единицу.
3311 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3312 -|PeriodValue|Значение периода.
3313 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3314 -
3315 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3316 -
3317 -(% class="box infomessage" %)
3318 -(((
3319 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3320 -)))
3321 -
3322 -Параметр запроса: **clientId **- идентификатор клиента.
3323 -
3324 -Ответ:
3325 -
3326 -[
3327 - {
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 -]
3349 -
3350 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3351 -|ClientId|Идентификатор клиента
3352 -|Id|Идентификатор тарифного плана
3353 -|OwnerId|Идентификатор клиента-владельца
3354 -|Name|Наименование тарифного плана
3355 -|IsArchived|Признак, определяющий архивный тарифный план
3356 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3357 -|PermissibleBalance|Допустимый баланс
3358 -|DefermentDays|Отсрочка, количество дней
3359 -|Feature|Код услуги
3360 -|IsFactual|Признак, определяющий расчёт по факту
3361 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3362 -|Price|Цена за единицу.
3363 -|PeriodValue|Значение периода.
3364 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3365 -
3366 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3367 -
3368 -(% class="box infomessage" %)
3369 -(((
3370 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3371 -)))
3372 -
3373 -Параметр запроса: **clientId **- идентификатор клиента.
3374 -
3375 -Ответ:
3376 -
3377 -[
3378 - {
3379 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3380 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3381 - "Name": "string",
3382 - "IsArchived": true,
3383 - "Constraint": {
3384 - "CalculationType": 0,
3385 - "PermissibleBalance": 0,
3386 - "DefermentDays": 0
3387 - },
3388 - "Features": [
3389 - {
3390 - "Feature": "string",
3391 - "IsFactual": true,
3392 - "Limit": 0,
3393 - "Price": 0,
3394 - "PeriodValue": 0,
3395 - "PeriodType": 0
3396 - }
3397 - ]
3398 - }
3399 -]
3400 -
3401 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3402 -|ClientId|Идентификатор клиента
3403 -|Id|Идентификатор тарифного плана
3404 -|OwnerId|Идентификатор клиента-владельца
3405 -|Name|Наименование тарифного плана
3406 -|IsArchived|Признак, определяющий архивный тарифный план
3407 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3408 -|PermissibleBalance|Допустимый баланс
3409 -|DefermentDays|Отсрочка, количество дней
3410 -|Feature|Код услуги
3411 -|IsFactual|Признак, определяющий расчёт по факту
3412 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3413 -|Price|Цена за единицу.
3414 -|PeriodValue|Значение периода.
3415 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3416 -
3417 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3418 -
3419 -(% class="box warningmessage" %)
3420 -(((
3421 -**PUT /api/v3/Billing/client/balance**
3422 -)))
3423 -
3424 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3425 -
3426 -Тело запроса:
3427 -
3428 -{
3429 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3430 - "Balance": 0
3431 -}
3432 -
3433 -Ответ: Success
3434 -
3435 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3436 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3437 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3438 -
3439 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3440 -
3441 -(% class="box warningmessage" %)
3442 -(((
3443 -**PUT /api/v3/billing/client/balance/deposit**
3444 -)))
3445 -
3446 -Создает операцию **Пополнение **с указанной суммой
3447 -
3448 -Тело запроса:
3449 -
3450 -{
3451 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3452 - "Balance": 0
3453 -}
3454 -
3455 -Ответ: Success
3456 -
3457 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3458 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3459 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3460 -
3461 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3462 -
3463 -Создает операцию **Списание **с указанной суммой
3464 -
3465 -(% class="box warningmessage" %)
3466 -(((
3467 -**PUT /api/v3/billing/client/balance/withdraw**
3468 -)))
3469 -
3470 -Тело запроса:
3471 -
3472 -{
3473 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3474 - "Balance": 0
3475 -}
3476 -
3477 -Ответ: Success
3478 -
3479 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3480 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3481 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3482 -
3483 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3484 -
3485 -(% class="box warningmessage" %)
3486 -(((
3487 -**PUT /api/v3/Billing/client/constraint**
3488 -)))
3489 -
3490 -Тело запроса:
3491 -
3492 -{
3493 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3494 - "CalculationType": 0,
3495 - "PermissibleBalance": 0,
3496 - "DefermentDays": 0,
3497 - "SendUiNotifications": true,
3498 - "SendEmailNotifications": true,
3499 - "IsPrivate": true,
3500 -}
3501 -
3502 -Ответ: Success
3503 -
3504 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3505 -|ClientId|Идентификатор клиента
3506 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3507 -|PermissibleBalance|Допустимый баланс
3508 -|DefermentDays|(((
3509 -Отсрочка, количество дней
3510 -)))
3511 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3512 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3513 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3514 -
3515 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3516 -
3517 -(% class="box warningmessage" %)
3518 -(((
3519 -**PUT /api/v3/Billing/client/plan**
3520 -)))
3521 -
3522 -Тело запроса:
3523 -
3524 -{
3525 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3526 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3527 - "Features": [
3528 - {
3529 - "Feature": "string",
3530 - "IsEnabled": true,
3531 - "IsFactual": true,
3532 - "Limit": 0,
3533 - "Price": 0,
3534 - "DebitDate": "2023-10-18T13:26:58.987Z",
3535 - "PeriodValue": 0,
3536 - "PeriodType": 0
3537 - }
3538 - ]
3539 -}
3540 -
3541 -Ответ: Success
3542 -
3543 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3544 -|ClientId|Идентификатор клиента
3545 -|PlanId|Идентификатор тарифного плана
3546 -|Feature|Код услуги
3547 -|IsEnabled|Признак, определяющий активирована ли услуга
3548 -|IsFactual|Признак, определяющий расчёт по факту
3549 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3550 -|Price|Цена за единицу.
3551 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3552 -|PeriodValue|Значение периода.
3553 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3554 -
3555 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3556 -
3557 -(% class="box warningmessage" %)
3558 -(((
3559 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3560 -)))
3561 -
3562 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3563 -
3564 -(% class="box infomessage" %)
3565 -(((
3566 -**POST /api/v3/vehicles/import/{agentId}**
3567 -)))
3568 -
3569 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3570 -
3571 -В пути указывается **agentId** - id клиента.
3572 -
3573 -**Заголовок**
3574 -
3575 -**X-Auth: [токен авторизации]**
3576 -
3577 -**Параметры**
3578 -
3579 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3580 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3581 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3582 -
3583 -В теле использовать тип **form-data,** тип значения** file**
3584 -
3585 -**Ключи**
3586 -
3587 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3588 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3589 -|csv|В значении передаем файл датчиков, формат **csv**
3590 -
3591 -Ответ:
3592 -
3593 -{
3594 - "vehicleId": 0,
3595 - "name": "string",
3596 - "errors": ["string"]
3597 -}
3598 -
3599 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3600 -|vehicleId|ID созданного объекта
3601 -|name|Имя созданного объекта
3602 -|errors|Ошибки и их описание
3603 -
3604 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3605 -
3606 -(% class="box infomessage" %)
3607 -(((
3608 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3609 -)))
3610 -
3611 -(% class="wikigeneratedid" %)
3612 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3613 -
3614 -(% class="wikigeneratedid" %)
3615 -В пути указывается **vehicleId **- id объекта.
3616 -
3617 -**Заголовок**
3618 -
3619 -**X-Auth: [токен авторизации]**
3620 -
3621 -В теле использовать тип **form-data.**
3622 -
3623 -Ключи:
3624 -
3625 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3626 -|**history**|В значении передавать файл с историей
3627 -
3628 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3629 -
3630 -Ответ:
3631 -
3632 -{
3633 - "results": [
3634 - {
3635 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3636 - "vehicleId": 0,
3637 - "errors": [
3638 - "string"
3639 - ],
3640 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3641 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3642 - "producedCount": 0,
3643 - "msgCount": 0
3644 - }
3645 - ]
3646 -}
3647 -
3648 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3649 -|results|Результаты импорта в разрезе ТС
3650 -|vehicleGuid|Guid ТС
3651 -|vehicleId|ID ТС
3652 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3653 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3654 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3655 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3656 -|msgCount|Кол-во обработанных сообщений всего
3657 -
3658 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3659 -
3660 -(% class="box infomessage" %)
3661 -(((
3662 -**GET /api/v3/vehicles/import/history/status**
3663 -)))
3664 -
3665 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3666 -
3667 -Ответ:
3668 -
3669 -{
3670 - "activity": true,
3671 - "progress": 0,
3672 - "message": "string"
3673 -}
3674 -
3675 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3676 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3677 -|progress|Guid ТС
3678 -
3679 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3680 -
3681 -(% class="box infomessage" %)
3682 -(((
3683 -**POST /api/v3/vehicles/export**
3684 -)))
3685 -
3686 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3687 -
3688 -Тело запроса:
3689 -
3690 -[
3691 - id
3692 -]
3693 -
3694 -Ответ: Success 200, получаете файлы с настройками.
3695 -
3696 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3697 -
3698 -(% class="box infomessage" %)
3699 -(((
3700 -**POST /api/v3/vehicles/export/history**
3701 -)))
3702 -
3703 -Метод возвращает список сообщений терминала объекта за выбранный период.
3704 -
3705 -Тело запроса:
3706 -
3707 -{
3708 - "vehicleId": 0,
3709 - "asArchive": true,
3710 - "from": "2023-09-27T12:17:45.973Z",
3711 - "to": "2023-09-27T12:17:45.973Z"
3712 -}
3713 -
3714 -Ответ:
3715 -
3716 -Получаете файл. Сообщение: Code 200/Success
3717 -
3718 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3719 -|vehicleId|ID объекта
3720 -|asArchive|true - Архивировать файл, False - не архивировать
3721 -|from|Дата и время начала запроса
3722 -|to|Дата и время окончания запроса
3723 -
3724 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3725 -
3726 -(% class="box infomessage" %)
3727 -(((
3728 -**GET /api/v3/vehicles/export/history/status**
3729 -)))
3730 -
3731 -Метод возвращает список сообщений терминала объекта за выбранный период.
3732 -
3733 -Ответ:
3734 -
3735 -{
3736 - "activity": true,
3737 - "progress": 0,
3738 - "message": "string"
3739 -}
3740 -
3741 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3742 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3743 -|progress|Прогресс экспорта, от 0 до 100%
3744 -|message|Текст описывающий статус
3745 -
3746 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3747 -
3748 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3749 -
3750 -(% class="box infomessage" %)
3751 -(((
3752 -**POST /api/v3/EcoDriving/rating**
3753 -)))
3754 -
3755 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3756 -
3757 -Тело запроса:
3758 -
3759 -{
3760 - "vehicleIds": [vehicleId],
3761 - "from": "2023-11-22T09:29:48.051Z",
3762 - "to": "2023-11-22T09:29:48.051Z"
3763 -}
3764 -
3765 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3766 -|vehicleIds|Массив ID объектов
3767 -|from|Дата начала запроса
3768 -|to|Дата окончания запроса
3769 -
3770 -Ответ:
3771 -
3772 -{
3773 - "items": [
3774 - {
3775 - "from": "2023-11-22T09:29:48.052Z",
3776 - "to": "2023-11-22T09:29:48.052Z",
3777 - "vehicleId": 0,
3778 - "vehicleName": "string",
3779 - "vehicleModel": "string",
3780 - "penalty": 0,
3781 - "score": 0,
3782 - "totalViolations": 0,
3783 - "violationsByType": {
3784 - "overspeedingViolations": 0,
3785 - "accelerationViolations": 0,
3786 - "brakingViolations": 0,
3787 - "turningViolations": 0,
3788 - "dangerousDrivingViolations": 0,
3789 - "sensorViolations": 0
3790 - },
3791 - "moveTime": 0,
3792 - "mileage": 0,
3793 - "tripsCount": 0,
3794 - "trips": [
3795 - {
3796 - "penalty": 0,
3797 - "score": 0,
3798 - "violationsCount": 0,
3799 - "violationsByType": {
3800 - "overspeedingViolations": 0,
3801 - "accelerationViolations": 0,
3802 - "brakingViolations": 0,
3803 - "turningViolations": 0,
3804 - "dangerousDrivingViolations": 0,
3805 - "sensorViolations": 0
3806 - },
3807 - "moveTime": 0,
3808 - "mileage": 0,
3809 - "motohours": 0,
3810 - "maxSpeed": 0,
3811 - "startAddress": "string",
3812 - "endAddress": "string",
3813 - "drivers": [
3814 - {
3815 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3816 - "driverName": "string",
3817 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3818 - }
3819 - ]
3820 - }
3821 - ]
3822 - }
3823 - ]
3824 -}
3825 -
3826 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3827 -|from|Дата начала запроса
3828 -|to|Дата  окончания
3829 -|vehicleId|ID объекта
3830 -|vehicleName|Имя объекта
3831 -|vehicleModel|Модель объекта
3832 -|penalty|Сумма штрафных баллов
3833 -|score|Оценка
3834 -|totalViolations|Суммарное количество нарушений
3835 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3836 -|overspeedingViolations|Превышение скорости
3837 -|accelerationViolations|Ускорение
3838 -|brakingViolations|Торможение
3839 -|turningViolations|Резкий поворот
3840 -|dangerousDrivingViolations|Резкое вождение
3841 -|sensorViolations|Нарушение по датчику
3842 -|moveTime|Время в движении
3843 -|mileage|Пробег
3844 -|tripsCount|Количество рейсов
3845 -|motohours|Моточасы
3846 -|maxSpeed|Максимальная скорость
3847 -|startAddress|Адрес начала рейса
3848 -|endAddress|Адрес окончания рейса
3849 -|drivers|Список водителей, которые были на объекте в течениии рейса
3850 -|driverGuid|Guid водителя
3851 -|driverName|Имя водителя
3852 -|driverRfid|Номер Карты-метки
3853 -
3854 3854  (% class="box" lang="en-US" style="text-align: center;" %)
3855 3855  (((
3856 3856  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

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